DDS::DataReaderProtocolQosPolicy Struct Reference

Along with DDS::WireProtocolQosPolicy and DDS::DataWriterProtocolQosPolicy, this QoS policy configures the DDS on-the-network protocol (RTPS). More...

#include <managed_infrastructure.h>

Static Public Member Functions
static System::String ^	get_datareaderprotocol_qos_policy_name ()
	Stringified human-readable name for DDS::DataReaderProtocolQosPolicy. More...

Public Attributes
GUID_t	virtual_guid
	The virtual GUID (Global Unique Identifier). More...
System::UInt32	rtps_object_id
	The RTPS Object ID. More...
RtpsReliableReaderProtocol_t	rtps_reliable_reader
	RTPS protocol-related configuration settings for the RTPS reliable reader associated to a DDS::DataReader. This parameter only has effect if the reader is configured with DDS::ReliabilityQosPolicyKind::RELIABLE_RELIABILITY_QOS DDS::ReliabilityQosPolicyKind. More...

Properties
System::Boolean	expects_inline_qos [get, set]
	Specifies whether this DataReader expects inline QoS with every sample. More...
System::Boolean	disable_positive_acks [get, set]
	Whether the reader sends positive acknowledgements to writers. More...
System::Boolean	propagate_dispose_of_unregistered_instances [get, set]
	Indicates whether or not an instance can move to the DDS::InstanceStateKind::NOT_ALIVE_DISPOSED_INSTANCE_STATE state without being in the DDS::InstanceStateKind::ALIVE_INSTANCE_STATE state. More...
System::Boolean	propagate_unregister_of_disposed_instances [get, set]
	Indicates whether or not an instance can move to the DDS::InstanceStateKind::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE state without being in the DDS::InstanceStateKind::ALIVE_INSTANCE_STATE state. More...

Detailed Description

Along with DDS::WireProtocolQosPolicy and DDS::DataWriterProtocolQosPolicy, this QoS policy configures the DDS on-the-network protocol (RTPS).

DDS has a standard protocol for packet (user and meta data) exchange between applications using DDS for communications. This QoS policy and DDS::DataReaderProtocolQosPolicy give you control over configurable portions of the protocol, including the configuration of the reliable data delivery mechanism of the protocol on a per DataWriter or DataReader basis.

These configuration parameters control timing, timeouts, and give you the ability to tradeoff between speed of data loss detection and repair versus network and CPU bandwidth used to maintain reliability.

It is important to tune the reliability protocol (on a per DDS::DataWriter and DDS::DataReader basis) to meet the requirements of the end-user application so that data can be sent between DataWriters and DataReaders in an efficient and optimal manner in the presence of data loss.

You can also use this QoS policy to control how RTI Connext responds to "slow" reliable DataReaders or ones that disconnect or are otherwise lost. See DDS::ReliabilityQosPolicy for more information on the per-DataReader/DataWriter reliability configuration. DDS::HistoryQosPolicy and DDS::ResourceLimitsQosPolicy also play an important role in the DDS reliable protocol.

This QoS policy is an extension to the DDS standard.

Entity:

DDS::DataReader

Properties:

RxO = N/A
Changeable = NO

Member Data Documentation

virtual_guid

GUID_t DDS::DataReaderProtocolQosPolicy::virtual_guid

The virtual GUID (Global Unique Identifier).

The virtual GUID is used to uniquely identify different incarnations of the same DDS::DataReader.

The association between a DDS::DataReader and its persisted state is done using the virtual GUID.

[default] DDS::GUID_t::GUID_AUTO

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

rtps_object_id

System::UInt32 DDS::DataReaderProtocolQosPolicy::rtps_object_id

The RTPS Object ID.

This value is used to determine the RTPS object ID of a data reader according to the DDS-RTPS Interoperability Wire Protocol.

Only the last 3 bytes are used; the most significant byte is ignored.

If the default value is specified, RTI Connext will automatically assign the object ID based on a counter value (per participant) starting at 0x00800000. That value is incremented for each new data reader.

A rtps_object_id value in the interval [0x00800000,0x00ffffff] may collide with the automatic values assigned by RTI Connext. In those cases, the recomendation is not to use automatic object ID assigment.

[default] DDS::WireProtocolQosPolicy::RTPS_AUTO_ID

[range] [0,0x00ffffff]

rtps_reliable_reader

RtpsReliableReaderProtocol_t DDS::DataReaderProtocolQosPolicy::rtps_reliable_reader

RTPS protocol-related configuration settings for the RTPS reliable reader associated to a DDS::DataReader. This parameter only has effect if the reader is configured with DDS::ReliabilityQosPolicyKind::RELIABLE_RELIABILITY_QOS DDS::ReliabilityQosPolicyKind.

For details, refer to the DDS::RtpsReliableReaderProtocol_t

[default]
min_heartbeat_response_delay 0.0 seconds;
max_heartbeat_response_delay 0.5 seconds;
heartbeat_suppression_duration 0.0625 seconds;
nack_period 5.0 seconds;
receive_window_size 256;
round_trip_time 0.0 seconds;
app_ack_period 5.0 seconds;
samples_per_app_ack 1;

Property Documentation

expects_inline_qos

System:: Boolean DDS::DataReaderProtocolQosPolicy::expects_inline_qos

getset

Specifies whether this DataReader expects inline QoS with every sample.

In RTI Connext, a DDS::DataReader nominally relies on Discovery to propagate QoS on a matched DDS::DataWriter. Alternatively, a DDS::DataReader may get information on a matched DDS::DataWriter through QoS sent inline with a sample.

Asserting DDS::DataReaderProtocolQosPolicy::expects_inline_qos indicates to a matching DDS::DataWriter that this DDS::DataReader expects to receive inline QoS with every sample. The complete set of inline QoS that a DDS::DataWriter may send inline is specified by the Real-Time Publish-Subscribe (RTPS) Wire Interoperability Protocol.

Because RTI Connext DDS::DataWriter and DDS::DataReader cache Discovery information, inline QoS are largely redundant and thus unecessary. Only for other stateless implementations whose DDS::DataReader does not cache Discovery information is inline QoS necessary.

Also note that inline QoS are additional wire-payload that consume additional bandwidth and serialization and deserialization time.

[default] false

disable_positive_acks

System:: Boolean DDS::DataReaderProtocolQosPolicy::disable_positive_acks

getset

Whether the reader sends positive acknowledgements to writers.

If set to true, the reader does not send positive acknowledgments (ACKs) in response to Heartbeat messages. The reader will send negative acknowledgements (NACKs) when a Heartbeat advertises samples that it has not received.

Otherwise, if set to false (the default), the reader will send ACKs to writers that expect ACKs (DDS::DataWriterProtocolQosPolicy::disable_positive_acks = false) and it will not send ACKs to writers that disable ACKs (DDS::DataWriterProtocolQosPolicy::disable_positive_acks = true)

[default] false

propagate_dispose_of_unregistered_instances

System:: Boolean DDS::DataReaderProtocolQosPolicy::propagate_dispose_of_unregistered_instances

getset

Indicates whether or not an instance can move to the DDS::InstanceStateKind::NOT_ALIVE_DISPOSED_INSTANCE_STATE state without being in the DDS::InstanceStateKind::ALIVE_INSTANCE_STATE state.

This field only applies to keyed readers.

When the field is set to true, the DataReader will receive dispose notifications even if the instance is not alive.

To guarantee the key availability through the usage of the API DDS::TypedDataReader::get_key_value, this option should be used in combination DDS::DataWriterProtocolQosPolicy::serialize_key_with_dispose on the DataWriter that should be set to true.

[default] false

propagate_unregister_of_disposed_instances

System:: Boolean DDS::DataReaderProtocolQosPolicy::propagate_unregister_of_disposed_instances

getset

Indicates whether or not an instance can move to the DDS::InstanceStateKind::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE state without being in the DDS::InstanceStateKind::ALIVE_INSTANCE_STATE state.

This field only applies to keyed readers.

When the field is set to true, the DataReader will receive unregister notifications even if the instance is not alive.

[default] false