Rti.Dds.Core.Policy.WireProtocol Class Reference

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 = 0
	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

With()

WireProtocol Rti.Dds.Core.Policy.WireProtocol.With ( Action< WireProtocolBuilder >  build )

inline

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

GetHashCode()

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

inline

Gets the hash code

Equals() [1/2]

override bool Rti.Dds.Core.Policy.WireProtocol.Equals

(

object

other

)

Compares for equality

Equals() [2/2]

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

inline

Compares for equality

Field Documentation

RtpsAutoId

const uint Rti.Dds.Core.Policy.WireProtocol.RtpsAutoId = 0

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_WireProtocolQosPolicy_RTPS_AUTO_ID

Property Documentation

ParticipantId

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

RtpsHostId

uint Rti.Dds.Core.Policy.WireProtocol.RtpsHostId

get

The RTPS Host ID of the domain participant.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy_rtps_host_id

RtpsAppId

uint Rti.Dds.Core.Policy.WireProtocol.RtpsAppId

get

The RTPS App ID of the domain participant.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy_rtps_app_id

RtpsInstanceId

uint Rti.Dds.Core.Policy.WireProtocol.RtpsInstanceId

get

The RTPS Instance ID of the Domain.DomainParticipant.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy_rtps_instance_id

RtpsWellKnownPorts

RtpsWellKnownPorts Rti.Dds.Core.Policy.WireProtocol.RtpsWellKnownPorts

get

Configures the RTPS well-known port mappings.

The full documentation is available in the C API: DDS_WireProtocolQosPolicy_rtps_well_known_ports

RtpsReservedPortMask

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

RtpsAutoIdKind

WireProtocolAutoKind Rti.Dds.Core.Policy.WireProtocol.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

ComputeCrc

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

CheckCrc

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

Default

WireProtocol Rti.Dds.Core.Policy.WireProtocol.Default

staticget

Singleton containing the default value of a WireProtocol