RTI Connext .NET API (legacy)  Version 6.1.0
DDS::LatencyBudgetQosPolicy Struct Reference

Provides a hint as to the maximum acceptable delay from the time the data is written to the time it is received by the subscribing applications. More...

#include <managed_infrastructure.h>

Static Public Member Functions

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

Public Attributes

Duration_t duration
 Duration of the maximum acceptable delay. More...
 

Detailed Description

Provides a hint as to the maximum acceptable delay from the time the data is written to the time it is received by the subscribing applications.

This policy is a hint to a DDS implementation; it can be used to change how it processes and sends data that has low latency requirements. The DDS specification does not mandate whether or how this policy is used.

Entity:
DDS::Topic, DDS::DataReader, DDS::DataWriter
Status:
OFFERED_INCOMPATIBLE_QOS_STATUS, REQUESTED_INCOMPATIBLE_QOS_STATUS
Properties:
RxO = YES
Changeable = YES
See also
DDS::PublishModeQosPolicy
DDS::FlowController

Usage

This policy provides a means for the application to indicate to the middleware the urgency of the data communication. By having a non-zero duration, RTI Connext can optimize its internal operation.

RTI Connext uses it in conjunction with ASYNCHRONOUS_PUBLISH_MODE_QOS DDS::DataWriter instances associated with a DDS_EDF_FLOW_CONTROLLER_SCHED_POLICY DDS::FlowController only. Together with the time of write, DDS::LatencyBudgetQosPolicy::duration determines the deadline of each individual sample. RTI Connext uses this information to prioritize the sending of asynchronously published data; see DDS::AsynchronousPublisherQosPolicy.

Compatibility

The value offered is considered compatible with the value requested if and only if the inequality offered duration <= requested duration evaluates to 'TRUE'.

Member Data Documentation

◆ duration

Duration_t DDS::LatencyBudgetQosPolicy::duration

Duration of the maximum acceptable delay.

[default] 0 (meaning minimize the delay)