RTI Connext Traditional C++ API  Version 6.1.1
DDS_DataReaderQos Struct Reference

QoS policies supported by a DDSDataReader entity. More...

Public Member Functions

bool operator== (const DDS_DataReaderQos &r) const
 Compares two DataReaderQos objects for equality. More...
 
bool operator!= (const DDS_DataReaderQos &r) const
 Compares two DataReaderQos objects for inequality. More...
 
DDS_ReturnCode_t print () const
 Prints this DDS_DataReaderQos to stdout. More...
 
DDS_ReturnCode_t to_string (char *string, DDS_UnsignedLong &string_size) const
 Obtains a string representation of this DDS_DataReaderQos. More...
 
DDS_ReturnCode_t to_string (char *string, DDS_UnsignedLong &string_size, const DDS_DataReaderQos &base) const
 Obtains a string representation of this DDS_DataReaderQos. More...
 
DDS_ReturnCode_t to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintFormat &format) const
 Obtains a string representation of this DDS_DataReaderQos. More...
 
DDS_ReturnCode_t to_string (char *string, DDS_UnsignedLong &string_size, const DDS_DataReaderQos &base, const DDS_QosPrintFormat &format) const
 Obtains a string representation of this DDS_DataReaderQos. More...
 
DDS_ReturnCode_t to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintAll_t &) const
 Obtains a string representation of this DDS_DataReaderQos. More...
 
DDS_ReturnCode_t to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintAll_t &, const DDS_QosPrintFormat &format) const
 Obtains a string representation of this DDS_DataReaderQos. More...
 

Public Attributes

struct DDS_DurabilityQosPolicy durability
 Durability policy, DURABILITY. More...
 
struct DDS_DeadlineQosPolicy deadline
 Deadline policy, DEADLINE. More...
 
struct DDS_LatencyBudgetQosPolicy latency_budget
 Latency budget policy, LATENCY_BUDGET. More...
 
struct DDS_LivelinessQosPolicy liveliness
 Liveliness policy, LIVELINESS. More...
 
struct DDS_ReliabilityQosPolicy reliability
 Reliability policy, RELIABILITY. More...
 
struct DDS_DestinationOrderQosPolicy destination_order
 Destination order policy, DESTINATION_ORDER. More...
 
struct DDS_HistoryQosPolicy history
 History policy, HISTORY. More...
 
struct DDS_ResourceLimitsQosPolicy resource_limits
 Resource limits policy, RESOURCE_LIMITS. More...
 
struct DDS_UserDataQosPolicy user_data
 User data policy, USER_DATA. More...
 
struct DDS_OwnershipQosPolicy ownership
 Ownership policy, OWNERSHIP. More...
 
struct DDS_TimeBasedFilterQosPolicy time_based_filter
 Time-based filter policy, TIME_BASED_FILTER. More...
 
struct DDS_ReaderDataLifecycleQosPolicy reader_data_lifecycle
 Reader data lifecycle policy, READER_DATA_LIFECYCLE. More...
 
struct DDS_DataRepresentationQosPolicy representation
 Data representation policy, DATA_REPRESENTATION. More...
 
struct DDS_TypeConsistencyEnforcementQosPolicy type_consistency
 Type consistency enforcement policy, TYPE_CONSISTENCY_ENFORCEMENT. More...
 
DDS_DataTagQosPolicy data_tags
 DataTag policy, DATA_TAG. More...
 
struct DDS_DataReaderResourceLimitsQosPolicy reader_resource_limits
 <<extension>> DDSDataReader resource limits policy, DATA_READER_RESOURCE_LIMITS. This policy is an extension to the DDS standard. More...
 
struct DDS_DataReaderProtocolQosPolicy protocol
 <<extension>> DDSDataReader protocol policy, DATA_READER_PROTOCOL More...
 
struct DDS_TransportSelectionQosPolicy transport_selection
 <<extension>> Transport selection policy, TRANSPORT_SELECTION. More...
 
struct DDS_TransportUnicastQosPolicy unicast
 <<extension>> Unicast transport policy, TRANSPORT_UNICAST. More...
 
struct DDS_TransportMulticastQosPolicy multicast
 <<extension>> Multicast transport policy, TRANSPORT_MULTICAST. More...
 
struct DDS_PropertyQosPolicy property
 <<extension>> Property policy, PROPERTY. More...
 
struct DDS_ServiceQosPolicy service
 <<extension>> Service policy, SERVICE. More...
 
struct DDS_AvailabilityQosPolicy availability
 <<extension>> Availability policy, AVAILABILITY. More...
 
struct DDS_EntityNameQosPolicy subscription_name
 <<extension>> EntityName policy, ENTITY_NAME. More...
 
struct DDS_TransportPriorityQosPolicy transport_priority
 Transport priority policy, TRANSPORT_PRIORITY. More...
 
struct DDS_TypeSupportQosPolicy type_support
 <<extension>> type support data, TYPESUPPORT. More...
 

Detailed Description

QoS policies supported by a DDSDataReader 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, DDSDataReader::set_qos and DDSDataReader::set_qos_with_profile will fail with DDS_RETCODE_INCONSISTENT_POLICY and DDSSubscriber::create_datareader will return NULL.

Member Function Documentation

◆ operator==()

bool DDS_DataReaderQos::operator== ( const DDS_DataReaderQos r) const
inline

Compares two DataReaderQos objects for equality.

See also
DDS_DataReaderQos_equals

References DDS_DataReaderQos_equals().

◆ operator!=()

bool DDS_DataReaderQos::operator!= ( const DDS_DataReaderQos r) const
inline

Compares two DataReaderQos objects for inequality.

See also
DDS_DataReaderQos_equals

References DDS_DataReaderQos_equals().

Member Data Documentation

◆ durability

struct DDS_DurabilityQosPolicy DDS_DataReaderQos::durability

Durability policy, DURABILITY.

◆ deadline

struct DDS_DeadlineQosPolicy DDS_DataReaderQos::deadline

Deadline policy, DEADLINE.

◆ latency_budget

struct DDS_LatencyBudgetQosPolicy DDS_DataReaderQos::latency_budget

Latency budget policy, LATENCY_BUDGET.

◆ liveliness

struct DDS_LivelinessQosPolicy DDS_DataReaderQos::liveliness

Liveliness policy, LIVELINESS.

◆ reliability

struct DDS_ReliabilityQosPolicy DDS_DataReaderQos::reliability

Reliability policy, RELIABILITY.

◆ destination_order

struct DDS_DestinationOrderQosPolicy DDS_DataReaderQos::destination_order

Destination order policy, DESTINATION_ORDER.

◆ history

struct DDS_HistoryQosPolicy DDS_DataReaderQos::history

History policy, HISTORY.

◆ resource_limits

struct DDS_ResourceLimitsQosPolicy DDS_DataReaderQos::resource_limits

Resource limits policy, RESOURCE_LIMITS.

◆ user_data

struct DDS_UserDataQosPolicy DDS_DataReaderQos::user_data

User data policy, USER_DATA.

◆ ownership

struct DDS_OwnershipQosPolicy DDS_DataReaderQos::ownership

Ownership policy, OWNERSHIP.

◆ time_based_filter

struct DDS_TimeBasedFilterQosPolicy DDS_DataReaderQos::time_based_filter

Time-based filter policy, TIME_BASED_FILTER.

◆ reader_data_lifecycle

struct DDS_ReaderDataLifecycleQosPolicy DDS_DataReaderQos::reader_data_lifecycle

Reader data lifecycle policy, READER_DATA_LIFECYCLE.

◆ representation

struct DDS_DataRepresentationQosPolicy DDS_DataReaderQos::representation

Data representation policy, DATA_REPRESENTATION.

◆ type_consistency

struct DDS_TypeConsistencyEnforcementQosPolicy DDS_DataReaderQos::type_consistency

Type consistency enforcement policy, TYPE_CONSISTENCY_ENFORCEMENT.

◆ data_tags

DDS_DataTagQosPolicy DDS_DataReaderQos::data_tags

DataTag policy, DATA_TAG.

◆ reader_resource_limits

struct DDS_DataReaderResourceLimitsQosPolicy DDS_DataReaderQos::reader_resource_limits

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

◆ protocol

struct DDS_DataReaderProtocolQosPolicy DDS_DataReaderQos::protocol

◆ transport_selection

struct DDS_TransportSelectionQosPolicy DDS_DataReaderQos::transport_selection

<<extension>> Transport selection policy, TRANSPORT_SELECTION.

Specifies the transports available for use by the DDSDataReader.

◆ unicast

struct DDS_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 DDSDataWriter entities in the domain.

◆ multicast

struct DDS_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 DDSDataWriter entities in the domain.

◆ property

struct DDS_PropertyQosPolicy DDS_DataReaderQos::property

<<extension>> Property policy, PROPERTY.

◆ service

struct DDS_ServiceQosPolicy DDS_DataReaderQos::service

<<extension>> Service policy, SERVICE.

◆ availability

struct DDS_AvailabilityQosPolicy DDS_DataReaderQos::availability

<<extension>> Availability policy, AVAILABILITY.

◆ subscription_name

struct DDS_EntityNameQosPolicy DDS_DataReaderQos::subscription_name

<<extension>> EntityName policy, ENTITY_NAME.

◆ transport_priority

struct DDS_TransportPriorityQosPolicy DDS_DataReaderQos::transport_priority

Transport priority policy, TRANSPORT_PRIORITY.

◆ type_support

struct DDS_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.