1. Preface — Vortex OpenSplice Record and Replay API Reference

### Navigation

- index
- next |
- previous |
- RnR API Reference »

# 1. Preface

## 1.1. About The Record and Replay API Reference

The Record and Replay (RnR) API Reference provides a complete description of the functions available via the API of the OpenSplice Record and Replay Service (RnR Service).

This API Reference is intended to be used after the Vortex OpenSplice software including the RnR Service has been installed on the network and configured according to the instructions in the Vortex OpenSplice Getting Started Guide.

## 1.2. Intended Audience

The API Reference is intended to be used by all Record and Replay Service users, including programmers, testers, system designers and system integrators.

## 1.3. Organisation

The Introduction gives an overview of the purpose and design of the Record and Replay Service.

The Scenarios section explains the key concept of the ‘scenario’ used in the RnR Service.

All of the functions of the RnR Service are then described in full detail.

There is a (very short) list of known issues which describes current limitations of the RnR Service.

The next section describes how the RnR Service is designed to minimize its intrusiveness on existing systems.

The RnR Topic API IDL specification contains the complete IDL definition of the RnR Service API.

Finally, there is a bibliography which lists all of the publications referred to in this Guide.

## 1.4. Conventions

The icons shown below are used in PrismTech 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.

### Navigation

- index
- next |
- previous |
- RnR API Reference »