Home / , , / API/IDL Guides

API/IDL Guides

When you begin development on OpenSplice DDS you will need to consult the API documentation. C++ and Java have the original DCPS API support (referred to as Classic) and the newer ISO C++ and Java 5 PSM APIs. The C++ and Java APIs will have been built with a specific ORB and a specific compiler in the case of the C++ API.

The following API Guides are available:

IDL/Google Protocol Buffers

  • OpenSplice IDL PreProcessor User Manual – (v6 pdf | html) (v7 pdf | html) provides detailed technical information on using and running the OpenSplice DDS Interface Definition Language (IDL) PreProcessor; idlpp.
  • Google Protocol Buffer Tutorial – (v6 pdf | html) (v7 pdf | html) A tutorial on using Google protocol Buffers with OpenSplice instead of IDL.

Java

  • Java 5 API – (v6 html) (v7 html) a detailed reference describing the OpenSplice DDS DCPS API for programming Java 5 including examples. This Java API is the latest, simpler DDS API.
  • Classic Java API – (v6 pdf) a detailed reference describing the OpenSplice DDS DCPS API for the Java Language.

C/C++

  • ISO/IEC C++ 2 API -(v6 html) (v7 html) a detailed reference describing the OpenSplice DDS DCPS API for programming ISO/IEC C++ 2 including examples. This C++ API is a new version of DCPS ISO/IEC C++ API.
  • Classic C++ API – (v6 pdf) a detailed reference describing the OpenSplice DDS DCPS API for the C++ Language.
  • Classic C API – (v6 pdf) a detailed reference describing the OpenSplice DDS DCPS Application Programmers Interface (API) for the C Language.

C#

  • C# API – (v6 html) (v7 html) a detailed reference describing the OpenSplice DDS DCPS API for the C# Language and other release notes.

Python

  • Python DCPS API Guide – (v6 pdf | html) (v7 pdf | html) information about Python DCPS API.

NodeJS

  • NodeJS DCPS API Guide – (v6 pdf | html) (v7 pdf | html) information on NodeJS DCPS API

Future Airborne Capability Environment (FACE)

  • ISO C++ 2 FACE API – (v6 html) (v7 html) a detailed reference describing the OpenSplice DDS FACE API for programming ISO/IEC C++ 2 including examples.
  • JAVA FACE API – (v6 html) (v7 html) a detailed reference describing the OpenSplice DDS FACE API for programming JAVA including examples

Remote Method Invocation (RMI)

  • RMI C++ API  – (v6 html) (v7 html) a detailed reference describing the OpenSplice RMI API in C++.
  • RMI JAVA API  – (v6 html) (v7 html) a detailed reference describing the OpenSplice RMI API in Java.

OpenSplice Streams

OpenSplice Streams API that supports a common data-distribution pattern where continuous flows or streams of data have to be transported with minimal overhead and therefore maximal achievable throughput

  • OpenSplice Streams API Reference – (v6 pdf | html) (v7 pdf | html) a detailed reference describing the OpenSplice Streams API.

Modeling Platforms

  • DDS MATLAB Guide – (v6 pdf | html) (v7 pdf | html) contains information on DDS MATLAB
  • DDS Simulink Guide – (v6 pdf | html) (v7 pdf | html) contains information on DDS Simulink
  • DDS LabVIEW Guide – (v6 pdf | html) (v7 pdf | html) contains information on DDS LabVIEW

OpenSplice Record and Replay

  • Record and Replay API – (v6 pdf | html) (v7 pdf | html) provides information on the OpenSplice Record and Replay Service API.

The following manuals are in html format and can be found inside the distribution

  • OpenSplice QoSProvider Documentation (All languages) – a detailed reference describing the OpenSplice DDS DCPS API for the QosProvider.
  • OpenSplice QoS Provider API Reference – a detailed reference on the OpenSplice QoS Provider API.
  • Dynamic Network Partitions for RTNetworking API Reference – a detailed reference on topic-API for the Dynamic Network Partitions for RTNetworking feature.