RTI Connext Modern C++ API  Version 5.3.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::core Namespace Reference

<<extension>> Extensions to dds::core More...

Namespaces

namespace  builtin_profiles
 <<extension>> Contains the names of the built-in profiles
 
namespace  xtypes
 <<extension>> Extensions to dds::core::xtypes
 

Classes

class  AllocationSettings
 <<extension>> Resource allocation settings More...
 
class  bounded_sequence
 <<value-type>> A bounded sequence of elements More...
 
class  ContentFilterProperty
 <<extension>> <<value-type>> Provides all the required information to enable content filtering. More...
 
class  Cookie
 Unique identifier for a written data sample in the form of a sequence of bytes. More...
 
struct  DiscoveryPluginPromiscuityKind_def
 The definition of the dds::core::safe_enum DiscoveryPluginPromiscuityKind. More...
 
class  EndpointGroup
 <<extension>> Specifies a group of endpoints that can be collectively identified by a name and satisfied by a quorum. More...
 
class  Guid
 <<extension>> <<value-type>> Class for GUID (Global Unique Identifier) representation More...
 
class  ListenerBinder
 <<reference-type>> Automatically manages the association of an Entity and a Listener More...
 
struct  LocatorKind_def
 The definition of the dds::core::safe_enum LocatorKind. More...
 
class  Locator
 <<extension>> <<value-type>> Type used to represent the addressing information needed to send a message to an RTPS Endpoint using one of the supported transports. More...
 
class  LocatorFilterElement
 <<extension>> <<value-type>> Specifies the configuration of an individual channel within a MultiChannel DataWriter. More...
 
class  LongDouble
 <<extension>> <<value-type>> Encapsulates an IDL long double More...
 
class  optional_value
 <<extension>> Represents a value that can be initialized or not More...
 
class  pointer
 
class  TransportUnicastSettings
 <<extension>> Represents a list of unicast locators More...
 
class  TransportMulticastSettings
 <<extension>> Represents a list of multicast locators More...
 
class  ChannelSettings
 <<extension>> Configures the properties of a channel in rti::core::policy::MultiChannel More...
 
class  RtpsReliableReaderProtocol
 <<extension>> Configures aspects of the RTPS protocol related to a reliable DataReader More...
 
class  ProductVersion
 <<extension>> <<value-type>> Represents the current version of RTI Connext More...
 
class  ProtocolVersion
 <<extension>> Represents the current version of RTI Connext More...
 
class  QosProviderParams
 <<extension>> <<value-type>> Configure options that control the way that XML documents containing QoS profiles are loaded by a dds::core::QosProvider. More...
 
class  RtpsWellKnownPorts
 <<extension>> Configures the mapping of the RTPS well-known ports More...
 
class  SampleFlag
 <<extension>> A set of flags that can be associated with a sample. More...
 
class  SampleIdentity
 <<extension>> <<value-type>> A SampleIdentity defines a pair (Virtual Writer Guid, SequenceNumber) that uniquely identifies a sample within a DDS domain and a Topic. More...
 
class  SequenceNumber
 <<extension>> <<value-type>> A class representing the DDS 64-bit Sequence Number More...
 
struct  ServiceRequestId_def
 The definition of the rti::core::safe_enum ServiceRequestId. More...
 
struct  ThreadSettingsCpuRotationKind_def
 Determines how rti::core::ThreadSettings::cpu_list affects processor affinity for thread-related QoS policies that apply to multiple threads. More...
 
class  ThreadSettingsKindMask
 <<extension>> A collection of flags used to configure threads of execution More...
 
class  ThreadSettings
 <<extension>> The properties of a thread of execution. More...
 
struct  TransportClassId_def
 The definition of the dds::core::safe_enum TransportClassId. More...
 
class  TransportInfo
 <<extension>> <<value-type>> Contains the class id and message max size of an installed transport More...
 
class  VendorId
 <<extension>> Represents the vendor of the service implementing the RTPS protocol. More...
 

Typedefs

typedef dds::core::safe_enum
< DiscoveryPluginPromiscuityKind_def
DiscoveryPluginPromiscuityKind
 Safe Enumeration of DiscoveryPluginPromiscuityKind_def. Type used to indicate promiscuity mode of the discovery plugin.
 
typedef dds::core::vector
< EndpointGroup
EndpointGroupSeq
 A sequence of rti::core::EndpointGroup.
 
typedef dds::core::safe_enum
< LocatorKind_def
LocatorKind
 Safe Enumeration of LocatorKind_def
 
typedef std::vector
< TransportUnicastSettings
TransportUnicastSettingsSeq
 <<extension>> A sequence of TransportUnicastSettings
 
typedef std::vector
< TransportMulticastSettings
TransportMulticastSettingsSeq
 A sequence of TransportMulticastSettings.
 
typedef std::vector
< ChannelSettings
ChannelSettingsSeq
 <<extension>> A sequence of ChannelSettings
 
typedef dds::core::safe_enum
< ServiceRequestId_def
ServiceRequestId
 Safe Enumeration of ServiceRequestId_def
 
typedef dds::core::safe_enum
< ThreadSettingsCpuRotationKind_def
ThreadSettingsCpuRotationKind
 Safe Enumeration of ThreadSettingsCpuRotationKind_def
 
typedef dds::core::safe_enum
< TransportClassId_def
TransportClassId
 Safe Enumeration of TransportClassId_def
 
typedef dds::core::vector
< TransportInfo
TransportInfoSeq
 A sequence of TransportInfo.
 

Functions

template<typename T , size_t N>
void fill_array (dds::core::array< T, N > &array, const T &value)
 
template<typename FinalType , typename ArrayType , size_t N, size_t M>
void fill_array (dds::core::array< dds::core::array< ArrayType, N >, M > &multi_array, const FinalType &value)
 
template<typename CType , typename T , size_t N, typename InitFunc >
void initialize_native_array (dds::core::array< T, N > &array, InitFunc init_func)
 
template<typename T , size_t N>
std::ostream & operator<< (std::ostream &out, const bounded_sequence< T, N > &v)
 Print a vector applying << to all of its elements.
 
template<typename Entity , typename Listener >
ListenerBinder< Entity, Listenerbind_listener (Entity entity, Listener *the_listener, dds::core::status::StatusMask mask)
 Sets the listener and creates a ListenerBinder that automatically resets it when all references go out of scope.
 
template<typename Entity , typename Listener >
ListenerBinder< Entity, Listenerbind_listener (Entity entity, Listener *the_listener)
 Sets the listener and creates a ListenerBinder that automatically resets it when all references go out of scope.
 
template<typename Entity , typename Listener >
ListenerBinder< Entity, Listenerbind_and_manage_listener (Entity entity, Listener *the_listener, dds::core::status::StatusMask mask)
 Sets the listener and creates a ListenerBinder that automatically resets and deletes it when all references go out of scope.
 
template<typename Entity , typename Listener >
ListenerBinder< Entity, Listenerbind_and_manage_listener (Entity entity, Listener *the_listener)
 Sets the listener and creates a ListenerBinder that automatically resets and deletes it when all references go out of scope.
 
template<typename T >
std::ostream & operator<< (std::ostream &out, const pointer< T > &ptr)
 

Variables

const int32_t PUBLICATION_PRIORITY_UNDEFINED
 Initializer value for rti::core::policy::PublishMode::priority and/or rti::core::ChannelSettings::priority.
 
const int32_t PUBLICATION_PRIORITY_AUTOMATIC
 Constant value for rti::core::policy::PublishMode::priority and/or rti::core::ChannelSettings::priority.
 

Detailed Description

<<extension>> Extensions to dds::core

Typedef Documentation

Function Documentation

template<typename T , size_t N>
void rti::core::fill_array ( dds::core::array< T, N > &  array,
const T &  value 
)

Initializes all the elements of an array to a value

template<typename FinalType , typename ArrayType , size_t N, size_t M>
void rti::core::fill_array ( dds::core::array< dds::core::array< ArrayType, N >, M > &  multi_array,
const FinalType &  value 
)

Initializes all the elements of an array of arbitrary dimensions

template<typename CType , typename T , size_t N, typename InitFunc >
void rti::core::initialize_native_array ( dds::core::array< T, N > &  array,
InitFunc  init_func 
)

Initializes all the elements of an array using a C function

template<typename T , size_t N>
std::ostream & rti::core::operator<< ( std::ostream &  out,
const bounded_sequence< T, N > &  v 
)

Print a vector applying << to all of its elements.

template<typename Entity , typename Listener >
ListenerBinder< Entity, Listener > bind_listener ( Entity  entity,
Listener the_listener,
dds::core::status::StatusMask  mask 
)

Sets the listener and creates a ListenerBinder that automatically resets it when all references go out of scope.

The ListenerBinder created from this function does not delete the listener, it simply sets the listener back to NULL in the Entity. The application is responsible for the life-cycle of the listener.

To also delete the listener when all references go out of scope, see bind_and_manage_listener().

MyListener my_listener;
dds::sub::DataReader<Foo> reader(subscriber, topic);
// reader will have no listener after scoped_listener (and any other
// references created from scoped_listener) go out of scope--note that
// my_listener is a stack variable so scoped_listener should not delete it
auto scoped_listener = bind_listener(
template<typename Entity , typename Listener >
ListenerBinder< Entity, Listener > bind_listener ( Entity  entity,
Listener the_listener 
)

Sets the listener and creates a ListenerBinder that automatically resets it when all references go out of scope.

This overload works for listeners that don't use a mask

See Also
bind_listener(Entity, Listener*, dds::core::status::StatusMask)
template<typename Entity , typename Listener >
ListenerBinder< Entity, Listener > bind_and_manage_listener ( Entity  entity,
Listener the_listener,
dds::core::status::StatusMask  mask 
)

Sets the listener and creates a ListenerBinder that automatically resets and deletes it when all references go out of scope.

Example:

dds::sub::DataReader<Foo> reader(subscriber, topic);
// The instance of MyListener we are creating and attaching to reader will be
// unset and deleted when scoped_listener (and any other references create from
// scoped_listener) go out of scope
auto scoped_listener = bind_and_manage_listener(
reader, new MyListener(), dds::core::status::StatusMask::data_available());
See Also
bind_listener()
template<typename Entity , typename Listener >
ListenerBinder< Entity, Listener > bind_and_manage_listener ( Entity  entity,
Listener the_listener 
)

Sets the listener and creates a ListenerBinder that automatically resets and deletes it when all references go out of scope.

This overload works for listeners that don't use a mask

See Also
bind_and_manage_listener(Entity, Listener*, dds::core::status::StatusMask)
template<typename T >
std::ostream& rti::core::operator<< ( std::ostream &  out,
const pointer< T > &  ptr 
)

Write pointer contents or the string "NULL"


RTI Connext Modern C++ API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc