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

Equals() [1/2]

override bool Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Equals

(

RtpsReliableReaderProtocol

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

RtpsReliableReaderProtocol With

(

Action< RtpsReliableReaderProtocolBuilder >

build

)

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

Parameters

build

An 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

Property Documentation

AppAckPeriod

Duration 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

Default

RtpsReliableReaderProtocol Default

staticget

Singleton containing the default value of a RtpsReliableReaderProtocol

HeartbeatSuppressionDuration

Duration 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

MaxHeartbeatResponseDelay

Duration 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

MinAppAckResponseKeepDuration

Duration 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

MinHeartbeatResponseDelay

Duration 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

NackPeriod

Duration 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 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 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

SamplesPerAppAck

int 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