Modules

Here is a list of all modules:

[detail level 12345]

Documentation Roadmap
Conventions
Namespaces and headers
RTI Connext DDS API Reference	RTI Connext modules following the DDS module definitions
Domain Module	Contains the dds::domain::DomainParticipant class that acts as an entrypoint of RTI Connext and acts as a factory for many of the classes. The dds::domain::DomainParticipant also acts as a container for the other objects that make up RTI Connext
DomainParticipants	Dds::domain::DomainParticipant entity and associated elements
Built-in Topics	Built-in objects created by RTI Connext but accessible to the application
Participant Built-in Topics	Builtin topic for accessing information about the DomainParticipants discovered by RTI Connext
Topic Built-in Topics	Builtin topic for accessing information about the Topics discovered by RTI Connext
Publication Built-in Topics	Builtin topic for accessing information about the Publications discovered by RTI Connext
Subscription Built-in Topics	Builtin topic for accessing information about the Subscriptions discovered by RTI Connext
Topic Module	Contains the dds::topic::Topic, dds::topic::ContentFilteredTopic, and MultiTopic classes, the TopicListener interface, and more generally, all that is needed by an application to define dds::topic::Topic objects and attach QoS policies to them
Topics	Dds::topic::Topic entity and associated elements
Built-in Types	RTI Connext provides a set of very simple data types for you to use with the topics in your application
Topic traits and data-type support	Traits and operations associated to topic-types
Topic-type serialization and deserialization	Provides functions to serialize and deserialize user data types to and from CDR format
Custom Content Filters	Classes and associated types used to implement custom content filters
Publication Module	Contains the rti::pub::FlowController, dds::pub::Publisher, and dds::pub::DataWriter classes as well as the PublisherListener and dds::pub::DataWriterListener interfaces, and more generally, all that is needed on the publication side
Publishers	Dds::pub::Publisher entity and associated elements
Data Writers	Dds::pub::DataWriter entity and associated elements
Flow Controllers	<<extension>> rti::pub::FlowController and associated elements
Multi-channel DataWriters	APIs related to Multi-channel DataWriters
Subscription Module	Contains the dds::sub::Subscriber, dds::sub::DataReader, dds::sub::cond::ReadCondition, and dds::sub::cond::QueryCondition classes, as well as the dds::sub::SubscriberListener and dds::sub::DataReaderListener interfaces, and more generally, all that is needed on the subscription side
Subscribers	Dds::sub::Subscriber entity and associated elements
DataReaders	Dds::sub::DataReader entity and associated elements
Read Conditions	Dds::sub::cond::ReadCondition and associated elements
Query Conditions	Dds::sub::cond::QueryCondition and associated elements
Data Samples	Dds::sub::SampleInfo, dds::sub::status::SampleState, dds::sub::status::ViewState, dds::sub::status::InstanceState and associated elements
Sample Information
Data State	Describes DataState, which includes SampleState, ViewState and InstanceState
Infrastructure Module	Defines the abstract classes and the interfaces that are refined by the other modules. Contains common definitions such as return codes, status values, and QoS policies
Clock Selection	APIs related to clock selection
Conditions and WaitSets	Dds::core::cond::Condition and dds::core::cond::WaitSet
Time Support	Time and duration types
Exceptions
Safe Enumeration	Describes the safe_enum class
Status Kinds	Kinds of communication status
Supporting Types and Constants	Miscellaneous, general-purpose types and constants
DynamicType and DynamicData	Describes dds::core::xtypes::DynamicType, dds::core::xtypes::DynamicData and related types and functions
Builtin Qos Profiles	<<extension>> QoS libraries and profiles that are automatically built into RTI Connext
QoS Policies	Quality of Service (QoS) policies
QoS Policy Traits	The traits types policy_id and policy_name provide information about a QoS policy
ASYNCHRONOUS_PUBLISHER	<<extension>> Specifies the asynchronous publishing settings of the dds::pub::Publisher instances
AVAILABILITY	<<extension>> Configures the availability of data
BATCH	<<extension>> Batch QoS policy used to enable batching in dds::pub::DataWriter instances
DATABASE	<<extension>> Various threads and resource limits settings used by RTI Connext to control its internal database
DATA_READER_PROTOCOL	<<extension>> Specifies the DataReader-specific protocol QoS
DATA_READER_RESOURCE_LIMITS	<<extension>> Various settings that configure how DataReaders allocate and use physical memory for internal resources
DATA_WRITER_PROTOCOL	<<extension>> Along with rti::core::policy::WireProtocol and rti::core::policy::DataReaderProtocol, this QoS policy configures the DDS on-the-network protocol (RTPS)
DATA_WRITER_RESOURCE_LIMITS	<<extension>> Various settings that configure how a dds::pub::DataWriter allocates and uses physical memory for internal resources
DEADLINE	Expresses the maximum duration (deadline) within which an instance is expected to be updated
DESTINATION_ORDER	Controls the criteria used to determine the logical order among changes made by dds::pub::Publisher entities to the same instance of data (i.e., matching dds::topic::Topic and key)
DISCOVERY	<<extension>> Specifies the attributes required to discover participants in the domain
NDDS_DISCOVERY_PEERS	Environment variable or a file that specifies the default values of rti::core::policy::Discovery::initial_peers(const dds::core::StringSeq & the_initial_peers) and rti::core::policy::Discovery::multicast_receive_addresses contained in the dds::domain::qos::DomainParticipantQos::discovery qos policy
DISCOVERY_CONFIG	<<extension>> Specifies the discovery configuration QoS
DOMAIN_PARTICIPANT_RESOURCE_LIMITS	<<extension>> Various settings that configure how a dds::domain::DomainParticipant allocates and uses physical memory for internal resources, including the maximum sizes of various properties
DURABILITY	This QoS policy specifies whether or not RTI Connext will store and deliver previously published data samples to new dds::sub::DataReader entities that join the network later
DURABILITY_SERVICE	Various settings to configure the external RTI Persistence Service used by RTI Connext for DataWriters with a dds::core::policy::Durability setting of rti::core::policy::DurabilityKind::PERSISTENT or rti::core::policy::DurabilityKind::TRANSIENT
ENTITY_FACTORY	A QoS policy for all dds::core::Entity types that can act as factories for one or more other dds::core::Entity types
ENTITY_NAME	<<extension>> Assigns a name to a dds::domain::DomainParticipant, dds::pub::Publisher, dds::sub::Subscriber, dds::pub::DataWriter or dds::sub::DataReader. Except for dds::pub::Publisher and dds::sub::Subscriber, these names are visible during the discovery process and in RTI tools to help you visualize and debug your system
EVENT	<<extension>> Configures the internal thread in a DomainParticipant that handles timed events
EXCLUSIVE_AREA	<<extension>> Configures multi-thread concurrency and deadlock prevention capabilities
HISTORY	Specifies the behavior of RTI Connext in the case where the value of an instance changes (one or more times) before it can be successfully communicated to one or more existing subscribers
GROUP_DATA	Attaches a buffer of opaque data that is distributed by means of Built-in Topics during discovery
LATENCY_BUDGET	Provides a hint as to the maximum acceptable delay from the time the data is written to the time it is received by the subscribing applications
LIFESPAN	Specifies how long the data written by the dds::pub::DataWriter is considered valid
LIVELINESS	Specifies and configures the mechanism that allows dds::sub::DataReader entities to detect when dds::pub::DataWriter entities become disconnected or "dead."
LOCATORFILTER	<<extension>> The QoS policy used to report the configuration of a MultiChannel DataWriter as part of dds::topic::PublicationBuiltinTopicData
LOGGING	<<extension>> Configures the RTI Connext logging facility
MULTICHANNEL	<<extension>> Configures the ability of a DataWriter to send data on different multicast groups (addresses) based on the value of the data
OWNERSHIP	Specifies whether it is allowed for multiple dds::pub::DataWriter (s) to write the same instance of the data and if so, how these modifications should be arbitrated
OWNERSHIP_STRENGTH	Specifies the value of the strength used to arbitrate among multiple dds::pub::DataWriter objects that attempt to modify the same instance of a data type (identified by dds::topic::Topic + key)
PARTITION	Set of strings that introduces a logical partition among the topics visible by a dds::pub::Publisher and a dds::sub::Subscriber
PRESENTATION	Specifies how the samples representing changes to data instances are presented to a subscribing application
PROFILE	<<extension>> Configures the way that XML documents containing QoS profiles are loaded by RTI Connext
PROPERTY	<<extension>> Stores name/value (string) pairs that can be used to configure certain parameters of RTI Connext that are not exposed through formal QoS policies. Can also be used to store and propagate application-specific name/value pairs that can be retrieved by user code during discovery
PUBLISH_MODE	<<extension>> Specifies how RTI Connext sends application data on the network. This QoS policy can be used to tell RTI Connext to use its own thread to send data, instead of the user thread
READER_DATA_LIFECYCLE	Controls how a DataReader manages the lifecycle of the data that it has received
RECEIVER_POOL	<<extension>> Configures threads used by RTI Connext to receive and process data from transports (for example, UDP sockets)
RELIABILITY	Indicates the level of reliability offered/requested by RTI Connext
RESOURCE_LIMITS	Controls the amount of physical memory allocated for DDS entities, if dynamic allocations are allowed, and how they occur. Also controls memory usage among different instance values for keyed topics
SERVICE	<<extension>> Service QoS policy is used to indicate what kind of service is associated with the DDS entity
SYSTEM_RESOURCE_LIMITS	<<extension>> Configures DomainParticipant-independent resources used by RTI Connext
TIME_BASED_FILTER	Filter that allows a dds::sub::DataReader to specify that it is interested only in (potentially) a subset of the values of the data
TOPIC_DATA	Attaches a buffer of opaque data that is distributed by means of Built-in Topics during discovery
TRANSPORT_BUILTIN	<<extension>> Specifies which built-in transports are used
TRANSPORT_MULTICAST	<<extension>> Specifies the multicast address on which a dds::sub::DataReader wants to receive its data. It can also specify a port number, as well as a subset of the available (at the dds::domain::DomainParticipant level) transports with which to receive the multicast data
TRANSPORT_MULTICAST_MAPPING	<<extension>> Specifies a list of topic expressions and addresses that can be used by an Entity with a specific topic name to receive data
TRANSPORT_PRIORITY	This QoS policy allows the application to take advantage of transport that are capable of sending messages with different priorities
TRANSPORT_SELECTION	<<extension>> Specifies the physical transports that a dds::pub::DataWriter or dds::sub::DataReader may use to send or receive data
TRANSPORT_UNICAST	<<extension>> Specifies a subset of transports and a port number that can be used by an Entity to receive data
TYPE_CONSISTENCY_ENFORCEMENT	Defines the rules for determining whether the type used to publish a given topic is consistent with that used to subscribe to it
TYPESUPPORT	<<extension>> Allows you to attach application-specific values to a dds::pub::DataWriter or dds::sub::DataReader, which are passed to the serialization or deserialization routine of the associated data type and choose whether to set padding bytes to zero during serialization
USER_DATA	Attaches a buffer of opaque data that is distributed by means of Built-in Topics during discovery
WRITER_DATA_LIFECYCLE	Controls how a DataWriter handles the lifecycle of the instances (keys) that it is registered to manage
WIRE_PROTOCOL	<<extension>> Specifies the wire protocol related attributes for the dds::domain::DomainParticipant
Pluggable Transports	APIs related to RTI Connext pluggable transports
Using Transport Plugins	Configuring transports used by RTI Connext
Built-in Transport Plugins	Transport plugins delivered with RTI Connext
Shared Memory Transport	Built-in transport plug-in for inter-process communications using shared memory
UDPv4 Transport	Built-in transport plug-in using UDP/IPv4
UDPv6 Transport	Built-in transport plug-in using UDP/IPv6
Class Id	Transport class ID. Specifies the ID of a Transport-Plugin 'class'
Address	Transport-independent addressing scheme using IPv6 presentation strings and numerically stored in network-ordered format
Attributes	Base "class" of the properties of any Transport Plugin
Queries and Filters Syntax
Configuration Utilities	Utility API's independent of the DDS standard
Unsupported Utilities	Unsupported APIs used by examples in the RTI Connext distribution as well as in rtiddsgen-generated examples
Durability and Persistence	APIs related to RTI Connext Durability and Persistence
System Properties	System Properties
Configuring QoS Profiles with XML	APIs related to XML QoS Profiles
Programming How-To's	These "How To"s illustrate how to apply RTI Connext APIs to common use cases
Publication Example	A data publication example
Subscription Example	A data subscription example
Participant Use Cases	Working with domain partcipants
Topic Use Cases
Publisher Use Cases
DataWriter Use Cases
Subscriber Use Cases
DataReader Use Cases
Entity Use Cases
Waitset Use Cases	Using WaitSets and Conditions
Filter Use Cases	Working with data filters
Creating Custom Content Filters	Creating a custom content filter
XML Application Creation	Creating a custom content filter
Built-in Types Examples	Using Built-in Types
Exceptions	How DDS return codes map to C++ exceptions
Qos Use Cases
Qos Provider Use Cases	How to use the QosProvider class to access XML QoS profiles
Working with IDL types	How IDL types map to C++ classes
DynamicType and DynamicData Use Cases	Using DynamicType and DynamicData
Programming Tools
rtiddsgen	Generates source code from data types declared in IDL or XML files
rtiddsping	Sends or receives simple messages using RTI Connext
rtiddsspy	Debugging tool which receives all RTI Connext communication