RTI Connext .NET API (legacy)  Version 6.1.2

DDS::Subscriber entity and associated elements More...

Classes

class  DDS::SubscriberQos
 QoS policies supported by a DDS::Subscriber entity. More...
 
class  DDS::SubscriberListener
 <<interface>> DDS::Listener for status about a subscriber. More...
 
class  DDS::SubscriberSeq
 Declares IDL sequence < DDS::Subscriber > . More...
 
class  DDS::Subscriber
 <<interface>> A subscriber is the object responsible for actually receiving data from a subscription. More...
 

Functions

bool DDS::SubscriberQos::equals (SubscriberQos^ other)
 Compares two DDS::SubscriberQos for equality. More...
 

Properties

static DataReaderQosDDS::Subscriber::DATAREADER_QOS_PRINT_ALL [get]
 Special value which can be supplied to DDS::DataReaderQos::ToString(DDS::DataReaderQos^ baseQos, DDS::QosPrintFormat^ format) indicating that all of the QoS should be printed. More...
 
static DataReaderQosDDS::Subscriber::DATAREADER_QOS_DEFAULT [get]
 Special value for creating data reader with default QoS. More...
 
static DataReaderQosDDS::Subscriber::DATAREADER_QOS_USE_TOPIC_QOS [get]
 Special value for creating DDS::DataReader with a combination of the default DDS::DataReaderQos and the DDS::TopicQos. More...
 

Detailed Description

DDS::Subscriber entity and associated elements

Function Documentation

◆ equals()

bool DDS::SubscriberQos::equals ( SubscriberQos other)

Compares two DDS::SubscriberQos for equality.

Parameters
other<<in>> The other SubscriberQos to be compared with this SubscriberQos.
Returns
true if the two Qos objects are equal or false otherwise.

Properties

◆ DATAREADER_QOS_PRINT_ALL

DataReaderQos^ DDS::Subscriber::DATAREADER_QOS_PRINT_ALL
staticget

Special value which can be supplied to DDS::DataReaderQos::ToString(DDS::DataReaderQos^ baseQos, DDS::QosPrintFormat^ format) indicating that all of the QoS should be printed.

The DDS::DataReaderQos::ToString(DDS::DataReaderQos^ baseQos, DDS::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 DDS::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 DDS::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 DDS::QosPrintFormat structure.

This value should only be used as the base parameter to the DDS::DataReaderQos::ToString(DDS::DataReaderQos^ baseQos, DDS::QosPrintFormat^ format) API.

◆ DATAREADER_QOS_DEFAULT

DataReaderQos^ DDS::Subscriber::DATAREADER_QOS_DEFAULT
staticget

Special value for creating data reader with default QoS.

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

When used in DDS::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 DDS::Subscriber::set_default_datareader_qos operation had never been called.

When used in DDS::DataReader::set_qos, this special value is used to indicate that the QoS of the DDS::DataReader should be changed to match the current default QoS set in the DDS::Subscriber that the DDS::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 DDS::DomainParticipant::get_default_datareader_qos.
See also
DDS::Subscriber::create_datareader
DDS::Subscriber::set_default_datareader_qos
DDS::DataReader::set_qos
Examples:
HelloWorld_subscriber.cpp, and HelloWorld_subscriber.cs.

◆ DATAREADER_QOS_USE_TOPIC_QOS

DataReaderQos^ DDS::Subscriber::DATAREADER_QOS_USE_TOPIC_QOS
staticget

Special value for creating DDS::DataReader with a combination of the default DDS::DataReaderQos and the DDS::TopicQos.

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

This value should only be used in DDS::Subscriber::create_datareader.

See also
DDS::Subscriber::create_datareader
DDS::Subscriber::get_default_datareader_qos
DDS::Topic::get_qos
DDS::Subscriber::copy_from_topic_qos