DDSDomainParticipant entity and associated elements More...

Classes
struct	DDS_InvalidLocalIdentityAdvanceNoticeStatus
	DDS_INVALID_LOCAL_IDENTITY_ADVANCE_NOTICE_STATUS More...

struct	DDS_DomainParticipantQos
	QoS policies supported by a DDSDomainParticipant entity. More...

struct	DDS_DomainParticipantProtocolStatus
	<<extension>> The status of a participant's protocol related metrics, like the number of corrupted messages, change in corrupted messages and timestamp of the last corrupted message. More...

class	DDSDomainParticipantListener
	<<interface>> Listener for participant status. More...

class	DDSDomainParticipant
	<<interface>> Container for all DDSDomainEntity objects. More...

Typedefs
typedef DDS_DOMAINID_TYPE_NATIVE	DDS_DomainId_t
	An integer that indicates in which domain a DDSDomainParticipant communicates. More...

Functions
DDS_Boolean	DDS_DomainParticipantQos_equals (const struct DDS_DomainParticipantQos self, const struct DDS_DomainParticipantQos other)
	Compares two DDS_DomainParticipantQos for equality. More...

DDS_ReturnCode_t	DDS_DomainParticipantQos::print () const
	Prints this DDS_DomainParticipantQos to stdout. More...

DDS_ReturnCode_t	DDS_DomainParticipantQos::to_string (char *string, DDS_UnsignedLong &string_size) const
	Obtains a string representation of this DDS_DomainParticipantQos. More...

DDS_ReturnCode_t	DDS_DomainParticipantQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_DomainParticipantQos &base) const
	Obtains a string representation of this DDS_DomainParticipantQos. More...

DDS_ReturnCode_t	DDS_DomainParticipantQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintFormat &format) const
	Obtains a string representation of this DDS_DomainParticipantQos. More...

DDS_ReturnCode_t	DDS_DomainParticipantQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_DomainParticipantQos &base, const DDS_QosPrintFormat &format) const
	Obtains a string representation of this DDS_DomainParticipantQos. More...

DDS_ReturnCode_t	DDS_DomainParticipantQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintAll_t &) const
	Obtains a string representation of this DDS_DomainParticipantQos. More...

DDS_ReturnCode_t	DDS_DomainParticipantQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintAll_t &, const DDS_QosPrintFormat &format) const
	Obtains a string representation of this DDS_DomainParticipantQos. More...

Variables
const struct DDS_TopicQos	DDS_TOPIC_QOS_DEFAULT
	Special value for creating a DDSTopic with default QoS. More...

const struct DDS_PublisherQos	DDS_PUBLISHER_QOS_DEFAULT
	Special value for creating a DDSPublisher with default QoS. More...

const struct DDS_SubscriberQos	DDS_SUBSCRIBER_QOS_DEFAULT
	Special value for creating a DDSSubscriber with default QoS. More...

const struct DDS_FlowControllerProperty_t	DDS_FLOW_CONTROLLER_PROPERTY_DEFAULT
	<<extension>> Special value for creating a DDSFlowController with default property. More...

const char *const	DDS_SQLFILTER_NAME
	<<extension>> The name of the built-in SQL filter that can be used with ContentFilteredTopics and MultiChannel DataWriters. More...

const char *const	DDS_STRINGMATCHFILTER_NAME
	<<extension>> The name of the built-in StringMatch filter that can be used with ContentFilteredTopics and MultiChannel DataWriters. More...

Detailed Description

DDSDomainParticipant entity and associated elements

Typedef Documentation

◆ DDS_DomainId_t

typedef DDS_DOMAINID_TYPE_NATIVE DDS_DomainId_t

An integer that indicates in which domain a DDSDomainParticipant communicates.

Participants with the same DDS_DomainId_t are said to be in the same domain, and can thus communicate with one another.

The lower limit for a domain ID is 0. The upper limit for a domain ID is determined by the guidelines stated in DDS_RtpsWellKnownPorts_t (specifically DDS_RtpsWellKnownPorts_t::domain_id_gain)

Function Documentation

◆ DDS_DomainParticipantQos_equals()

DDS_Boolean DDS_DomainParticipantQos_equals	(	const struct DDS_DomainParticipantQos *	self,
		const struct DDS_DomainParticipantQos *	other
	)

Compares two DDS_DomainParticipantQos for equality.

Parameters

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

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

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

◆ print()

DDS_ReturnCode_t DDS_DomainParticipantQos::print ( ) const

inline

Prints this DDS_DomainParticipantQos to stdout.

Only the differences between this DDS_DomainParticipantQos and the documented default are printed. If you wish to print everything regardless, see DDS_DomainParticipantQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantQos&, 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_DomainParticipantQos::to_string	(	char *	string,
		DDS_UnsignedLong &	string_size
	)		const

inline

Obtains a string representation of this DDS_DomainParticipantQos.

Only the differences between this DDS_DomainParticipantQos and the documented default are printed. If you wish to print everything regardless, see DDS_DomainParticipantQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantQos&, 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_DomainParticipantQos is written to the buffer.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DomainParticipantQos. 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_DomainParticipantQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantQos&, const DDS_QosPrintFormat&) const

◆ to_string() [2/6]

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

inline

Obtains a string representation of this DDS_DomainParticipantQos.

This overload behaves the same as DDS_DomainParticipantQos::to_string but allows the caller to specify the DDS_DomainParticipantQos, 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_DomainParticipantQos. 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_DomainParticipantQos 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_DomainParticipantQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantQos&, const DDS_QosPrintFormat&) const

References DDS_QosPrintFormat_INITIALIZER.

◆ to_string() [3/6]

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

inline

Obtains a string representation of this DDS_DomainParticipantQos.

This overload behaves the same as DDS_DomainParticipantQos::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_DomainParticipantQos. 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_DomainParticipantQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantQos&, const DDS_QosPrintFormat&) const

References DDS_RETCODE_ERROR, and DDS_RETCODE_OK.

◆ to_string() [4/6]

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

inline

Obtains a string representation of this DDS_DomainParticipantQos.

Only the differences between this DDS_DomainParticipantQos and the DDS_DomainParticipantQos 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_DomainParticipantQos is written to the buffer.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DomainParticipantQos. 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_DomainParticipantQos 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_DomainParticipantQos::to_string	(	char *	string,
		DDS_UnsignedLong &	string_size,
		const DDS_QosPrintAll_t &
	)		const

inline

Obtains a string representation of this DDS_DomainParticipantQos.

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

For example

DomainParticipantQos 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_DomainParticipantQos. 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_DomainParticipantQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantQos&, const DDS_QosPrintFormat&) const

References DDS_QosPrintFormat_INITIALIZER.

◆ to_string() [6/6]

DDS_ReturnCode_t DDS_DomainParticipantQos::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_DomainParticipantQos.

This overload behaves the same as the DDS_DomainParticipantQos::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_DomainParticipantQos. 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_DomainParticipantQos::to_string(char*, DDS_UnsignedLong&, const DDS_DomainParticipantQos&, const DDS_QosPrintFormat&) const

Variable Documentation

◆ DDS_TOPIC_QOS_DEFAULT

const struct DDS_TopicQos DDS_TOPIC_QOS_DEFAULT

extern

Special value for creating a DDSTopic with default QoS.

When used in DDSDomainParticipant::create_topic, this special value is used to indicate that the DDSTopic should be created with the default DDSTopic QoS by means of the operation get_default_topic_qos and using the resulting QoS to create the DDSTopic.

When used in DDSDomainParticipant::set_default_topic_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 DDSDomainParticipant::set_default_topic_qos operation had never been called.

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

Warning: This value is a constant and should never be modified. You cannot use this value to get the default QoS values for a Topic; for this purpose, use DDSDomainParticipant::get_default_topic_qos.

See also: DDSDomainParticipant::create_topic; DDSDomainParticipant::set_default_topic_qos; DDSTopic::set_qos

Examples: HelloWorld_publisher.cxx, and HelloWorld_subscriber.cxx.

◆ DDS_PUBLISHER_QOS_DEFAULT

const struct DDS_PublisherQos DDS_PUBLISHER_QOS_DEFAULT

extern

Special value for creating a DDSPublisher with default QoS.

When used in DDSDomainParticipant::create_publisher, this special value is used to indicate that the DDSPublisher should be created with the default DDSPublisher QoS by means of the operation get_default_publisher_qos and using the resulting QoS to create the DDSPublisher.

When used in DDSDomainParticipant::set_default_publisher_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 DDSDomainParticipant::set_default_publisher_qos operation had never been called.

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

Warning: This value is a constant and should never be modified. You cannot use this value to get the default QoS values for a Publisher; for this purpose, use DDSDomainParticipant::get_default_publisher_qos.

See also: DDSDomainParticipant::create_publisher; DDSDomainParticipant::set_default_publisher_qos; DDSPublisher::set_qos

Examples: HelloWorld_publisher.cxx.

◆ DDS_SUBSCRIBER_QOS_DEFAULT

const struct DDS_SubscriberQos DDS_SUBSCRIBER_QOS_DEFAULT

extern

Special value for creating a DDSSubscriber with default QoS.

When used in DDSDomainParticipant::create_subscriber, this special value is used to indicate that the DDSSubscriber should be created with the default DDSSubscriber QoS by means of the operation get_default_subscriber_qos and using the resulting QoS to create the DDSSubscriber.

When used in DDSDomainParticipant::set_default_subscriber_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 DDSDomainParticipant::set_default_subscriber_qos operation had never been called.

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

Warning: This value is a constant and should never be modified. You cannot use this value to get the default QoS values for a Subscriber; for this purpose, use DDSDomainParticipant::get_default_subscriber_qos.

See also: DDSDomainParticipant::create_subscriber; DDSDomainParticipant::get_default_subscriber_qos; DDSSubscriber::set_qos

Examples: HelloWorld_subscriber.cxx.

◆ DDS_FLOW_CONTROLLER_PROPERTY_DEFAULT

const struct DDS_FlowControllerProperty_t DDS_FLOW_CONTROLLER_PROPERTY_DEFAULT

extern

<<extension>> Special value for creating a DDSFlowController with default property.

When used in DDSDomainParticipant::create_flowcontroller and DDSFlowController::set_property, this special value represents the set of values specified on the last successful call to DDSDomainParticipant::set_default_flowcontroller_property, or else, if the call was never made, the default values listed in DDS_FlowControllerProperty_t.

When used in DDSDomainParticipant::set_default_flowcontroller_property, this special value indicates that the default QoS should be reset back to the initial value that would be used if the DDSDomainParticipant::set_default_flowcontroller_property operation had never been called.

Warning: This value is a constant and should never be modified. You cannot use this value to get the default properties for a FlowController; for this purpose, use DDSDomainParticipant::get_default_flowcontroller_property.

See also: DDSDomainParticipant::create_flowcontroller; DDSDomainParticipant::set_default_flowcontroller_property; DDSFlowController::set_property

◆ DDS_SQLFILTER_NAME

const char* const DDS_SQLFILTER_NAME

<<extension>> The name of the built-in SQL filter that can be used with ContentFilteredTopics and MultiChannel DataWriters.

See also: Queries and Filters Syntax

◆ DDS_STRINGMATCHFILTER_NAME

const char* const DDS_STRINGMATCHFILTER_NAME

<<extension>> The name of the built-in StringMatch filter that can be used with ContentFilteredTopics and MultiChannel DataWriters.

The StringMatch Filter is a subset of the SQL filter; it only supports the MATCH relational operator on a single string field.

See also: Queries and Filters Syntax

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ DDS_DomainId_t

Function Documentation

◆ DDS_DomainParticipantQos_equals()

◆ print()

◆ to_string() [1/6]

◆ to_string() [2/6]

◆ to_string() [3/6]

◆ to_string() [4/6]

◆ to_string() [5/6]

◆ to_string() [6/6]

Variable Documentation

◆ DDS_TOPIC_QOS_DEFAULT

◆ DDS_PUBLISHER_QOS_DEFAULT

◆ DDS_SUBSCRIBER_QOS_DEFAULT

◆ DDS_FLOW_CONTROLLER_PROPERTY_DEFAULT

◆ DDS_SQLFILTER_NAME

◆ DDS_STRINGMATCHFILTER_NAME