1. Preface

1.1. About The Vortex Streams API Reference Guide

The Vortex Streams API Reference Guide provides a detailed overview of the Vortex OpenSplice Streams API. The Streams API is an add-on, built on the Data Centric Public Subscribe (DCPS) paradigm that is implemented by Vortex OpenSplice and standardized in the OMG’s Data Distribution Service Specification.

This Guide complements the Vortex OpenSplice C++ Reference Guide.

1.2. Intended Audience

The Streams API Reference Guide is intended to be used by C++ programmers who are using the OpenSplice Streams API to develop applications. While not strictly required, it is assumed that the reader has a basic understanding of the DDS C++ API as detailed in the Vortex OpenSplice C++ Reference Guide.

1.3. Organisation

This Guide is organised in two parts.

The Introduction provides some background information about the features of the Streams API and how to use them. It also gives a broad overview of all entities and relations between entities in the Streams API.

The API Reference provides detailed descriptions of all of the classes and operations of the Streams API.

1.4. Conventions

The icons shown below are used in ADLINK product documentation to help readers to quickly identify information relevant to their specific use of Vortex OpenSplice.

Icon	Meaning
	Item of special significance or where caution needs to be taken.
	Item contains helpful hint or special information.
	Information applies to Windows (e.g. XP, 2003, Windows 7) only.
	Information applies to Unix-based systems (e.g. Solaris) only.
	Information applies to Linux-based systems (e.g. Ubuntu) only.
	C language specific.
	C++ language specific.
	C# language specific.
	Java language specific.