TransportInfo Class Reference

Contains the class id and message max size of an installed transport. More...

Inherits IEquatable< TransportInfo >.

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

Properties
TransportClassId	ClassId [get]
	The class_id identifies the transport associated with the message_size_max. More...
int	MessageSizeMax [get]
	The maximum size of an RTPS message in bytes that can be sent or received by the transport plugin identified by the class_id. More...
static TransportInfo	Default [get]
	Singleton containing the default value of a TransportInfo More...

Detailed Description

Contains the class id and message max size of an installed transport.

The full documentation is available in the C API: DDS_TransportInfo_t

Member Function Documentation

Equals() [1/2]

override bool Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Equals

(

TransportInfo

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

TransportInfo With

(

Action< TransportInfoBuilder >

build

)

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

Returns

A new TransportInfo with the changes applied by the Action

Property Documentation

ClassId

TransportClassId ClassId

get

The class_id identifies the transport associated with the message_size_max.

The full documentation is available in the C API: DDS_TransportInfo_t::class_id

Default

TransportInfo Default

staticget

Singleton containing the default value of a TransportInfo

MessageSizeMax

int MessageSizeMax

get

The maximum size of an RTPS message in bytes that can be sent or received by the transport plugin identified by the class_id.

The full documentation is available in the C API: DDS_TransportInfo_t::message_size_max