An implementation of the ISO/IEC C++ PSM, or simply put, a C++ binding for Eclipse Cyclone DDS. Cyclone DDS is developed completely in the open as an Eclipse IoT project (see eclipse-cyclone-dds) with a growing list of adopters (if you're one of them, please add your logo). It is a tier-1 middleware for the Robot Operating System ROS 2.
In order to build the C++ binding for Cyclone DDS you need a Linux, Mac or Windows 10 machine (or, with some caveats, a *BSD, OpenIndiana one) with the following installed on your host:
- C and C++ compilers (most commonly GCC on Linux, Visual Studio on Windows, Xcode on macOS);
- Git version control system;
- CMake, version 3.16 or later;
- Eclipse Cyclone DDS
Eclipse Cyclone DDS has dependencies of its own, most notably Bison. To
build and install it, please consult the build instructions. Ensure the
project is installed into a location convenient for you by specifying
CMAKE_INSTALL_PREFIX.
To obtain the C++ binding for Cyclone DDS, do
$ git clone https://github.com/eclipse-cyclonedds/cyclonedds-cxx.git
$ cd cyclonedds-cxx
$ mkdir build
Depending on whether you want to develop applications using the C++ binding for Cyclone DDS or contribute to it you can follow different procedures.
There are some configuration options specified using CMake defines in addition to the standard options like CMAKE_BUILD_TYPE:
-DBUILD_DDSLIB=OFF: to disable DDS lib build, useful in crosscompiling scenarios where you only need the generator and use the DDS lib from another build.-DBUILD_IDLLIB=OFF: to disable IDL preprocessor lib build-DBUILD_DOCS=ON: to build the documentation-DBUILD_TESTING=ON: to build the testing tree-DBUILD_EXAMPLES=ON: to build examples-DENABLE_LEGACY=YES: to enable legacy c++11 mode, adds boost as dependency (otherwise it uses c++17)-DENABLE_ICEORYX=YES: to enable Iceoryx tests-DENABLE_TYPELIB=YES: to enable type library support-DENABLE_TOPIC_DISCOVERY=YES: to enable topic discovery support-DENABLE_COVERAGE=YES: to enable coverage build-DENABLE_QOS_PROVIDER=YES: to enable qos provider support
To build and install the required libraries needed to develop your own applications using the C++ binding for Cyclone DDS requires a few simple steps. There are some small differences between Linux and macOS on the one hand, and Windows on the other. For Linux or macOS:
$ cd build
$ cmake -DCMAKE_INSTALL_PREFIX=<install-location> \
-DCMAKE_PREFIX_PATH="<cyclonedds-install-location>" \
..
$ cmake --build .
and for Windows:
$ cd build
$ cmake -G "<generator-name>" \
-DCMAKE_INSTALL_PREFIX=<install-location> \
-DCMAKE_PREFIX_PATH="<cyclonedds-install-location>" \
..
$ cmake --build .
where you should replace <install-location> by the directory under which you
would like to install the C++ binding for Cyclone DDS and <generator-name>
by one of the ways CMake generators offer for generating build files. For
example, "Visual Studio 15 2017 Win64" would target a 64-bit build using
Visual Studio 2017.
To install it after a successful build, do:
$ cmake --build . --target install
Which will copy everything to:
<install-location>/lib<install-location>/bin<install-location>/include/ddsc<install-location>/share/CycloneDDS-CXX
Depending on the installation location you may need administrator privileges.
At this point you are ready to use Eclipse Cyclone DDS in your own projects.
Note that the default build type is a release build with debug information
included (RelWithDebInfo), which is generally the most convenient type of
build to use from applications because of a good mix between performance and
still being able to debug things. If you'd rather have a Debug or pure Release
build, set CMAKE_BUILD_TYPE accordingly.
We very much welcome all contributions to the project, whether that is
questions, examples, bug fixes, enhancements or improvements to the
documentation, or anything else really. When considering contributing code,
it might be good to know that build configurations for Travis CI and AppVeyor
are present in the repository and that there is a test suite using CTest and
Google Test that can be built locally if desired. To build it, set the cmake
variable BUILD_TESTING to on when configuring, e.g.:
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON ..
$ cmake --build .
$ ctest
Such a build requires the presence of Google Test. You need to install this yourself.
The documentation is still rather limited, and at the moment only available in
the sources (in the form of restructured text files in docs and Doxygen
comments in the header files). The intent is to automate the process of
building the documentation and have them available in more convenient formats
and in the usual locations.
We will show you how to build and run an example program that illustrates the necessary steps to setup DCPS entities. The examples are built automatically when you build the C++ language binding for Cyclone DDS, so you don't need to follow these steps to be able to run the program, it is merely to illustrate the process.
$ mkdir helloworld
$ cd helloworld
$ cmake <install-location>/share/CycloneDDS-CXX/examples/helloworld
$ cmake --build .
On one terminal start the application that will be responding to messages:
$ ./ddscxxHelloWorldSubscriber
On another terminal, start the application that will be sending the messages:
$ ./ddscxxHelloWorldPublisher
- "Eclipse Cyclone DDS" and "Cyclone DDS" are trademarks of the Eclipse Foundation.
- "DDS" is a trademark of the Object Management Group, Inc.
- "ROS" is a trademark of Open Source Robotics Foundation, Inc.
This project contains 2 types of license: Apache2 and Eclipse Public License / Eclipse Distribution License
- The Apache2 license located in src/ddscxx/include/dds is for all files under src/ddscxx/include/dds except the details directories
- Eclipse Public License / Eclipse Distribution License is valid for all other files.