Supporting Types and Constants

Miscellaneous, general-purpose types and constants. More...

Classes
class	dds::core::external< T >
	A managed reference to an object. More...
class	dds::core::basic_string< CharType, Allocator >
	<<value-type>> A string convertible to std::string and with similar functionality More...
class	rti::core::bounded_sequence< T, MaxLength >
	<<value-type>> A bounded sequence of elements More...
class	rti::core::ListenerBinder< Entity, Listener >
	<<reference-type>> Automatically manages the association of an Entity and a Listener More...
class	rti::core::LongDouble
	<<extension>> <<value-type>> Encapsulates an IDL long double More...
class	dds::core::optional< T >
	<<value-type>> Represents an object that may not contain a valid value More...
class	rti::core::optional_value< T >
	<<extension>> Represents a value that can be initialized or not More...
class	rti::core::UnregisterThreadOnExit
	<<extension>> Utility that calls rti::core::unregister_thread when leaving scope More...
class	dds::core::vector< T >
	<<value-type>> A vector convertible to std::vector and with similar functionality More...

Typedefs
typedef boost_or_std_array	dds::core::array
	Represents an IDL array.
typedef std::shared_ptr< T >	dds::core::external< T >::shared_ptr
	The smart pointer that external<T> uses.
typedef basic_string< char, rti::core::memory::OsapiAllocator < char > >	dds::core::string
	A string convertible to std::string and with similar functionality.
typedef basic_string < DDS_Wchar, rti::core::memory::OsapiAllocator < DDS_Wchar > >	dds::core::wstring
	An IDL-derived wide string.
typedef std::vector< uint8_t >	dds::core::ByteSeq
	A vector of bytes.
typedef std::vector< std::string >	dds::core::StringSeq
	A vector of strings.
typedef std::nullptr_t	dds::core::null_type
	<<C++11>> The type of dds::core::null
typedef ::std::true_type	dds::core::true_type
	True type used by trait types.
typedef ::std::false_type	dds::core::false_type
	False type used by trait types.

Functions
void	rti::core::unregister_thread ()
	<<extension>> Releases resources that RTI Connext keeps for this thread

Variables
const int32_t	dds::core::LENGTH_UNLIMITED = -1
	A special value indicating an unlimited quantity.
const null_type	dds::core::null
	Indicates an empty reference.

Detailed Description

Miscellaneous, general-purpose types and constants.

Typedef Documentation

typedef boost_or_std_array dds::core::array

Represents an IDL array.

An IDL array maps to this C++ type.

This type is std::array if supported or boost::array otherwise.

Examples:

Foo.hpp.

template<typename T >

typedef std::shared_ptr<T> dds::core::external< T >::shared_ptr

The smart pointer that external<T> uses.

Selects std::shared_ptr if available when compiling or a boost implementation otherwise.

typedef basic_string<char, rti::core::memory::OsapiAllocator<char> > dds::core::string

A string convertible to std::string and with similar functionality.

See Also

basic_string

Examples:

Foo.hpp.

typedef basic_string<DDS_Wchar, rti::core::memory::OsapiAllocator<DDS_Wchar> > dds::core::wstring

An IDL-derived wide string.

IDL wstring maps to this type in the C++ API.

It's character type is DDS_Wchar, a portable 4-byte character type.

See Also

basic_string

typedef std::vector<uint8_t> dds::core::ByteSeq

A vector of bytes.

typedef std::vector<std::string> dds::core::StringSeq

A vector of strings.

typedef std::nullptr_t dds::core::null_type

<<C++11>> The type of dds::core::null

typedef ::std::true_type dds::core::true_type

True type used by trait types.

typedef ::std::false_type dds::core::false_type

False type used by trait types.

Function Documentation

void rti::core::unregister_thread

(

)

<<extension>> Releases resources that RTI Connext keeps for this thread

This function should be called by the user right before exiting a thread where DDS API were used. In this way the middleware will be able to free all the resources related to this specific thread. The best approach is to call the function during the thread deletion after all the DDS related API have have been called.

Exceptions

One	of the Standard Exceptions

See Also

UnregisterThreadOnExit

Variable Documentation

const int32_t dds::core::LENGTH_UNLIMITED = -1

A special value indicating an unlimited quantity.

Examples:

USER_QOS_PROFILES.xml.

const null_type dds::core::null

Indicates an empty reference.

See Also

<<reference-type>>