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(). More...

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

Functions
DDS_Boolean	DDS_DomainParticipantFactoryQos_equals (const struct DDS_DomainParticipantFactoryQos *self, const struct DDS_DomainParticipantFactoryQos *other)
	Compares two DDS_DomainParticipantFactoryQos for equality. More...
DDS_ReturnCode_t	DDS_DomainParticipantFactoryQos::print () const
	Prints this DDS_DomainParticipantFactoryQos to stdout. More...
DDS_ReturnCode_t	DDS_DomainParticipantFactoryQos::to_string (char *string, DDS_UnsignedLong &string_size) const
	Obtains a string representation of this DDS_DomainParticipantQos. More...
DDS_ReturnCode_t	DDS_DomainParticipantFactoryQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_DomainParticipantFactoryQos &base) const
	Obtains a string representation of this DDS_DomainParticipantFactoryQos. More...
DDS_ReturnCode_t	DDS_DomainParticipantFactoryQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintFormat &format) const
	Obtains a string representation of this DDS_DomainParticipantFactoryQos. More...
DDS_ReturnCode_t	DDS_DomainParticipantFactoryQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_DomainParticipantFactoryQos &base, const DDS_QosPrintFormat &format) const
	Obtains a string representation of this DDS_DomainParticipantFactoryQos. More...
DDS_ReturnCode_t	DDS_DomainParticipantFactoryQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintAll_t &) const
	Obtains a string representation of this DDS_DomainParticipantFactoryQos. More...
DDS_ReturnCode_t	DDS_DomainParticipantFactoryQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintAll_t &, const DDS_QosPrintFormat &format) const
	Obtains a string representation of this DDS_DomainParticipantFactoryQos. More...

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

Detailed Description

DDSDomainParticipantFactory entity and associated elements

Macro Definition Documentation

DDSTheParticipantFactory

#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

DDSDomainParticipantFactory_RegisterTypeFunction

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_DomainParticipantFactoryQos_equals()

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!=(), DDS_DomainParticipantFactoryQos::operator==(), and DDS_DomainParticipantQos::to_string().

print()

DDS_ReturnCode_t DDS_DomainParticipantFactoryQos::print ( ) const

inline

Prints this DDS_DomainParticipantFactoryQos to stdout.

Only the differences between this DDS_DomainParticipantFactoryQos and the documented default are printed. If you wish to print everything regardless, see DDS_DomainParticipantFactoryQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantFactoryQos&, const DDS_QosPrintFormat&) const. The output is formatted according to the default values for DDS_QosPrintFormat.

Returns

DDS_RETCODE_OK if no error was encountered.

to_string() [1/6]

DDS_ReturnCode_t DDS_DomainParticipantFactoryQos::to_string ( char *  string, DDS_UnsignedLong &  string_size  ) const

inline

Obtains a string representation of this DDS_DomainParticipantQos.

Only the differences between this DDS_DomainParticipantFactoryQos and the documented default are printed to the string. If you wish to print everything regardless, see DDS_DomainParticipantFactoryQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantFactoryQos&, const DDS_QosPrintFormat&) const. The output is formatted according to the default values for DDS_QosPrintFormat.

If the supplied buffer is NULL, the required length of the string is returned via the string_size parameter.

If the supplied buffer is not NULL, the string representation of the DDS_DomainParticipantFactoryQos is written to the buffer.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DomainParticipantFactoryQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.

Returns

DDS_RETCODE_OK if no error was encountered.

See also

DDS_DomainParticipantFactoryQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantFactoryQos&, const DDS_QosPrintFormat&) const

to_string() [2/6]

DDS_ReturnCode_t DDS_DomainParticipantFactoryQos::to_string ( char *  string, DDS_UnsignedLong &  string_size, const DDS_DomainParticipantFactoryQos &  base  ) const

inline

Obtains a string representation of this DDS_DomainParticipantFactoryQos.

This overload behaves the same as DDS_DomainParticipantFactoryQos::to_string but allows the caller to specify the DDS_DomainParticipantFactoryQos, which is used as the base profile. Only the differences between the QoS and the base profile are included in the output string.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DomainParticipantFactoryQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.
base	<<in>> The DDS_DomainParticipantFactoryQos to be used as the base QoS profile. Only the differences with respect to this base profile will be included in the output string.

Returns

DDS_RETCODE_OK if no error was encountered.

See also

DDS_DomainParticipantFactoryQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantFactoryQos&, const DDS_QosPrintFormat&) const

References DDS_QosPrintFormat_INITIALIZER.

to_string() [3/6]

DDS_ReturnCode_t DDS_DomainParticipantFactoryQos::to_string ( char *  string, DDS_UnsignedLong &  string_size, const DDS_QosPrintFormat &  format  ) const

inline

Obtains a string representation of this DDS_DomainParticipantFactoryQos.

This overload behaves the same as DDS_DomainParticipantFactoryQos::to_string but allows the caller to specify the DDS_QosPrintFormat which is used to format the output.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DomainParticipantFactoryQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.
format	<<in>> The DDS_QosPrintFormat to be used to format the output string.

Returns

DDS_RETCODE_OK if no error was encountered.

See also

DDS_DomainParticipantFactoryQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantFactoryQos&, const DDS_QosPrintFormat&) const

References DDS_RETCODE_ERROR, and DDS_RETCODE_OK.

to_string() [4/6]

DDS_ReturnCode_t DDS_DomainParticipantFactoryQos::to_string ( char *  string, DDS_UnsignedLong &  string_size, const DDS_DomainParticipantFactoryQos &  base, const DDS_QosPrintFormat &  format  ) const

inline

Obtains a string representation of this DDS_DomainParticipantFactoryQos.

Only the differences between this DDS_DomainParticipantFactoryQos and the DDS_DomainParticipantFactoryQos supplied as the base are printed to the string.

If the supplied buffer is NULL, the required length of the string is returned via the string_size parameter.

If the supplied buffer is not NULL, the string representation of the DDS_DomainParticipantFactoryQos is written to the buffer.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DomainParticipantFactoryQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.
base	<<in>> The DDS_DomainParticipantFactoryQos to be used as the base QoS profile. Only the differences with respect to this base profile will be included in the output string.
format	<<in>> The DDS_QosPrintFormat to be used to format the output string.

Returns

DDS_RETCODE_OK if no error was encountered.

to_string() [5/6]

DDS_ReturnCode_t DDS_DomainParticipantFactoryQos::to_string ( char *  string, DDS_UnsignedLong &  string_size, const DDS_QosPrintAll_t &    ) const

inline

Obtains a string representation of this DDS_DomainParticipantFactoryQos.

This overload behaves the same as DDS_DomainParticipantFactoryQos::to_string but prints the entire DDS_DomainParticipantFactoryQos object. The only valid value for the argument of type DDS_QosPrintAll_t is DDS_QOS_PRINT_ALL.

For example

DomainParticipantFactoryQos qos;
char *str = NULL;
DDS_UnsignedLong str_size = 0;
qos.to_string(str, str_size, QOS_PRINT_ALL);

The resultant string is formatted according to the default value for DDS_QosPrintFormat.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DomainParticipantFactoryQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.

Returns

DDS_RETCODE_OK if no error was encountered.

See also

DDS_DomainParticipantFactoryQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantFactoryQos&, const DDS_QosPrintFormat&) const

References DDS_QosPrintFormat_INITIALIZER.

to_string() [6/6]

DDS_ReturnCode_t DDS_DomainParticipantFactoryQos::to_string ( char *  string, DDS_UnsignedLong &  string_size, const DDS_QosPrintAll_t &  , const DDS_QosPrintFormat &  format  ) const

inline

Obtains a string representation of this DDS_DomainParticipantFactoryQos.

This overload behaves the same as the DDS_DomainParticipantFactoryQos::to_string(char*, DDS_UnsignedLong&, const DDS_QosPrintAll_t&) const overload. The only difference is that it allows the caller to specify the DDS_QosPrintFormat which is used to format the resultant string.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DomainParticipantFactoryQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.
format	<<in>> The DDS_QosPrintFormat to be used to format the output string.

Returns

DDS_RETCODE_OK if no error was encountered.

See also

DDS_DomainParticipantFactoryQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantFactoryQos&, const DDS_QosPrintFormat&) const

Variable Documentation

DDS_PARTICIPANT_QOS_DEFAULT

const 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.

Warning

This value is a constant and should never be modified. 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.

DDS_PARTICIPANT_CONFIG_PARAMS_DEFAULT

const 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