RTI Connext C# API Version 7.2.0
Rti.Dds.Core.Policy.TransportMulticast Class Reference

Specifies the multicast address on which a Subscription.DataReader<T> wants to receive its data. It can also specify a port number as well as a subset of the available (at the Domain.DomainParticipant level) transports with which to receive the multicast data. More...

Inherits IEquatable< TransportMulticast >.

Public Member Functions

TransportMulticast With (Action< TransportMulticastBuilder > build)
 Creates a new TransportMulticast 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 (TransportMulticast other)
 Compares for equality More...
 

Properties

ImmutableList< TransportMulticastSettingsValue [get]
 A sequence of multicast communications TransportMulticastSettings. More...
 
TransportMulticastKind Kind [get]
 A value that specifies a way to determine how to obtain the multicast address. More...
 
static TransportMulticast Default [get]
 Singleton containing the default value of a TransportMulticast More...
 

Detailed Description

Specifies the multicast address on which a Subscription.DataReader<T> wants to receive its data. It can also specify a port number as well as a subset of the available (at the Domain.DomainParticipant level) transports with which to receive the multicast data.

The full documentation is available in the C API: DDS_TransportMulticastQosPolicy

Member Function Documentation

◆ With()

TransportMulticast Rti.Dds.Core.Policy.TransportMulticast.With ( Action< TransportMulticastBuilder build)
inline

Creates a new TransportMulticast with a set of changes specified in an Action

Parameters
buildAn Action (typically a lambda function) that receives a modifiable object with the current values of this TransportMulticast.
Returns
A new TransportMulticast with the changes applied by the Action

◆ GetHashCode()

override int Rti.Dds.Core.Policy.TransportMulticast.GetHashCode ( )
inline

Gets the hash code

◆ Equals() [1/2]

override bool Rti.Dds.Core.Policy.TransportMulticast.Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Rti.Dds.Core.Policy.TransportMulticast.Equals ( TransportMulticast  other)
inline

Compares for equality

Property Documentation

◆ Value

ImmutableList<TransportMulticastSettings> Rti.Dds.Core.Policy.TransportMulticast.Value
get

A sequence of multicast communications TransportMulticastSettings.

The full documentation is available in the C API: DDS_TransportMulticastQosPolicy_value

◆ Kind

TransportMulticastKind Rti.Dds.Core.Policy.TransportMulticast.Kind
get

A value that specifies a way to determine how to obtain the multicast address.

The full documentation is available in the C API: DDS_TransportMulticastQosPolicy_kind

◆ Default

TransportMulticast Rti.Dds.Core.Policy.TransportMulticast.Default
staticget

Singleton containing the default value of a TransportMulticast