RTI Connext C API Version 7.4.0
DDS_LifespanQosPolicy Struct Reference

<<spec>> Specifies how long the data written by the DDS_DataWriter is considered valid. More...

Data Fields

struct DDS_Duration_t duration
 <<basic>> <<spec>> Maximum duration for the data's validity. More...
 

Detailed Description

<<spec>> Specifies how long the data written by the DDS_DataWriter is considered valid.

Each data sample written by the DDS_DataWriter has an associated expiration time beyond which the data should not be delivered to any application. Once the sample expires, the data will be removed from the DDS_DataReader caches as well as from the transient and persistent information caches.

The expiration time of each sample from the DDS_DataWriter's cache is computed by adding the duration specified by this QoS policy to the time when the sample is added to the DDS_DataWriter's cache. This timestamp is not necessarily equal to the sample's source timestamp that can be provided by the user using the FooDataWriter_write_w_timestamp or FooDataWriter_write_w_params API.

The expiration time of each sample from the DDS_DataReader's cache is computed by adding the duration to the reception timestamp.

See also
FooDataWriter_write
FooDataWriter_write_w_timestamp
Entity:
DDS_Topic, DDS_DataWriter
Properties:
RxO = N/A
Changeable = YES

Usage

The Lifespan QoS policy can be used to control how much data is stored by RTI Connext. Even if it is configured to store "all" of the data sent or received for a topic (see DDS_HistoryQosPolicy), the total amount of data it stores may be limited by this QoS policy.

You may also use this QoS policy to ensure that applications do not receive or act on data, commands or messages that are too old and have 'expired.'

To avoid inconsistencies, multiple writers of the same instance should have the same lifespan.

See also
DDS_SampleInfo::source_timestamp
DDS_SampleInfo::reception_timestamp

Field Documentation

◆ duration

struct DDS_Duration_t DDS_LifespanQosPolicy::duration

<<basic>> <<spec>> Maximum duration for the data's validity.

[default] DDS_DURATION_INFINITE

[range] [1 nanosec, 1 year] or DDS_DURATION_INFINITE

Categories
Mutable, Discovery Metadata, Durability, Data Availability