Skip to content

Latest commit

 

History

History
172 lines (120 loc) · 6.48 KB

dependencies.md

File metadata and controls

172 lines (120 loc) · 6.48 KB
Raw

OpenDDS Dependencies

Required to Build the Core OpenDDS Libraries

NOTE: Perl is required to run the configure script; MPC, ACE, and TAO will be downloaded automatically by the configure script by default.

Perl

Perl is an interpreted language used in the configure script, the tests, and any other scripting in OpenDDS codebase. Even if the configure script is not used, it is also required to run MPC, so it is required to build OpenDDS.

Testing scripts are written in Perl and use the common PerlACE modules provided by ACE. For scripts that will be part of automated testing, don't assume the presence of any non-standard (CPAN) modules. Perl offers many facilities for portability. Shell scripts are by definition non-portable and should not to be committed to the OpenDDS repository.

MPC

MPC is the build system used by OpenDDS, used to configure the build and generate platform specific build files (Makefiles, VS solution files, etc.).

The official repository is hosted on Github at DOCGroup/MPC.

ACE

ACE is the platform abstraction layer used by OpenDDS. It is used both directly and through TAO. Facilities not provided by the C++ 2003 standard library, for example sockets, threads, and dynamic library loading, are provided by ACE.

Some other features OpenDDS relies on ACE for:

  • ACE provides the gnuace type used by MPC for generating Makefiles for OpenDDS
  • ACE contains a script, generate_export_file.pl, which is used (along with MPC) to manage shared libraries' symbol visibility (also known as export/import)
    • See ACE documentation and usage guidelines for details
    • ACE logging is used (ACE_Log_Msg and related classes).
    • ACE logging uses a formatting string that works like std::printf() but not all of the formatting specifiers are the same as printf(). Please read the ACE_Log_Msg documentation before using.
  • The most commonly misused one is %s for char* strings. ACE uses %C for char* strings.
  • ACE has classes and macros for wide/narrow string conversion. See docs/design/WCHAR in the OpenDDS repository for details.
  • ACE provides support for platforms that have a non-standard program entry point (main). All of our main functions are int ACE_TMAIN(int argc, ACE_TCHAR* argv[]).

The OCI page for ACE is https://objectcomputing.com/products/ace.

The upstream DOC Group repository is hosted on Github at DOCGroup/ACE_TAO, which it shares with TAO.

TAO

TAO is a C++ CORBA Implementation built on ACE.

  • TAO provides the tao_idl IDL compiler and non-generated classes which implement the IDL-to-C++ mapping.
  • TAO ORBs are only created for interaction with the DCPSInfoRepo, all other uses of TAO are basic types and local interfaces.
  • A separate library, OpenDDS_InfoRepoDiscovery, encapsulates the participant process's use of the ORB
    • This is the only library which depends on TAO_PortableServer

The OCI page for TAO is https://objectcomputing.com/products/tao.

The upstream DOC Group repository is hosted on Github at DOCGroup/ACE_TAO, which it shares with ACE.

Optional Dependencies

CMake

OpenDDS has a CMake FindPacakge module included. See cmake.md for how to make OpenDDS applications with CMake and without the need to use MPC in your application.

CMake is required to build Google Test for OpenDDS tests if a prebuilt Google Test is not found or provided. You can forgo having to have CMake by passing --no-tests to the OpenDDS configure script or building and/or installing Google Test separately.

See ../tests/gtest_setup.txt for details.

Google Test

Google Test is required for OpenDDS tests. You can forgo this dependency by passing --no-tests to the OpenDDS configure script.

Google Test is a git submodule that will be downloaded automatically if the repository was recursively cloned or submodules were initialized separately.

If OpenDDS was downloaded from opendds.org or another source that's not a git repository, Google Test will have to be downloaded separately and configured manually.

Google Test is available as package, at least in Debian based Linux distributions.

See ../tests/gtest_setup.txt for details.

Java

OpenDDS has optional Java bindings. It requires the Java Development Kit (JDK). See ../java/README.

There is also support for Java Message Server (JMS) v1.1. In addition to the JDK, it requires Ant and JBoss 4.2.x. See ../java/jms.

Qt

Qt5 is used for the monitor utility program and the ishapes RTPS demo.

See qt.md for details on configuring OpenDDS to use Qt.

Wireshark

A Wireshark dissector plugin for OpenDDS' non-RTPS transports is included with OpenDDS. The dissector supports Wireshark 1.2 and onwards and supports displaying and filtering by sample contents and from Wireshark 1.12 onwards.

Because of Wireshark's use of Glib, Glib is also required to build the dissector.

See ../tools/dissector/README.md for details.

RapidJSON

RapidJSON is a C++ JSON Library used for generating in ITL and RapidJSON type support. ITL is the Wireshark dissector for sample dissection. Samples are described in what is called the Intermediate Type Language (ITL) which is JSON that can be generated by opendds_idl from IDL files. RapidJSON support is enabled by default unless --no-rapidjson was passed.

See ../tools/dissector/README.md#sample-dissection for details.

RapidJSON is a git submodule that will be downloaded automatically if the repository was recursively cloned or submodules were initialized separately.

If OpenDDS was downloaded from opendds.org or another source that's not a git repository, RapidJSON will have to be downloaded separately and configured manually.

RapidJSON is available as package, at least in Debian based Linux distributions.

Boost

Boost, as of writing, is just an optional dependency of the ishapes RTPS demo and only if C++11 is not available.

Xerces

Apache Xerces ("Xerces 3 C++" specifically) is used for parsing QoS XML and security XML configuration files.

OpenSSL

OpenSSL is used for DDS Security for verifying security configurations and encryption and decryption. Version 1.0 and version 1.1 are supported.