RTI Connext C# API Version 7.2.0
Rti.Dds.Core.Policy.LatencyBudget Class 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...

Inherits IEquatable< LatencyBudget >.

Public Member Functions

 LatencyBudget (Duration duration)
 Creates a new instance More...
 
LatencyBudget With (Action< LatencyBudgetBuilder > build)
 Creates a new LatencyBudget with a set of changes specified in an Action More...
 
override int GetHashCode ()
 Gets the hash code More...
 
override bool Equals (object other)
 Compares for equality More...
 
bool Equals (LatencyBudget other)
 Compares for equality More...
 

Properties

Duration Duration [get]
 Duration of the maximum acceptable delay. More...
 
static LatencyBudget Default [get]
 Singleton containing the default value of a LatencyBudget 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.

Constructor & Destructor Documentation

◆ LatencyBudget()

Rti.Dds.Core.Policy.LatencyBudget.LatencyBudget ( Duration  duration)

Creates a new instance

Parameters
durationThe value for Duration

Member Function Documentation

◆ With()

LatencyBudget Rti.Dds.Core.Policy.LatencyBudget.With ( Action< LatencyBudgetBuilder build)
inline

Creates a new LatencyBudget with a set of changes specified in an Action

Parameters
buildAn Action (typically a lambda function) that receives a modifiable object with the current values of this LatencyBudget.
Returns
A new LatencyBudget with the changes applied by the Action

◆ GetHashCode()

override int Rti.Dds.Core.Policy.LatencyBudget.GetHashCode ( )
inline

Gets the hash code

◆ Equals() [1/2]

override bool Rti.Dds.Core.Policy.LatencyBudget.Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Rti.Dds.Core.Policy.LatencyBudget.Equals ( LatencyBudget  other)
inline

Compares for equality

Property Documentation

◆ Duration

Duration Rti.Dds.Core.Policy.LatencyBudget.Duration
get

Duration of the maximum acceptable delay.

The full documentation is available in the C API: DDS_LatencyBudgetQosPolicy_duration

◆ Default

LatencyBudget Rti.Dds.Core.Policy.LatencyBudget.Default
staticget

Singleton containing the default value of a LatencyBudget