QoS related to the reliable writer protocol defined in RTPS. More...

Inherits IEquatable< RtpsReliableWriterProtocol >.

Public Member Functions
RtpsReliableWriterProtocol	With (Action< RtpsReliableWriterProtocolBuilder > build)
	Creates a new RtpsReliableWriterProtocol 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 (RtpsReliableWriterProtocol other)
	Compares for equality More...

Properties
int	LowWatermark `[get]`
	When the number of unacknowledged samples in the current send window of a reliable writer meets or falls below this threshold, the Status.ReliableWriterCacheChangedStatus is considered to have changed. More...

int	HighWatermark `[get]`
	When the number of unacknowledged samples in the current send window of a reliable writer meets or exceeds this threshold, the Status.ReliableWriterCacheChangedStatus is considered to have changed. More...

Duration	HeartbeatPeriod `[get]`
	The period at which to send heartbeats. More...

Duration	FastHeartbeatPeriod `[get]`
	An alternative heartbeat period used when a reliable writer needs to flush its unacknowledged samples more quickly. More...

Duration	LateJoinerHeartbeatPeriod `[get]`
	An alternative heartbeat period used when a reliable reader joins late and needs to be caught up on cached samples of a reliable writer more quickly than the normal heartbeat rate. More...

Duration	VirtualHeartbeatPeriod `[get]`
	The period at which to send virtual heartbeats. Virtual heartbeats inform the reliable reader about the range of samples currently present, for each virtual GUID, in the reliable writer's queue. More...

int	SamplesPerVirtualHeartbeat `[get]`
	The number of samples that a reliable writer has to publish before sending a virtual heartbeat. More...

int	MaxHeartbeatRetries `[get]`
	The maximum number of periodic heartbeat retries before marking a remote reader as inactive. More...

bool	InactivateNonprogressingReaders `[get]`
	Whether to treat remote readers as inactive when their NACKs do not progress More...

int	HeartbeatsPerMaxSamples `[get]`
	The number of heartbeats per current send window. More...

Duration	MinNackResponseDelay `[get]`
	The minimum delay to respond to a NACK. More...

Duration	MaxNackResponseDelay `[get]`
	The maximum delay to respond to a nack. More...

Duration	NackSuppressionDuration `[get]`
	The duration for ignoring consecutive NACKs that may trigger redundant repairs. More...

int	MaxBytesPerNackResponse `[get]`
	The maximum total message size when resending rejected samples. More...

Duration	DisablePositiveAcksMinSampleKeepDuration `[get]`
	The minimum duration a sample is queued for ACK-disabled readers. More...

Duration	DisablePositiveAcksMaxSampleKeepDuration `[get]`
	The maximum duration a sample is queued for ACK-disabled readers. More...

bool	DisablePositiveAcksEnableAdaptiveSampleKeepDuration `[get]`
	Enables dynamic adjustment of sample keep duration in response to congestion. More...

int	DisablePositiveAcksDecreaseSampleKeepDurationFactor `[get]`
	Controls rate of contraction of dynamic sample keep duration. More...

int	DisablePositiveAcksIncreaseSampleKeepDurationFactor `[get]`
	Controls rate of growth of dynamic sample keep duration. More...

int	MinSendWindowSize `[get]`
	Minimum size of send window of unacknowledged samples More...

int	MaxSendWindowSize `[get]`
	Maximum size of send window of unacknowledged samples More...

Duration	SendWindowUpdatePeriod `[get]`
	Period in which send window may be dynamically changed More...

int	SendWindowIncreaseFactor `[get]`
	Increases send window size by this percentage when reacting dynamically to network conditions More...

int	SendWindowDecreaseFactor `[get]`
	Decreases send window size by this percentage when reacting dynamically to network conditions More...

bool	EnableMulticastPeriodicHeartbeat `[get]`
	Whether periodic heartbeat messages are sent over multicast More...

int	MulticastResendThreshold `[get]`
	The minimum number of requesting readers needed to trigger a multicast resend More...

bool	DisableRepairPiggybackHeartbeat `[get]`
	Prevents piggyback heartbeats from being sent with repair samples More...

static RtpsReliableWriterProtocol	Default `[get]`
	Singleton containing the default value of a RtpsReliableWriterProtocol More...

Detailed Description

QoS related to the reliable writer protocol defined in RTPS.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t

Member Function Documentation

◆ With()

RtpsReliableWriterProtocol Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.With ( Action< RtpsReliableWriterProtocolBuilder > build )

inline

Creates a new RtpsReliableWriterProtocol 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 RtpsReliableWriterProtocol.

Returns: A new RtpsReliableWriterProtocol with the changes applied by the Action

◆ GetHashCode()

override int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.GetHashCode ( )

inline

Gets the hash code

◆ Equals() [1/2]

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

Compares for equality

◆ Equals() [2/2]

bool Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.Equals ( RtpsReliableWriterProtocol other )

inline

Compares for equality

Property Documentation

◆ LowWatermark

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.LowWatermark

get

When the number of unacknowledged samples in the current send window of a reliable writer meets or falls below this threshold, the Status.ReliableWriterCacheChangedStatus is considered to have changed.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_low_watermark

◆ HighWatermark

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.HighWatermark

get

When the number of unacknowledged samples in the current send window of a reliable writer meets or exceeds this threshold, the Status.ReliableWriterCacheChangedStatus is considered to have changed.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_high_watermark

◆ HeartbeatPeriod

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.HeartbeatPeriod

get

The period at which to send heartbeats.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_heartbeat_period

◆ FastHeartbeatPeriod

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.FastHeartbeatPeriod

get

An alternative heartbeat period used when a reliable writer needs to flush its unacknowledged samples more quickly.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_fast_heartbeat_period

◆ LateJoinerHeartbeatPeriod

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.LateJoinerHeartbeatPeriod

get

An alternative heartbeat period used when a reliable reader joins late and needs to be caught up on cached samples of a reliable writer more quickly than the normal heartbeat rate.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_late_joiner_heartbeat_period

◆ VirtualHeartbeatPeriod

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.VirtualHeartbeatPeriod

get

The period at which to send virtual heartbeats. Virtual heartbeats inform the reliable reader about the range of samples currently present, for each virtual GUID, in the reliable writer's queue.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_virtual_heartbeat_period

◆ SamplesPerVirtualHeartbeat

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.SamplesPerVirtualHeartbeat

get

The number of samples that a reliable writer has to publish before sending a virtual heartbeat.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_samples_per_virtual_heartbeat

◆ MaxHeartbeatRetries

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.MaxHeartbeatRetries

get

The maximum number of periodic heartbeat retries before marking a remote reader as inactive.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_max_heartbeat_retries

◆ InactivateNonprogressingReaders

bool Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.InactivateNonprogressingReaders

get

Whether to treat remote readers as inactive when their NACKs do not progress

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_inactivate_nonprogressing_readers

◆ HeartbeatsPerMaxSamples

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.HeartbeatsPerMaxSamples

get

The number of heartbeats per current send window.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_heartbeats_per_max_samples

◆ MinNackResponseDelay

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.MinNackResponseDelay

get

The minimum delay to respond to a NACK.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_min_nack_response_delay

◆ MaxNackResponseDelay

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.MaxNackResponseDelay

get

The maximum delay to respond to a nack.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_max_nack_response_delay

◆ NackSuppressionDuration

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.NackSuppressionDuration

get

The duration for ignoring consecutive NACKs that may trigger redundant repairs.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_nack_suppression_duration

◆ MaxBytesPerNackResponse

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.MaxBytesPerNackResponse

get

The maximum total message size when resending rejected samples.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_max_bytes_per_nack_response

◆ DisablePositiveAcksMinSampleKeepDuration

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.DisablePositiveAcksMinSampleKeepDuration

get

The minimum duration a sample is queued for ACK-disabled readers.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_disable_positive_acks_min_sample_keep_duration

◆ DisablePositiveAcksMaxSampleKeepDuration

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.DisablePositiveAcksMaxSampleKeepDuration

get

The maximum duration a sample is queued for ACK-disabled readers.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_disable_positive_acks_max_sample_keep_duration

◆ DisablePositiveAcksEnableAdaptiveSampleKeepDuration

bool Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.DisablePositiveAcksEnableAdaptiveSampleKeepDuration

get

Enables dynamic adjustment of sample keep duration in response to congestion.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_disable_positive_acks_enable_adaptive_sample_keep_duration

◆ DisablePositiveAcksDecreaseSampleKeepDurationFactor

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.DisablePositiveAcksDecreaseSampleKeepDurationFactor

get

Controls rate of contraction of dynamic sample keep duration.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_disable_positive_acks_decrease_sample_keep_duration_factor

◆ DisablePositiveAcksIncreaseSampleKeepDurationFactor

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.DisablePositiveAcksIncreaseSampleKeepDurationFactor

get

Controls rate of growth of dynamic sample keep duration.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_disable_positive_acks_increase_sample_keep_duration_factor

◆ MinSendWindowSize

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.MinSendWindowSize

get

Minimum size of send window of unacknowledged samples

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_min_send_window_size

◆ MaxSendWindowSize

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.MaxSendWindowSize

get

Maximum size of send window of unacknowledged samples

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_max_send_window_size

◆ SendWindowUpdatePeriod

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.SendWindowUpdatePeriod

get

Period in which send window may be dynamically changed

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_send_window_update_period

◆ SendWindowIncreaseFactor

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.SendWindowIncreaseFactor

get

Increases send window size by this percentage when reacting dynamically to network conditions

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_send_window_increase_factor

◆ SendWindowDecreaseFactor

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.SendWindowDecreaseFactor

get

Decreases send window size by this percentage when reacting dynamically to network conditions

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_send_window_decrease_factor

◆ EnableMulticastPeriodicHeartbeat

bool Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.EnableMulticastPeriodicHeartbeat

get

Whether periodic heartbeat messages are sent over multicast

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_enable_multicast_periodic_heartbeat

◆ MulticastResendThreshold

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.MulticastResendThreshold

get

The minimum number of requesting readers needed to trigger a multicast resend

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_multicast_resend_threshold

◆ DisableRepairPiggybackHeartbeat

bool Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.DisableRepairPiggybackHeartbeat

get

Prevents piggyback heartbeats from being sent with repair samples

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t_disable_repair_piggyback_heartbeat

◆ Default

RtpsReliableWriterProtocol Rti.Dds.Core.Policy.RtpsReliableWriterProtocol.Default

staticget

Singleton containing the default value of a RtpsReliableWriterProtocol

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ With()

◆ GetHashCode()

◆ Equals() [1/2]

◆ Equals() [2/2]

Property Documentation

◆ LowWatermark

◆ HighWatermark

◆ HeartbeatPeriod

◆ FastHeartbeatPeriod

◆ LateJoinerHeartbeatPeriod

◆ VirtualHeartbeatPeriod

◆ SamplesPerVirtualHeartbeat

◆ MaxHeartbeatRetries

◆ InactivateNonprogressingReaders

◆ HeartbeatsPerMaxSamples

◆ MinNackResponseDelay

◆ MaxNackResponseDelay

◆ NackSuppressionDuration

◆ MaxBytesPerNackResponse

◆ DisablePositiveAcksMinSampleKeepDuration

◆ DisablePositiveAcksMaxSampleKeepDuration

◆ DisablePositiveAcksEnableAdaptiveSampleKeepDuration

◆ DisablePositiveAcksDecreaseSampleKeepDurationFactor

◆ DisablePositiveAcksIncreaseSampleKeepDurationFactor

◆ MinSendWindowSize

◆ MaxSendWindowSize

◆ SendWindowUpdatePeriod

◆ SendWindowIncreaseFactor

◆ SendWindowDecreaseFactor

◆ EnableMulticastPeriodicHeartbeat

◆ MulticastResendThreshold

◆ DisableRepairPiggybackHeartbeat

◆ Default