A Guide to the Provided Documentation

This document will introduce you to the power and flexibility of Connext DDS. We invite you to explore further by referring to the wealth of available information, examples, and resources:

The Connext DDS documentation includes:

• RTI Connext DDS Core Libraries Getting Started Guide—This document describes how to install the Connext DDS core libraries and utilities. It also lays out the benefits and concepts behind the product and takes you step-by-step through the creation of a simple example application. Developers should read this document first.

• If you want to use the Connext DDS Extensible Types feature, please read:
  • Addendum for Extensible Types —Extensible Types allow you to define DDS data types in a more flexible way. Your DDS data types can evolve over time—without giving up portability, interoperability, or the expressiveness of the DDS type system.
• If you are using Connext DDS on an Android or embedded platform, or with a database, you will find additional documents that specifically address these configurations:
  • Addendum for Android Systems
  • Addendum for Embedded Systems
  • Addendum for Database Setup
• What’s New—This document describes changes and enhancements in the current version of Connext DDS. If you are upgrading from a previous version, read this document first.
• Release Notes and Platform Notes—These documents provide system requirements, compatibility, and other platform-specific information about the product, including specific information required to build your applications using Connext DDS, such as compiler flags and libraries.
• User’s Manual—This document describes the features of the product and how to use them. It is organized around the structure of the Connext DDS APIs and certain common high-level tasks.
• API Reference HTML Documentation (ReadMe.html)—This extensively cross-referenced documentation, available for all supported programming languages, is your in-depth reference to every operation and configuration parameter in the middleware. Even experienced Connext DDS developers will often consult this information.
• The Programming How To's provide a good place to begin learning the APIs. These are hyper-linked code snippets to the full API documentation. From the ReadMe.html file, select one of the supported programming languages, then scroll down to the Programming How To’s. Start by reviewing the Publication Example and Subscription Example, which provide step-by step examples of how to send and receive data with Connext DDS.

Many readers will also want to look at additional documentation available online. In particular, RTI recommends the following:

• Use the RTI Customer Portal (http://support.rti.com/) to download RTI software, access documentation and contact RTI Support. The RTI Customer Portal requires a username and password. You will receive this in the email confirming your purchase. If you do not have this email, please contact license@rti.com. Resetting your login password can be done directly at the RTI Customer Portal.

• The RTI Community website (http://community.rti.com) provides a wealth of knowledge to help you use Connext DDS, including:
  • Best Practices
  • Example code for specific features, as well as more complete use-case examples,
  • Solutions to common questions,
  • A glossary,
  • Downloads of experimental software,
  • And more.
• Whitepapers and other articles are available from http://www.rti.com/resources

Of course, RTI also offers excellent technical support and professional services. To contact RTI Support, simply log into the Customer Portal, send email to support@rti.com, or call the telephone number provided for your region.

© 2015 RTI