Skip to content

Latest commit

 

History

History
241 lines (171 loc) · 8.31 KB

README.md

File metadata and controls

241 lines (171 loc) · 8.31 KB
Raw

OpenDDS

Build Status Build status Coverity Scan Build Status Codacy Badge Azure DevOps

OpenDDS is an open-source C++ implementation of the Object Management Group's specification "Data Distribution Service for Real-time Systems". Although OpenDDS is itself developed in C++, Java and JMS bindings are provided so that Java applications can use OpenDDS. OpenDDS also includes support for the DDS Security specification.

OpenDDS is built on the ACE abstraction layer to provide platform portability. OpenDDS also leverages capabilities of TAO, such as its IDL compiler and as the basis of the OpenDDS DCPS Information Repository (DCPSInfoRepo).

The primary development of OpenDDS was done by Object Computing, Incorporated in St. Louis and Phoenix. It is released under the same generous license terms as ACE, TAO and MPC. See the LICENSE file for details.

Table of Contents:

Documentation

Other documentation can be found in docs directory.

Support

If you encounter any problems with this release please fill out the PROBLEM-REPORT-FORM file found in this directory and use it when posting to the mailing list or creating a GitHub Issue.

For commercial support please see http://opendds.org/support.html.

Features

This release of OpenDDS is based on the DDS Specification formal/2015-04-10 (version 1.4). It features the following transport protocols:

  • TCP/IP
  • UDP/IP
  • IP multicast
  • RTPS over UDP/IP (unicast and multicast)

RTPS (Interoperability) features are based on the DDS-RTPS Specification formal/2014-09-01 (version 2.2). See the OpenDDS Developer's Guide and the file docs/design/RTPS for more details on RTPS.

See the Developer's Guide for information on OpenDDS compliance with the DDS specification. If you would like to contribute a feature or sponsor the developers to add a feature please see the Support section above for contact information.

Dependencies

For a complete detailed list of dependencies, see docs/dependencies.md.

TAO

OpenDDS requires TAO for both IDL compilation as well as interaction with the DCPSInfoRepo. If you will be using the "configure" script for OpenDDS (see the INSTALL.md file for details), you do not need to download TAO first -- the "configure" script will download it for you.

Use one of the following versions when building OpenDDS:

Perl

Perl is used for the configure script, running the automated tests and examples included in this source tree, and generating Makefiles or Visual Studio project files.

On Windows we recommend the use of ActiveState Perl.

Google Test

Starting with OpenDDS 3.14, Google Test is required for OpenDDS tests. Tests are built by default so that means Google Test is required unless --no-tests is passed to configure.

Supported Platforms

Operating Systems

This release of OpenDDS has been tested under the following platforms:

Linux family:

  • Red Hat EL and CentOS 6.6 and 6.9, x86_64
  • Red Hat EL and CentOS 7.2 and 7.3, x86_64
  • Fedora 24 and 29, x86_64
  • Debian 9.4, i686
  • Ubuntu 16.04 LTS, x86_64
  • openSUSE 42.1, and 42.2, x86_64

Windows family:

  • Windows 7 (32-bit, 64-bit)
  • Windows Server 2012 R2 (64-bit)
  • Windows 10 (64-bit)

Others:

  • macOS 10.13 (High Sierra)

Embedded/Mobile/IoT:

  • LynxOS-178 (OpenDDS Safety Profile)
  • VxWorks 6.9 and 7 (see below)
  • Linux on Raspberry Pi
  • Android

We have built OpenDDS for VxWorks 6.9 and 7 and have run basic system and performance tests (but not the entire regression test suite). Please contact [email protected] or [email protected] for more information on support for ACE, TAO, and OpenDDS on VxWorks. OCI's packages for ACE, TAO, and OpenDDS can be obtained on the Wind River Marketplace.

Compilers

This release of OpenDDS has been tested using the following compilers:

  • Microsoft Visual C++ 9 with SP1 (Visual Studio 2008)
  • Microsoft Visual C++ 10 with SP1 (Visual Studio 2010)
  • Microsoft Visual C++ 11 (Visual Studio 2012) - Update 4
  • Microsoft Visual C++ 12 (Visual Studio 2013) - Update 5
  • Microsoft Visual C++ 14 (Visual Studio 2015) - Update 3
  • Microsoft Visual C++ 14.1 (Visual Studio 2017) cl 19.12.25835
  • gcc 4.4.7, 4.8, 4.9
  • gcc 5.4
  • gcc 6.2, 6.3
  • gcc 7.2
  • gcc 8.1, 8.2
  • Clang 6.0 (llvm.org) and 9.0 (Apple)

Building and Installing

For building and installation instructions see the INSTALL.md file in this directory.

Quick Start with Docker

Docker images containing a pre-built OpenDDS are available on DockerHub. An image corresponding to a particular release has a tag of the form release-DDS-X.xx, e.g., release-DDS-3.12.

  1. Check for prerequisites

     docker --version
 docker-compose --version

  2. Enter a container

     docker run --rm -ti -v "$PWD:/opt/workspace" objectcomputing/opendds

  3. Copy the Messenger directory which contains an example from the Developer's Guide

     cp -R /opt/OpenDDS/DevGuideExamples/DCPS/Messenger Messenger
 cd Messenger

  4. Configure and build the Messenger example

     mwc.pl -type gnuace
 make

  5. Exit the container

     exit

  6. Enter the Messenger directory

     cd Messenger

  7. Create an rtps.ini file to control discovery with the following content

     [common]
 DCPSGlobalTransportConfig=$file
 DCPSDefaultDiscovery=DEFAULT_RTPS

 [transport/the_rtps_transport]
 transport_type=rtps_udp

  8. Run the Messenger example with RTPS

     docker-compose up

  9. Run the Messenger example with InfoRepo

     docker-compose -f docker-compose-inforepo.yml up
 # Use Control-C to kill the InfoRepo process