| Documentation Roadmap | |
| Conventions | |
| ▼RTI Connext DDS API Reference | RTI Connext modules following the DDS module definitions |
| ▼Domain Module | Contains the DDS_DomainParticipant class that acts as an entrypoint of RTI Connext and acts as a factory for many of the classes. The DDS_DomainParticipant also acts as a container for the other objects that make up RTI Connext |
| ►DomainParticipantFactory | DDS_DomainParticipantFactory entity and associated elements |
| DomainParticipantConfigParams | <<extension>> DDS_DomainParticipantConfigParams_t |
| DomainParticipants | DDS_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 | |
| 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 DDS_Topic, DDS_ContentFilteredTopic, and DDS_MultiTopic classes, the DDS_TopicListener interface, and more generally, all that is needed by an application to define DDS_Topic objects and attach QoS policies to them |
| Topics | DDS_Topic entity and associated elements |
| FlatData Topic-Types | <<extension>> FlatData Language Binding for IDL topic-types |
| 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 |
| Built-in Topic's Trust Types | Types used as part of DDS_ParticipantBuiltinTopicData, DDS_PublicationBuiltinTopicData, DDS_SubscriptionBuiltinTopicData to describe Trust Plugins configuration |
| 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 DDS_FlowController, DDS_Publisher, and DDS_DataWriter classes as well as the DDS_PublisherListener and DDS_DataWriterListener interfaces, and more generally, all that is needed on the publication side |
| Publishers | DDS_Publisher entity and associated elements |
| Data Writers | DDS_DataWriter entity and associated elements |
| Flow Controllers | <<extension>> DDS_FlowController and associated elements |
| Multi-channel DataWriters | APIs related to Multi-channel DataWriters |
| ▼Subscription Module | Contains the DDS_Subscriber, DDS_DataReader, DDS_ReadCondition, DDS_QueryCondition, and DDS_TopicQuery classes, as well as the DDS_SubscriberListener and DDS_DataReaderListener interfaces, and more generally, all that is needed on the subscription side |
| Subscribers | DDS_Subscriber entity and associated elements |
| ►DataReaders | DDS_DataReader entity and associated elements |
| Read Conditions | DDS_ReadCondition and associated elements |
| Query Conditions | DDS_QueryCondition and associated elements |
| Topic Queries | DDS_TopicQuery 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 |
| SampleProcessor | <<experimental>> <<extension>> Utility to concurrently read and process the data samples received by DDS_DataReader |
| ▼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 | Quality of Service (QoS) policies |
| ►QoS Policies | Quality of Service (QoS) policies |
| ASYNCHRONOUS_PUBLISHER | <<extension>> Specifies the asynchronous publishing settings of the DDS_Publisher instances |
| AVAILABILITY | <<extension>> Configures the availability of data |
| BATCH | <<extension>> Batch QoS policy used to enable batching in DDS_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_REPRESENTATION | <<spec>> A list of data representations and compression methods supported by a DDS_DataWriter or DDS_DataReader |
| Compression Settings | <<extension>> Compression settings that can be applied to data that is sent and received by DataWriters and DataReaders |
| DATA_TAG | <<spec>> 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 DDS_DataWriter allocates and uses physical memory for internal resources |
| DATA_WRITER_TRANSFER_MODE | <<extension>> Specifies the DataWriter transfer mode QoS |
| DEADLINE | <<spec>> Expresses the maximum duration (deadline) within which an instance is expected to be updated |
| DESTINATION_ORDER | <<spec>> Controls the criteria used to determine the logical order among changes made by DDS_Publisher entities to the same instance of data (i.e., matching DDS_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 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 DDS_DomainParticipant allocates and uses physical memory for internal resources, including the maximum sizes of various properties |
| DURABILITY | <<spec>> This QoS policy specifies whether or not RTI Connext will store and deliver previously published data samples to new DDS_DataReader entities that join the network later |
| DURABILITY_SERVICE | <<spec>> 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 | <<spec>> A QoS policy for all DDS_Entity types that can act as factories for one or more other DDS_Entity types |
| ENTITY_NAME | <<extension>> Assigns a name to a DDS_DomainParticipant, DDS_Publisher, DDS_Subscriber, DDS_DataWriter or DDS_DataReader. Except for DDS_Publisher and DDS_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 |
| HISTORY | <<spec>> 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 | <<spec>> 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 | <<spec>> Specifies how long the data written by the DDS_DataWriter is considered valid |
| LIVELINESS | <<spec>> Specifies and configures the mechanism that allows DDS_DataReader entities to detect when DDS_DataWriter 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 |
| MONITORING | <<extension>> Configures the use of RTI Monitoring Library 2.0 to collect and distribute RTI Connext telemetry data |
| MULTICHANNEL | <<extension>> Configures the ability of a DataWriter to send data on different multicast groups (addresses) based on the value of the data |
| OWNERSHIP | <<spec>> Specifies whether it is allowed for multiple DDS_DataWriter (s) to write the same instance of the data and if so, how these modifications should be arbitrated |
| OWNERSHIP_STRENGTH | <<spec>> Specifies the value of the strength used to arbitrate among multiple DDS_DataWriter objects that attempt to modify the same instance of a data type (identified by DDS_Topic + key) |
| PARTITION | <<spec>> Set of strings that introduces logical partitions in DDS_DomainParticipant, DDS_Publisher, or DDS_Subscriber entities |
| PRESENTATION | <<spec>> 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 | <<spec>> 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 | <<spec>> Indicates the level of reliability offered/requested by RTI Connext |
| RESOURCE_LIMITS | <<spec>> 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 | <<spec>> Filter that allows a DDS_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 |
| TOPIC_QUERY_DISPATCH | <<extension>> Configures the ability of a DDS_DataWriter to publish historical samples |
| TRANSPORT_BUILTIN | <<extension>> Specifies which built-in transports are used |
| ►TRANSPORT_MULTICAST | <<extension>> Specifies the multicast address on which a DDS_DataReader wants to receive its data. It can also specify a port number, as well as a subset of the available (at the DDS_DomainParticipant level) transports with which to receive the multicast data |
| Multicast Settings | <<extension>> Multicast communication settings |
| Multicast Mapping | <<extension>> 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 | <<spec>> 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_DataWriter or DDS_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 |
| Unicast Settings | <<extension>> Unicast communication settings |
| TYPE_CONSISTENCY_ENFORCEMENT | <<spec>> Defines the rules for determining whether the type used to publish a given topic is consistent with that used to subscribe to it |
| TYPESUPPORT | [DEPRECATED] <<extension>> Allows you to attach application-specific values to a DDS_DataWriter or DDS_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 | <<spec>> 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_DomainParticipant |
| ►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 |
| ►QoS Categories | Quality of Service (QoS) categories |
| Basic QoS | QoS that are considered basic and fundamental to RTI Connext |
| DDS Specification QoS | QoS that are defined in one of the OMG DDS Specifications |
| DDS Extension QoS | QoS that are RTI extensions to the DDS standard |
| ►Functional Categories | These categories help you to discover which QoS may be relevant or related to a desired functionality or feature. For example, if you are interested in Sending Large Data, then looking at any QoS in that category will be helpful |
| Application Acknowledgement | This page lists all QoS related to application acknowledgement |
| Application-Defined Metadata | This page lists QoS fields that can be used to send application-specific data during participant and endpoint discovery |
| Application Startup | Use these QoS fields to configure entity creation and application startup settings |
| Batching | Use these QoS fields to configure the batching feature |
| Concurrency | Use these QoS fields to configure threads and concurrency settings in RTI Connext |
| Content Filtering | Use these QoS fields if you are using content filtering on your data |
| Data Availability | Use these QoS fields to configure how much data, which data, and when that data is available to an application |
| Debuggability | Use these QoS to configure logging and observability capabilities to help debug RTI Connext applications |
| Discovery | Use these QoS fields to configure how applications discover each other |
| Discovery Isolation | Use these QoS fields to isolate applications from each other |
| Durability | Use these QoS fields to configure how much and how long data remains retrievable in the system |
| Flow Control | Use these QoS fields to configure features which help to control the rate at which data is sent, preventing network congestion |
| Fragmentation | QoS related to DDS-level data fragmentation |
| Instance Lifecycle | QoS that control the lifecycle of instances |
| Sending Large Data | Use these QoS fields to optimize the process of sending large data |
| Liveliness | Use these QoS fields to manage the liveliness of participants and endpoints, ensuring active communication and timely updates of the system state |
| Logging | Use these QoS fields to configure the RTI Connext logging infrastructure |
| Middleware Memory Management | Use these QoS fields to configure the memory usage of the middleware, including various initial and max limits |
| QoS Profile Management | Use these QoS fields to configure how QoS profiles are loaded and which ones should be used when entities are created |
| Reliability QoS | Reliability related QoS |
| Sample Memory Management QoS | Use these QoS fields to configure how Connext manages memory related to the samples that are stored and managed by the DataReader and DataWriter queues |
| Sample Ordering | Use these QoS fields to configure how samples are ordered when stored and accessed by a DataReader |
| Security | Use these QoS fields to enable and configure some security-related capabilities in RTI Connext |
| Throughput | Use these QoS fields to configure features which may be helpful to increase throughput |
| Transports | Use these QoS fields to configure aspects of the transports (udp, shared memory, etc.) used for communication |
| Topic Queries | Use these QoS fields to configure the topic query feature |
| Type System | Use these QoS fields to configure aspects of the type system |
| ►QoS Mutability | Some QoS are mutable after an entity is enabled, and others are not |
| Immutable QoS | This page lists all QoS that are immutable after an entity has been enabled |
| Mutable QoS | This page lists all QoS that are always mutable |
| ►Other QoS Attributes | These attributes are characteristics of the QoS – for example if they are mutable or immutable, or if they apply per-instance |
| Applied Per-Instance | These QoS are applied per-instance |
| Discovery Metadata | These QoS are sent as part of one of the built-in discovery topics |
| Matching | These QoS affect participant and endpoint matching |
| Deprecated QoS | Deprecated QoS |
| Entity Support | DDS_Entity, DDS_Listener and related items |
| ►Conditions and WaitSets | DDS_Condition and DDS_WaitSet and related items |
| AsyncWaitSet | <<extension>> A specialization of DDS_WaitSet that provides a mechanism to perform the wait asynchronously and uses a thread pool to dispatch the attached active DDS_Condition |
| 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 |
| ▼Transports | APIs related to RTI Connext pluggable transports |
| Installing Transport Plugins | Installing and configuring transports used by RTI Connext |
| ►Built-in Transport Plugins | Transport plugins delivered with RTI Connext |
| UDP Transport Plugin definitions | UDP Transport Plugin definitions |
| Shared Memory Transport | Built-in transport plug-in for inter-process communications using shared memory (NDDS_TRANSPORT_CLASSID_SHMEM) |
| UDPv4 Transport | Transport plug-in using UDP/IPv4 (NDDS_TRANSPORT_CLASSID_UDPv4) |
| Real-Time WAN Transport | Transport plug-in using UDP/IPv4 for WAN communications. (NDDS_TRANSPORT_CLASSID_UDPv4_WAN) |
| UDPv6 Transport | Transport plug-in using UDP/IPv6 (NDDS_TRANSPORT_CLASSID_UDPv6) |
| Creating New Transport Plugins | Developing new transport plugins for RTI Connext |
| Transport Plugins Configuration | Transport plugins configuration with RTI Connext |
| Transport Address | Transport-independent addressing scheme using IPv6 presentation strings and numerically stored in network-ordered format |
| Queries and Filters Syntax | |
| ▼Logging and Version | APIs of troubleshooting utilities and APIs designed to configure the overall behavior of RTI Connext |
| Version | Retrieve information for the RTI Connext product, the core library, and the C, C++ or Java libraries |
| ►Logging | Configure how much debugging information is reported during runtime and where it is logged |
| Activity Context | Add contextual information to log messages |
| ▼General Utilities and Compliance Configuration | API of general utilities used in the RTI Connext distribution |
| Compliance Configuration | APIs to configure compliance with certain standard specifications |
| Heap Monitoring | Monitor memory allocations done by the middleware on the native heap |
| Network Capture | Save network traffic into a capture file for further analysis |
| Other Utilities | Other Utilities, such as NDDS_Utility_spin |
| ▼Observability Framework | RTI Connext Observability Framework modules and APIs |
| Monitoring Library 2.0 | RTI Monitoring Library 2.0 public API |
| 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 |
| ▼Additional RTI Connext Communication Patterns | Extensions to the RTI Connext publish-subscribe functionality |
| ►Request-Reply Pattern | Support for the request-reply communication pattern |
| Requester | FooBarRequester and associated elements |
| Replier | FooBarReplier, FooBarSimpleReplier and associated elements |
| 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 |
| Interface | Abstraction of a Transport Plugin network interface |