rti::core::TransportUnicastSettings Class Reference

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

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

Public Member Functions
	TransportUnicastSettings ()
	Creates the default policy.
	TransportUnicastSettings (const dds::core::StringSeq &transports, int32_t receive_port=0)
	Creates an instance with the specified transports and receive_port.
TransportUnicastSettings &	transports (const dds::core::StringSeq &value)
	Sets a sequence of transport aliases that specifies the unicast interfaces on which to receive unicast traffic for the entity.
dds::core::StringSeq	transports () const
	Getter (see setter with the same name)
TransportUnicastSettings &	receive_port (int32_t value)
	The unicast port on which the entity can receive data.
int32_t	receive_port () const
	Getter (see setter with the same name)

Detailed Description

<<extension>> Represents a list of unicast locators

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

QoS:

rti::core::policy::TransportUnicast

Constructor & Destructor Documentation

rti::core::TransportUnicastSettings::TransportUnicastSettings ( )

inline

Creates the default policy.

rti::core::TransportUnicastSettings::TransportUnicastSettings ( const dds::core::StringSeq &  transports, int32_t  receive_port = 0  )

explicit

Creates an instance with the specified transports and receive_port.

Member Function Documentation

TransportUnicastSettings& rti::core::TransportUnicastSettings::transports

(

const dds::core::StringSeq &

value

)

Sets a sequence of transport aliases that specifies the unicast interfaces on which to receive unicast traffic for the entity.

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

Of the transport instances available to the entity, only those with aliases matching an alias on this sequence are used to determine the unicast interfaces used by the entity.

Thus, this list of aliases sub-selects from the transports available to the entity.

Each unicast interface on a transport results in a unicast locator for 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::TransportUnicastSettings::transports

(

)

const

Getter (see setter with the same name)

TransportUnicastSettings& rti::core::TransportUnicastSettings::receive_port

(

int32_t

value

)

The unicast port on which the entity can receive data.

The unicast port on which the entity can receive data.

Must be an unused unicast port on the system.

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

[range] [0,0xffffffff]

See Also

rti::core::policy::WireProtocol::participant_id.

int32_t rti::core::TransportUnicastSettings::receive_port

(

)

const

Getter (see setter with the same name)