1. Upgrade Overview¶
See Upgrade Path at the beginning of this document.
1.1. Upgrade Steps¶
Whenever upgrading to a new, major release, you must regenerate the type-specific code that was generated from your IDL, XML, or XSD definitions with the new version of rtiddsgen, then recompile and re-link your applications with the new versions of the Connext DDS libraries. The basic steps are as follows:
Make the changes required for your system, based on the compatibility issues described in this guide:
See the “Product-Specific Compatibility” section for your release, for issues that affect your products.
See the “General Compatibility” section for your release. This section is particularly important if your release will coexist with older releases.
See Regressions for any issues that may apply to you.
Regenerate code as described in Section 1.2.1.
Recompile your source as described in Section 1.2.2.
If you had early access to a pre-release version of Connext 6.1.0, delete
(or move or rename) the
rti_workspace/6.1.0 directory before
1.2. Regenerating and Recompiling¶
1.2.1. Generated code compatibility¶
For Connext DDS applications defining types in IDL, XML, or XSD, moving from a previous Connext DDS version to Connext DDS 6.0.0, 6.0.1, or 6.1.0 requires code regeneration and recompilation.
You will need to regenerate the code for your application types using the RTI Code Generator shipped with your release (6.0.0, 6.0.1, or 6.1.0). The regeneration process is simple; you only need to run the new version of Code Generator using the original input IDL file. For example:
rtiddsgen -language C++11 -update typefiles your_previous_release_IDL.idl
You should see a message that says you are running rtiddsgen version 3.0.0 if you are upgrading to 6.0.0, rtiddsgen version 3.0.1 if you are upgrading to 6.0.1, or rtiddsgen version 3.1.0 if you are upgrading to 6.1.0.
This process will regenerate the header and source files, which can then be compiled along with the rest of your application.
1.2.2. Application Binary Interface¶
RTI Connext DDS does not provide Application Binary Interface (ABI) compatibility with previous versions of Connext DDS. Therefore, an application compiled using a previous version of Connext DDS must be recompiled when moving to Connext DDS 6.0.0, 6.0.1, or 6.1.0.
The Connext DDS core primarily consists of libraries and a set of header files. In most cases, upgrading simply requires you to recompile your source using the new header files and link your application with the new libraries. In some cases, minor modifications to your application code might be required; any such changes are noted in this Migration Guide.
After you make modifications to your application code, recompile your source using the new header files and link the new libraries.