TransportMulticastSettings Class Reference

Represents a list of multicast locators. More...

Inherits IEquatable< TransportMulticastSettings >.

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

Properties
ImmutableList< string >	Transports [get]
	A sequence of transport aliases that specifies the transports on which to receive multicast traffic for the entity. More...
string	ReceiveAddress [get]
	The multicast group address on which the entity can receive data. More...
int	ReceivePort [get]
	The multicast port on which the entity can receive data. More...
static TransportMulticastSettings	Default [get]
	Singleton containing the default value of a TransportMulticastSettings More...

Detailed Description

Represents a list of multicast locators.

The full documentation is available in the C API: DDS_TransportMulticastSettings_t

Member Function Documentation

Equals() [1/2]

override bool Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Equals

(

TransportMulticastSettings

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

TransportMulticastSettings With

(

Action< TransportMulticastSettingsBuilder >

build

)

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

Returns

A new TransportMulticastSettings with the changes applied by the Action

Property Documentation

Default

TransportMulticastSettings Default

staticget

Singleton containing the default value of a TransportMulticastSettings

ReceiveAddress

string ReceiveAddress

get

The multicast group address on which the entity can receive data.

The full documentation is available in the C API: DDS_TransportMulticastSettings_t::receive_address

ReceivePort

int ReceivePort

get

The multicast port on which the entity can receive data.

The full documentation is available in the C API: DDS_TransportMulticastSettings_t::receive_port

Transports

ImmutableList<string> Transports

get

A sequence of transport aliases that specifies the transports on which to receive multicast traffic for the entity.

The full documentation is available in the C API: DDS_TransportMulticastSettings_t::transports