rti::core::TransportMulticastSettings Class Reference

<<extension>> Represents a list of multicast locators More...

#include <rti/core/policy/CorePolicy.hpp>

Public Member Functions
	TransportMulticastSettings (const dds::core::StringSeq &the_transports, const std::string &the_receive_address, int32_t the_receive_port)
	Creates an instance with the specified transport aliases, receive address and receive port.
TransportMulticastSettings &	transports (const dds::core::StringSeq &the_transports)
	A sequence of transport aliases that specifies the transports on which to receive multicast traffic for the entity.
dds::core::StringSeq	transports () const
	Getter (see the setter with the same name)
TransportMulticastSettings &	receive_address (const std::string &the_receive_address)
	The multicast group address on which the entity can receive data.
std::string	receive_address () const
	Getter (see the setter with the same name)
TransportMulticastSettings &	receive_port (int32_t the_receive_port)
	The multicast port on which the entity can receive data.
int32_t	receive_port () const
	Getter (see the setter with the same name)

Detailed Description

<<extension>> Represents a list of multicast locators

A multicast locator specifies a transport class, a multicast address, and a multicast port number on which messages can be received by an entity.

QoS:

rti::core::policy::TransportMulticast

Constructor & Destructor Documentation

rti::core::TransportMulticastSettings::TransportMulticastSettings ( const dds::core::StringSeq &  the_transports, const std::string &  the_receive_address, int32_t  the_receive_port  )

inline

Creates an instance with the specified transport aliases, receive address and receive port.

See individual setters.

Member Function Documentation

TransportMulticastSettings& rti::core::TransportMulticastSettings::transports ( const dds::core::StringSeq &  the_transports )

inline

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

Of the transport instances available to the entity, only those with aliases matching an alias in this sequence are used to subscribe to the multicast group addresses. Thus, this list of aliases sub-selects from the transport s available to the entity.

An empty sequence is a special value that specifies all the transports available to the entity.

Alias names for the builtin transports are defined in TRANSPORT_BUILTIN.

[default] Empty sequence; i.e. all the transports available to the entity.

[range] Any sequence of non-null, non-empty strings.

dds::core::StringSeq rti::core::TransportMulticastSettings::transports ( ) const

inline

Getter (see the setter with the same name)

TransportMulticastSettings& rti::core::TransportMulticastSettings::receive_address

(

const std::string &

the_receive_address

)

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

Must must be an address in the proper format (see Address Format).

[default] NONE/INVALID. Required to specify a multicast group address to join.

[range] A valid IPv4 or IPv6 multicast address.

See Also

Address Format

std::string rti::core::TransportMulticastSettings::receive_address ( ) const

inline

Getter (see the setter with the same name)

TransportMulticastSettings& rti::core::TransportMulticastSettings::receive_port ( int32_t  the_receive_port )

inline

The multicast port on which the entity can receive data.

[default] 0, which implies that the actual port number is determined by a formula as a function of the domain_id (see rti::core::policy::WireProtocol::participant_id).

[range] [0,0xffffffff]

int32_t rti::core::TransportMulticastSettings::receive_port ( ) const

inline

Getter (see the setter with the same name)