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

Namespaces
	builtin_profiles
	<<extension>> Contains the names of the built-in profiles

	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	ChannelSettings
	<<extension>> Configures the properties of a channel in rti::core::policy::MultiChannel More...

class	CoherentSetInfo
	<<extension>> <<value-type>> A CoherentSampleInfo provides information about the coherent set associated with a sample. More...

class	CompressionIdMask
	<<extension>> Mask that specifies which built-in compression method to used. More...

class	CompressionSettings
	<<extension>> Compression Settings 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...

class	DataReaderResourceLimitsInstanceReplacementSettings
	<<extension>> How instances are replaced in the DataReader queue when resource limits are reached. More...

class	DataWriterShmemRefTransferModeSettings
	<<extension>> Configures aspects of the shared memory reference transfer mode related to a DataWriter 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...

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...

struct	LocatorKind_def
	The definition of the dds::core::safe_enum LocatorKind. 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	ProductVersion
	<<extension>> <<value-type>> Represents the current version of RTI Connext More...

class	ProtocolVersion
	<<extension>> Represents the current version of RTI Connext More...

struct	qos_print_all_t
	A tag type that selects the to_string overload that prints all the values of a Qos object. More...

class	QosPrintFormat
	<<extension>> <<value-type>> A collection of attributes used to configure how QoS will be formatted when converted to strings. 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	RtpsReliableReaderProtocol
	<<extension>> Configures aspects of the RTPS protocol related to a reliable DataReader 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...

class	ThreadSettings
	<<extension>> The properties of a thread of execution. 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...

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	TransportMulticastSettings
	<<extension>> Represents a list of multicast locators More...

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

class	UnregisterThreadOnExit
	<<extension>> Utility that calls rti::core::unregister_thread when leaving scope 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. More...

typedef dds::core::vector< EndpointGroup >	EndpointGroupSeq
	A sequence of rti::core::EndpointGroup. More...

typedef dds::core::safe_enum< LocatorKind_def >	LocatorKind
	Safe Enumeration of LocatorKind_def More...

typedef std::vector< TransportUnicastSettings >	TransportUnicastSettingsSeq
	<<extension>> A sequence of TransportUnicastSettings More...

typedef std::vector< TransportMulticastSettings >	TransportMulticastSettingsSeq
	A sequence of TransportMulticastSettings. More...

typedef std::vector< ChannelSettings >	ChannelSettingsSeq
	<<extension>> A sequence of ChannelSettings More...

typedef dds::core::safe_enum< ServiceRequestId_def >	ServiceRequestId
	Safe Enumeration of ServiceRequestId_def More...

typedef dds::core::safe_enum< ThreadSettingsCpuRotationKind_def >	ThreadSettingsCpuRotationKind
	Safe Enumeration of ThreadSettingsCpuRotationKind_def More...

typedef dds::core::safe_enum< TransportClassId_def >	TransportClassId
	Safe Enumeration of TransportClassId_def More...

typedef dds::core::vector< TransportInfo >	TransportInfoSeq
	A sequence of TransportInfo. More...

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. More...

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. More...

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. More...

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. More...

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. More...

template<typename T >
std::ostream &	operator<< (std::ostream &out, const pointer< T > &ptr)

QosProviderParams	default_qos_provider_params ()
	<<extension>> Get the rti::core::QosProviderParams for the default QosProvider More...

void	default_qos_provider_params (const rti::core::QosProviderParams &params)
	<<extension>> Set the rti::core::QosProviderParams for the default QosProvider More...

void	unregister_thread ()
	<<extension>> Releases resources that RTI Connext keeps for this thread More...

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

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

const qos_print_all_t	qos_print_all
	Sentinel value that selects the to_string overload that prints all of the values of a Qos object. More...

Detailed Description

<<extension>> Extensions to dds::core

Typedef Documentation

◆ LocatorKind

typedef dds::core::safe_enum<LocatorKind_def> rti::core::LocatorKind

Safe Enumeration of LocatorKind_def

See also: LocatorKind_def

◆ ThreadSettingsCpuRotationKind

typedef dds::core::safe_enum<ThreadSettingsCpuRotationKind_def> rti::core::ThreadSettingsCpuRotationKind

Safe Enumeration of ThreadSettingsCpuRotationKind_def

See also: ThreadSettingsCpuRotationKind_def

◆ TransportClassId

typedef dds::core::safe_enum<TransportClassId_def> rti::core::TransportClassId

Safe Enumeration of TransportClassId_def

See also: TransportClassId_def

◆ TransportInfoSeq

typedef dds::core::vector<TransportInfo> rti::core::TransportInfoSeq

A sequence of TransportInfo.

Function Documentation

◆ fill_array() [1/2]

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

Referenced by fill_array().

◆ fill_array() [2/2]

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

References fill_array().

◆ initialize_native_array()

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

◆ operator<<() [1/2]

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.

Referenced by rti::core::status::EventCount< IntegerType >::change(), rti::core::LongDouble::operator[](), and rti::core::Cookie::to_pointer().

◆ bind_listener() [1/2]

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.

[DEPRECATED] The use of ListenerBinder is no longer required as long as the a std::shared_ptr is used to set an Entity's listener.

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(
    reader, &my_listener, dds::core::status::StatusMask::data_available());

References rti::core::ListenerBinder< Entity, Listener >::entity().

◆ bind_listener() [2/2]

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.

[DEPRECATED] The use of ListenerBinder is no longer required as long as the a std::shared_ptr is used to set an Entity's listener.

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

See also: bind_listener(Entity, Listener*, dds::core::status::StatusMask)

References rti::core::ListenerBinder< Entity, Listener >::entity().

◆ bind_and_manage_listener() [1/2]

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.

[DEPRECATED] The use of ListenerBinder is no longer required as long as the a std::shared_ptr is used to set an Entity's listener.

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()

References rti::core::ListenerBinder< Entity, Listener >::entity().

◆ bind_and_manage_listener() [2/2]

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.

[DEPRECATED] The use of ListenerBinder is no longer required as long as the a std::shared_ptr is used to set an Entity's listener.

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

See also: bind_and_manage_listener(Entity, Listener*, dds::core::status::StatusMask)

References rti::core::ListenerBinder< Entity, Listener >::entity().

◆ operator<<() [2/2]

template<typename T >

std::ostream& rti::core::operator<<	(	std::ostream &	out,
		const pointer< T > &	ptr
	)

Write pointer contents or the string "NULL"

References dds::core::null.

◆ default_qos_provider_params() [1/2]

QosProviderParams rti::core::default_qos_provider_params ( )

<<extension>> Get the rti::core::QosProviderParams for the default QosProvider

Note: This is a standalone function in the namespace rti::core

Returns: rti::core::QosProviderParams

◆ default_qos_provider_params() [2/2]

void rti::core::default_qos_provider_params ( const rti::core::QosProviderParams & params )

<<extension>> Set the rti::core::QosProviderParams for the default QosProvider

Note: This is a standalone function in the namespace rti::core

Use this function to configure the profiles that dds::core::QosProvider::Default() loads.

rti::core::QosProviderParams params;
params.url_profile({"my_profiles.xml"});
rti::core::default_qos_provider_params(params);
auto participant_qos =
    dds::core::QosProvider::Default().participant_qos("my_library::my_profile");

Parameters

params The QosProviderParams to set

Namespaces

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ LocatorKind

◆ ThreadSettingsCpuRotationKind

◆ TransportClassId

◆ TransportInfoSeq

Function Documentation

◆ fill_array() [1/2]

◆ fill_array() [2/2]

◆ initialize_native_array()

◆ operator<<() [1/2]

◆ bind_listener() [1/2]

◆ bind_listener() [2/2]

◆ bind_and_manage_listener() [1/2]

◆ bind_and_manage_listener() [2/2]

◆ operator<<() [2/2]

◆ default_qos_provider_params() [1/2]

◆ default_qos_provider_params() [2/2]