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 most 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.
Perl should be 5.18 or newer and be available on the system PATH
.
Older versions of Perl will probably work, but are not tested anymore.
Strawberry Perl is recommended for Windows.
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.
Perl core modules are a required part of Perl.
Some Linux distributions install the Perl interpreter without including core modules.
Using OpenDDS with this sort of partial Perl installation may fail unexpectedly when using configure, MPC, make depend
, or test scripts.
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.
It is included in the release archive of ACE/TAO, which is downloaded by the configure script by default.
ACE/TAO#
The DOC Group repository for ACE/TAO is hosted on Github at DOCGroup/ACE_TAO.
There are two versions of ACE/TAO that are officially supported by OpenDDS in this release (3.28.0):
- DOC Group ACE 6.5.20/TAO 2.5.20
The configure script will download this version by default. CMake will download this version if
OPENDDS_ACE_TAO_KIND
is set toace6tao
.Pass
--ace-github-latest
to the configure script to clone theace6tao2
branch of ACE/TAO as is. This also clones themaster
branch of MPC as is. CMake will do the same ifOPENDDS_ACE_TAO_KIND
is set toace6tao
andOPENDDS_ACE_TAO_GIT
is set toTRUE
.
- DOC Group ACE 7.1.3/TAO 3.1.3
Pass
--doc-group3
to the configure script to download this version. CMake will download this version by default.This version requires a C++14-capable compiler.
Pass
--ace-github-latest
to the configure script to clone themaster
branch of ACE/TAO as is. This also clones themaster
branch of MPC as is. CMake will do the same ifOPENDDS_ACE_TAO_GIT
is set toTRUE
.
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 OpenDDSACE 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).This is used through the
ACE_DEBUG
andACE_ERROR
macros.ACE logging uses a formatting string that works like
std::printf()
but not all of the formatting specifiers are the same asprintf()
. Please read theACE_Log_Msg
documentation before using.The most commonly misused formatting specifier is
%s
. Inprintf
this is forchar*
C strings, but inACE_Log_Msg
this is forACE_TCHAR*
C strings.ACE_TCHAR
can bechar
or a wide character depending on how ACE was built (see next point).%C
should be used for strings that are alwayschar*
, likestd::string::c_str()
.
ACE has classes and macros for wide/narrow string conversion. See
docs/design/WCHAR
for details.ACE provides support for platforms that have a non-standard program entry point (
main
). All of ourmain
functions areint ACE_TMAIN(int argc, ACE_TCHAR* argv[])
.
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 TAO Developer’s Guide book can be requested for free from https://objectcomputing.com/products/tao/tao-developers-guide. The CORBA Programmers Guide can be downloaded for free from https://www.remedy.nl/opensource/corbapg.html.
Optional Dependencies#
CMake#
OpenDDS has a package included for CMake. See Using OpenDDS in a CMake Project for how to build OpenDDS applications with CMake and without the need to use MPC in your application.
CMake is required to build GoogleTest for OpenDDS tests if a prebuilt GoogleTest is not found or provided.
See tests/gtest_setup.txt
for details.
CMake should be version 3.3 or later for Using OpenDDS in a CMake Project. It should be version 3.23 or later for Building OpenDDS Using CMake.
GoogleTest#
GoogleTest is required for OpenDDS tests.
GoogleTest is a git submodule that will be downloaded automatically if the repository was recursively cloned or submodules were initialized separately.
Note
If OpenDDS is not a git repository or Git isn’t available, GoogleTest will have to be downloaded separately and configured manually.
See tests/gtest_setup.txt
for details.
Java#
OpenDDS has optional Java bindings. It requires the Java Development Kit (JDK).
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/README
.
Qt#
Qt5 is used for the tools/monitor
utility program and the examples/DCPS/ishapes
RTPS demo.
See docs/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 sample dissection in the Wireshark dissector and RapidJSON type support.
Support for RapidJSON, if available, is enabled by default unless --no-rapidjson
was passed.
RapidJSON is a git submodule that will be downloaded automatically if the repository was recursively cloned or submodules were initialized separately.
Note
If OpenDDS is not a git repository or Git isn’t available, RapidJSON will have to be downloaded separately and configured manually.
Xerces#
Apache Xerces (“Xerces 3 C++” specifically) is used for parsing QoS XML and DDS Security XML configuration files.
OpenSSL#
OpenSSL is used for DDS Security for verifying security configurations and encryption and decryption. Versions 1.0, 1.1 and 3.0 (3.0.1 or later) are supported.
Python#
Python is used for some scripts where Perl isn’t as suitable.
Most notably this includes this Sphinx-based documentation and processing the results of the CMake tests in tests/auto_run_tests.pl
if --cmake
is passed.
Unless noted otherwise, Python should be version 3.10 or later.
Because it’s an optional dependency, Python should not be required for any script used for building and testing the core functionality of OpenDDS. Right now only Perl can be used for situations like that.