Specifies the wire-protocol-related attributes for a Domain.DomainParticipant More...

Inherits IEquatable< WireProtocol >.

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

Static Public Attributes
const uint	RtpsAutoId
	Indicates that DDS should choose an appropriate host, app, instance or object ID automatically. More...

Properties
int	ParticipantId `[get]`
	A value used to distinguish among different participants belonging to the same domain on the same host. More...

uint	RtpsHostId `[get]`
	The RTPS Host ID of the domain participant. More...

uint	RtpsAppId `[get]`
	The RTPS App ID of the domain participant. More...

uint	RtpsInstanceId `[get]`
	The RTPS Instance ID of the Domain.DomainParticipant. More...

RtpsWellKnownPorts	RtpsWellKnownPorts `[get]`
	Configures the RTPS well-known port mappings. More...

int	RtpsReservedPortMask `[get]`
	Specifies which well-known ports to reserve when enabling the participant. More...

WireProtocolAutoKind	RtpsAutoIdKind `[get]`
	Kind of auto mechanism used to calculate the GUID prefix. More...

bool	ComputeCrc `[get]`
	Adds RTPS CRC submessage to every message when this field is set to `true`. More...

bool	CheckCrc `[get]`
	Checks if the received RTPS message is valid by comparing the computed CRC with the received RTPS CRC submessage when this field is set to `true`. More...

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

Detailed Description

Specifies the wire-protocol-related attributes for a Domain.DomainParticipant

Member Function Documentation

◆ Equals() [1/2]

override bool Equals ( object other )

Compares for equality

◆ Equals() [2/2]

bool Equals ( WireProtocol other )

Compares for equality

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code

◆ With()

WireProtocol With ( Action< WireProtocolBuilder > build )

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

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

Member Data Documentation

◆ RtpsAutoId

const uint RtpsAutoId

static

Indicates that DDS should choose an appropriate host, app, instance or object ID automatically.

The full documentation is available in the C API: DDS_RTPS_AUTO_ID

Property Documentation

◆ CheckCrc

bool CheckCrc

get

Checks if the received RTPS message is valid by comparing the computed CRC with the received RTPS CRC submessage when this field is set to true.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy::check_crc

◆ ComputeCrc

bool ComputeCrc

get

Adds RTPS CRC submessage to every message when this field is set to true.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy::compute_crc

◆ Default

WireProtocol Default

staticget

Singleton containing the default value of a WireProtocol

◆ ParticipantId

int ParticipantId

get

A value used to distinguish among different participants belonging to the same domain on the same host.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy::participant_id

◆ RtpsAppId

uint RtpsAppId

get

The RTPS App ID of the domain participant.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy::rtps_app_id

◆ RtpsAutoIdKind

WireProtocolAutoKind RtpsAutoIdKind

get

Kind of auto mechanism used to calculate the GUID prefix.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy::rtps_auto_id_kind

◆ RtpsHostId

uint RtpsHostId

get

The RTPS Host ID of the domain participant.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy::rtps_host_id

◆ RtpsInstanceId

uint RtpsInstanceId

get

The RTPS Instance ID of the Domain.DomainParticipant.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy::rtps_instance_id

◆ RtpsReservedPortMask

int RtpsReservedPortMask

get

Specifies which well-known ports to reserve when enabling the participant.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy::rtps_reserved_port_mask

◆ RtpsWellKnownPorts

RtpsWellKnownPorts RtpsWellKnownPorts

get

Configures the RTPS well-known port mappings.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy::rtps_well_known_ports

Public Member Functions

Static Public Attributes

Properties