Developer’s Guide#

The Developer’s Guide explains how to use OpenDDS.

About This Guide
- Conventions
- DDS_ROOT
- Examples
Quick Start Guides
- Windows
- Linux/macOS
- Raspberry Pi
- Docker
Introduction to DDS
- Basic Concepts
- Discovery, Matching, and Association
- Quality of Service Policies
- Conceptual Data Flow
- Built-in Topics (BITs)
- Listeners
- Conditions
Shapes Demo
- Environment Prerequisites
- Running the Shapes Demo
- Example Scenarios
- Conclusion
- Next Steps
Introduction to OpenDDS
- What is OpenDDS?
- Licensing Terms
- Specifications
- Compliance
- Extensions to the DDS Specification
- OpenDDS Implementation and Architecture
Building and Installing
- Supported Platforms
- Configuring and Building
- Installation
  - Using an Installed OpenDDS
- Tests
- Building Applications that use OpenDDS
- Building OpenDDS Using CMake
Getting Started
- Using DCPS
- Data Handling Optimizations
Quality of Service
- Changing QoS Policies
- Default QoS Policy Values
- Policies
- Policy Example
Conditions and Listeners
- Introduction
- Communication Status Types
- Listeners
- Conditions
  - Status Condition
    - Status Condition Example
  - Additional Condition Types
Content-Subscription Profile
- Introduction
- Content-Filtered Topic
- Query Condition
  - Query Expressions
  - Query Condition Example
- Multi Topic
Built-in Topics
- Introduction
- Built-in Topics for DCPSInfoRepo Configuration
- DCPSParticipant Topic
- DCPSTopic Topic
- DCPSPublication Topic
- DCPSSubscription Topic
- Built-in Topic Subscription Example
- OpenDDS-specific Built-in Topics
Run-time Configuration
- Configuration Approach
- Common Configuration Properties
  - common
- Discovery Configuration
- Transport Configuration
- ICE Configuration
  - ice
- Discovery and Transport Configuration Templates
- Logging
opendds_idl
- opendds_idl Command Line Options
- Using the IDL-to-C++11 Mapping
The DCPS Information Repository
- DCPS Information Repository Options
- Repository Federation
  - Federation Management
  - Federation Example
    - Configuring the Federation Example
    - Running the Federation Example
Java Bindings
- Introduction
- IDL and Code Generation
- Setting up an OpenDDS Java Project
- A Simple Message Publisher
- Setting up the Subscriber
  - Creating a Subscriber
  - Creating a DataReader and Listener
- The DataReader Listener Implementation
- Cleaning up OpenDDS Java Clients
- Configuring the Example
- Running the Example
- Java Message Service (JMS) Support
Modeling SDK
- Overview
- Installation and Getting Started
- Developing Applications
Alternate Interfaces to Data
- Recorder and Replayer
- Observer
Safety Profile
- Overview
- Safety Profile Subset of OpenDDS
- Safety Profile Configurations of ACE
- Run-time Configurable Options
- Running ACE and OpenDDS Tests
- Using the Memory Pool in Applications
DDS Security
- Building OpenDDS with Security Enabled
- Architecture of the DDS Security Specification
- Terms and Background Info
- Required DDS Security Artifacts
  - Per-Domain Artifacts
  - Per-Participant Artifacts
- Required OpenDDS Configuration
- Common XML Elements
  - Domain Id Set
- Domain Governance Document
- Participant Permissions Document
  - Key Permissions Elements
  - Permissions XML Example
- DDS Security Implementation Status
Internet-Enabled RTPS
- Overview
- The RtpsRelay
- Interactive Connectivity Establishment (ICE) for RTPS
- Security Considerations
XTypes
- Overview
- Features
- Examples and Explanation
- Data Representation
- Type Consistency Enforcement
- IDL Annotations
- Dynamic Language Binding
- Unimplemented Features
- Differences from the specification
FAQ
- General
- Obtaining and building OpenDDS
  - How do I obtain, configure, and build OpenDDS?
  - What could be causing std lib related build failures on Linux?
- Configuring OpenDDS
- Built-In Topics (BITs)
- Using IDL
  - How do I use sequences of built-in types in IDL?
- Using the OpenDDS Modeling SDK
- Using the DDS DCPS API
Annex
- Fnmatch Expressions