AvailabilityQosPolicy Class Reference
[AVAILABILITY]

Configures the availability of data. More...

Inheritance diagram for AvailabilityQosPolicy:

List of all members.

Public Attributes
final Duration_t	max_data_availability_waiting_time
	Defines how much time to wait before delivering a sample to the application without having received some of the previous samples.
final Duration_t	max_endpoint_availability_waiting_time
	Defines how much time to wait to discover DataWriters providing samples for the same data source (virtual GUID).
final EndpointGroupSeq	required_matched_endpoint_groups
	A sequence of endpoint groups.

---

Detailed Description

Configures the availability of data.

Entity:

com.rti.dds.subscription.DataReader

Properties:

RxO = NO
Changeable = NO

Usage

This QoS policy is used in the context of the Collaborative DataWriters feature.

Collaborative DataWriters

The Collaborative DataWriters feature allows having multiple DataWriters publishing samples from a common logical data source. The DataReaders will combine the samples coming from the DataWriters in order to reconstruct the correct order at the source.

This QoS policy allows you to configure the ordering and combination process in the DataReader and can be used to support two different use cases:

• Ordered delivery of samples with RTI Persistence Service: When a late-joining DataReader configured with com.rti.dds.infrastructure.DurabilityQosPolicy set to DurabilityQosPolicyKind.PERSISTENT_DURABILITY_QOS or DurabilityQosPolicyKind.TRANSIENT_DURABILITY_QOS joins a DDS domain, it will start receiving historical samples from multiple DataWriters. For example, if the original DataWriter is still alive, the newly created DataReader will receive samples from the original DataWriter and one or more RTI Persistence Service DataWriters (PRSTDataWriters). This policy can be used to configure the sample ordering process on the DataReader.

• Ordered delivery of samples with Group Ordered Access: This policy can also be used to configure the sample ordering process when the Subscriber is configured with com.rti.dds.infrastructure.PresentationQosPolicy access_scope set to PresentationQosPolicyAccessScopeKind.GROUP_PRESENTATION_QOS. In this case, the Subscriber must deliver in order the samples published by a group of DataWriters that belong to the same Publisher and have access_scope set to PresentationQosPolicyAccessScopeKind.GROUP_PRESENTATION_QOS.

Each sample published in a DDS domain for a given logical data source is uniquely identified by a pair (virtual GUID, virtual sequence number). Samples from the same data source (same virtual GUID) can be published by different DataWriters. A DataReader will deliver a sample (VGUIDn, VSNm) to the application if one of the following conditions is satisfied:

• (VGUIDn, VSNm-1) has already been delivered to the application.
• All the known DataWriters publishing VGUIDn have announced that they do not have (VGUIDn, VSNm-1).
• None of the known DataWriters publishing GUIDn have announced potential availability of (VGUIDn, VSNm-1) and both timeouts in this QoS policy have expired.

A DataWriter announces potential availability of samples by using virtual heartbeats (HBs).

When com.rti.dds.infrastructure.PresentationQosPolicy.access_scope is set to PresentationQosPolicyAccessScopeKind.TOPIC_PRESENTATION_QOS or PresentationQosPolicyAccessScopeKind.INSTANCE_PRESENTATION_QOS, the virtual HB contains information about the samples contained in the com.rti.dds.publication.DataWriter history.

When com.rti.dds.infrastructure.PresentationQosPolicy.access_scope is set to PresentationQosPolicyAccessScopeKind.GROUP_PRESENTATION_QOS, the virtual HB contains information about all DataWriters in the com.rti.dds.publication.Publisher.

The frequency at which virtual HBs are sent is controlled by the protocol parameters com.rti.dds.infrastructure.RtpsReliableWriterProtocol_t.virtual_heartbeat_period and com.rti.dds.infrastructure.RtpsReliableWriterProtocol_t.samples_per_virtual_heartbeat.

---

Member Data Documentation

final Duration_t max_data_availability_waiting_time

Defines how much time to wait before delivering a sample to the application without having received some of the previous samples.

A sample identified by (GUIDn, SNm) will be delivered to the application if this timeout expires for the sample and the following two conditions are satisfied:

• None of the known DataWriters publishing GUIDn have announced potential availability of (GUIDn, SNm-1).
• The DataWriters for all the endpoint groups specified in required_matched_endpoint_groups have been discovered or max_endpoint_availability_waiting_time has expired.

[default] com.rti.dds.infrastructure.Duration_t.AUTO (com.rti.dds.infrastructure.Duration_t.INFINITE for PresentationQosPolicyAccessScopeKind.GROUP_PRESENTATION_QOS. Otherwise, 0 seconds)

[range] [0, com.rti.dds.infrastructure.Duration_t.INFINITE], com.rti.dds.infrastructure.Duration_t.AUTO

final Duration_t max_endpoint_availability_waiting_time

Defines how much time to wait to discover DataWriters providing samples for the same data source (virtual GUID).

The set of endpoint groups that are required to provide samples for a data source can be configured using required_matched_endpoint_groups.

A non-consecutive sample identified by (GUIDn, SNm) cannot be delivered to the application unless DataWriters for all the endpoint groups in required_matched_endpoint_groups are discovered or this timeout expires.

[default] com.rti.dds.infrastructure.Duration_t.AUTO (com.rti.dds.infrastructure.Duration_t.INFINITE for PresentationQosPolicyAccessScopeKind.GROUP_PRESENTATION_QOS. Otherwise, 0 seconds)

[range] [0, com.rti.dds.infrastructure.Duration_t.INFINITE], com.rti.dds.infrastructure.Duration_t.AUTO

final EndpointGroupSeq required_matched_endpoint_groups

A sequence of endpoint groups.

In the context of Collaborative DataWriters, it specifies the set of endpoint groups that are expected to provide samples for the same data source.

The quorum count in a group represents the number of DataWriters that must be discovered for that group before the DataReader is allowed to provide non consecutive samples to the application.

A DataWriter becomes a member of an endpoint group by configuring the role_name in com.rti.dds.publication.DataWriterQos.publication_name.

[default] Empty sequence