RTI Connext C# API  6.1.2
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()

LatencyBudget ( Duration  duration)

Creates a new instance

Parameters
durationThe value for Duration

Member Function Documentation

◆ Equals() [1/2]

bool Equals ( LatencyBudget  other)

Compares for equality

◆ Equals() [2/2]

override bool Equals ( object  other)

Compares for equality

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code

◆ With()

LatencyBudget With ( Action< LatencyBudgetBuilder build)

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

Property Documentation

◆ Default

LatencyBudget Default
staticget

Singleton containing the default value of a LatencyBudget

◆ Duration

Duration of the maximum acceptable delay.

The full documentation is available in the C API: DDS_LatencyBudgetQosPolicy::duration