rti::core::policy::TransportBuiltin Class Reference

<<extension>> Specifies which built-in transports to use More...

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

Public Member Functions
	TransportBuiltin ()
	Creates the default policy. More...
	TransportBuiltin (const rti::core::policy::TransportBuiltinMask &the_mask)
	Creates an instnace with the transport selection that the mask specifies. More...
TransportBuiltin &	mask (rti::core::policy::TransportBuiltinMask the_mask)
	Set the selected transports through a mask. More...
rti::core::policy::TransportBuiltinMask	mask () const
	Get the mask that indicates which transports are selected. More...

Static Public Member Functions
static TransportBuiltin	All ()
	Creates a policy that selects TransportBuiltinMask::all() More...
static TransportBuiltin	None ()
	Creates a policy that selects TransportBuiltinMask::none() More...
static TransportBuiltin	Shmem ()
	Creates a policy that selects TransportBuiltinMask::shmem() More...
static TransportBuiltin	UDPv4 ()
	Creates a policy that selects TransportBuiltinMask::udpv4() More...
static TransportBuiltin	UDPv6 ()
	Creates a policy that selects TransportBuiltinMask::udpv6() More...
static TransportBuiltin	UDPv4_WAN ()
	Creates a policy that selects TransportBuiltinMask::udpv4_wan() More...

Static Public Attributes
static const std::string	SHMEM_ALIAS
	Alias name for the shared-memory built-in transport: "builtin.shmem". More...
static const std::string	UDPv4_ALIAS
	Alias name for the UDPv4 built-in transport: "builtin.udpv4". More...
static const std::string	UDPv4_WAN_ALIAS
	Alias name for the UDPv4 asymmetric built-in transport: "builtin.udpv4_wan". More...
static const std::string	UDPv6_ALIAS
	Alias name for the UDPv6 built-in transport: "builtin.udpv6". More...

Detailed Description

<<extension>> Specifies which built-in transports to use

Three different transport plug-ins are built into the core RTI Connext libraries (for most supported target platforms): UDPv4, shared memory, and UDPv6.

This QoS policy allows you to control which of these built-in transport plug-ins are used by a dds::domain::DomainParticipant. By default, only the UDPv4 and shared memory plug-ins are enabled (although on some embedded platforms, the shared memory plug-in is not available). In some cases, users will disable the shared memory transport when they do not want applications to use shared memory to communicate when running on the same node.

Entity:

dds::domain::DomainParticipant

Properties:

RxO = N/A
Changeable = NO

Constructor & Destructor Documentation

TransportBuiltin() [1/2]

rti::core::policy::TransportBuiltin::TransportBuiltin ( )

inline

Creates the default policy.

TransportBuiltin() [2/2]

rti::core::policy::TransportBuiltin::TransportBuiltin ( const rti::core::policy::TransportBuiltinMask &  the_mask )

inline

Creates an instnace with the transport selection that the mask specifies.

Member Function Documentation

All()

static TransportBuiltin rti::core::policy::TransportBuiltin::All ( )

inlinestatic

Creates a policy that selects TransportBuiltinMask::all()

None()

static TransportBuiltin rti::core::policy::TransportBuiltin::None ( )

inlinestatic

Creates a policy that selects TransportBuiltinMask::none()

Shmem()

static TransportBuiltin rti::core::policy::TransportBuiltin::Shmem ( )

inlinestatic

Creates a policy that selects TransportBuiltinMask::shmem()

UDPv4()

static TransportBuiltin rti::core::policy::TransportBuiltin::UDPv4 ( )

inlinestatic

Creates a policy that selects TransportBuiltinMask::udpv4()

UDPv6()

static TransportBuiltin rti::core::policy::TransportBuiltin::UDPv6 ( )

inlinestatic

Creates a policy that selects TransportBuiltinMask::udpv6()

UDPv4_WAN()

static TransportBuiltin rti::core::policy::TransportBuiltin::UDPv4_WAN ( )

inlinestatic

Creates a policy that selects TransportBuiltinMask::udpv4_wan()

mask() [1/2]

TransportBuiltin& rti::core::policy::TransportBuiltin::mask

(

rti::core::policy::TransportBuiltinMask

the_mask

)

Set the selected transports through a mask.

mask() [2/2]

rti::core::policy::TransportBuiltinMask rti::core::policy::TransportBuiltin::mask

(

)

const

Get the mask that indicates which transports are selected.

Member Data Documentation

SHMEM_ALIAS

const std::string rti::core::policy::TransportBuiltin::SHMEM_ALIAS

static

Alias name for the shared-memory built-in transport: "builtin.shmem".

UDPv4_ALIAS

const std::string rti::core::policy::TransportBuiltin::UDPv4_ALIAS

static

Alias name for the UDPv4 built-in transport: "builtin.udpv4".

UDPv4_WAN_ALIAS

const std::string rti::core::policy::TransportBuiltin::UDPv4_WAN_ALIAS

static

Alias name for the UDPv4 asymmetric built-in transport: "builtin.udpv4_wan".

UDPv6_ALIAS

const std::string rti::core::policy::TransportBuiltin::UDPv6_ALIAS

static

Alias name for the UDPv6 built-in transport: "builtin.udpv6".