DDS_DestinationOrderQosPolicy Struct Reference

Controls how the middleware will deal with data sent by multiple DDSDataWriter entities for the same instance of data (i.e., same DDSTopic and key). More...

Public Attributes
DDS_DestinationOrderQosPolicyKind	kind
	Specifies the desired kind of destination order.
DDS_DestinationOrderQosPolicyScopeKind	scope
	Specifies the desired scope of the source destination order.
struct DDS_Duration_t	source_timestamp_tolerance
	<<extension>> Allowed tolerance between source timestamps of consecutive samples.

Detailed Description

Controls how the middleware will deal with data sent by multiple DDSDataWriter entities for the same instance of data (i.e., same DDSTopic and key).

Entity:

DDSTopic, DDSDataReader, DDSDataWriter

Status:

DDS_OFFERED_INCOMPATIBLE_QOS_STATUS, DDS_REQUESTED_INCOMPATIBLE_QOS_STATUS

Properties:

RxO = YES
Changeable = UNTIL ENABLE

Usage

When multiple DataWriters send data for the same topic, the order in which data from different DataWriters are received by the applications of different DataReaders may be different. So different DataReaders may not receive the same "last" value when DataWriters stop sending data.

This QoS policy controls how each subscriber resolves the final value of a data instance that is written by multiple DDSDataWriter entities (which may be associated with different DDSPublisher entities) running on different nodes.

This QoS can be used to create systems that have the property of "eventual consistency." Thus intermediate states across multiple applications may be inconsistent, but when DataWriters stop sending changes to the same topic, all applications will end up having the same state.

This QoS policy can be set for both DataWriters and DataReaders.

For the DataReader:

The default setting, DDS_BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS, indicates that (assuming the OWNERSHIP_STRENGTH policy allows it) the latest received value for the instance should be the one whose value is kept. That is, data will be delivered by a DDSDataReader in the order in which it was received (which may lead to inconsistent final values).

For DDS_BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS, if the scope is set to DDS_INSTANCE_SCOPE_DESTINATIONORDER_QOS (default), within each instance, the sample's source timestamp shall be used to determine the most recent information. This is the only setting that, in the case of concurrent same-strength DataWriters updating the same instance, ensures that all DataReaders end up with the same final value for the instance. If a DataReader receives a sample for an instance with a source timestamp that is older than the last source timestamp received for the instance, the sample is dropped silently. The SAMPLE_REJECTED status or the SAMPLE_LOST status will not be updated.

If scope is set to DDS_TOPIC_SCOPE_DESTINATIONORDER_QOS, the ordering is enforced per topic across all instances.

In addition, a DataReader will accept a sample only if the source timestamp is no farther in the future from the reception timestamp than source_timestamp_tolerance. Otherwise, the DDS sample is dropped silently. The SAMPLE_REJECTED status or the SAMPLE_LOST status will not be updated.

For the DataWriter:

For the default setting, DDS_BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS, the DataWriter will not enforce source timestamp ordering when writing samples using the FooDataWriter::write_w_params or FooDataWriter::write_w_timestamp API. The source timestamp of a new sample can be older than the source timestamp of the previous samples.

When using DDS_BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS, If scope is set to DDS_INSTANCE_SCOPE_DESTINATIONORDER_QOS (default), when writing a sample, the sample's timestamp must not be older than the timestamp of the previously written DDS sample for the same instance. If, however, the timestamp is older than the timestamp of the previously written DDS sample—but the difference is less than the source_timestamp_tolerance—the DDS sample will use the previously written DDS sample's timestamp as its timestamp. Otherwise, if the difference is greater than the tolerance, the write will fail with retcode DDS_RETCODE_BAD_PARAMETER.

If scope is set to DDS_TOPIC_SCOPE_DESTINATIONORDER_QOS, a new sample timestamp must not be older than the timestamp of the previously written DDS sample, across all instances. (The ordering is enforced across all instances.)

Compatibility

The value offered is considered compatible with the value requested if and only if the inequality offered kind >= requested kind evaluates to 'TRUE'. For the purposes of this inequality, the values of DDS_DestinationOrderQosPolicy::kind are considered ordered such that DDS_BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS < DDS_BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS

Member Data Documentation

DDS_DestinationOrderQosPolicyKind DDS_DestinationOrderQosPolicy::kind

Specifies the desired kind of destination order.

[default] DDS_BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS,

DDS_DestinationOrderQosPolicyScopeKind DDS_DestinationOrderQosPolicy::scope

Specifies the desired scope of the source destination order.

Indicates if tolerance check and the current sample's timestamp is computed based on instance or topic basis.
[default] DDS_INSTANCE_SCOPE_DESTINATIONORDER_QOS

struct DDS_Duration_t DDS_DestinationOrderQosPolicy::source_timestamp_tolerance

<<extension>> Allowed tolerance between source timestamps of consecutive samples.

When a DDSDataWriter sets DDS_DestinationOrderQosPolicyKind to DDS_BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS, when writing a sample, its timestamp must not be less than the timestamp of the previously written sample. However, if it is less than the timestamp of the previously written sample but the difference is less than this tolerance, the sample will use the previously written sample's timestamp as its timestamp. Otherwise, if the difference is greater than this tolerance, the write will fail.

When a DDSDataReader sets DDS_DestinationOrderQosPolicyKind to DDS_BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS, the DDSDataReader will accept a sample only if the source timestamp is no farther in the future from the reception timestamp than this tolerance. Otherwise, the sample is dropped silently.

[default] 100 milliseconds for DDSDataWriter, 30 seconds for DDSDataReader