WireProtocolBuilder Class Reference

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

Public Member Functions
	WireProtocolBuilder (WireProtocol data)
	Creates a builder with the values of an existing immutable instance More...
WireProtocol	Build ()
	Creates a new WireProtocol immutable object from this one. More...

Properties
int	ParticipantId [get, set]
	A value used to distinguish among different participants belonging to the same domain on the same host. More...
uint	RtpsHostId [get, set]
	The RTPS Host ID of the domain participant. More...
uint	RtpsAppId [get, set]
	The RTPS App ID of the domain participant. More...
uint	RtpsInstanceId [get, set]
	The RTPS Instance ID of the Domain.DomainParticipant. More...
RtpsWellKnownPorts	RtpsWellKnownPorts [get, set]
	Configures the RTPS well-known port mappings. More...
int	RtpsReservedPortMask [get, set]
	Specifies which well-known ports to reserve when enabling the participant. More...
WireProtocolAutoKind	RtpsAutoIdKind [get, set]
	Kind of auto mechanism used to calculate the GUID prefix. More...
bool	ComputeCrc [get, set]
	Adds RTPS CRC submessage to every message when this field is set to true. More...
bool	CheckCrc [get, set]
	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...

Detailed Description

A modifiable type used to create an immutable WireProtocol

Constructor & Destructor Documentation

WireProtocolBuilder()

WireProtocolBuilder

(

WireProtocol

data

)

Creates a builder with the values of an existing immutable instance

Member Function Documentation

Build()

WireProtocol Build

(

)

Creates a new WireProtocol immutable object from this one.

Property Documentation

CheckCrc

bool CheckCrc

getset

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

getset

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

ParticipantId

int ParticipantId

getset

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

getset

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

getset

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

getset

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

getset

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

getset

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

getset

Configures the RTPS well-known port mappings.

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