com.rti.dds.domain.DomainParticipant entity and associated elements More...

Classes
interface	DomainParticipant
	<<interface>> Container for all com.rti.dds.infrastructure.DomainEntity objects. More...

class	DomainParticipantAdapter
	<<extension>> A listener adapter in the spirit of the Java AWT listener adapters. (The Adapter provides empty implementations for the listener methods) More...

interface	DomainParticipantListener
	<<interface>> Listener for participant status. More...

class	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	DomainParticipantQos
	QoS policies supported by a com.rti.dds.domain.DomainParticipant entity. More...

Variables
static final TopicQos	TOPIC_QOS_DEFAULT = new TopicQos()
	Special value for creating a com.rti.dds.topic.Topic with default QoS. More...

static final TopicQos	TOPIC_QOS_PRINT_ALL = new TopicQos()
	Special value which can be supplied to com.rti.dds.topic.TopicQos.toString(TopicQos baseQos, QosPrintFormat format) indicating that all of the QoS should be printed. More...

static final PublisherQos	PUBLISHER_QOS_DEFAULT = new PublisherQos()
	Special value for creating a com.rti.dds.publication.Publisher with default QoS. More...

static final PublisherQos	PUBLISHER_QOS_PRINT_ALL = new PublisherQos()
	Special value which can be supplied to com.rti.dds.publication.PublisherQos.toString(PublisherQos baseQos, QosPrintFormat format) indicating that all of the QoS should be printed. More...

static final SubscriberQos	SUBSCRIBER_QOS_PRINT_ALL
	Special value which can be supplied to com.rti.dds.subscription.SubscriberQos.toString(SubscriberQos baseQos, QosPrintFormat format) indicating that all of the QoS should be printed. More...

static final SubscriberQos	SUBSCRIBER_QOS_DEFAULT
	Special value for creating a com.rti.dds.subscription.Subscriber with default QoS. More...

static final DomainParticipantQos	DOMAINPARTICIPANT_QOS_PRINT_ALL
	Special value which can be supplied to com.rti.dds.domain.DomainParticipantQos.toString(DomainParticipantQos baseQos, QosPrintFormat format) indicating that all of the QoS should be printed. More...

static final DomainParticipantFactoryQos	DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL
	Special value which can be supplied to com.rti.dds.domain.DomainParticipantFactoryQos.toString(DomainParticipantFactoryQos baseQos, QosPrintFormat format) indicating that all of the QoS should be printed. More...

static final FlowControllerProperty_t	FLOW_CONTROLLER_PROPERTY_DEFAULT
	<<extension>> Special value for creating a com.rti.dds.publication.FlowController with default property. More...

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

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

Detailed Description

com.rti.dds.domain.DomainParticipant entity and associated elements

Variable Documentation

◆ TOPIC_QOS_DEFAULT

final TopicQos TOPIC_QOS_DEFAULT = new TopicQos()

static

Special value for creating a com.rti.dds.topic.Topic with default QoS.

When used in com.rti.dds.domain.DomainParticipant.create_topic, this special value is used to indicate that the com.rti.dds.topic.Topic should be created with the default com.rti.dds.topic.Topic QoS by means of the operation get_default_topic_qos and using the resulting QoS to create the com.rti.dds.topic.Topic.

When used in com.rti.dds.domain.DomainParticipant.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 com.rti.dds.domain.DomainParticipant.set_default_topic_qos operation had never been called.

When used in com.rti.dds.topic.Topic.set_qos, this special value is used to indicate that the QoS of the com.rti.dds.topic.Topic should be changed to match the current default QoS set in the com.rti.dds.domain.DomainParticipant that the com.rti.dds.topic.Topic 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 com.rti.dds.domain.DomainParticipant.get_default_topic_qos.

See also: com.rti.dds.domain.DomainParticipant.create_topic; com.rti.dds.domain.DomainParticipant.set_default_topic_qos; com.rti.dds.topic.Topic.set_qos

◆ TOPIC_QOS_PRINT_ALL

final TopicQos TOPIC_QOS_PRINT_ALL = new TopicQos()

static

Special value which can be supplied to com.rti.dds.topic.TopicQos.toString(TopicQos baseQos, QosPrintFormat format) indicating that all of the QoS should be printed.

The com.rti.dds.topic.TopicQos.toString(TopicQos baseQos, QosPrintFormat format) API accepts a base QoS profile as one of its arguments. The resultant string only contains the differences with respect to the supplied base QoS profile. Supplying the com.rti.dds.domain.DomainParticipant.TOPIC_QOS_PRINT_ALL sentinel value as the base QoS will result in all of the QoS being printed.

Note that there are some QoS policies and fields which are not intended for public use. Even when com.rti.dds.domain.DomainParticipant.TOPIC_QOS_PRINT_ALL is supplied as the base, these will not be printed unless they differ from the documented default. If you want to see their values, you must use the print_private field within the com.rti.dds.infrastructure.QosPrintFormat structure.

This value should only be used as the base parameter to the com.rti.dds.topic.TopicQos.toString(TopicQos baseQos, QosPrintFormat format) API.

Referenced by TopicQos.toString().

◆ PUBLISHER_QOS_DEFAULT

final PublisherQos PUBLISHER_QOS_DEFAULT = new PublisherQos()

static

Special value for creating a com.rti.dds.publication.Publisher with default QoS.

When used in com.rti.dds.domain.DomainParticipant.create_publisher, this special value is used to indicate that the com.rti.dds.publication.Publisher should be created with the default com.rti.dds.publication.Publisher QoS by means of the operation get_default_publisher_qos and using the resulting QoS to create the com.rti.dds.publication.Publisher.

When used in com.rti.dds.domain.DomainParticipant.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 com.rti.dds.domain.DomainParticipant.set_default_publisher_qos operation had never been called.

When used in com.rti.dds.publication.Publisher.set_qos, this special value is used to indicate that the QoS of the com.rti.dds.publication.Publisher should be changed to match the current default QoS set in the com.rti.dds.domain.DomainParticipant that the com.rti.dds.publication.Publisher 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 com.rti.dds.domain.DomainParticipant.get_default_publisher_qos.

See also: com.rti.dds.domain.DomainParticipant.create_publisher; com.rti.dds.domain.DomainParticipant.set_default_publisher_qos; com.rti.dds.publication.Publisher.set_qos

◆ PUBLISHER_QOS_PRINT_ALL

final PublisherQos PUBLISHER_QOS_PRINT_ALL = new PublisherQos()

static

Special value which can be supplied to com.rti.dds.publication.PublisherQos.toString(PublisherQos baseQos, QosPrintFormat format) indicating that all of the QoS should be printed.

The com.rti.dds.publication.PublisherQos.toString(PublisherQos baseQos, QosPrintFormat format) API accepts a base QoS profile as one of its arguments. The resultant string only contains the differences with respect to the supplied base QoS profile. Supplying the com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_PRINT_ALL sentinel value as the base QoS will result in all of the QoS being printed.

Note that there are some QoS policies and fields which are not intended for public use. Even when com.rti.dds.domain.DomainParticipant.PUBLISHER_QOS_PRINT_ALL is supplied as the base, these will not be printed unless they differ from the documented default. If you want to see their values, you must use the print_private field within the com.rti.dds.infrastructure.QosPrintFormat structure.

This value should only be used as the base parameter to the com.rti.dds.publication.PublisherQos.toString(PublisherQos baseQos, QosPrintFormat format) API.

Referenced by PublisherQos.toString().

◆ SUBSCRIBER_QOS_PRINT_ALL

final SubscriberQos SUBSCRIBER_QOS_PRINT_ALL

static

Initial value:

=

new SubscriberQos()

Special value which can be supplied to com.rti.dds.subscription.SubscriberQos.toString(SubscriberQos baseQos, QosPrintFormat format) indicating that all of the QoS should be printed.

The com.rti.dds.subscription.SubscriberQos.toString(SubscriberQos baseQos, QosPrintFormat format) API accepts a base QoS profile as one of its arguments. The resultant string only contains the differences with respect to the supplied base QoS profile. Supplying the com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_PRINT_ALL sentinel value as the base QoS will result in all of the QoS being printed.

Note that there are some QoS policies and fields which are not intended for public use. Even when com.rti.dds.domain.DomainParticipant.SUBSCRIBER_QOS_PRINT_ALL is supplied as the base, these will not be printed unless they differ from the documented default. If you want to see their values, you must use the print_private field within the com.rti.dds.infrastructure.QosPrintFormat structure.

This value should only be used as the base parameter to the com.rti.dds.subscription.SubscriberQos.toString(SubscriberQos baseQos, QosPrintFormat format) API.

Referenced by SubscriberQos.toString().

◆ SUBSCRIBER_QOS_DEFAULT

final SubscriberQos SUBSCRIBER_QOS_DEFAULT

static

Initial value:

=

new SubscriberQos()

Special value for creating a com.rti.dds.subscription.Subscriber with default QoS.

When used in com.rti.dds.domain.DomainParticipant.create_subscriber, this special value is used to indicate that the com.rti.dds.subscription.Subscriber should be created with the default com.rti.dds.subscription.Subscriber QoS by means of the operation get_default_subscriber_qos and using the resulting QoS to create the com.rti.dds.subscription.Subscriber.

When used in com.rti.dds.domain.DomainParticipant.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 com.rti.dds.domain.DomainParticipant.set_default_subscriber_qos operation had never been called.

When used in com.rti.dds.subscription.Subscriber.set_qos, this special value is used to indicate that the QoS of the com.rti.dds.subscription.Subscriber should be changed to match the current default QoS set in the com.rti.dds.domain.DomainParticipant that the com.rti.dds.subscription.Subscriber 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 com.rti.dds.domain.DomainParticipant.get_default_subscriber_qos.

See also: com.rti.dds.domain.DomainParticipant.create_subscriber; com.rti.dds.domain.DomainParticipant.get_default_subscriber_qos; com.rti.dds.subscription.Subscriber.set_qos

◆ DOMAINPARTICIPANT_QOS_PRINT_ALL

final DomainParticipantQos DOMAINPARTICIPANT_QOS_PRINT_ALL

static

Initial value:

=

new DomainParticipantQos()

Special value which can be supplied to com.rti.dds.domain.DomainParticipantQos.toString(DomainParticipantQos baseQos, QosPrintFormat format) indicating that all of the QoS should be printed.

The com.rti.dds.domain.DomainParticipantQos.toString(DomainParticipantQos baseQos, QosPrintFormat format) API accepts a base QoS profile as one of its arguments. The resultant string only contains the differences with respect to the supplied base QoS profile. Supplying the com.rti.dds.domain.DomainParticipant.DOMAINPARTICIPANT_QOS_PRINT_ALL sentinel value as the base QoS will result in all of the QoS being printed.

Note that there are some QoS policies and fields which are not intended for public use. Even when com.rti.dds.domain.DomainParticipant.DOMAINPARTICIPANT_QOS_PRINT_ALL is supplied as the base, these will not be printed unless they differ from the documented default. If you want to see their values, you must use the print_private field within the com.rti.dds.infrastructure.QosPrintFormat structure.

This value should only be used as the base parameter to the com.rti.dds.domain.DomainParticipantQos.toString(DomainParticipantQos baseQos, QosPrintFormat format) API.

Referenced by DomainParticipantQos.toString().

◆ DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL

final DomainParticipantFactoryQos DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL

static

Initial value:

=

new DomainParticipantFactoryQos()

Special value which can be supplied to com.rti.dds.domain.DomainParticipantFactoryQos.toString(DomainParticipantFactoryQos baseQos, QosPrintFormat format) indicating that all of the QoS should be printed.

The com.rti.dds.domain.DomainParticipantFactoryQos.toString(DomainParticipantFactoryQos baseQos, QosPrintFormat format) API accepts a base QoS profile as one of its arguments. The resultant string only contains the differences with respect to the supplied base QoS profile. Supplying the com.rti.dds.domain.DomainParticipant.DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL sentinel value as the base QoS will result in all of the QoS being printed.

Note that there are some QoS policies and fields which are not intended for public use. Even when com.rti.dds.domain.DomainParticipant.DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL is supplied as the base, these will not be printed unless they differ from the documented default. If you want to see their values, you must use the print_private field within the com.rti.dds.infrastructure.QosPrintFormat structure.

This value should only be used as the base parameter to the com.rti.dds.domain.DomainParticipantFactoryQos.toString(DomainParticipantFactoryQos baseQos, QosPrintFormat format) API.

Referenced by DomainParticipantFactoryQos.toString().

◆ FLOW_CONTROLLER_PROPERTY_DEFAULT

final FlowControllerProperty_t FLOW_CONTROLLER_PROPERTY_DEFAULT

static

Initial value:

=

new FlowControllerProperty_t()

<<extension>> Special value for creating a com.rti.dds.publication.FlowController with default property.

When used in com.rti.dds.domain.DomainParticipant.create_flowcontroller and com.rti.dds.publication.FlowController.set_property, this special value represents the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set_default_flowcontroller_property, or else, if the call was never made, the default values listed in com.rti.dds.publication.FlowControllerProperty_t.

When used in com.rti.dds.domain.DomainParticipant.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 com.rti.dds.domain.DomainParticipant.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 com.rti.dds.domain.DomainParticipant.get_default_flowcontroller_property.

See also: com.rti.dds.domain.DomainParticipant.create_flowcontroller; com.rti.dds.domain.DomainParticipant.set_default_flowcontroller_property; com.rti.dds.publication.FlowController.set_property

◆ SQLFILTER_NAME

final String SQLFILTER_NAME

static

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

See also: Queries and Filters Syntax

◆ STRINGMATCHFILTER_NAME

final String STRINGMATCHFILTER_NAME

static

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

Variables

Detailed Description

Variable Documentation

◆ TOPIC_QOS_DEFAULT

◆ TOPIC_QOS_PRINT_ALL

◆ PUBLISHER_QOS_DEFAULT

◆ PUBLISHER_QOS_PRINT_ALL

◆ SUBSCRIBER_QOS_PRINT_ALL

◆ SUBSCRIBER_QOS_DEFAULT

◆ DOMAINPARTICIPANT_QOS_PRINT_ALL

◆ DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL

◆ FLOW_CONTROLLER_PROPERTY_DEFAULT

◆ SQLFILTER_NAME

◆ STRINGMATCHFILTER_NAME