DomainParticipantFactory

DDS_DomainParticipantFactory entity and associated elements More...

Data Structures
struct	DDS_DomainParticipantFactoryQos
	<<cert>> QoS policies supported by a DDS_DomainParticipantFactory. More...

Macros
#define	DDS_DomainParticipantFactoryQos_INITIALIZER
	<<cert>> Initializer for new QoS instances.
#define	DDS_TheParticipantFactory   DDS_DomainParticipantFactory_get_instance()
	<<cert>> Alias for singleton participant factory.

Typedefs
typedef struct DDS_DomainParticipantFactoryImpl	DDS_DomainParticipantFactory
	<<singleton>> <<interface>> <<cert>> Allows creation and destruction of DDS_DomainParticipant objects.

Functions
DDS_DomainParticipantFactory *	DDS_DomainParticipantFactory_get_instance (void)
	<<cert>> Gets the singleton instance of this class.
DDS_ReturnCode_t	DDS_DomainParticipantFactory_finalize_instance (void)
	<<eXtension>> Destroys the singleton instance of this class.
DDS_ReturnCode_t	DDS_DomainParticipantFactory_set_default_participant_qos (DDS_DomainParticipantFactory *self, const struct DDS_DomainParticipantQos *qos)
	Sets the default DDS_DomainParticipantQos values for this domain participant factory.
DDS_ReturnCode_t	DDS_DomainParticipantFactory_get_default_participant_qos (DDS_DomainParticipantFactory *self, struct DDS_DomainParticipantQos *qos)
	Initializes the DDS_DomainParticipantQos instance with default values.
DDS_DomainParticipant *	DDS_DomainParticipantFactory_create_participant (DDS_DomainParticipantFactory *self, DDS_DomainId_t domainId, const struct DDS_DomainParticipantQos *qos, const struct DDS_DomainParticipantListener *listener, DDS_StatusMask mask)
	<<cert>> Creates a new DDS_DomainParticipant object.
DDS_ReturnCode_t	DDS_DomainParticipantFactory_delete_participant (DDS_DomainParticipantFactory *self, DDS_DomainParticipant *a_participant)
	Deletes an existing DDS_DomainParticipant.
DDS_DomainParticipant *	DDS_DomainParticipantFactory_lookup_participant (DDS_DomainParticipantFactory *self, DDS_DomainId_t domainId)
	<<cert>> Locates an existing DDS_DomainParticipant.
DDS_ReturnCode_t	DDS_DomainParticipantFactory_get_qos (DDS_DomainParticipantFactory *self, struct DDS_DomainParticipantFactoryQos *qos)
	<<cert>> Gets the value for participant factory QoS.
DDS_ReturnCode_t	DDS_DomainParticipantFactory_set_qos (DDS_DomainParticipantFactory *self, const struct DDS_DomainParticipantFactoryQos *qos)
	<<cert>> Sets the value for a participant factory QoS.
RT_Registry_T *	DDS_DomainParticipantFactory_get_registry (DDS_DomainParticipantFactory *self)
	<<cert>> Retrieves the singleton registry instance associated with the factory.

Variables
struct DDS_DomainParticipantFactoryQos	DDS_PARTICIPANT_FACTORY_QOS_DEFAULT
	<<cert>> Special value for creating domain participant with default QoS.
struct DDS_DomainParticipantQos	DDS_PARTICIPANT_QOS_DEFAULT
	<<cert>> Special value for creating domain participant with default QoS.

---

Detailed Description

DDS_DomainParticipantFactory entity and associated elements

---

Macro Definition Documentation

#define DDS_DomainParticipantFactoryQos_INITIALIZER

<<cert>> Initializer for new QoS instances.

DDS_DomainParticipantFactoryQos instances stored on the stack should be initialized with this value before they are passed to any function. This step ensures that those contained QoS policies that use dynamic memory are properly initialized. This does not allocate memory.

The simplest way to create a new QoS structure is to initialize it on the stack at the time of its creation.

#define DDS_TheParticipantFactory   DDS_DomainParticipantFactory_get_instance()

<<cert>> Alias for singleton participant factory.

---

Typedef Documentation

typedef struct DDS_DomainParticipantFactoryImpl DDS_DomainParticipantFactory

<<singleton>> <<interface>> <<cert>> Allows creation and destruction of DDS_DomainParticipant objects.

The sole purpose of this class is to allow the creation and destruction of DDS_DomainParticipant objects. This class itself is a <<singleton>>, and accessed via the get_instance() function, and destroyed with finalize_instance() function.

A single application can participate in multiple domains by instantiating multiple DDS_DomainParticipant objects.

An application may even instantiate multiple participants in the same domain. Participants in the same domain exchange data in the same way regardless of whether they are in the same application or different applications or on the same node or different nodes; their location is transparent.

There are two important caveats:

• With multiple participants in the same domain on the same node (in the same application or different applications), each participant must be assigned its own receive ports. The receive ports are calculated based on the domain ID and the participant index set in the DDS_WireProtocolQosPolicy. The default index (-1) causes the participant to automatically search for the next available index, starting at 0, when it is created. If an index larger or equal to 0 is assigned then only that value will be used. If another participant with the same index already exists the participant creation will fail.

  NOTE: An exception to this rule is multicast ports. Multicast ports are shared between between participants in the same domain on the same host). Thus, the index value is ignored.

• You cannot mix entities from different participants. For example, you cannot delete a topic on a different participant than you created it from, and you cannot ask a subscriber to create a reader for a topic created from a participant different than the subscriber's own participant. (Note that it is permissable for an application built on top of RTI Connext DDS Micro to know about entities from different participants. For example, an application could keep references to a reader from one domain and a writer from another and then bridge the domains by writing the data received in the reader callback.)

See also:

DDS_DomainParticipant

---

Function Documentation

DDS_DomainParticipantFactory* DDS_DomainParticipantFactory_get_instance

(

void

)

<<cert>> Gets the singleton instance of this class.

Returns:

the DDS_DomainParticipantFactory instance.

MT Safety:

UNSAFE on the FIRST call to DDS_DomainParticipantFactory_get_instance(). It is not safe for two threads to simultaneously make the first call to get an instance of the factory. Subsequent calls are thread safe.

DDS_TheParticipantFactory can be used as an alias for the singleton factory returned by this operation.

Returns:

the singleton DDS_DomainParticipantFactory instance.

See also:

DDS_TheParticipantFactory

DDS_ReturnCode_t DDS_DomainParticipantFactory_finalize_instance

(

void

)

<<eXtension>> Destroys the singleton instance of this class.

Only necessary to explicitly reclaim resources used by the participant factory singleton. Note that on many OSes, these resources are automatically reclaimed by the OS when the program terminates. Some memory checker tools still flag these as unreclaimed however. So this function provides a way to clean up memory used by the participant factory.

Precondition:

All participants created from the factory have been deleted.

Postcondition:

All resources belonging to the factory reclaimed. Another call to DDS_DomainParticipantFactory_get_instance will return a new lifecycle of the singleton.

MT Safety:

UNSAFE for two threads to simultaneously call DDS_DomainParticipantFactory_finalize_instance() or DDS_DomainParticipantFactory_get_instance() at the same time.

Returns:

One of the Standard Return Codes, or DDS_RETCODE_PRECONDITION_NOT_MET

DDS_ReturnCode_t DDS_DomainParticipantFactory_set_default_participant_qos	(	DDS_DomainParticipantFactory *	self,
		const struct DDS_DomainParticipantQos *	qos
	)

Sets the default DDS_DomainParticipantQos values for this domain participant factory.

This function may potentially allocate memory depending on the sequences contained in some QoS policies.

Parameters:

self	<<in>> Cannot be NULL.
qos	<<inout>> Qos to be used by the DDS_DomainParticipant. The special value DDS_PARTICIPANT_QOS_DEFAULT may be passed as qos to indicate that the default QoS should be reset back to the initial values the factory would used if DDS_DomainParticipantFactory_set_default_participant_qos had never been called. Cannot be NULL.

Returns:

One of the Standard Return Codes

See also:

DDS_PARTICIPANT_QOS_DEFAULT

DDS_DomainParticipantFactory_create_participant

DDS_ReturnCode_t DDS_DomainParticipantFactory_get_default_participant_qos	(	DDS_DomainParticipantFactory *	self,
		struct DDS_DomainParticipantQos *	qos
	)

Initializes the DDS_DomainParticipantQos instance with default values.

The retrieved qos will match the set of values specified on the last successful call to DDS_DomainParticipantFactory_set_default_participant_qos, or else, if the call was never made, the default values listed in DDS_DomainParticipantQos.

This function may potentially allocate memory depending on the sequences contained in some QoS policies.

Parameters:

self	<<in>> Cannot be NULL.
qos	<<out>> the domain participant's QoS Cannot be NULL.

Returns:

One of the Standard Return Codes

See also:

DDS_PARTICIPANT_QOS_DEFAULT

DDS_DomainParticipantFactory_create_participant

DDS_DomainParticipant* DDS_DomainParticipantFactory_create_participant	(	DDS_DomainParticipantFactory *	self,
		DDS_DomainId_t	domainId,
		const struct DDS_DomainParticipantQos *	qos,
		const struct DDS_DomainParticipantListener *	listener,
		DDS_StatusMask	mask
	)

<<cert>> Creates a new DDS_DomainParticipant object.

Precondition:

The specified QoS policies must be consistent, or the operation will fail and no DDS_DomainParticipant will be created.

If you want to create multiple participants on a given host in the same domain, make sure each one has a different participant index (set in the DDS_WireProtocolQosPolicy). This in turn will ensure each participant uses a different port number (since the unicast port numbers are calculated from the participant index and the domain ID).

Note that if there is a single participant per host in a given domain, the participant index can be left at the default value (-1).

Precondition:

if listener is specified, none of the listener callback functions can be NULL.

Parameters:

self	<<in>> Cannot be NULL.
domainId	<<in>> ID of the domain that the application intends to join. [range] [>=0], and does not violate guidelines stated in DDS_RtpsWellKnownPorts_t.
qos	<<in>> the domain participant's QoS. The special value DDS_PARTICIPANT_QOS_DEFAULT can be used to indicate that the DDS_DomainParticipant should be created with the default DDS_DomainParticipantQos set in the DDS_DomainParticipantFactory. Cannot be NULL.
listener	<<in>> the domain participant's listener.
mask	<<in>> Changes of communication status to be invoked on the listener.

Returns:

domain participant or NULL on failure

See also:

Specifying QoS on entities for information on setting QoS before entity creation

DDS_DomainParticipantQos for rules on consistency among QoS

DDS_PARTICIPANT_QOS_DEFAULT

DDS_ReturnCode_t DDS_DomainParticipantFactory_delete_participant	(	DDS_DomainParticipantFactory *	self,
		DDS_DomainParticipant *	a_participant
	)

Deletes an existing DDS_DomainParticipant.

Precondition:

All domain entities belonging to the participant must have already been deleted. Otherwise it fails with the error DDS_RETCODE_PRECONDITION_NOT_MET.

Postcondition:

Listener installed on the DDS_DomainParticipant will not be called after this function returns successfully.

Parameters:

self	<<in>> Cannot be NULL.
a_participant	<<in>> DDS_DomainParticipant to be deleted.

Returns:

One of the Standard Return Codes, or DDS_RETCODE_PRECONDITION_NOT_MET.

DDS_DomainParticipant* DDS_DomainParticipantFactory_lookup_participant	(	DDS_DomainParticipantFactory *	self,
		DDS_DomainId_t	domainId
	)

<<cert>> Locates an existing DDS_DomainParticipant.

If no such DDS_DomainParticipant exists, the operation will return NULL value.

If multiple DDS_DomainParticipant entities belonging to that domainId exist, then the operation will return one of them. It is not specified which one.

Parameters:

self	<<in>> Cannot be NULL.
domainId	<<in>> ID of the domain participant to lookup.

Returns:

domain participant if it exists, or NULL

DDS_ReturnCode_t DDS_DomainParticipantFactory_get_qos	(	DDS_DomainParticipantFactory *	self,
		struct DDS_DomainParticipantFactoryQos *	qos
	)

<<cert>> Gets the value for participant factory QoS.

Parameters:

self	<<in>> Cannot be NULL.
qos	<<inout>> QoS to be filled up. Cannot be NULL.

Returns:

One of the Standard Return Codes

DDS_ReturnCode_t DDS_DomainParticipantFactory_set_qos	(	DDS_DomainParticipantFactory *	self,
		const struct DDS_DomainParticipantFactoryQos *	qos
	)

<<cert>> Sets the value for a participant factory QoS.

The DDS_DomainParticipantFactoryQos::entity_factory can be changed. The other policies are immutable.

Note that despite having QoS, the DDS_DomainParticipantFactory is not an DDS_Entity.

Note that this function may cause RTI Connext DDS Micro to free and reallocate memory, depending on the QoS policies that are changed.

Parameters:

self	<<in>> Cannot be NULL.
qos	<<in>> Set of policies to be applied to DDS_DomainParticipantFactory. Policies must be consistent. Immutable policies can only be changed before calling any other RTI Connext DDS Micro functions except for DDS_DomainParticipantFactory_get_qos Cannot be NULL.

Returns:

One of the Standard Return Codes, DDS_RETCODE_IMMUTABLE_POLICY if immutable policy is changed, or DDS_RETCODE_INCONSISTENT_POLICY if policies are inconsistent

See also:

DDS_DomainParticipantFactoryQos for rules on consistency among QoS

RT_Registry_T* DDS_DomainParticipantFactory_get_registry

(

DDS_DomainParticipantFactory *

self

)

<<cert>> Retrieves the singleton registry instance associated with the factory.

Parameters:

self	<<in>> Cannot be NULL.

Returns:

the registry instance or NULL on failure.

---

Variable Documentation

struct DDS_DomainParticipantFactoryQos DDS_PARTICIPANT_FACTORY_QOS_DEFAULT

<<cert>> Special value for creating domain participant with default QoS.

When used in DDS_DomainParticipantFactory_create_participant, this special value is used to indicate that the DDS_DomainParticipant should be created with the default DDS_DomainParticipant QoS.

See also:

DDS_DomainParticipantFactory_create_participant()

struct DDS_DomainParticipantQos DDS_PARTICIPANT_QOS_DEFAULT

<<cert>> Special value for creating domain participant with default QoS.

When used in DDS_DomainParticipantFactory_create_participant, this special value is used to indicate that the DDS_DomainParticipant should be created with the default DDS_DomainParticipant QoS.

See also:

DDS_DomainParticipantFactory_create_participant()