| Documentation Guide | |
| ▼DDS API | RTI Connext DDS Micro modules following the DDS module definitions |
| Content Filter Plugin | <<experimental>> Content Filter Plugin |
| ►Domain Module | Contains the DDS_DomainParticipant class that acts as an entrypoint of RTI Connext DDS Micro 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 DDS Micro. Testing RTI Connext DDS Micro command |
| DomainParticipantFactory | DDS_DomainParticipantFactory entity and associated elements |
| DomainParticipant | DDS_DomainParticipant entity and associated elements |
| ►Discovery | Descriptions of remote entities used for discovery |
| Participant Built-in Topic | Builtin topic for accessing information about the DomainParticipants discovered by RTI Connext DDS Micro |
| Publication Built-in Topic | Builtin topic for configuring information about the Publications to be discovered by RTI Connext DDS Micro |
| Subscription Built-in Topic | Builtin topic for configuring information about the Subscriptions to be discovered by RTI Connext DDS Micro |
| ►Topic | Contains the DDS_Topic, the DDS_TopicListener interface, and more generally, all that is needed by an application to define DDS_Topic objects and the data types that are associated with DDS_Topic objects |
| DDS-Specific Primitive Types | Basic DDS value types for use in user data types |
| Topic | 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 |
| ►Publication Module | Contains the DDS_Publisher, and DDS_DataWriter classes, and more generally, all that is needed on the publication side |
| Flow Controllers | <<eXtension>> DDS_FlowController and associated elements |
| Publisher | DDS_Publisher entity and associated elements |
| DataWriter | DDS_DataWriter entity and associated elements |
| ►Subscription Module | Contains the DDS_Subscriber, and DDS_DataReader classes, and more generally, all that is needed on the subscription side |
| Subscriber | DDS_Subscriber entity and associated elements |
| DataReader | DDS_DataReader entity and associated elements |
| ►Data Sample | 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 |
| ►Infrastructure Module | Defines the DDS infrastructure package |
| Time Support | Time and duration types and defines |
| GUID Support | GUID type and defines |
| Sequence Number Support | Sequence number type and defines |
| Return Codes | Types of return codes |
| Status Kinds | Kinds of communication status |
| ►QoS Policies | Quality of Service (QoS) policies |
| FILTER | <<experimental>> The FILTER QoS policy allows you to configure the content filter capabilities and resource limits for a DDS_DomainParticipant and all of its child entities |
| CONTENT_FILTER | <<experimental>> <<eXtension>> Filter that allows a DDS_DataReader to specify that it is interested only in (potentially) a subset of the samples on its topic |
| DISCOVERY | <<eXtension>> Specifies the attributes required to discover participants in the domain |
| USER_TRAFFIC | <<eXtension>> <<cert>> Specify user-traffic transport settings |
| DEADLINE | Expresses the maximum duration (deadline) within which an instance is expected to be updated |
| 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 |
| OWNERSHIP | 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 | 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) |
| LIVELINESS | Determines the mechanism and parameters used by the application to determine whether a DDS_Entity is alive |
| RELIABILITY | Indicates the level of reliability offered/requested by RTI Connext DDS Micro |
| HISTORY | Specifies the behavior of RTI Connext DDS Micro 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 |
| DURABILITY | <<eXtension>> Specifies the Durability properties used by a DDS_DataWriter and/or DDS_DataReader |
| DATA_REPRESENTATION | A list of data representations supported by a DDS_DataWriter or DDS_DataReader |
| RESOURCE_LIMITS | Specifies the resources that RTI Connext DDS Micro can consume in order to meet the requested QoS |
| PRESENTATION | Specifies how the samples representing changes to data instances are presented to a subscribing application |
| DESTINATION_ORDER | <<eXtension>> Specifies the DestinationOrder policy |
| ENTITY_FACTORY | A QoS policy for all DDS_Entity types that can act as factories for one or more other DDS_Entity types |
| ►Extended Qos Support | <<eXtension>> Types and defines used in extended QoS policies |
| DataReader Resource Limits | <<eXtension>> Specifies the DataReader-specific resources that RTI Connext DDS Micro can use |
| DataWriter Resource Limits | <<eXtension>> Specifies the DataWriter-specific resources that RTI Connext DDS Micro can use |
| SYSTEM_RESOURCE_LIMITS | <<eXtension>> Specifies the system-specific resources that RTI Connext DDS Micro can use |
| WIRE_PROTOCOL | <<eXtension>> Specifies the wire protocol related attributes for the DDS_DomainParticipant |
| DATA_READER_PROTOCOL | <<eXtension>> Specifies the DataReader-specific protocol QoS |
| DATA_WRITER_PROTOCOL | <<eXtension>> Specifies the DataWriter-specific protocol QoS |
| TRANSPORT | <<eXtension>> <<cert>> Specify transport settings |
| DOMAIN_PARTICIPANT_RESOURCE_LIMITS | <<eXtension>> Specifies the DomainParticipant-specific resources that RTI Connext DDS Micro can use |
| ENTITY_NAME | <<eXtension>> Name of the entity |
| PUBLISH_MODE | <<eXtension>> Specifies how RTI Connext DDS Micro sends application data on the network. This QoS policy can be used to tell RTI Connext DDS Micro to use its own thread to send data, instead of the user thread |
| PARTITION | The PARTITION QoS policy provides a method to prevent Entities that have otherwise compatible Qos policies from matching with each other and thus communicating with each other |
| PROPERTY | <<eXtension>> Stores (name, value) pairs that can be used to configure certain parameters of RTI Connext DDS Micro that are not exposed through formal QoS policies |
| USER_DATA | The USER_DATA QoS policy allows the user to attach a buffer of opaque data to a DDS_DomainParticipant, DDS_DataWriter, or DDS_DataReader. How this information is used will be up to user code; RTI Connext DDS Micro distributes this information to other applications as part of the discovery process, but RTI Connext DDS Micro does not interpret the information |
| GROUP_DATA | The GROUP_DATA QoS policy allows you to attach a buffer of opaque data to a DDS_Publisher or DDS_Subscriber. How this information is used will be up to user code; RTI Connext DDS Micro distributes this information to other applications as part of the discovery process, but RTI Connext DDS Micro does not interpret the information |
| TOPIC_DATA | The TOPIC_DATA QoS policy allows the user to attach a buffer of opaque data to a DDS_Topic. How this information is used will be up to user code; RTI Connext DDS Micro distributes this information to other applications as part of the discovery process, but RTI Connext DDS Micro does not interpret the information |
| DATA_WRITER_TRANSFER_MODE | <<eXtension>> Specifies the DataWriter transfer mode QoS |
| Conditions and WaitSets | DDS_Condition and DDS_WaitSet and related items |
| Entity Support | DDS_Entity, DDS_Listener and related items |
| Sequence Support | Defines sequence interface and primitive data types sequences |
| Exception codes | Exception codes |
| Type Support | Type Plugin |
| String Support | String creation, cloning, assignment, and deletion |
| ►General Utilities and Compliance Configuration | |
| Compliance Configuration | APIs to configure compliance with certain standard specifications |
| Property Reference | This is the property reference for RTI Connext DDS Micro |
| DPSE Static Discovery API | |
| DPDE Dynamic Discovery API | |
| CDR Stream API | |
| RT Run-Time API | |
| RHSM Reader History API | |
| WHSM Writer History API | |
| ▼NETIO API | <<eXtension>> <<cert>> The NETIO API |
| NETIO Packet API | NETIO_Packet implementation |
| NETIO Interface API | |
| NETIO Address API | |
| UDP Transport API | |
| UDP Transform API | |
| RTPS Transport API | |
| ▼Shared Memory Transport API | |
| ►NETIO Shared Memory API | OS independent way to setup and access shared-memory segments, shared-memory mutexes and shared memory binary semaphores |
| Shared Memory Mutex API | |
| Shared Memory Segment API | Allow access to a shared memory segment (memory block) so that multiple processes can read-and write a common memory area |
| Shared Memory Signaling Semaphore | |
| NETIO DGRAM API | NETIO DGRAM Interface |
| ▼Zero Copy v2 API | NETIO Zero Copy v2 interface |
| Notification Interface | ZCOPY Notification Interface |
| ▼OS API | |
| OSAPI Heap | |
| OSAPI Mutex | Mutex API |
| OSAPI Process | Abstract Process API |
| OSAPI Semaphore | Abstract Semaphore API |
| OSAPI Memory API | |
| OSAPI String API | |
| OSAPI System API | Abstract System API |
| OSAPI Thread API | OSAPI Thread API |
| OSAPI Time | |
| OSAPI Timer | |
| OSAPI Types | OSAPI Types |
| OSAPI_SharedMemoryMonitor | A shared memory monitor to provide mutual exclusion between processes and inter-process signaling |
| OSAPI_SharedMemorySegment | Allow access to a shared memory segment (memory block) so that multiple processes can read-and write a common memory area |
| Log API | |
| Application Generation API | |
| Lightweight Security API | Lightweight Security Plugin API |
| ▼Resource Limits | |
| ►DomainParticipantFactoryQos | |
| max_components | |
| max_participants | |
| ►DomainParticipantQos | |
| local_topic_allocation | |
| local_type_allocation | |
| local_publisher_allocation | |
| local_subscriber_allocation | |
| local_reader_allocation | |
| local_writer_allocation | |
| matching_writer_reader_pair_allocation | |
| remote_participant_allocation | |
| remote_writer_allocation | |
| remote_reader_allocation | |
| max_destination_ports | |
| max_receive_ports | |
| ►DataReaderQos | |
| max_instances | |
| max_remote_writers_per_instance | |
| max_samples | |
| max_samples_per_instance | |
| max_remote_writers | |
| max_samples_per_remote_writer | |
| max_routes_per_writer | |
| max_outstanding_reads | |
| max_fragmented_samples | |
| max_fragmented_samples_per_remote_writer | |
| ►DataWriterQos | |
| max_samples | |
| max_samples_per_instance | |
| max_instances | |
| max_routes_per_reader | |
| max_remote_readers | |
| ►OSAPI | |
| max_buffer_size | |
| ►UDP Transport | |
| max_message_size | |
| ►Dynamic Participant Static Endpoint (DPSE) | |
| max_participant_locators | |
| max_locators_per_discovered_participant | |
| ►Dynamic Participant Dynamic Endpoint (DPDE) | |
| max_participant_locators | |
| max_locators_per_discovered_participant | |
| max_samples_per_builtin_endpoint_reader | |
| ▼Log Codes | |
| OSAPI | OSAPI. ModuleID = 0 |
| REDA | Real-time Efficient Data Structures and Algorithms. ModuleID = 1 |
| DB | Database. ModuleID = 2 |
| RT | RT. ModuleID = 3 |
| CDR | CDR. ModuleID = 5 |
| NETIO | Network I/O. ModuleID = 4 |
| RTPS | Real-Time Publish-Subscribe. ModuleID = 6 |
| DDS_C | DDS C. ModuleID = 7 |
| WHSQ | Writer History Shared Queue. ModuleID = 22 |
| RH | Reader History. ModuleID = 8 |
| WH | Writer History. ModuleID = 9 |
| DPSE | DPSE. ModuleID = 10 |
| DPDE | DPDE. ModuleID = 11 |
| APPGEN | APPGEN. ModuleID = 13 |
| DDS_FILTER | DDS Filter. ModuleID = 16 |
