QoS policies supported by a DDS::DataReader entity. More...

#include <managed_subscription.h>

Public Member Functions
bool	equals (DataReaderQos^ other)
	Compares two DDS::DataReaderQos for equality. More...

virtual System::String ^	ToString () override
	Overrides the builtin ToString method. More...

System::String ^	ToString (DataReaderQos^ base, QosPrintFormat^ format)
	Obtains a string representation of a DataReaderQos object. More...

System::String ^	ToString (QosPrintFormat^ format)
	Obtains a string representation of a DataReaderQos object. More...

System::String ^	ToString (DataReaderQos^ base)
	Obtains a string representation of a DataReaderQos object. More...

Public Attributes
DurabilityQosPolicy	durability
	Durability policy, DURABILITY. More...

DeadlineQosPolicy	deadline
	Deadline policy, DEADLINE. More...

LatencyBudgetQosPolicy	latency_budget
	Latency budget policy, LATENCY_BUDGET. More...

LivelinessQosPolicy	liveliness
	Liveliness policy, LIVELINESS. More...

ReliabilityQosPolicy	reliability
	Reliability policy, RELIABILITY. More...

DestinationOrderQosPolicy	destination_order
	Destination order policy, DESTINATION_ORDER. More...

HistoryQosPolicy	history
	History policy, HISTORY. More...

ResourceLimitsQosPolicy	resource_limits
	Resource limits policy, RESOURCE_LIMITS. More...

UserDataQosPolicy ^	user_data
	User data policy, USER_DATA. More...

OwnershipQosPolicy	ownership
	Ownership policy, OWNERSHIP. More...

TimeBasedFilterQosPolicy	time_based_filter
	Time-based filter policy, TIME_BASED_FILTER. More...

ReaderDataLifecycleQosPolicy	reader_data_lifecycle
	Reader data lifecycle policy, READER_DATA_LIFECYCLE. More...

TransportPriorityQosPolicy	transport_priority
	Transport priority policy, TRANSPORT_PRIORITY. More...

DataRepresentationQosPolicy ^	representation
	Data representation policy, DATA_REPRESENTATION. More...

TypeConsistencyEnforcementQosPolicy	type_consistency
	Type consistency enforcement policy, TYPE_CONSISTENCY_ENFORCEMENT. More...

DataTagQosPolicy ^	data_tags
	DataTag policy, DATA_TAG. More...

DataReaderResourceLimitsQosPolicy	reader_resource_limits
	<<extension>> DDS::DataReader resource limits policy, DATA_READER_RESOURCE_LIMITS. This policy is an extension to the DDS standard. More...

DataReaderProtocolQosPolicy	protocol
	<<extension>> DDS::DataReader protocol policy, DATA_READER_PROTOCOL More...

TransportSelectionQosPolicy ^	transport_selection
	<<extension>> Transport selection policy, TRANSPORT_SELECTION. More...

TransportUnicastQosPolicy ^	unicast
	<<extension>> Unicast transport policy, TRANSPORT_UNICAST. More...

TransportMulticastQosPolicy ^	multicast
	<<extension>> Multicast transport policy, TRANSPORT_MULTICAST. More...

PropertyQosPolicy ^	property_qos
	<<extension>> Property policy, PROPERTY. More...

ServiceQosPolicy	service
	<<extension>> Service policy, SERVICE. More...

AvailabilityQosPolicy ^	availability
	<<extension>> Availability policy, AVAILABILITY. More...

EntityNameQosPolicy ^	subscription_name
	<<extension>> EntityName policy, ENTITY_NAME. More...

TypeSupportQosPolicy	type_support
	<<extension>> type support data, TYPESUPPORT. More...

Detailed Description

QoS policies supported by a DDS::DataReader entity.

You must set certain members in a consistent manner:

DDS::DataReaderQos::deadline .period >= DDS::DataReaderQos::time_based_filter .minimum_separation

DDS::DataReaderQos::history .depth <= DDS::DataReaderQos::resource_limits .max_samples_per_instance

DDS::DataReaderQos::resource_limits .max_samples_per_instance <= DDS::DataReaderQos::resource_limits .max_samples DDS::DataReaderQos::resource_limits .initial_samples <= DDS::DataReaderQos::resource_limits .max_samples

DDS::DataReaderQos::resource_limits .initial_instances <= DDS::DataReaderQos::resource_limits .max_instances

DDS::DataReaderQos::reader_resource_limits .initial_remote_writers_per_instance <= DDS::DataReaderQos::reader_resource_limits .max_remote_writers_per_instance

DDS::DataReaderQos::reader_resource_limits .initial_infos <= DDS::DataReaderQos::reader_resource_limits .max_infos

DDS::DataReaderQos::reader_resource_limits .max_remote_writers_per_instance <= DDS::DataReaderQos::reader_resource_limits .max_remote_writers

DDS::DataReaderQos::reader_resource_limits .max_samples_per_remote_writer <= DDS::DataReaderQos::resource_limits .max_samples

length of DDS::DataReaderQos::user_data .value <= DDS::DomainParticipantQos::resource_limits .reader_user_data_max_length

If any of the above are not true, DDS::DataReader::set_qos and DDS::DataReader::set_qos_with_profile will fail with DDS::Retcode_InconsistentPolicy and DDS::Subscriber::create_datareader will return NULL.

Member Function Documentation

◆ ToString() [1/4]

virtual System::String ^ DDS::DataReaderQos::ToString ( )

overridevirtual

Overrides the builtin ToString method.

The various ToString() overloads allow formatting the output and printing only the differences with respect to another DataReaderQos object.

DataReaderQos qos = new DataReaderQos();
String theString = new String();
// The most basic version of the API simply overrides the builtin
// ToString method. Only the differences with respect to the
// documented default are printed to the string. The string is formatted
// according to the default values for QosPrintFormat.
theString = qos.ToString();
// This overload allows us to specify a base profile. Only the differences
// with respect to this base profile are printed to the string. If the two
// Qos objects are equal, the resultant string will be empty.
DataReaderQos base = new DataReaderQos();
theString = qos.toString(base);
// It is also possible to supply a custom format at this point
QosPrintFormat printFormat = new QosPrintFormat();
theString = qos.ToString(base, format);
// The sentinel value DATAREADER_QOS_PRINT_ALL can be used as
// the base in order to print the entire qos object
theString = qos.ToString(DATAREADER_QOS_PRINT_ALL);

This overload uses the default print format and only prints the differences between the supplied DataReaderQos and the documented default.

Returns: The string representation of the Qos.

◆ ToString() [2/4]

System::String ^ DDS::DataReaderQos::ToString	(	DataReaderQos^	base,
		QosPrintFormat^	format
	)

Obtains a string representation of a DataReaderQos object.

Parameters

format	The print format used to format the output.
base	Only the differences between base and the Qos object are included in the output string. If you want to print everything within the Qos, use the DDS::Subscriber::DATAREADER_QOS_PRINT_ALL sentinel value.

This overload prints the differences between the qos and the supplied base. The output string is formatted using the supplied DDS::QosPrintFormat.

Returns: The string representation of the Qos.

◆ ToString() [3/4]

System::String ^ DDS::DataReaderQos::ToString ( QosPrintFormat^ format )

Obtains a string representation of a DataReaderQos object.

Parameters

format The print format used to format the output.

This overload prints the differences between the qos and the documented. default. The output string is formatted using the supplied DDS::QosPrintFormat.

Returns: The string representation of the Qos.

◆ ToString() [4/4]

System::String ^ DDS::DataReaderQos::ToString ( DataReaderQos^ base )

Obtains a string representation of a DataReaderQos object.

Parameters

base	Only the differences between base and the Qos object are included in the output string. If you want to print everything within the Qos, use the DDS::Subscriber::DATAREADER_QOS_PRINT_ALL sentinel value.

This overload prints the differences between the qos and the supplied base. The output string is formatted using the default value for DDS::QosPrintFormat.

Returns: The string representation of the Qos.

Member Data Documentation

◆ durability

DurabilityQosPolicy DDS::DataReaderQos::durability

Durability policy, DURABILITY.

◆ deadline

DeadlineQosPolicy DDS::DataReaderQos::deadline

Deadline policy, DEADLINE.

◆ latency_budget

LatencyBudgetQosPolicy DDS::DataReaderQos::latency_budget

Latency budget policy, LATENCY_BUDGET.

◆ liveliness

LivelinessQosPolicy DDS::DataReaderQos::liveliness

Liveliness policy, LIVELINESS.

◆ reliability

ReliabilityQosPolicy DDS::DataReaderQos::reliability

Reliability policy, RELIABILITY.

◆ destination_order

DestinationOrderQosPolicy DDS::DataReaderQos::destination_order

Destination order policy, DESTINATION_ORDER.

◆ history

HistoryQosPolicy DDS::DataReaderQos::history

History policy, HISTORY.

◆ resource_limits

ResourceLimitsQosPolicy DDS::DataReaderQos::resource_limits

Resource limits policy, RESOURCE_LIMITS.

◆ user_data

UserDataQosPolicy ^ DDS::DataReaderQos::user_data

User data policy, USER_DATA.

◆ ownership

OwnershipQosPolicy DDS::DataReaderQos::ownership

Ownership policy, OWNERSHIP.

◆ time_based_filter

TimeBasedFilterQosPolicy DDS::DataReaderQos::time_based_filter

Time-based filter policy, TIME_BASED_FILTER.

◆ reader_data_lifecycle

ReaderDataLifecycleQosPolicy DDS::DataReaderQos::reader_data_lifecycle

Reader data lifecycle policy, READER_DATA_LIFECYCLE.

◆ transport_priority

TransportPriorityQosPolicy DDS::DataReaderQos::transport_priority

Transport priority policy, TRANSPORT_PRIORITY.

◆ representation

DataRepresentationQosPolicy ^ DDS::DataReaderQos::representation

Data representation policy, DATA_REPRESENTATION.

◆ type_consistency

TypeConsistencyEnforcementQosPolicy DDS::DataReaderQos::type_consistency

Type consistency enforcement policy, TYPE_CONSISTENCY_ENFORCEMENT.

◆ data_tags

DataTagQosPolicy ^ DDS::DataReaderQos::data_tags

DataTag policy, DATA_TAG.

◆ reader_resource_limits

DataReaderResourceLimitsQosPolicy DDS::DataReaderQos::reader_resource_limits

<<extension>> DDS::DataReader resource limits policy, DATA_READER_RESOURCE_LIMITS. This policy is an extension to the DDS standard.

◆ protocol

DataReaderProtocolQosPolicy DDS::DataReaderQos::protocol

<<extension>> DDS::DataReader protocol policy, DATA_READER_PROTOCOL

Referenced by RTI.Connext.Queuing.QueueConsumer< TRep >::QueueConsumer().

◆ transport_selection

TransportSelectionQosPolicy ^ DDS::DataReaderQos::transport_selection

<<extension>> Transport selection policy, TRANSPORT_SELECTION.

Specifies the transports available for use by the DDS::DataReader.

◆ unicast

TransportUnicastQosPolicy ^ DDS::DataReaderQos::unicast

<<extension>> Unicast transport policy, TRANSPORT_UNICAST.

Specifies the unicast transport interfaces and ports on which messages can be received.

The unicast interfaces are used to receive messages from DDS::DataWriter entities in the domain.

◆ multicast

TransportMulticastQosPolicy ^ DDS::DataReaderQos::multicast

<<extension>> Multicast transport policy, TRANSPORT_MULTICAST.

Specifies the multicast group addresses and ports on which messages can be received.

The multicast addresses are used to receive messages from DDS::DataWriter entities in the domain.

◆ property_qos

PropertyQosPolicy ^ DDS::DataReaderQos::property_qos

<<extension>> Property policy, PROPERTY.

◆ service

ServiceQosPolicy DDS::DataReaderQos::service

<<extension>> Service policy, SERVICE.

◆ availability

AvailabilityQosPolicy ^ DDS::DataReaderQos::availability

<<extension>> Availability policy, AVAILABILITY.

◆ subscription_name

EntityNameQosPolicy ^ DDS::DataReaderQos::subscription_name

<<extension>> EntityName policy, ENTITY_NAME.

◆ type_support

TypeSupportQosPolicy DDS::DataReaderQos::type_support

<<extension>> type support data, TYPESUPPORT.

Optional value that is passed to a type plugin's on_endpoint_attached and deserialization functions.

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ ToString() [1/4]

◆ ToString() [2/4]

◆ ToString() [3/4]

◆ ToString() [4/4]

Member Data Documentation

◆ durability

◆ deadline

◆ latency_budget

◆ liveliness

◆ reliability

◆ destination_order

◆ history

◆ resource_limits

◆ user_data

◆ ownership

◆ time_based_filter

◆ reader_data_lifecycle

◆ transport_priority

◆ representation

◆ type_consistency

◆ data_tags

◆ reader_resource_limits

◆ protocol

◆ transport_selection

◆ unicast

◆ multicast

◆ property_qos

◆ service

◆ availability

◆ subscription_name

◆ type_support