RTI Connext Modern C++ API Version 7.6.0
rti::core::policy::MulticastMapping Class Reference

<<extension>> Type representing a list of multicast mapping elements. More...

#include <CorePolicy.hpp>

Inherits rti::core::NativeValueType< T, NATIVE_T, ADAPTER >.

Public Member Functions

MulticastMappingaddresses (const std::string &the_addresses)
 <<extension>> 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 rti::core::policy::MulticastMapping::topic_expression. More...
 
rti::core::optional_value< std::string > addresses () const
 Getter (see setter with the same name) More...
 
MulticastMappingtopic_expression (const std::string &the_topic_expression)
 <<extension>> A regular expression that will be used to map topic names to corresponding multicast receive addresses. More...
 
rti::core::optional_value< std::string > topic_expression () const
 Getter (see setter with the same name) More...
 
MulticastMappingmapping_function (const TransportMulticastMappingFunction &the_mappings)
 <<extension>> Specifies a function that will define the mapping between a topic name and a specific multicast address from a list of addresses. More...
 
const TransportMulticastMappingFunction & mapping_function () const
 Getter (see setter with the same name) More...
 

Detailed Description

<<extension>> Type representing a list of multicast mapping elements.

A multicast mapping element specifies a string containing a list of IP addresses, a topic expression and a mapping function.

QoS:
rti::core::policy::TransportMulticastMapping

Member Function Documentation

◆ addresses() [1/2]

MulticastMapping & rti::core::policy::MulticastMapping::addresses ( const std::string &  the_addresses)

<<extension>> 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 rti::core::policy::MulticastMapping::topic_expression.

The string must contain IPv4 or IPv6 addresses separated by commas. For example: "239.255.100.1,239.255.100.2,239.255.100.3"

You may specify ranges of addresses by enclosing the start address and the end address in square brackets. For example: "[239.255.100.1,239.255.100.3]"

You may combine the two approaches. For example:

"239.255.200.1,[239.255.100.1,239.255.100.3], 239.255.200.3"

IPv4 addresses must be specified in Dot-decimal notation.

IPv6 addresses must be specified using 8 groups of 16-bit hexadecimal values separated by colons. For example: FF00:0000:0000:0000:0202:B3FF:FE1E:8329

Leading zeroes can be skipped. For example: "FF00:0:0:0:202:B3FF:FE1E:8329"

You may replace a consecutive number of zeroes with a double colon, but only once within an address. For example: "FF00::202:B3FF:FE1E:8329"

[default] NULL

◆ addresses() [2/2]

rti::core::optional_value< std::string > rti::core::policy::MulticastMapping::addresses ( ) const

Getter (see setter with the same name)

◆ topic_expression() [1/2]

MulticastMapping & rti::core::policy::MulticastMapping::topic_expression ( const std::string &  the_topic_expression)

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

A topic name must match the expression before a corresponding address is assigned.

[default] NULL

◆ topic_expression() [2/2]

rti::core::optional_value< std::string > rti::core::policy::MulticastMapping::topic_expression ( ) const

Getter (see setter with the same name)

◆ mapping_function() [1/2]

MulticastMapping & rti::core::policy::MulticastMapping::mapping_function ( const TransportMulticastMappingFunction &  the_mappings)

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

This function is optional. If not specified, the middleware will use a hash function to perform the mapping.

◆ mapping_function() [2/2]

const TransportMulticastMappingFunction & rti::core::policy::MulticastMapping::mapping_function ( ) const

Getter (see setter with the same name)