DomainParticipants

DDSDomainParticipant entity and associated elements More...

Classes
struct	DDS_DomainParticipantQos
	QoS policies supported by a DDSDomainParticipant entity. 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.

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

Variables
struct DDS_TopicQos	DDS_TOPIC_QOS_DEFAULT
	Special value for creating a DDSTopic with default QoS.
struct DDS_PublisherQos	DDS_PUBLISHER_QOS_DEFAULT
	Special value for creating a DDSPublisher with default QoS.
struct DDS_SubscriberQos	DDS_SUBSCRIBER_QOS_DEFAULT
	Special value for creating a DDSSubscriber with default QoS.
struct DDS_FlowControllerProperty_t	DDS_FLOW_CONTROLLER_PROPERTY_DEFAULT
	<<extension>> Special value for creating a DDSFlowController with default property.
const char *const	DDS_SQLFILTER_NAME
	<<extension>> The name of the built-in SQL filter that can be used with ContentFilteredTopics and MultiChannel DataWriters.
const char *const	DDS_STRINGMATCHFILTER_NAME
	<<extension>> The name of the built-in StringMatch filter that can be used with ContentFilteredTopics and MultiChannel DataWriters.

Detailed Description

DDSDomainParticipant entity and associated elements

Typedef Documentation

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

Variable Documentation

struct DDS_TopicQos DDS_TOPIC_QOS_DEFAULT

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.

Note: 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.

struct DDS_PublisherQos DDS_PUBLISHER_QOS_DEFAULT

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.

Note: 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.

struct DDS_SubscriberQos DDS_SUBSCRIBER_QOS_DEFAULT

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.

Note: 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.

struct DDS_FlowControllerProperty_t DDS_FLOW_CONTROLLER_PROPERTY_DEFAULT

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

When used in DDSDomainParticipant::create_flowcontroller, this special value is used to indicate that the DDSFlowController should be created with the default DDSFlowController property by means of the operation get_default_flowcontroller_property and using the resulting QoS to create the 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.

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

Note: 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

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

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