The DDS_DomainParticipantFactory is used to configure, create and destroy DomainParticipant objects. More...

Related Functions
(Note that these are not member functions.)
DDS_DomainParticipant	DDS_DomainParticipantFactory_create_participant_ex (DDS_DomainParticipantFactory dpf, DDS_DomainId_t domain_id, DDS_DomainParticipantQos qos, DDS_DomainParticipantListener a_listener, DDS_StatusMask mask)
	This operation creates a new DomainParticipant object. More...

DDS_DomainParticipant	DDS_DomainParticipantFactory_create_participant (DDS_DomainId_t domain_id, DDS_DomainParticipantQos qos, DDS_DomainParticipantListener a_listener, DDS_StatusMask mask)
	This operation creates a new DomainParticipant object. More...

DDS_ReturnCode_t	DDS_DomainParticipantFactory_set_license (const char *lic)
	Configures the CoreDX DDS run-time license. More...

DDS_ReturnCode_t	DDS_DomainParticipantFactory_set_license_debug (unsigned char debug)
	Enables debug output from the CoreDX DDS run-time license system. More...

DDS_ReturnCode_t	DDS_DomainParticipantFactory_delete_participant (DDS_DomainParticipant a_participant)
	Destroys the provided DomainParticipant. More...

DDS_DomainParticipant	DDS_DomainParticipantFactory_lookup_participant (DDS_DomainId_t domain_id)
	Returns a previously created DomainParticipant belonging to the specified domain_id. More...

DDS_ReturnCode_t	DDS_DomainParticipantFactory_set_default_participant_qos (DDS_DomainParticipantQos *qos)
	Sets the default DDS_DomainParticipantQos held in the factory. More...

DDS_ReturnCode_t	DDS_DomainParticipantFactory_get_default_participant_qos (DDS_DomainParticipantQos *qos)
	Provides access to the default Participant qos held in the factory. More...

DDS_ReturnCode_t	DDS_DomainParticipantFactory_set_qos (const DDS_DomainParticipantFactoryQos *qos)
	Sets the DomainParticipantFactory QoS values. More...

DDS_ReturnCode_t	DDS_DomainParticipantFactory_get_qos (DDS_DomainParticipantFactoryQos *qos)
	Provides access to the QoS settings of the DomainParticipantFactory.

char *	CoreDX_DDS_get_lib_version (void)
	Returns the version string associated with the CoreDX DDS library. More...

DDS_ReturnCode_t	CoreDX_DDS_get_lib_version_string (char *vstring_buf, int buf_len)
	Returns the version string associated with the CoreDX DDS library. More...

Detailed Description

The DDS_DomainParticipantFactory is used to configure, create and destroy DomainParticipant objects.

Friends And Related Function Documentation

char * CoreDX_DDS_get_lib_version ( void )

Deprecated:: Use CoreDX_DDS_get_lib_version_string() instead.

Routine allocates a buffer to hold the version string. Caller must free the buffer.

DDS_ReturnCode_t CoreDX_DDS_get_lib_version_string	(	char *	vstring_buf,
		int	buf_len
	)

Caller must provide a buffer to hold the version string 'vstring_buf' If the paramter 'buf_len' indicates that buffer is too small to hold the version string, then DDS_RETCODE_BAD_PARAMETER is returned. If the 'vstring_buf' is NULL, then DDS_RETCODE_BAD_PARAMETER is returned.

DDS_DomainParticipant DDS_DomainParticipantFactory_create_participant	(	DDS_DomainId_t	domain_id,
		DDS_DomainParticipantQos *	qos,
		DDS_DomainParticipantListener *	a_listener,
		DDS_StatusMask	mask
	)

The caller provides the domain_id to which the Participant should belong. The listener and mask arguments are used to specify a set of callback routines which will be invoked upon detection of certain events. The qos argument specifies the DomainParticipant Quality of Service settings that should be used when creating the DomainParticipant. It may be specified as DDS_PARTICIPANT_QOS_DEFAULT to instruct CoreDX DDS to use the default qos settings held in the DomainParticipantFactory.
This routine will return NULL if it fails to create a DomainParticipant.

Note: : deprectated...

DDS_DomainParticipant DDS_DomainParticipantFactory_create_participant_ex	(	DDS_DomainParticipantFactory	dpf,
		DDS_DomainId_t	domain_id,
		DDS_DomainParticipantQos *	qos,
		DDS_DomainParticipantListener *	a_listener,
		DDS_StatusMask	mask
	)

The caller provides the domain_id to which the Participant should belong. The listener and mask arguments are used to specify a set of callback routines which will be invoked upon detection of certain events. The qos argument specifies the DomainParticipant Quality of Service settings that should be used when creating the DomainParticipant. It may be specified as DDS_PARTICIPANT_QOS_DEFAULT to instruct CoreDX DDS to use the default qos settings held in the DomainParticipantFactory.
This routine will return NULL if it fails to create a DomainParticipant.

DDS_ReturnCode_t DDS_DomainParticipantFactory_delete_participant ( DDS_DomainParticipant a_participant )

This routine will fail if all Entities (Publishers, Subscribers, etc) created through the specified DomainParticipant have not yet been deleted. (In this case, DDS_RETCODE_PRECONDITION_NOT_MET will be returned.)

DDS_ReturnCode_t DDS_DomainParticipantFactory_get_default_participant_qos ( DDS_DomainParticipantQos * qos )

The provided qos argument is populated with the default qos settings.

DDS_DomainParticipant DDS_DomainParticipantFactory_lookup_participant ( DDS_DomainId_t domain_id )

If there are multiple DomainParticipants in existence within the specified domain, one of them will be returned.

DDS_ReturnCode_t DDS_DomainParticipantFactory_set_default_participant_qos ( DDS_DomainParticipantQos * qos )

This default qos will be used during subsequent calls to DDS_DomainParticipantFactory_create_participant() if the special DDS_PARTICIPANT_QOS_DEFAULT value is provided for qos.
This routine may fail if the provided qos argument is not internally consistent. In this case, DDS_INCONSISTENT_POLICY will be returned, and no changes will be made to the DomainParticipantFactory.

DDS_ReturnCode_t DDS_DomainParticipantFactory_set_license ( const char * lic )

This routine will configure CoreDX DDS to utilize the provided license at run-time. The 'lic' parameter may be either: 1) the full path and filename of a file containing CoreDX DDS license(s); or 2) the complete license string surrounded by '<' and '>'.

DDS_ReturnCode_t DDS_DomainParticipantFactory_set_license_debug ( unsigned char debug )

This routine will configure CoreDX DDS to generate debug information in processing the license at run-time. The 'deubg' parameter may be either: 'nonzero' to enable debug output or 'zero' to disable debug ouput.

DDS_ReturnCode_t DDS_DomainParticipantFactory_set_qos ( const DDS_DomainParticipantFactoryQos * qos )

These QoS values affect the behavior of the factory.

This routine may fail if the provided qos argument is not internally consistent. In this case, DDS_INCONSISTENT_POLICY will be returned, and no changes will be made to the DomainParticipantFactory.

Related Functions

Detailed Description

Friends And Related Function Documentation