DomainParticipantFactory

DDSDomainParticipantFactory entity and associated elements More...

Modules
	DomainParticipantConfigParams
	<<extension>> DDS_DomainParticipantConfigParams_t

Classes
struct	DDS_DomainParticipantFactoryQos
	QoS policies supported by a DDSDomainParticipantFactory. More...
class	DDSDomainParticipantFactory
	<<singleton>> <<interface>> Allows creation and destruction of DDSDomainParticipant objects. More...

Macros
#define	DDSTheParticipantFactory   DDSDomainParticipantFactory::get_instance()
	Can be used as an alias for the singleton factory returned by the operation DDSDomainParticipantFactory::get_instance().

Typedefs
typedef DDS_ReturnCode_t(*	DDSDomainParticipantFactory_RegisterTypeFunction )(DDSDomainParticipant *participant, const char *type_name)
	Prototype of a register type function.

Functions
DDS_Boolean	DDS_DomainParticipantFactoryQos_equals (const struct DDS_DomainParticipantFactoryQos *self, const struct DDS_DomainParticipantFactoryQos *other)
	Compares two DDS_DomainParticipantFactoryQos for equality.

Variables
struct DDS_DomainParticipantQos	DDS_PARTICIPANT_QOS_DEFAULT
	Special value for creating a DomainParticipant with default QoS.
struct DDS_DomainParticipantConfigParams_t	DDS_PARTICIPANT_CONFIG_PARAMS_DEFAULT
	Special value for creating a DDSDomainParticipant from configuration using default parameters.

Detailed Description

DDSDomainParticipantFactory entity and associated elements

Macro Definition Documentation

#define DDSTheParticipantFactory   DDSDomainParticipantFactory::get_instance()

Can be used as an alias for the singleton factory returned by the operation DDSDomainParticipantFactory::get_instance().

See Also

DDSDomainParticipantFactory::get_instance

Examples:

HelloWorld_publisher.cxx, and HelloWorld_subscriber.cxx.

Typedef Documentation

typedef DDS_ReturnCode_t(* DDSDomainParticipantFactory_RegisterTypeFunction)(DDSDomainParticipant *participant, const char *type_name)

Prototype of a register type function.

Parameters

participant	<<inout>> DDSDomainParticipant participant the type is registered with.
type_name	<<in>> Name the type is registered with.

Returns

One of the Standard Return Codes

Function Documentation

DDS_Boolean DDS_DomainParticipantFactoryQos_equals	(	const struct DDS_DomainParticipantFactoryQos *	self,
		const struct DDS_DomainParticipantFactoryQos *	other
	)

Compares two DDS_DomainParticipantFactoryQos for equality.

Parameters

self	<<in>> This DomainParticipantFactoryQos.
other	<<in>> The other DomainParticipantFactoryQos to be compared with this DomainParticipantFactoryQos.

Returns

DDS_BOOLEAN_TRUE if the two Qos objects are equal or DDS_BOOLEAN_FALSE otherwise.

Referenced by DDS_DomainParticipantFactoryQos::operator!=(), and DDS_DomainParticipantFactoryQos::operator==().

Variable Documentation

struct DDS_DomainParticipantQos DDS_PARTICIPANT_QOS_DEFAULT

Special value for creating a DomainParticipant with default QoS.

When used in DDSDomainParticipantFactory::create_participant, this special value is used to indicate that the DDSDomainParticipant should be created with the default DDSDomainParticipant QoS by means of the operation DDSDomainParticipantFactory::get_default_participant_qos() and using the resulting QoS to create the DDSDomainParticipant.

When used in DDSDomainParticipantFactory::set_default_participant_qos, this special value is used to indicate that the default QoS should be reset back to the initial value that would be used if the DDSDomainParticipantFactory::set_default_participant_qos operation had never been called.

When used in DDSDomainParticipant::set_qos, this special value is used to indicate that the QoS of the DDSDomainParticipant should be changed to match the current default QoS set in the DDSDomainParticipantFactory that the DDSDomainParticipant belongs to.

RTI Connext treats this special value as a constant.

Note: You cannot use this value to get the default QoS values from the DomainParticipant factory; for this purpose, use DDSDomainParticipantFactory::get_default_participant_qos.

See Also

NDDS_DISCOVERY_PEERS

DDSDomainParticipantFactory::create_participant()

DDSDomainParticipantFactory::set_default_participant_qos()

DDSDomainParticipant::set_qos()

Examples:

HelloWorld_publisher.cxx, and HelloWorld_subscriber.cxx.

struct DDS_DomainParticipantConfigParams_t DDS_PARTICIPANT_CONFIG_PARAMS_DEFAULT

Special value for creating a DDSDomainParticipant from configuration using default parameters.

This value can be used only in DDSDomainParticipantFactory::create_participant_from_config_w_params and indicates that the DDSDomainParticipant must be created applying the information defined in the participant configuration. That is, the domain ID, participant entity name, and QoS profiles for all the entities will be retrieved from the configuration.

RTI Connext treats this special value as a constant.

See Also

DDS_DomainParticipantConfigParams_t

DDSDomainParticipantFactory::create_participant_from_config_w_params