README.md

   1 <img src="docs/logo.svg" alt="OpenDDS" width="200">
   2
   3 # OpenDDS
   4
   5 [![Coverity Scan Build Status](https://scan.coverity.com/projects/opendds/badge.svg)](https://scan.coverity.com/projects/opendds)
   6
   7 OpenDDS is an open-source C++ implementation of the Object Management Group's specification "Data Distribution Service for Real-time Systems" (DDS), as well as some other related specifications.
   8 These standards define a set of interfaces and protocols for developing distributed applications based on the publish-subscribe and distributed cache models.
   9 Although OpenDDS is itself developed in C++, Java bindings are provided so that Java applications can use OpenDDS.
  10 OpenDDS also includes support for the DDS Security and XTypes specifications.
  11
  12 OpenDDS is built on the [ACE](https://opendds.readthedocs.io/en/latest-release/devguide/building/dependencies.html#ace-tao) abstraction layer to provide platform portability.
  13 OpenDDS also leverages the capabilities of [TAO](https://opendds.readthedocs.io/en/latest-release/devguide/building/dependencies.html#ace-tao) for IDL compilation and the OpenDDS [DCPS Information Repository](https://opendds.readthedocs.io/en/latest-release/devguide/the_dcps_information_repository.html).
  14
  15 The primary development of OpenDDS was done by
  16 [Object Computing, Incorporated](http://www.objectcomputing.com) in
  17 St. Louis and Phoenix.  It is released under generous license
  18 terms similar to ACE, TAO and MPC.  See the [`LICENSE`](LICENSE) file for
  19 details.
  20
  21 **Table of Contents:**
  22
  23 * [Documentation](#documentation)
  24 * [Support](#support)
  25 * [Features](#features)
  26 * [Dependencies](#dependencies)
  27   * [ACE/TAO](#acetao)
  28   * [Perl](#perl)
  29   * [Optional Dependencies](#optional-dependencies)
  30 * [Supported Platforms](#supported-platforms)
  31   * [Operating Systems](#operating-systems)
  32   * [Compilers](#compilers)
  33 * [Building and Installing](#building-and-installing)
  34 * [Quick Start with Docker](#quick-start-with-docker)
  35
  36 ## Documentation
  37
  38 - The OpenDDS Developer's Guide is available at https://opendds.readthedocs.io/en/latest-release.
  39
  40 - For developers wanting to contribute to OpenDDS, please read [the development guidelines](https://opendds.readthedocs.io/en/master/internal/dev_guidelines.html).
  41
  42 Other documentation can be found in [`docs` directory](docs).
  43
  44 ## Support
  45
  46 For commercial support, please see https://opendds.org/support.html.
  47
  48 Questions concerning OpenDDS should be directed to [GitHub Discussions](https://github.com/OpenDDS/OpenDDS/discussions).
  49
  50 If you wish to file a bug report:
  51
  52 1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) OpenDDS on GitHub.
  53 2. Add a [minimum working example](#mwe) that demonstrates the problem.
  54 3. Create a pull request.
  55 4. Fill out the [PROBLEM-REPORT-FORM](PROBLEM-REPORT-FORM) and attach it to the pull request.
  56
  57 ### <a id="mwe">How to make a minimum working example</a>
  58
  59 1. Create a directory `tests/DCPS/MyExample` (`MyExample` is a placeholder.)
  60 2. Add the IDL, code, and configuration files for the example programs.  Be sure to exclude any proprietary information as the submitted example will be public.
  61 3. Add an MPC file that builds the test programs.
  62 4. Add a launcher script `run_test.pl`.  Be sure to document the options.  See `tests/DCPS/HelloWorld/run_test.pl` for inspiration.
  63 5. Add a `README.rst` file that gives a high-level overview of the example and the problem that it illustrates.
  64
  65 It should be possible to build and run the example using `run_test.pl` as in the quickstarts for [Windows](https://opendds.org/quickstart/GettingStartedWindows.html) and [Linux](https://opendds.org/quickstart/GettingStartedLinux.html).
  66 If the problem lies in the example, then GitHub's Pull Request interface will allow people to discuss, comment on, and propose changes to get the example working.
  67 If the problem lies in OpenDDS, then the example is a new test case.
  68
  69 ## Features
  70
  71 This release of OpenDDS is based on the DDS Specification [formal/2015-04-10
  72 (version 1.4)](https://www.omg.org/spec/DDS/1.4).  It features the following
  73 transport protocols:
  74
  75 * TCP/IP
  76 * UDP/IP
  77 * IP multicast
  78 * RTPS over UDP/IP (unicast and multicast)
  79 * Shared memory
  80
  81 RTPS (Interoperability) features are based on the [DDS-RTPS Specification
  82 formal/2019-04-03 (version 2.3)](https://www.omg.org/spec/DDSI-RTPS/2.3).  See
  83 the OpenDDS Developer's Guide and the file [docs/design/RTPS](docs/design/RTPS)
  84 for more details on RTPS.
  85
  86 See the [Developer's Guide](https://opendds.readthedocs.io/en/latest-release/devguide/building/introduction.html) for
  87 information on OpenDDS compliance with the DDS specification. If you would like
  88 to contribute a feature or sponsor the developers to add a feature please see
  89 the Support section above for contact information.
  90
  91 ## Dependencies
  92
  93 These are just the required dependencies. For a complete detailed list of
  94 dependencies, including optional ones, see
  95 https://opendds.readthedocs.io/en/latest-release/devguide/building/dependencies.html.
  96
  97 ### ACE/TAO
  98
  99 OpenDDS requires TAO for both IDL compilation as well as interaction with the
 100 DCPSInfoRepo. ACE is also required, but it is always included with TAO. If you
 101 will be using the `configure` script for OpenDDS, you do not need to download TAO
 102 first -- the `configure` script will download it for you.
 103
 104 ### Perl
 105
 106 Perl is used for the configure script, running the automated tests and examples
 107 included in this source tree, and generating Makefiles or Visual Studio project
 108 files.
 109
 110 On Windows we recommend the use of [Strawberry Perl](https://strawberryperl.com).
 111
 112 ## Supported Platforms
 113
 114 ### Operating Systems
 115
 116 This release of OpenDDS has been tested under the following platforms:
 117
 118 Linux family:
 119 * Red Hat EL and CentOS 6.6, 6.8, 6.9 (x86\_64)
 120 * Red Hat EL and CentOS 7.2, 7.3, 7.4 (x86\_64)
 121 * Red Hat EL 8.0 (x86\_64)
 122 * Fedora 24 and 31 (x86\_64)
 123 * Debian 9.4 (i686)
 124 * Ubuntu 22.04 LTS (x86\_64)
 125 * openSUSE 42.1 (x86\_64)
 126 * Yocto 3.4.4 (ARMv8)
 127
 128 Windows family:
 129 * Windows 7 (32-bit, 64-bit)
 130 * Windows Server 2012 R2 (64-bit)
 131 * Windows 10 (64-bit)
 132
 133 Embedded/Mobile/IoT:
 134 * LynxOS-178 (OpenDDS Safety Profile)
 135 * VxWorks 6.9, 7, 21.03 (see below)
 136 * [Linux on Raspberry Pi](https://opendds.org/quickstart/GettingStartedPi.html)
 137 * [Android 9.0 "Pie" (API Level 28) NDK r18b](https://opendds.readthedocs.io/en/latest-release/devguide/building/android.html)
 138
 139 We have built OpenDDS for VxWorks 6.9, 7, and 21.03 and have run basic
 140 system and performance tests (but not the entire regression test suite).
 141 Please see the [OpenDDS Support page](https://opendds.org/support.html)
 142 for more information on support for ACE, TAO, and OpenDDS on VxWorks.
 143 Download VxWorks RPM packages for ACE, TAO, and OpenDDS [here](https://objectcomputing.com/products/opendds/vxworks).
 144
 145 ### Compilers
 146
 147 This release of OpenDDS has been tested using the following compilers:
 148
 149 * Microsoft Visual C++ 10 with SP1 (Visual Studio 2010)
 150 * Microsoft Visual C++ 11 (Visual Studio 2012) - Update 4
 151 * Microsoft Visual C++ 12 (Visual Studio 2013) - Update 5
 152 * Microsoft Visual C++ 14 (Visual Studio 2015) - Update 3
 153 * Microsoft Visual C++ 14.1 (Visual Studio 2017) cl 19.16.27048
 154 * Microsoft Visual C++ 14.2 (Visual Studio 2019) cl 19.29.30146
 155 * gcc 4.4.7, 4.8.5
 156 * gcc 6.2.1, 6.3.0
 157 * gcc 7.2.0, 7.3.0, 7.5.0
 158 * gcc 8.2.0, 8.2.1
 159 * gcc 9.3.1
 160 * gcc 12.2.0
 161 * Ubuntu clang 14.0.6
 162 * Ubuntu clang 15.0.0
 163
 164 ## Building and Installing
 165
 166 For building and installation instructions see
 167 https://opendds.readthedocs.io/en/latest-release/devguide/building/index.html
 168
 169 ## Quick Start with Docker
 170
 171 See the [Docker Quick
 172 Start](https://opendds.org/quickstart/GettingStartedDocker.html) for
 173 how to use the pre-built docker image.