A modifiable type used to create an immutable RtpsReliableWriterProtocol More...

Public Member Functions
	RtpsReliableWriterProtocolBuilder (RtpsReliableWriterProtocol data)
	Creates a builder with the values of an existing immutable instance More...

RtpsReliableWriterProtocol	Build ()
	Creates a new RtpsReliableWriterProtocol immutable object from this one. More...

Properties
int	LowWatermark `[get, set]`
	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, set]`
	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, set]`
	The period at which to send heartbeats. More...

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

Duration	LateJoinerHeartbeatPeriod `[get, set]`
	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, set]`
	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, set]`
	The number of samples that a reliable writer has to publish before sending a virtual heartbeat. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

A modifiable type used to create an immutable RtpsReliableWriterProtocol

Constructor & Destructor Documentation

◆ RtpsReliableWriterProtocolBuilder()

RtpsReliableWriterProtocolBuilder ( RtpsReliableWriterProtocol data )

Creates a builder with the values of an existing immutable instance

Member Function Documentation

◆ Build()

RtpsReliableWriterProtocol Build ( )

Creates a new RtpsReliableWriterProtocol immutable object from this one.

Property Documentation

◆ DisablePositiveAcksDecreaseSampleKeepDurationFactor

int DisablePositiveAcksDecreaseSampleKeepDurationFactor

getset

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

◆ DisablePositiveAcksEnableAdaptiveSampleKeepDuration

bool DisablePositiveAcksEnableAdaptiveSampleKeepDuration

getset

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

◆ DisablePositiveAcksIncreaseSampleKeepDurationFactor

int DisablePositiveAcksIncreaseSampleKeepDurationFactor

getset

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

◆ DisablePositiveAcksMaxSampleKeepDuration

Duration DisablePositiveAcksMaxSampleKeepDuration

getset

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

◆ DisablePositiveAcksMinSampleKeepDuration

Duration DisablePositiveAcksMinSampleKeepDuration

getset

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

◆ DisableRepairPiggybackHeartbeat

bool DisableRepairPiggybackHeartbeat

getset

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

◆ EnableMulticastPeriodicHeartbeat

bool EnableMulticastPeriodicHeartbeat

getset

Whether periodic heartbeat messages are sent over multicast

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t::enable_multicast_periodic_heartbeat

◆ FastHeartbeatPeriod

Duration FastHeartbeatPeriod

getset

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

◆ HeartbeatPeriod

Duration HeartbeatPeriod

getset

The period at which to send heartbeats.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t::heartbeat_period

◆ HeartbeatsPerMaxSamples

int HeartbeatsPerMaxSamples

getset

The number of heartbeats per current send window.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t::heartbeats_per_max_samples

◆ HighWatermark

int HighWatermark

getset

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

◆ InactivateNonprogressingReaders

bool InactivateNonprogressingReaders

getset

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

◆ LateJoinerHeartbeatPeriod

Duration LateJoinerHeartbeatPeriod

getset

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

◆ LowWatermark

int LowWatermark

getset

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

◆ MaxBytesPerNackResponse

int MaxBytesPerNackResponse

getset

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

◆ MaxHeartbeatRetries

int MaxHeartbeatRetries

getset

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

◆ MaxNackResponseDelay

Duration MaxNackResponseDelay

getset

The maximum delay to respond to a nack.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t::max_nack_response_delay

◆ MaxSendWindowSize

int MaxSendWindowSize

getset

Maximum size of send window of unacknowledged samples

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t::max_send_window_size

◆ MinNackResponseDelay

Duration MinNackResponseDelay

getset

The minimum delay to respond to a NACK.

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t::min_nack_response_delay

◆ MinSendWindowSize

int MinSendWindowSize

getset

Minimum size of send window of unacknowledged samples

The full documentation is available in the C API: DDS_RtpsReliableWriterProtocol_t::min_send_window_size

◆ MulticastResendThreshold

int MulticastResendThreshold

getset

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

◆ NackSuppressionDuration

Duration NackSuppressionDuration

getset

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

◆ SamplesPerVirtualHeartbeat

int SamplesPerVirtualHeartbeat

getset

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

◆ SendWindowDecreaseFactor

int SendWindowDecreaseFactor

getset

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

◆ SendWindowIncreaseFactor

int SendWindowIncreaseFactor

getset

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

◆ SendWindowUpdatePeriod

Duration SendWindowUpdatePeriod

getset

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

◆ VirtualHeartbeatPeriod

Duration VirtualHeartbeatPeriod

getset

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RtpsReliableWriterProtocolBuilder()

Member Function Documentation

◆ Build()

Property Documentation

◆ DisablePositiveAcksDecreaseSampleKeepDurationFactor

◆ DisablePositiveAcksEnableAdaptiveSampleKeepDuration

◆ DisablePositiveAcksIncreaseSampleKeepDurationFactor

◆ DisablePositiveAcksMaxSampleKeepDuration

◆ DisablePositiveAcksMinSampleKeepDuration

◆ DisableRepairPiggybackHeartbeat

◆ EnableMulticastPeriodicHeartbeat

◆ FastHeartbeatPeriod

◆ HeartbeatPeriod

◆ HeartbeatsPerMaxSamples

◆ HighWatermark

◆ InactivateNonprogressingReaders

◆ LateJoinerHeartbeatPeriod

◆ LowWatermark

◆ MaxBytesPerNackResponse

◆ MaxHeartbeatRetries

◆ MaxNackResponseDelay

◆ MaxSendWindowSize

◆ MinNackResponseDelay

◆ MinSendWindowSize

◆ MulticastResendThreshold

◆ NackSuppressionDuration

◆ SamplesPerVirtualHeartbeat

◆ SendWindowDecreaseFactor

◆ SendWindowIncreaseFactor

◆ SendWindowUpdatePeriod

◆ VirtualHeartbeatPeriod