DataWriterProtocol Class Reference

Configures DDS on-the-wire protocol (RTPS). More...

Inherits IEquatable< DataWriterProtocol >.

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

Properties
Guid	VirtualGuid [get]
	The virtual GUID (Global Unique Identifier). More...
uint	RtpsObjectId [get]
	The RTPS Object ID. More...
bool	PushOnWrite [get]
	Whether to push sample out when write is called. More...
bool	DisablePositiveAcks [get]
	Controls whether or not the writer expects positive acknowledgements from matching readers. More...
bool	DisableInlineKeyhash [get]
	Controls whether or not a keyhash is propagated on the wire with each sample. More...
bool	SerializeKeyWithDispose [get]
	Controls whether or not the serialized key is propagated on the wire with dispose samples. More...
bool	PropagateAppAckWithNoResponse [get]
	Controls whether or not a Publication.DataWriter<T> receives Publication.AnyDataWriter.ApplicationAcknowledgementReceived notifications with an empty or invalid response. More...
RtpsReliableWriterProtocol	RtpsReliableWriter [get]
	RTPS protocol-related configuration settings for the RTPS reliable writer associated with a Publication.DataWriter<T> . This parameter only has effect if both the writer and the matching reader are configured with Reliability Reliability.Kind. More...
long	InitialVirtualSequenceNumber [get]
	Determines, the initial virtual sequence number for this DataWriter. More...
static DataWriterProtocol	Default [get]
	Singleton containing the default value of a DataWriterProtocol More...

Detailed Description

Configures DDS on-the-wire protocol (RTPS).

The full documentation is available in the C API: DDS_DataWriterProtocolQosPolicy

Member Function Documentation

Equals() [1/2]

bool Equals

(

DataWriterProtocol

other

)

Compares for equality

Equals() [2/2]

override bool Equals

(

object

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

DataWriterProtocol With

(

Action< DataWriterProtocolBuilder >

build

)

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

Returns

A new DataWriterProtocol with the changes applied by the Action

Property Documentation

Default

DataWriterProtocol Default

staticget

Singleton containing the default value of a DataWriterProtocol

DisableInlineKeyhash

bool DisableInlineKeyhash

get

Controls whether or not a keyhash is propagated on the wire with each sample.

The full documentation is available in the C API: DDS_DataWriterProtocolQosPolicy::disable_inline_keyhash

DisablePositiveAcks

bool DisablePositiveAcks

get

Controls whether or not the writer expects positive acknowledgements from matching readers.

The full documentation is available in the C API: DDS_DataWriterProtocolQosPolicy::disable_positive_acks

InitialVirtualSequenceNumber

long InitialVirtualSequenceNumber

get

Determines, the initial virtual sequence number for this DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolQosPolicy::initial_virtual_sequence_number

PropagateAppAckWithNoResponse

bool PropagateAppAckWithNoResponse

get

Controls whether or not a Publication.DataWriter<T> receives Publication.AnyDataWriter.ApplicationAcknowledgementReceived notifications with an empty or invalid response.

The full documentation is available in the C API: DDS_DataWriterProtocolQosPolicy::propagate_app_ack_with_no_response

PushOnWrite

bool PushOnWrite

get

Whether to push sample out when write is called.

The full documentation is available in the C API: DDS_DataWriterProtocolQosPolicy::push_on_write

RtpsObjectId

uint RtpsObjectId

get

The RTPS Object ID.

The full documentation is available in the C API: DDS_DataWriterProtocolQosPolicy::rtps_object_id

RtpsReliableWriter

RtpsReliableWriterProtocol RtpsReliableWriter

get

RTPS protocol-related configuration settings for the RTPS reliable writer associated with a Publication.DataWriter<T> . This parameter only has effect if both the writer and the matching reader are configured with Reliability Reliability.Kind.

The full documentation is available in the C API: DDS_DataWriterProtocolQosPolicy::rtps_reliable_writer

SerializeKeyWithDispose

bool SerializeKeyWithDispose

get

Controls whether or not the serialized key is propagated on the wire with dispose samples.

The full documentation is available in the C API: DDS_DataWriterProtocolQosPolicy::serialize_key_with_dispose

VirtualGuid

Guid VirtualGuid

get

The virtual GUID (Global Unique Identifier).

The full documentation is available in the C API: DDS_DataWriterProtocolQosPolicy::virtual_guid