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 Web documentation
The Vortex Web documentation set will help you install Vortex Web and develop applications using Vortex Web. Vortex Web allows you to develop DDS applications that will run in a web browser and can interoperate with other DDS systems.
Getting Started with Vortex Web
Installing Vortex Web
Before you can use Vortex Web you will need to install and license it. The Vortex Web installation 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.
Using Vortex Web
The Vortex Web User Guide (pdf | html) contains all the information to help you get started using Vortex Web. This will show you how to start and stop Vortex Web and how to include it in an application.
Vortex Web API
Vortex Web examples
Vortex Web contains a complete set of examples which will help you to become familiar with using the product. These can be found in the examples directory in the installation. The documentation explaining how to build and run the examples is found on the index.html page inside the distribution. The examples are designed to interoperate with the examples found inside the other Vortex products.
The complete list of examples is as follows:
- WebShapes example – this example shows Vortex Web Coffeescript API and the embedded deployment of the Vortex Web Server
- Roundtrip example – this is an example of measuring the roundtrip with VortexWeb
- Throughput example – this is an example of measuring thoughput with Vortex Web
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 Gateway Documentation
The Vortex Gateway documentation set will help you install and use Vortex Gateway.
Vortex Gateway is a tool which allows data to flow across different systems. It allows systems running the Data Distribution Service (DDS) to communicate e with systems running different messaging technology. For example the Java Message Service (JMS).
Vortex Gateway is part of the Vortex Platforms installer.
Installing Vortex Gateway
Using Vortex Gateway
Vortex Gateway Examples
Vortex Gateway comes with examples to show you how it works. You will find these inside the distribution in the examples directory. If you go to the index.html page you will find the information for running them.
The list of examples is as follows:
- Chatroom example – demonstration of the Camel Vortex OpenSplice connector
- Chatroom with JMS example -demonstration of the Camel Vortex OpenSplice connector with message routing to JMS
- Chatroom with REST example – Chat example using Camel Vortex OpenSplice connector with Rest endpoint
- Chatroom with REST and COMETD example – Chat example using Camel Vortex OpenSplice connector with Rest endpoint and cometd
- Chatroom with Web Service example – Chat example using Web Service
- Chatroom-pollEnricher example – Demo of Camel Vortex OpenSplice connector with a pollEnricher pattern on Camel route
- Camel Messages mode example – The camel-messages-mode examples demonstrate routing of camel messages with DDS as the underlying transport.
- Shapes in Java example – Graphical example using Java DSL and ishapes demo.
- Shapes in Scala example – Graphical example using Scala DSL and ishapes demo.
- Shapes in Java with camel-ddsi endpoint example – Graphical example using camel-ddsi and ishapes demo.
- Shapes bridging with camel-ddsi endpoint example – Graphical example showing different bridges between 2 DDS Domains.
- PingPong example – Latency measurement example.
- PingPong with camel-ddsi endpoint example – Latency measurement example using camel-ddsi endpoint.
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 Cloud and Fog Documentation
Vortex Cloud and Fog extend the OpenSplice domain beyond the limits of the network. They provide 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 Cloud and Vortex Fog are part of the Vortex Platforms installer.
Installing Vortex Cloud and Fog
Using Vortex Cloud and Fog
Once you have installed Vortex Cloud or Fog the Vortex Cloud and Fog User Guide (pdf | html) will show you how to configure and run Vortex Cloud and Fog. This guide also contains a complete set of examples which show how to use Vortex Cloud and Fog to connect the following:
- Device to Device
- Device to Device & Device to Cloud
- 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)