Modules

Here is a list of all modules:

[detail level 12345]

Documentation Roadmap
Conventions
Using DDS:: Namespace
RTI Connext DDS API Reference	RTI Connext modules following the DDS module definitions
Domain Module	Contains the DDSDomainParticipant class that acts as an entrypoint of RTI Connext and acts as a factory for many of the classes. The DDSDomainParticipant also acts as a container for the other objects that make up RTI Connext
DomainParticipantFactory	DDSDomainParticipantFactory entity and associated elements
DomainParticipantConfigParams	<<extension>> DDS_DomainParticipantConfigParams_t
DomainParticipants	DDSDomainParticipant 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
ServiceRequest Built-in Topic	Builtin topic for accessing requests from different services within RTI Connext
Common types and functions	Types and functions related to the built-in topics
Topic Module	Contains the DDSTopic, DDSContentFilteredTopic, and DDSMultiTopic classes, the DDSTopicListener interface, and more generally, all that is needed by an application to define DDSTopic objects and attach QoS policies to them
Topics	DDSTopic entity and associated elements
FlatData Topic-Types	<<extension>> FlatData Language Binding for IDL topic-types
FlatData Builders	A Builder allows creating and initializing variable-size data
FlatData Samples	A Sample represents an instance of the IDL topic-type and contains the data in serialized format
FlatData Offsets	Offsets provide access to the members of a FlatData Sample
Zero Copy Transfer Over Shared Memory	<<extension>> Zero Copy transfer over shared memory
User Data Type Support	Defines generic classes and macros to support user data types
Type Code Support	<<extension>> A DDS_TypeCode is a mechanism for representing a type at runtime. RTI Connext can use type codes to send type definitions on the network. You will need to understand this API in order to use the Dynamic Data capability or to inspect the type information you receive from remote readers and writers
Built-in Types	RTI Connext provides a set of very simple data types for you to use with the topics in your application
String Built-in Type	Built-in type consisting of a single character string
KeyedString Built-in Type	Built-in type consisting of a string payload and a second string that is the key
Octets Built-in Type	Built-in type consisting of a variable-length array of opaque bytes
KeyedOctets Built-in Type	Built-in type consisting of a variable-length array of opaque bytes and a string that is the key
Dynamic Data	<<extension>> The Dynamic Data API provides a way to interact with arbitrarily complex data types at runtime without the need for code generation
DDS-Specific Primitive Types	Basic DDS value types for use in user data types
Publication Module	Contains the DDSFlowController, DDSPublisher, and DDSDataWriter classes as well as the DDSPublisherListener and DDSDataWriterListener interfaces, and more generally, all that is needed on the publication side
Publishers	DDSPublisher entity and associated elements
Data Writers	DDSDataWriter entity and associated elements
Flow Controllers	<<extension>> DDSFlowController and associated elements
Multi-channel DataWriters	APIs related to Multi-channel DataWriters
Subscription Module	Contains the DDSSubscriber, DDSDataReader, DDSReadCondition, DDSQueryCondition, and DDSTopicQuery classes, as well as the DDSSubscriberListener and DDSDataReaderListener interfaces, and more generally, all that is needed on the subscription side
Subscribers	DDSSubscriber entity and associated elements
DataReaders	DDSDataReader entity and associated elements
Read Conditions	DDSReadCondition and associated elements
Query Conditions	DDSQueryCondition and associated elements
Topic Queries	DDSTopicQuery and associated elements
Data Samples	DDS_SampleInfo, DDS_SampleStateKind, DDS_ViewStateKind, DDS_InstanceStateKind and associated elements
Sample States	DDS_SampleStateKind and associated elements
View States	DDS_ViewStateKind and associated elements
Instance States	DDS_InstanceStateKind and associated elements
Stream Kinds	DDS_StreamKind and associated elements
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
Time Support	Time and duration types and defines
GUID Support	<<extension>> GUID type and defines
Sequence Number Support	<<extension>> Sequence number type and defines
Exception Codes	<<extension>> Exception codes
Return Codes	Types of return codes
Status Kinds	Kinds of communication status
QoS Policies	Quality of Service (QoS) policies
ASYNCHRONOUS_PUBLISHER	<<extension>> Specifies the asynchronous publishing settings of the DDSPublisher instances
AVAILABILITY	<<extension>> Configures the availability of data
BATCH	<<extension>> Batch QoS policy used to enable batching in DDSDataWriter 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_REPRESENTATION	A list of data representations supported by a DDSDataWriter or DDSDataReader
DATA_TAG	Stores (name, value) pairs that can be used to determine access permissions
DATA_WRITER_PROTOCOL	<<extension>> Along with DDS_WireProtocolQosPolicy and DDS_DataReaderProtocolQosPolicy, this QoS policy configures the DDS on-the-network protocol (RTPS)
DATA_WRITER_RESOURCE_LIMITS	<<extension>> Various settings that configure how a DDSDataWriter allocates and uses physical memory for internal resources
DATA_WRITER_TRANSFER_MODE	<<extension>> Specifies the DataWriter transfer mode QoS
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 DDSPublisher entities to the same instance of data (i.e., matching DDSTopic 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 DDS_DiscoveryQosPolicy::initial_peers and DDS_DiscoveryQosPolicy::multicast_receive_addresses contained in the DDS_DomainParticipantQos::discovery qos policy
DISCOVERY_CONFIG	<<extension>> Specifies the discovery configuration QoS
DOMAIN_PARTICIPANT_RESOURCE_LIMITS	<<extension>> Various settings that configure how a DDSDomainParticipant 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 DDSDataReader 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_DurabilityQosPolicy setting of DDS_PERSISTENT_DURABILITY_QOS or DDS_TRANSIENT_DURABILITY_QOS
ENTITY_FACTORY	A QoS policy for all DDSEntity types that can act as factories for one or more other DDSEntity types
ENTITY_NAME	<<extension>> Assigns a name to a DDSDomainParticipant, DDSPublisher, DDSSubscriber, DDSDataWriter or DDSDataReader. Except for DDSPublisher and DDSSubscriber, 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 DDSDataWriter is considered valid
LIVELINESS	Specifies and configures the mechanism that allows DDSDataReader entities to detect when DDSDataWriter entities become disconnected or "dead."
LOCATORFILTER	<<extension>> The QoS policy used to report the configuration of a MultiChannel DataWriter as part of DDS_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 DDSDataWriter (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 DDSDataWriter objects that attempt to modify the same instance of a data type (identified by DDSTopic + key)
PARTITION	Set of strings that introduces a logical partition among the topics visible by a DDSPublisher and a DDSSubscriber
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) 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 DDSDataReader 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
TOPIC_QUERY_DISPATCH	Configures the ability of a DDSDataWriter to publish historical samples
TRANSPORT_BUILTIN	<<extension>> Specifies which built-in transports are used
TRANSPORT_MULTICAST	<<extension>> Specifies the multicast address on which a DDSDataReader wants to receive its data. It can also specify a port number, as well as a subset of the available (at the DDSDomainParticipant level) transports with which to receive the multicast data
Multicast Settings	Multicast communication settings
Multicast Mapping	Multicast communication mapping
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 DDSDataWriter or DDSDataReader 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
Unicast Settings	Unicast communication settings
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 DDSDataWriter or DDSDataReader, 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 DDSDomainParticipant
Extended Qos Support	<<extension>> Types and defines used in extended QoS policies
Thread Settings	The properties of a thread of execution. Consult Platform Notes for additional platform specific details
Entity Support	DDSEntity, DDSListener and related items
Conditions and WaitSets	DDSCondition and DDSWaitSet and related items
AsyncWaitSet	<<experimental>> <<extension>> A specialization of DDSWaitSet that provides a mechanism to perform the wait asynchronously and uses a thread pool to dispatch the attached active DDSCondition
Cookie	<<extension>> Unique identifier for a written data sample
Sample Flags	<<extension>> Flags for samples
WriteParams	<<extension>>
Heap Support in C	<<extension>> Heap allocation and free routines in C
Builtin Qos Profiles	<<extension>> QoS libraries, profiles, and snippets that are automatically built into RTI Connext
User-managed Threads	User-managed thread infrastructure
Octet Buffer Support	<<extension>> Octet buffer creation, cloning, and deletion
Sequence Support	The FooSeq interface allows you to work with variable-length collections of homogeneous data
Built-in Sequences	Defines sequences of primitive data type
String Support	<<extension>> String creation, cloning, assignment, and deletion
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 (NDDS_TRANSPORT_CLASSID_SHMEM)
UDPv4 Transport	Built-in transport plug-in using UDP/IPv4 (NDDS_TRANSPORT_CLASSID_UDPv4)
UDPv6 Transport	Built-in transport plug-in using UDP/IPv6 (NDDS_TRANSPORT_CLASSID_UDPv6)
Port	4-byte number used by RTI Connext to distinguish between receivers of messages on the same interface (address)
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
RTI Connext Messaging API Reference	Extensions to the RTI Connext publish-subscribe functionality
Request-Reply Pattern	Support for the request-reply communication pattern
Requester	connext::Requester and associated elements
Replier	connext::Replier, connext::SimpleReplier and associated elements
Infrastructure	Infrastructure types for RTI Connext Messaging
RTI Connext Exceptions	RTI Connext return-code exceptions
Utilities	Utilities for the RTI Connext Messaging module
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 participants
Topic Use Cases	Working with topics
FlowController Use Cases	Working with flow controllers
Publisher Use Cases	Working with publishers
DataWriter Use Cases	Working with data writers
Subscriber Use Cases	Working with subscribers
DataReader Use Cases	Working with data readers
Entity Use Cases	Working with entities
Waitset Use Cases	Using wait-sets and conditions
Transport Use Cases	Working with pluggable transports
Filter Use Cases	Working with data filters
Creating Custom Content Filters	Working with custom content filters
Large Data Use Cases	Working with large data types
Request-Reply Examples	Examples on how to use the request-reply API
Programming Tools
rtiddsgen	Generates source code from data types declared in IDL, XML, or XSD files
rtiddsping	Sends or receives simple messages using RTI Connext
rtiddsspy	Debugging tool which receives all RTI Connext communication