1. Before You Get Started
1.1. What is Connext?
![What Is Connext?](_images/what_is.png)
RTI® Connext® is a connectivity framework for building distributed applications with requirements for high performance and scalability. It includes these components:
An SDK that provides you with APIs to help you send and receive data using the communication patterns described in this documentation (see Next Steps). These APIs allow you to connect your own applications to other applications on the databus.
Tools that help you visualize your data and debug your distributed system.
Infrastructure Services that can perform dedicated functions in your system, such as recording, bridging, and persisting data.
1.2. Downloading Connext
If you haven’t already purchased a Connext bundle, you can follow this Getting Started guide with an evaluation bundle. To obtain an evaluation bundle, click the Free Trial button at https://www.rti.com/. Fill out the brief form, and you will receive an evaluation package shortly.
1.3. Installing Connext
Note
These instructions apply to Connext 6.1.1 and newer.
To develop C# applications, you will need the following Connext bundles:
A host bundle that contains files such as documentation, the code generator, other tools, and infrastructure services executables. The host bundle is provided in a .run or .exe file that will run an installer.
Host bundles are named:
rti_connext_dds-<version>-<package_type>-host-<host-platform>.run
rti_connext_dds-<version>-<package_type>-host-<host-platform>.dmg
rti_connext_dds-<version>-<package_type>-host-<host-platform>.exe
The
<package_type>
is usuallypro
.The
<host_platform>
depends on your development platform, such asx64Win64
for a 64-bit Windows® platform.
The NuGet packages required to develop Connext C# applications. There are two ways to obtain these NuGet packages:
Install
rti_dotnet_support-<version>.rtipkg
to add the NuGet packages to your installation directory (see Installing additional packages with a GUI or Installing additional packages from a Command Line).
or
Let .NET automatically download the NuGet packages from nuget.org when you build your C# applications. The nuget.org libraries require a license file when you run your application (see Setting up a License for the C# API).
Note that the nuget.org packages allow writing C# applications without a host installation, but this guide uses the code generator and some tools that are included in the host package.
If you plan to develop C, C++, or Java applications or use add-on libraries you will also need a target bundle. See the C++ version of this Getting Started Guide for more information.
1.3.1. Installing a Host
The host bundle is an application; thus, it can be started from a GUI or command line. To install the host bundle, do either of the following:
Double-click the installer.
Run the installation script from a command prompt. See Installing RTI Connext, in the RTI Connext Installation Guide.
1.3.2. Installing additional packages with a GUI
After you install the host bundle, you’ll have a tool called RTI Launcher. (See Starting Launcher, in the RTI Launcher User’s Manual.)
To install additional packages from the Launcher tool, open the Configuration tab, and select “Install RTI Packages.” This will open a dialog that allows you to select one or more .rtipkg files that you would like to install.
![Install RTI Packages](_images/install_rti_pkg.png)
![RTI Package Installer](_images/pkg_installer.png)
1.3.3. Installing additional packages from a Command Line
To install additional packages from the command line, type:
$ <installdir>/bin/rtipkginstall <path to rtipkg>
$ <installdir>/bin/rtipkginstall <path to rtipkg>
> <installdir>\bin\rtipkginstall <path to rtipkg>
1.3.4. Paths Mentioned in Documentation
This documentation refers to the following directories, depending on your operating system:
$NDDSHOME
This refers to the installation directory for Connext.
The default installation paths are:
Non-root user:
/home/<your user name>/rti_connext_dds-<version>
Root user:
/opt/rti_connext_dds-<version>
$NDDSHOME
is an environment variable set to the installation path.
$NDDSHOME
This refers to the installation directory for Connext.
The default installation path is:
/Applications/rti_connext_dds-<version>
$NDDSHOME
is an environment variable set to the installation path.
%NDDSHOME%
This refers to the installation directory for Connext.
The default installation paths are:
User without Administrator privileges:
<your home directory>\rti_connext_dds-<version>
User with Administrator privileges:
"C:\Program Files\rti_connext_dds-<version>"
%NDDSHOME%
is an environment variable set to the installation path.
Note
When using a command prompt to enter a command that includes the path
C:\Program Files
(or any directory name that has a space), enclose
the path in quotation marks. For example:
“C:\Program Files\rti_connext_dds-version\bin\rtilauncher.bat”
.
Or if you have defined the NDDSHOME
environment variable:
"%NDDSHOME%\bin\rtilauncher.bat"
.
Sometimes this documentation uses <NDDSHOME>
to refer to the installation path.
Whenever you see <NDDSHOME>
used in a path, replace it with $NDDSHOME
for Linux or
macOS systems, with %NDDSHOME%
for Windows systems, or with your installation path.
1.4. Setting Up a License
1.4.1. Setting up a License for the C# API
If you’re using the NuGet packages from your host installation, you don’t need a license file to run your applications.
If you’re using the NuGet packages from nuget.org, your applications need to load a license file every time they run. To obtain an evaluation license, click the Free Trial button at https://www.rti.com/.
There are several ways to specify your license file:
You can copy the rti_license.dat file to the location where you run your application.
You can set the
RTI_LICENSE_FILE
environment variable to the full path of your license file, including the file name.You can set the
DomainParticipantQos
to point to your license file (see the License Management section in the RTI Connext Installation Guide).
1.4.2. Setting up a License for the tools and other features
Most installations require a license file to run the tools or features included in the Connext platform. If your distribution requires a license file, you will receive one from RTI via e-mail.
The easiest way to permanently configure your license file is using Launcher, as shown below:
![Configure License](_images/config_license.png)
If you do not want to use Launcher, you can also install a license by placing it in one of these two locations:
<installation directory>/rti_license.dat
<workspace directory>/rti_license.dat
The workspace directory is in this location by default, depending on your operating system:
/home/<your username>/rti_workspace/
/Users/<your username>/rti_workspace/
<your Windows documents folder>\rti_workspace\
A third way to install a license is to configure the environment
variable RTI_LICENSE_FILE
to point to your license file.
For more details on how to install a license file, see the License Management section in the RTI Connext Installation Guide.
1.5. Checking What is Installed
To find out what target libraries or add-ons you have installed, you can use the Launcher tool. See Starting Launcher, in the RTI Launcher User’s Manual. Once in Launcher, open the Configuration tab.
1.6. Where Do I Get More Help?
The full RTI Connext Installation Guide contains more information:
Installer command-line options
Controlling the location of the RTI Workspace directory
Additional license management options
Special backup of RTI libraries
How to uninstall Connext
Additional documentation and user forums can be found on community.rti.com.
Continue to Publish/Subscribe to start learning about the capabilities and features of Connext.