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

Maps topics to multicast addresses More...

Inherits IEquatable< MulticastMapping >.

Public Member Functions

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

Properties

string Addresses [get]
 A string containing a comma-separated list of IP addresses or IP address ranges to be used to receive multicast traffic for the entity with a topic that matches the TopicExpression. More...
 
string TopicExpression [get]
 A regular expression that will be used to map topic names to corresponding multicast receive addresses. More...
 
MulticastMappingFunction MappingFunction [get]
 Specifies a function that will define the mapping between a topic name and a specific multicast address from a list of addresses. More...
 
static MulticastMapping Default = CreateDefault() [get]
 Singleton containing the default value of a TransportMulticastMapping More...
 

Detailed Description

Maps topics to multicast addresses

Member Function Documentation

◆ With()

MulticastMapping Rti.Dds.Core.Policy.MulticastMapping.With ( Action< MulticastMappingBuilder build)
inline

Creates a new TransportMulticastMapping 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 TransportMulticastMapping.
Returns
A new TransportMulticastMapping with the changes applied by the Action

◆ GetHashCode()

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

Gets the hash code

◆ Equals() [1/2]

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

Compares for equality

◆ Equals() [2/2]

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

Compares for equality

Property Documentation

◆ Addresses

string Rti.Dds.Core.Policy.MulticastMapping.Addresses
get

A string containing a comma-separated list of IP addresses or IP address ranges to be used to receive multicast traffic for the entity with a topic that matches the TopicExpression.

The full documentation is available in the C API: DDS_TransportMulticastMapping_t_addresses

◆ TopicExpression

string Rti.Dds.Core.Policy.MulticastMapping.TopicExpression
get

A regular expression that will be used to map topic names to corresponding multicast receive addresses.

The full documentation is available in the C API: DDS_TransportMulticastMapping_t_topic_expression

◆ MappingFunction

MulticastMappingFunction Rti.Dds.Core.Policy.MulticastMapping.MappingFunction
get

Specifies a function that will define the mapping between a topic name and a specific multicast address from a list of addresses.

The full documentation is available in the C API: DDS_TransportMulticastMapping_t_mapping_function

◆ Default

MulticastMapping Rti.Dds.Core.Policy.MulticastMapping.Default = CreateDefault()
staticget

Singleton containing the default value of a TransportMulticastMapping