/rticonnextdds-connector-go

RTI Connector for Connext DDS is a lightweight technology that enables DDS data to be accessed with Go.

Primary LanguageC

rticonnextdds-connector-go

GoDoc Build Status Coverage Go Report Card

RTI Connector for Connext DDS

RTI Connector for Connext DDS is a quick and easy way to access the power and functionality of RTI Connext DDS. It is based on XML-Based Application Creation and Dynamic Data.

Connector was created by the RTI Research Group to quickly and easily develop demos and proofs of concept. It can be useful for anybody that needs a quick way to develop an application communicating over the Connext DDS Databus. Thanks to the binding with multiple programming languages, you can integrate with many other available technologies.

The Connector library is provided in binary form for select architectures. Language bindings and examples are provided in source format.

Go Connector leverages cgo to call its C library; this detail is hidden in a Go wrapper.

Getting started

RTI Go Connector requires Git LFS to check out the Connector C library properly.

Be sure you have golang installed (we tested with golang v1.9 above).

Install:

$ go get github.com/rticommunity/rticonnextdds-connector-go

Import:

import "github.com/rticommunity/rticonnextdds-connector-go"

Please see examples for usage details.

Platform support

Go Connector builds its library for few select architectures. If you need another architecture, please contact your RTI account manager or sales@rti.com.

If you want to check the version of the libraries you can run the following command:

strings librtiddsconnector.so | grep BUILD

Threading model

The Connector Native API does not yet implement any mechanism for thread safety. Originally, the Connector native code was built to work with RTI Prototyper and Lua. That was a single-threaded loop. RTI then introduced support for JavaScript, Python, and Go. For now, you are responsible for protecting calls to Connector. Thread safety may be implemented in the future.

Support

Connector is an experimental RTI product. If you have questions, please use the RTI Community Forum. If you would like to report a bug or have a feature request, please create an issue.

Documentation

The best way to get started with Connector is to look at the examples; you will see that it is very easy to use.

Please see the API documentaiton for more information.

License

With the sole exception of the contents of the "examples" subdirectory, all use of this product is subject to the RTI Software License Agreement included at the top level of this repository. Files within the "examples" subdirectory are licensed as marked within the file.

This software is an experimental (aka "pre-production") product. The Software is provided "as is", with no warranty of any type, including any warranty for fitness for any purpose. RTI is under no obligation to maintain or support the Software. RTI shall not be liable for any incidental or consequential damages arising out of the use or inability to use the software.

Contributing

Contributions to the code, examples, documentation are really appreciated. Please follow the steps below for contributions.

  1. Sign the CLA.
  2. Create a fork and make your changes.
  3. Run tests (use run_test.sh).
  4. Push your branch.
  5. Open a new pull request.