RtpsWellKnownPorts Class Reference

Configures the RTPS well-known ports mapping. More...

Inherits IEquatable< RtpsWellKnownPorts >.

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

Properties
static RtpsWellKnownPorts	RtiBackwardsCompatible [get]
	Well-known port mappings which are compatible with previous versions of the RTI Data Distribution Service middleware. More...
static RtpsWellKnownPorts	Interoperable [get]
	Well-known port mappings which are compliant with the standard DDS Interoperability Wire Protocol. More...
static RtpsWellKnownPorts	Default [get]
	Default RtpsWellKnownPorts, same as Interoperable. More...
int	PortBase [get]
	The base port offset. More...
int	DomainIdGain [get]
	Tunable domain gain parameter. More...
int	ParticipantIdGain [get]
	Tunable participant gain parameter. More...
int	BuiltinMulticastPortOffset [get]
	Additional offset for metatraffic multicast port. More...
int	BuiltinUnicastPortOffset [get]
	Additional offset for metatraffic unicast port. More...
int	UserMulticastPortOffset [get]
	Additional offset for usertraffic multicast port. More...
int	UserUnicastPortOffset [get]
	Additional offset for usertraffic unicast port. More...

Detailed Description

Configures the RTPS well-known ports mapping.

Member Function Documentation

Equals() [1/2]

override bool Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Equals

(

RtpsWellKnownPorts

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

RtpsWellKnownPorts With

(

Action< RtpsWellKnownPortsBuilder >

build

)

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

Returns

A new RtpsWellKnownPorts with the changes applied by the Action

Property Documentation

BuiltinMulticastPortOffset

int BuiltinMulticastPortOffset

get

Additional offset for metatraffic multicast port.

The full documentation is available in the C API: DDS_RtpsWellKnownPorts_t::builtin_multicast_port_offset

BuiltinUnicastPortOffset

int BuiltinUnicastPortOffset

get

Additional offset for metatraffic unicast port.

The full documentation is available in the C API: DDS_RtpsWellKnownPorts_t::builtin_unicast_port_offset

Default

RtpsWellKnownPorts Default

staticget

Default RtpsWellKnownPorts, same as Interoperable.

DomainIdGain

int DomainIdGain

get

Tunable domain gain parameter.

The full documentation is available in the C API: DDS_RtpsWellKnownPorts_t::domain_id_gain

Interoperable

RtpsWellKnownPorts Interoperable

staticget

Well-known port mappings which are compliant with the standard DDS Interoperability Wire Protocol.

The full documentation is available in the C API: DDS_INTEROPERABLE_RTPS_WELL_KNOWN_PORTS

ParticipantIdGain

int ParticipantIdGain

get

Tunable participant gain parameter.

The full documentation is available in the C API: DDS_RtpsWellKnownPorts_t::participant_id_gain

PortBase

int PortBase

get

The base port offset.

The full documentation is available in the C API: DDS_RtpsWellKnownPorts_t::port_base

RtiBackwardsCompatible

RtpsWellKnownPorts RtiBackwardsCompatible

staticget

Well-known port mappings which are compatible with previous versions of the RTI Data Distribution Service middleware.

The full documentation is available in the C API: DDS_RTI_BACKWARDS_COMPATIBLE_RTPS_WELL_KNOWN_PORTS

UserMulticastPortOffset

int UserMulticastPortOffset

get

Additional offset for usertraffic multicast port.

The full documentation is available in the C API: DDS_RtpsWellKnownPorts_t::user_multicast_port_offset

UserUnicastPortOffset

int UserUnicastPortOffset

get

Additional offset for usertraffic unicast port.

The full documentation is available in the C API: DDS_RtpsWellKnownPorts_t::user_unicast_port_offset