ChannelSettings Class Reference

Configures the properties of a channel in MultiChannel. More...

Inherits IEquatable< ChannelSettings >.

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

Properties
ImmutableList< TransportMulticastSettings >	MulticastSettings [get]
	A sequence of TransportMulticastSettings used to configure the multicast addresses associated with a channel. More...
string	FilterExpression [get]
	A logical expression used to determine the data that will be published in the channel. More...
int	Priority [get]
	Publication priority More...
static ChannelSettings	Default [get]
	Singleton containing the default value of a ChannelSettings More...

Detailed Description

Configures the properties of a channel in MultiChannel.

The full documentation is available in the C API: DDS_ChannelSettings_t

Member Function Documentation

Equals() [1/2]

bool Equals

(

ChannelSettings

other

)

Compares for equality

Equals() [2/2]

override bool Equals

(

object

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

ChannelSettings With

(

Action< ChannelSettingsBuilder >

build

)

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

Returns

A new ChannelSettings with the changes applied by the Action

Property Documentation

Default

ChannelSettings Default

staticget

Singleton containing the default value of a ChannelSettings

FilterExpression

string FilterExpression

get

A logical expression used to determine the data that will be published in the channel.

The full documentation is available in the C API: DDS_ChannelSettings_t::filter_expression

MulticastSettings

ImmutableList<TransportMulticastSettings> MulticastSettings

get

A sequence of TransportMulticastSettings used to configure the multicast addresses associated with a channel.

The full documentation is available in the C API: DDS_ChannelSettings_t::multicast_settings

Priority

int Priority

get

Publication priority

See also

Rti.Dds.Core.Priority for special values

The full documentation is available in the C API: DDS_ChannelSettings_t::priority