This page lists all the documentation to help you get started installing, running and using the Vortex product family:
The Vortex product family consists of:
The Vortex OpenSplice documentation is on a separate page.
Vortex Cafe Documentation
Vortex Cafe is one of the products that is bundled with the Vortex Platforms installer. All the documentation is included with the release. The easiest way to access it is to find the index.html file inside the distribution. This provides the links to all the documentation.
The Vortex Cafe documentation set will help you install and develop applications using Vortex Cafe. Vortex Cafe is a Java (TM) implementation of the Data Distribution Service (DDS) It allows you to develop DDS applications that run on Android devices and any JVM enabled devices. These applications will interoperate with existing DDS systems
Installing Vortex Cafe
Before you can use Vortex Cafe you will need to install and license it. The Vortex Cafe installation Guide (pdf | html) will take you though the steps to install and license the software. It also shows you how to compile the examples that are included in the distribution.
Using Vortex Cafe
The Vortex Cafe User Guide (pdf | html) will show you how to configure Vortex Cafe, how to use Vortex Cafe and what runtime configurations you should use. It will help you start developing applications using Vortex Cafe.
Vortex Cafe API
The Vortex Cafe API documentation will be a great help once you start active development using Vortex Cafe
Vortex Cafe Examples
Vortex Cafe comes with a set of example to help you get up and running quickly. These examples also interoperate with examples included with the other Vortex products. You can find more information about them in the index.html file included in the distribution.
These are the examples that are inside the distribution:
- HelloWorld example – which provides a simple example of using DDS
- Chat example – which is another simple example of using DDS
- Roundtrip example – this is an example of latency measurement
- Throughput example – this is an example of throughput measurement
- PingPong example – this example consists of two executables that exchange data using 2 partitions. Running both these executables allows you to measure roundtrip duration when sending and receiving a single message
- JavaFX ishapes example – this is a graphical example that demonstrates advanced Vortex Cafe usage.
- Android Chat example – this is the same example as the Chat example but demonstrates how to run it on Android.
- Android ishapes example – this is the Android version of the previous iShapes example
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
There are a number of API reference manuals that will help guide you when you begin developing with Vortex Lite. These are:
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:
- 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
- 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
Vortex Insight Documentation
The Votex Insight documentation set will help you to use Vortex Insight to monitor the performance of your Vortex based system.
Vortex Insight is a tool that allows you to obtain real time data from a Vortex system. You can use it to monitor and manage a system from any device with web browser. It will help you to identify problems in the system as well as providing statistics and alerts while the system runs.
Vortex Insight is part of the Vortex Platforms installer.
Installing Vortex Insight
Using Vortex Insight
Vortex Link Documentation
Vortex Link extends the OpenSplice domain beyond the limits of the network. It provides discovery and routing services which allow different networks to communicate with the DDS domain. This allows data to be routed beyond the LAN and into the WAN and the internet transparently.
Vortex Link is part of the Vortex Platforms installer.
Installing Vortex Link
Using Vortex Link
Once you have installed Vortex Link the Vortex Link User Guide (pdf | html) will show you how to configure and run Link. This guide also contains a complete set of examples which show how to use Vortex Link to connect the following:
- Device to Device
- Device to Device & Device to Link
- LAN to LAN (I can deploy on my Firewall/NAT)
- LAN to LAN (I can’t deploy on my Firewall/NAT but can configure it)
- Indirect LAN to LAN (I can’t deploy on my Firewall/NAT and can’t configure it)
- LAN to LAN + Internet devices (no cloud)
- LAN to LAN + Internet devices (with public cloud)