RTI Connext Modern C++ API  Version 5.2.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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.
 
 TransportBuiltin (const rti::core::policy::TransportBuiltinMask &the_mask)
 Creates an instnace with the transport selection that the mask specifies.
 
TransportBuiltinmask (rti::core::policy::TransportBuiltinMask the_mask)
 Set the selected transports through a mask.
 
rti::core::policy::TransportBuiltinMask mask () const
 Get the mask that indicates which transports are selected.
 

Static Public Member Functions

static TransportBuiltin All ()
 Creates a policy that selects TransportBuiltinMask::all()
 
static TransportBuiltin None ()
 Creates a policy that selects TransportBuiltinMask::none()
 
static TransportBuiltin Shmem ()
 Creates a policy that selects TransportBuiltinMask::shmem()
 
static TransportBuiltin UDPv4 ()
 Creates a policy that selects TransportBuiltinMask::udpv4()
 
static TransportBuiltin UDPv6 ()
 Creates a policy that selects TransportBuiltinMask::udpv6()
 

Static Public Attributes

static const std::string SHMEM_ALIAS
 Alias name for the shared-memory built-in transport.
 
static const std::string UDPv4_ALIAS
 Alias name for the UDPv4 built-in transport.
 
static const std::string UDPv6_ALIAS
 Alias name for the UDPv6 built-in transport.
 

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.

Note: If one application is configured to use UDPv4 and shared memory, while another application is only configured for UDPv4, and these two applications run on the same node, they will not communicate. This is due to an internal optimization which will default to use shared memory instead of loopback. However if the other peer application does not enable shared memory there is no common transport, therefore they will not communicate.

Entity:
dds::domain::DomainParticipant
Properties:
RxO = N/A
Changeable = NO

Constructor & Destructor Documentation

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

Creates the default policy.

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

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

Creates a policy that selects TransportBuiltinMask::all()

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

Creates a policy that selects TransportBuiltinMask::none()

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

Creates a policy that selects TransportBuiltinMask::shmem()

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

Creates a policy that selects TransportBuiltinMask::udpv4()

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

Creates a policy that selects TransportBuiltinMask::udpv6()

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

Set the selected transports through a mask.

rti::core::policy::TransportBuiltinMask rti::core::policy::TransportBuiltin::mask ( ) const

Get the mask that indicates which transports are selected.

Member Data Documentation

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

Alias name for the shared-memory built-in transport.

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

Alias name for the UDPv4 built-in transport.

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

Alias name for the UDPv6 built-in transport.


RTI Connext Modern C++ API Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc