Vortex OpenSplice - documentation index

##### Vortex OpenSplice

- Introduction Vortex OpenSplice Intro An introduction to Vortex OpenSplice.
- User Guides
- Changes
  Release Notes The release notes for Vortex OpenSplice.
- Supported Platforms
- Known Issues
  Known Issues The list of known issues in Vortex OpenSplice.
- DDSI Release Notes
- Rebuilding the C++ APIs
- Upgrading OpenSplice
- Examples
- Third party licenses
- License

## Getting Started

- Getting Started Guide (pdf) (html) - the document that users should read first. The Getting Started Guide provides:
  - information for running your first example
  - basic installation and configuration information
  - how to license your installation
- Evaluating and Benchmarking OpenSplice (pdf) (html) - the document that users should read to help get the best out of OpenSplice DDS:
  - choosing your architectural model
  - choosing the right networking service
  - how to benchmark to get the best results
- OpenSplice Tutorial (pdf) - A step-by-step guide to using OpenSplice DDS APIs. A good guide to understand the concepts of DDS, based on the C API with other language examples available in the examples/dcps/tutorial directory.
- DDS Tutorial (pdf) (html) - A step-by-step guide to using the DDS API. A good guide to understand the concepts of DDS.
- Examples (html) - information on how to build and run the DCPS examples.
- OpenSplice RMI User Guide (pdf) (html) - an introduction to using OpenSplice RMI to achieve request/reply communication over OpenSplice DDS.

## Reference Manuals

- Deployment Guide (pdf) (html) - essential reference for configuring OpenSplice DDS.
- Configuration Guide (html) - This guide describes the various configuration elements and attributes available for Vortex OpenSplice.
- OpenSplice IDL PreProcessor User Manual (pdf) (html) - provides detailed technical information on using and running the OpenSplice DDS Interface Definition Language (IDL) PreProcessor ; idlpp.
- Secure Networking Configuration (pdf) (html) - information on configuring and managing the OpenSplice secure networking module.
- Record and Replay API (pdf) (html) - information on the OpenSplice Record and Replay Service API.
- Record and Replay Manager (pdf) (html) - information on using the OpenSplice Record and Replay Manager.
- Google Protocol Buffer Tutorial (pdf) (html) - A tutorial on using Google protocol Buffers with OpenSplice.
- Modeling Guide (pdf) (html) - information on using the OpenSplice Modeler.

## API Reference Manuals

- DCPS ISO/IEC C++ Documentation (html) - a detailed reference describing the OpenSplice DDS DCPS API for programming ISO/IEC C++ including examples. This C++ API is the latest, simpler DDS API.
- DCPS ISO/IEC C++ 2 Documentation (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.
- DCPS Java 5 Documentation (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.
- DCPS Java Reference Guide (pdf) - a detailed reference describing the OpenSplice DDS DCPS API for the Java Language.
- DCPS C Reference Guide (pdf) - a detailed reference describing the OpenSplice DDS DCPS Application Programmers Interface (API) for the C Language.
- DCPS C++ Reference Guide (pdf) - a detailed reference describing the OpenSplice DDS DCPS API for the C++ Language.
- DCPS C# Documentation (html) - a detailed reference describing the OpenSplice DDS DCPS API for the C# Language and other release notes.
- QosProvider Documentation (All languages) (html) - a detailed reference describing the OpenSplice DDS DCPS API for the QosProvider.
- OpenSplice Streams API Reference (pdf) OpenSplice Streams API Reference (html) - a detailed reference describing the 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 RMI C++ API Reference (html) - a detailed reference describing the OpenSplice RMI API in C++.
- OpenSplice RMI JAVA API Reference (html) - a detailed reference describing the OpenSplice RMI API in Java.
- OpenSplice QoS Provider API Reference (html) - a detailed reference on the OpenSplice QoS Provider API.
- Dynamic Network Partitions for RTNetworking API Reference (html) - a detailed reference on topic-API for the Dynamic Network Partitions for RTNetworking feature.
- ISO C++ 2 FACE API Documentation (html) - a detailed reference describing the OpenSplice DDS FACE API for programming ISO/IEC C++ 2 including examples.
- JAVA FACE API Documentation (html) - a detailed reference describing the OpenSplice DDS FACE API for programming JAVA including examples.

## Tool User Guides

- OpenSplice DDS Tuner Guide (pdf) (html) - provides detailed technical information on using and running the OpenSplice DDS Tuner.
- OpenSplice DDS Tester Guide (pdf) (html) - provides detailed information on using and running the OpenSplice DDS Tester application.
- OpenSplice DDS Node Monitor (pdf) (html) - provides detailed information on using and running the OpenSplice DDS Node Monitor application.

## Upgrading

- V5-V6 Migration Guide (pdf) - guide to assist OpenSplice V5 users to migrate to OpenSplice DDS V6.
- V4-V5 Migration Guide (pdf) - guide to assist OpenSplice V4 users to migrate to OpenSplice DDS V5.
- ISOCPP to ISOCPP2 Migration (html) - guide to assist ISOCPP users to migrate to the new ISOCPP V2.