Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder Class Reference

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()

Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.RtpsReliableWriterProtocolBuilder ( RtpsReliableWriterProtocol  data )

inline

Creates a builder with the values of an existing immutable instance

Member Function Documentation

Build()

RtpsReliableWriterProtocol Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.Build

(

)

Creates a new RtpsReliableWriterProtocol immutable object from this one.

Property Documentation

LowWatermark

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

HighWatermark

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

HeartbeatPeriod

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.HeartbeatPeriod

getset

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.RtpsReliableWriterProtocolBuilder.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

LateJoinerHeartbeatPeriod

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

VirtualHeartbeatPeriod

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

SamplesPerVirtualHeartbeat

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

MaxHeartbeatRetries

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

InactivateNonprogressingReaders

bool Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

HeartbeatsPerMaxSamples

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

MinNackResponseDelay

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

MaxNackResponseDelay

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

NackSuppressionDuration

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

MaxBytesPerNackResponse

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

DisablePositiveAcksMinSampleKeepDuration

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

DisablePositiveAcksMaxSampleKeepDuration

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

DisablePositiveAcksEnableAdaptiveSampleKeepDuration

bool Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

DisablePositiveAcksDecreaseSampleKeepDurationFactor

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

DisablePositiveAcksIncreaseSampleKeepDurationFactor

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

MinSendWindowSize

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

MaxSendWindowSize

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

SendWindowUpdatePeriod

Duration Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

SendWindowIncreaseFactor

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

SendWindowDecreaseFactor

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

EnableMulticastPeriodicHeartbeat

bool Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

MulticastResendThreshold

int Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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

DisableRepairPiggybackHeartbeat

bool Rti.Dds.Core.Policy.RtpsReliableWriterProtocolBuilder.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