Vortex Lite Documentation

The Vortex Lite documentation set will help you install and develop applications using Vortex Lite. Vortex Lite is an ultra lightweight implementation of the Object Management Group’s (OMG) Data Distribution Service (DDS) standard. It allows you to develop DDS applications that run on resource constrained embedded devices. For example networked sensors, single board computers, embedded gateways and micro-controllers.

Installing and using Vortex Lite

Before you can use Vortex Lite you will need to install and license it. The Vortex Web User Guide (pdf | html) shows you how to install and license the software. It also shows you how to compile the examples that come with the distribution. The Vortex Lite User Guide also contains all the information you need to build and run an application using Vortex Lite

Configuring Vortex Lite

The Vortex Lite Configuration Guide describes the various configuration elements and attributes available for Vortex Lite

RMI User Guide

The Vortex Lite RMI Guide (pdf | html) is intended for developers using remote invocations in DDS applications. It explains the steps required to enable you to do this.

API Reference

There are a number of API reference manuals that will help guide you when you begin developing with Vortex Lite. These are:

Vortex Lite Google Protocol Buffers Tutorial

Vortex Lite is capable of using the Google Protocol Buffer ( GPB) system for publishing and subscribing GPB

messages in a DDS system. The Google Protocol Buffers Tutorial takes you though how to do this with the ISO C++ language binding.

Vortex Lite Examples

Vortex Lite comes with a number of examples that will show you how to use Vortex Lite. You can find these in the examples directory. Information on running them can be found in the index.html file in the distribution. The list of examples is as follows:

Standard Examples

Simple – a simple example showing how to set up DCPS entities and send a message that does not contain keyed data
Hello – another simple example showing how to set up the DCPS entities
Error – this example shows how to use the API return codes to indicate success or failure
Listener – an example which shows how to use Listeners
Listener Inheritance – based on the previous listener example this show how to use a listener on the publisher side
Waitset – an example showing the use of a WaitSet for a Status condition
Status – this example shows the use of Communication Status
Filtered Topic – an example showing the use of Filtered Topics
Throughput – this example shows how to measure data throughput when receiving samples from a publisher
Roundtrip – an example showing how to measure the roundtrip duration when sending a single message
Query Condition – this example illustrates the use of query conditions
Durability – this example shows the steps needed to create a durable (transient/persistent) topic
Changeable Qos – this example shows how to set the Ownership QoS dynamically

RMI Examples

HelloWorld – an example showing the basic steps to write a client/server application
ClientServer – is a simple client and server application demonstrating synchronous RMI invocations of a rich set of IDL operations.

Google Protobuf Example

Protobuf – this example shows how to use google protocol buffers with DDS