.. _`Preface`:


#######
Preface
#######


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*.

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*.

Organisation
************

This *Guide* is organised in two parts.

The :ref:`Introduction <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 :ref:`API Reference <API Reference>` provides detailed
descriptions of all of the classes and operations of the Streams API.


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*
 ========= ==================================================================
 |caution| Item of special significance or where caution needs to be taken.
 |info|    Item contains helpful hint or special information.
 |windows| Information applies to Windows (*e.g.* XP, 2003, Windows 7) only.
 |unix|    Information applies to Unix-based systems (*e.g.* Solaris) only.
 |linux|   Information applies to Linux-based systems (*e.g.* Ubuntu) only.
 |c|       C language specific.
 |cpp|     C++ language specific.
 |csharp|  C# language specific.
 |java|    Java language specific.
 ========= ==================================================================




.. |caution| image:: ./images/icon-caution.*
            :height: 6mm
.. |info|   image:: ./images/icon-info.*
            :height: 6mm
.. |windows| image:: ./images/icon-windows.*
            :height: 6mm
.. |unix| image:: ./images/icon-unix.*
            :height: 6mm
.. |linux| image:: ./images/icon-linux.*
            :height: 6mm
.. |c| image:: ./images/icon-c.*
            :height: 6mm
.. |cpp| image:: ./images/icon-cpp.*
            :height: 6mm
.. |csharp| image:: ./images/icon-csharp.*
            :height: 6mm
.. |java| image:: ./images/icon-java.*
            :height: 6mm