RTI Connext Java API Version 7.3.0

com.rti.dds.subscription.Subscriber entity and associated elements More...

Classes

interface  Subscriber
 <<interface>> A subscriber is the object responsible for actually receiving data from a subscription. More...
 
class  SubscriberAdapter
 A listener adapter in the spirit of the Java AWT listener adapters. (The Adapter provides empty implementations for the listener methods) More...
 
interface  SubscriberListener
 <<interface>> com.rti.dds.infrastructure.Listener for status about a subscriber. More...
 
class  SubscriberQos
 QoS policies supported by a com.rti.dds.subscription.Subscriber entity. More...
 
class  SubscriberSeq
 Declares IDL sequence < com.rti.dds.subscription.Subscriber > . More...
 

Variables

static final DataReaderQos DATAREADER_QOS_DEFAULT
 Special value for creating data reader with default QoS. More...
 
static final DataReaderQos DATAREADER_QOS_USE_TOPIC_QOS = new DataReaderQos()
 Special value for creating com.rti.dds.subscription.DataReader with a combination of the default com.rti.dds.subscription.DataReaderQos and the com.rti.dds.topic.TopicQos. More...
 
static final DataReaderQos DATAREADER_QOS_PRINT_ALL = new DataReaderQos()
 Special value which can be supplied to com.rti.dds.subscription.DataReaderQos.toString(DataReaderQos baseQos, QosPrintFormat format) indicating that all of the QoS should be printed. More...
 

Detailed Description

com.rti.dds.subscription.Subscriber entity and associated elements

Variable Documentation

◆ DATAREADER_QOS_DEFAULT

final DataReaderQos DATAREADER_QOS_DEFAULT
static
Initial value:
=
new DataReaderQos()

Special value for creating data reader with default QoS.

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

When used in com.rti.dds.subscription.Subscriber.set_default_datareader_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.subscription.Subscriber.set_default_datareader_qos operation had never been called.

When used in com.rti.dds.subscription.DataReader.set_qos, this special value is used to indicate that the QoS of the com.rti.dds.subscription.DataReader should be changed to match the current default QoS set in the com.rti.dds.subscription.Subscriber that the com.rti.dds.subscription.DataReader 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 DataReader; for this purpose, use com.rti.dds.domain.DomainParticipant.get_default_datareader_qos.
See also
com.rti.dds.subscription.Subscriber.create_datareader
com.rti.dds.subscription.Subscriber.set_default_datareader_qos
com.rti.dds.subscription.DataReader.set_qos

◆ DATAREADER_QOS_USE_TOPIC_QOS

final DataReaderQos DATAREADER_QOS_USE_TOPIC_QOS = new DataReaderQos()
static

Special value for creating com.rti.dds.subscription.DataReader with a combination of the default com.rti.dds.subscription.DataReaderQos and the com.rti.dds.topic.TopicQos.

The use of this value is equivalent to the application obtaining the default com.rti.dds.subscription.DataReaderQos and the com.rti.dds.topic.TopicQos (by means of the operation com.rti.dds.topic.Topic.get_qos) and then combining these two QoS using the operation com.rti.dds.subscription.Subscriber.copy_from_topic_qos whereby any policy that is set on the com.rti.dds.topic.TopicQos "overrides" the corresponding policy on the default QoS. The resulting QoS is then applied to the creation of the com.rti.dds.subscription.DataReader.

This value should only be used in com.rti.dds.subscription.Subscriber.create_datareader.

See also
com.rti.dds.subscription.Subscriber.create_datareader
com.rti.dds.subscription.Subscriber.get_default_datareader_qos
com.rti.dds.topic.Topic.get_qos
com.rti.dds.subscription.Subscriber.copy_from_topic_qos

◆ DATAREADER_QOS_PRINT_ALL

final DataReaderQos DATAREADER_QOS_PRINT_ALL = new DataReaderQos()
static

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

The com.rti.dds.subscription.DataReaderQos.toString(DataReaderQos 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.subscription.Subscriber.DATAREADER_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.subscription.Subscriber.DATAREADER_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.DataReaderQos.toString(DataReaderQos baseQos, QosPrintFormat format) API.

Referenced by DataReaderQos.toString().