RTI Connext C# API Version 7.2.0
Rti.Dds.Core.Policy.RtpsReliableReaderProtocol Class Reference

Qos related to reliable reader protocol defined in RTPS. More...

Inherits IEquatable< RtpsReliableReaderProtocol >.

Public Member Functions

RtpsReliableReaderProtocol With (Action< RtpsReliableReaderProtocolBuilder > build)
 Creates a new RtpsReliableReaderProtocol 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 (RtpsReliableReaderProtocol other)
 Compares for equality More...
 

Properties

Duration MinHeartbeatResponseDelay [get]
 The minimum delay to respond to a heartbeat. More...
 
Duration MaxHeartbeatResponseDelay [get]
 The maximum delay to respond to a heartbeat. More...
 
Duration HeartbeatSuppressionDuration [get]
 The duration a reader ignores consecutively received heartbeats More...
 
Duration NackPeriod [get]
 The period at which to send NACKs More...
 
int ReceiveWindowSize [get]
 The number of received out-of-order samples a reader can keep at a time More...
 
Duration RoundTripTime [get]
 The duration from sending a NACK to receiving a repair of a sample More...
 
Duration AppAckPeriod [get]
 The period at which application-level acknowledgment messages are sent More...
 
Duration MinAppAckResponseKeepDuration [get]
 Minimum duration for which application-level acknowledgment response data is kept More...
 
int SamplesPerAppAck [get]
 The minimum number of samples acknowledged by one application-level acknowledgment message More...
 
static RtpsReliableReaderProtocol Default [get]
 Singleton containing the default value of a RtpsReliableReaderProtocol More...
 

Detailed Description

Qos related to reliable reader protocol defined in RTPS.

The full documentation is available in the C API: DDS_RtpsReliableReaderProtocol_t

Member Function Documentation

◆ With()

RtpsReliableReaderProtocol Rti.Dds.Core.Policy.RtpsReliableReaderProtocol.With ( Action< RtpsReliableReaderProtocolBuilder build)
inline

Creates a new RtpsReliableReaderProtocol 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 RtpsReliableReaderProtocol.
Returns
A new RtpsReliableReaderProtocol with the changes applied by the Action

◆ GetHashCode()

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

Gets the hash code

◆ Equals() [1/2]

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

Compares for equality

◆ Equals() [2/2]

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

Compares for equality

Property Documentation

◆ MinHeartbeatResponseDelay

Duration Rti.Dds.Core.Policy.RtpsReliableReaderProtocol.MinHeartbeatResponseDelay
get

The minimum delay to respond to a heartbeat.

The full documentation is available in the C API: DDS_RtpsReliableReaderProtocol_t_min_heartbeat_response_delay

◆ MaxHeartbeatResponseDelay

Duration Rti.Dds.Core.Policy.RtpsReliableReaderProtocol.MaxHeartbeatResponseDelay
get

The maximum delay to respond to a heartbeat.

The full documentation is available in the C API: DDS_RtpsReliableReaderProtocol_t_max_heartbeat_response_delay

◆ HeartbeatSuppressionDuration

Duration Rti.Dds.Core.Policy.RtpsReliableReaderProtocol.HeartbeatSuppressionDuration
get

The duration a reader ignores consecutively received heartbeats

The full documentation is available in the C API: DDS_RtpsReliableReaderProtocol_t_heartbeat_suppression_duration

◆ NackPeriod

Duration Rti.Dds.Core.Policy.RtpsReliableReaderProtocol.NackPeriod
get

The period at which to send NACKs

The full documentation is available in the C API: DDS_RtpsReliableReaderProtocol_t_nack_period

◆ ReceiveWindowSize

int Rti.Dds.Core.Policy.RtpsReliableReaderProtocol.ReceiveWindowSize
get

The number of received out-of-order samples a reader can keep at a time

The full documentation is available in the C API: DDS_RtpsReliableReaderProtocol_t_receive_window_size

◆ RoundTripTime

Duration Rti.Dds.Core.Policy.RtpsReliableReaderProtocol.RoundTripTime
get

The duration from sending a NACK to receiving a repair of a sample

The full documentation is available in the C API: DDS_RtpsReliableReaderProtocol_t_round_trip_time

◆ AppAckPeriod

Duration Rti.Dds.Core.Policy.RtpsReliableReaderProtocol.AppAckPeriod
get

The period at which application-level acknowledgment messages are sent

The full documentation is available in the C API: DDS_RtpsReliableReaderProtocol_t_app_ack_period

◆ MinAppAckResponseKeepDuration

Duration Rti.Dds.Core.Policy.RtpsReliableReaderProtocol.MinAppAckResponseKeepDuration
get

Minimum duration for which application-level acknowledgment response data is kept

The full documentation is available in the C API: DDS_RtpsReliableReaderProtocol_t_min_app_ack_response_keep_duration

◆ SamplesPerAppAck

int Rti.Dds.Core.Policy.RtpsReliableReaderProtocol.SamplesPerAppAck
get

The minimum number of samples acknowledged by one application-level acknowledgment message

The full documentation is available in the C API: DDS_RtpsReliableReaderProtocol_t_samples_per_app_ack

◆ Default

RtpsReliableReaderProtocol Rti.Dds.Core.Policy.RtpsReliableReaderProtocol.Default
staticget

Singleton containing the default value of a RtpsReliableReaderProtocol