RTI Connext .NET API (legacy)  Version 6.1.1
DDS::LifespanQosPolicy Struct Reference

Specifies how long the data written by the DDS::DataWriter is considered valid. More...

#include <managed_infrastructure.h>

Static Public Member Functions

static System::String ^ get_lifespan_qos_policy_name ()
 Stringified human-readable name for DDS::LifespanQosPolicy. More...
 

Public Attributes

Duration_t duration
 Maximum duration for the data's validity. More...
 

Detailed Description

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 DDS::TypedDataWriter::write_w_timestamp or DDS::TypedDataWriter::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
DDS::TypedDataWriter::write
DDS::TypedDataWriter::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

Member Data Documentation

◆ duration

Duration_t DDS::LifespanQosPolicy::duration

Maximum duration for the data's validity.

[default] DDS::Duration_t::DURATION_INFINITE

[range] [1 nanosec, 1 year] or DDS::Duration_t::DURATION_INFINITE