Vortex OpenSplice RMI User Guide

Preface

About the RMI User Guide

The Lite RMI User Guide is intended to explain the steps required to take advantage of the client/server interaction paradigm provided by Lite RMI layered over the publish/subscribe paradigm of Lite.

Intended Audience

This Lite RMI User Guide is for developers using remote invocations in DDS applications.

Organisation

The first two chapters give a general introduction to RMI over DDS.

Building an RMI Application describes the steps involved in building applications using RMI over DDS.

Language mapping for Lite RMI gives the C++ mapping of the IDL types that can be declared in the RMI services description file.

RMI Interface to DDS topics mapping rules shows how IDL declarations of RMI interfaces are mapped into IDL declarations of the implied DDS topics.

RMI Runtime Configuration Options describes the command-line options available when starting the RMI runtime.

QoS policies XML schema contains the XML schema for reference.

Conventions

The icons shown below are used to help readers to quickly identify information relevant to their specific use of Vortex.

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.

Introduction

Features

Lite RMI provides an implementation of the general concept of invoking a remote method over DDS. It enhances Lite with a service-oriented interaction pattern that can be used with combination with the native data-centric pattern. Lite RMI is a service invocation framework on top of DDS DCPS that uses DDS mechanisms to export, find and invoke services. It maps all the application-exchanged requests/replies into DDS data exchanges, and gives the ability to configure the associated QoS policies according to the application needs. Finally, Lite RMI enables the definition of a distributed services space over a DDS data space with all the known DDS benefits, such as discovery, fault tolerance, performance and real-time features.

RMI Communication Scheme

RMI Communication Scheme

Lite RMI targets service-oriented applications needing a request/reply communication scheme while they need to have a very fine control over the data and the underlying network quality of service. Typically, Lite RMI can be used in systems to issue commands. Commands are a kind of stimulus that express the ability of the system to do something. As commands have the `do-something’ connotation, it is often useful to be informed synchronously that the command has been executed. Thanks to the various DDS QoSs, applications can associate expiration time, prioritities, persistency and so on to those commands.

Benefits

As a complementary paradigm to data centricity, Lite RMI provides these benefits:

  • A more productive and higher abstraction level than can be achieved manually through topic exchanges and applications synchronization.
  • A unique middleware technology for mixing Global Services and Data Spaces with an easy and dynamic services registration, data declaration, and the same discovery mechanisms.
  • Enables data-centric applications to use RMI without the burden of an additional middleware technology (e.g. CORBA).
  • Strong services location transparency. Thanks to the connectionless nature of DDS, service identities do not need to include any network-related information. In Lite RMI, a service is identified by a simple name. Services’ identities are exported naturally via a DDS publication on specific topics. Services can even move from one location to another without any impact on client applications.
  • Simple API.
  • Easy deployment process.

Lite RMI over DDS

As in traditional service-oriented applications, communication from client to server is performed through a well-defined service model. The RMI module enables a user to build a service model with remote method invocation capabilities and completely hides the DDS DCPS API. Of course, using RMI does not prevent the application from using the DDS API as shown by the following figure:

RMI Relationship to DDS

RMI Relationship to DDS

A service model is defined by one or more object-oriented interfaces. A DDS RMI interface is an IDL interface having a name and a set of operations. Each operation has a fixed set of typed parameters. The RMI module provides:

  • A service invocation framework that maps the different services operations onto a set of DDS topics that hold the operation’s invocation requests and replies. A set of mapping rules have been defined for this purpose. At runtime, this framework sets up the underlying DDS environment and handles the remote interface invocations using the basic DDS read/write operations.
  • A simple and intuitive programming model for both the server application side implementing the interface, and the client application side invoking that interface. The server programming model is as simple as implementing an interface, and the client programming model is as simple as calling a local interface.
  • A powerful feature to enable tuning of the invocation request and reply QoS by setting their corresponding DDS QoS policies. This feature enables developers to improve the invocations quality with real-time and high-performance features. For instance, priorities and validity durations (lifespan) could be set on the different operation requests/replies.
  • Synchronous, asynchronous and oneway invocation modes. The synchronous mode is the invocation mode that blocks the client thread until the reply is sent back to him by the server. The asynchronous mode is similar to the CORBA Asynchronous Messaging Interface (AMI) callback model. It is a non-blocking mode where the client does not wait for the reply from the server, but rather provides a callback object that will be invoked by the middleware to deliver the request return values when they are received. Finally, the oneway mode is a fire-and-forget invocation mode where the client does not care about the success or failure of the invocation. A oneway method cannot return values and no reply message will ever return to the client once the request is sent to the server.
  • C++ implementation.

Key components

The Lite RMI module includes the following components:

RMI Pre-processor (rmipp)
Generates the interface-type-specific requests/replies topics and invocation handling classes.
Core library
Provides the runtime setup operations and a generic invocation framework.

Binding Languages

The Lite RMI module is available for the C++ language.

Building an RMI Application

About RMI Applications

The process of building a Vortex Lite RMI application is shown in Steps Building Applications with RMI below. The different steps are described in the following subsections.

Steps Building Applications with RMI

Steps Building Applications with RMI

Services description

The first step in building an RMI application is the definition of its provided services in terms of interfaces. The application interfaces should be declared using the OMG IDL language. The operations parameters can be either of basic (short, long, ...) or complex (struct, sequence, string, ...) types. However, the following restrictions should be respected:

  • the Any and the valuetype IDL types are not supported because they are not supported by the underlying DDS DCPS layer. Union type is also not supported.
  • Exceptions are not supported at this time.
  • Each interface must extend DDS_RMI::Services base interface to indicate that it is invocable over DDS. This interface is defined in the file dds_rmi.idl, which must be included.
  • Each interface must be declared `local’.
  • Oneway operations are supported. The semantics of oneway operations is the same as for the OMG CORBA interfaces. A oneway operation must not contain any output parameter and must return a void type.

The following IDL snippet shows an example of a service data description:

#include "dds_rmi.idl"
module HelloWorld
{
  // interface definition
local interface HelloService : ::DDS_RMI::Services
{
  string greet();
};
};

QoS policies description

The Lite RMI module provides the ability to tune the quality of service of the services invocations (requests and/or replies), if needed, by setting the underlying QoS policies. By default, the Lite RMI module uses the default values of the QoS policies except for the reliability QoS policy which is set to RELIABLE.

If needed, the application designer can define the QoS policies to be set on the invocations in an XML file. This file must respect the XML schema given in QoS policies XML schema.

Note that setting the QoS policies requires a good knowledge of the rules for mapping the specified interfaces onto the DDS topics description (please refer to RMI Interface to DDS topics mapping rules).

The following XML snippet shows an example:

<?xml version="1.0" encoding="ISO-8859-1" ?>
<dcps xmlns="http://www.omg.org/dds/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.omg.org/dds/DCPS.xsd">

<domain id="">
  <topic name="greet_req"
idltype="::HelloWorld::HelloService::greet_request" idlfile="">

  <topic_qos>
  <destinationOrderQosPolicy>
    <destinationOrderKind>
      BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS
    </destinationOrderKind>
  </destinationOrderQosPolicy>

  <durabilityQosPolicy>
    <durabilityKind>
      PERSISTENT_DURABILITY_QOS
    </durabilityKind>
  </durabilityQosPolicy>

  <latencyBudgetQosPolicy>
    <duration>
      <nanosec>10000000</nanosec>
      <sec>0</sec>
    </duration>
  </latencyBudgetQosPolicy>

  <reliabilityQosPolicy>
    <duration>
      <nanosec>100000000</nanosec>
      <sec>0</sec>
    </duration>
  <reliabilityKind>
    RELIABLE_RELIABILITY_QOS
  </reliabilityKind>
  </reliabilityQosPolicy>

  </topic_qos>

  </topic>

</domain>
</dcps>

This example specifies the QoS policies to be applied on the topic invocation request of the greet operation of the interface HelloWorld::HelloService. Note that the invocation request topic is named greet_req and its IDL type is HelloWorld::HelloService::greet_request.

RMI compilation

Once the application has defined its services and (optionally) its QoS settings, these definitions are compiled to generate type-specific code for the application services invocation.

The RMI compilation is done using the rmipp pre-processor applied on the interfaces definition file and the QoS file if it exists. The rmipp usage is:

rmipp [-I <path>] [-d <directory>] [-topics <qos_file>]
[-P dll_macro_name[,<header-file>]] <interfaces_file>

The parameters are:

-I <path>
Define the include path directives.
-d <directory>
Define the location to place the generated files.
-topics <qos_file>
Define the XML file including the QoS policies settings.
-P dll_macro_name[,<header-file>]
Sets export macro that will be prefixed to all functions in the generated code. This allows creating DLLs from generated code. Optionally a header file can be given that will be included in each generated file.
<interfaces_file>
The IDL file including the interfaces definition.

The rmipp compilation will generate a set of C++ source files as well as an IDL file including the mapping of the provided interfaces onto the DDS topics. The generated IDL file name is the interfaces file name with “_topics” concatenated.

rmipp follows the mapping rules described in Language mapping for Lite RMI.

Example usage:

rmipp -d generated HelloService.idl

The generated directory will include:

HelloService_topics.idl
HelloService_Interface.h
HelloService_Interface.cpp
HelloService_InterfaceProxy.h
HelloService_InterfaceProxy.cpp

In addition, the rmipp compiler performs a DDS compilation to generate the DDS/DCPS code that is required to support the requests/replies transport over DDS.

Application implementation

As mentioned before, the target applications have a client/server design. A typical application includes a server part that implements the provided interfaces, and a client part that invokes these interfaces. This section describes the programming model of both parts.

Runtime starting and stopping

Any Lite RMI application process must initialize the RMI runtime prior to any other operation, regardless of whether it is a client and/or a server process. The runtime initialization sets up the underlying DDS infrastructure and configures it to make the services invocable and the clients capable of invoking the services. It is also important to stop the runtime when the application is no longer using RMI.

The following code snippets show the runtime initialisation and stopping procedure in C++.

cpp

RMI runtime starting and stopping in C++

01  #include "ddsrmi.hpp"
02
03  using namespace org::opensplice::DDS_RMI;
04
05  int main (int argc, char * argv [])
06  {
07    CRuntime_ref runtime = CRuntime::getDefaultRuntime();
08    if (runtime.get() == NULL)
09    {
10      std::cout << "Failed to get the Runtime " << std::endl;
11      exit(1);
12    }
13
14    //starting the runtime
15    bool result = runtime->start(argc, argv);
16    if (result !=true)
17    {
18      std::cout << "Failed to start the Runtime " << std::endl;
19      exit(1);
20    }
21    ...
22
23    //stopping the runtime
24    result = runtime->stop();
25    if (result !=true)
26    {
27      std::cout << "Failed to stop the Runtime " << std::endl;
28      exit(1);
29    }
30  }

Comments below refer to line numbers in the sample code above:

1 Include the RMI library header file.
Any Lite RMI application should include this file.

3 Declare the usage of the RMI library namespace.

7-12 Get the default DDS runtime.
This selects the default DDS domain as the data space where all subsequent RMI requests and replies will be exchanged.
15-20 Initialize the created runtime.
This creates all the needed DDS entities. A set of configuration options can be passed to the start operation via argc and argv parameters. This latter is a string array including possible option names and values, and argc is the length of this array. Note that these parameters are typically the same parameters that were passed to the main program so that the RMI options can be specified on the command line, each following the format ‘--option=value‘. All of the supported options are described in the section RMI Runtime Configuration Options.
24-28 Stop the created runtime.
This removes all the created DDS entities and releases the RMI-allocated resources. It is strongly recommended to stop the runtime when it no longer needed.

Server programming model

At the server side of the application, each provided interface should be implemented, then instantiated and finally registered to be invocable via DDS.

To define an implementation, the application developer must write an implementation class including public methods corresponding to the operations of the related IDL interface. The rmipp compilation generates for each interface a skeleton class, named ::DDS_RMI::HelloWorld::HelloServiceInterface, that must be extended by the application-supplied implementation class. The language mapping rules of the RMI IDL interfaces are given in Language mapping for Lite RMI.

To make an interface invocable over DDS, it must be registered within the RMI framework, then activated. The registration process requires the following information:

  • the implementation class object
  • the server name, as well as a unique id identifying that interface inside the server.

The services activation makes the RMI runtime wait for incoming requests for all the registered services.

The following code snippets show the server programming model in C++

cpp

C++ RMI interface implementation

class HelloService_impl :
      public virtual DDS_RMI::HelloWorld::HelloServiceInterface
{
public:
    HelloService_impl();
   ~ HelloService_impl();

   virtual DDS::String greet ();
}

cpp

C++ RMI server

01   #include “ddsrmi.hpp”
02   #include “HelloService_Interface.hpp”
03
04   using namespace org::opensplice::DDS_RMI;
05
06   int main (int argc, char * argv [])
07   {
08
09      // Runtime starting
10      ...
11
12      // implementation class instantiation
13      shared_ptr<HelloService_impl> impl (new HelloService_impl());
14
15      //interface registration
16      bool res = DDS_Service::register_interface<
16      ::DDS_RMI::HelloWorld::HelloServiceInterface, HelloService_impl>
17      (
18            impl, //implementation class
19            “HelloServer”, // server name
20            1 // unique server id
21       );
22
23      if(!res)
24      {
25          std::cout << "Failed to register the
25                        HelloWorld::HelloService interface") ;
26          System.exit(1);
27      }
28      //services activation
29      runtime->run()
30      // Runtime stopping
31      ...
32   }

Comments below refer to line numbers in the sample code above:

1-2 Include the Lite RMI library header file as well as the generated interface skeleton header file.

4 Declare the usage of the RMI library namespace.

10 Start the DDS runtime.

13 Instantiate the implementation class of the HelloService interface and assign it to a smart pointer.
The RMI library provides an implementation of smart pointers via the shared_ptr template class.
16-27 Register the HelloService interface in the default DDS domain.
The register_interface function is a template function requiring the interface skeleton class and the interface implementation class as template parameters.
28 Activates all the registered services including the HelloServer service.
This is a blocking call that makes the server runtime wait for incoming requests. To shut down the server runtime the shutdown() operation must be called.

31 Stop the DDS runtime.

Client programming model

As mentioned before, Lite RMI supports synchronous, asynchronous and oneway invocation modes. The following subsections present the synchronous and asynchronous programming model. The oneway programming model is similar to the synchronous one but, of course, with a different behaviour.

Synchronous invocation mode

The client part of the RMI application is as simple as calling a local class. Note that these calls block until the server-side responds or an internal timeout expires. Typically, in case of failure, the call will block until the timeout expiration. This timeout value is set by default to 10 minutes, but it may be configured via the interface proxy object. This object is a generated object, named ::DDS_RMI::HelloWorld::HelloServiceInterfaceProxy, that is the local representative of the RMI interface. This object is mainly used to call the RMI services, as shown in the following client code examples.

cpp

C++ RMI client

01 #include “ddsrmi.hpp”
02 #include “HelloService_InterfaceProxy.hpp”
03
04 using namespace org::opensplice::DDS_RMI;
05
06 int main (int argc, char * argv [])
07 {
08
09   // Runtime starting
10   ...
11
12   // Getting the interface proxy
13   shared_ptr<::DDS_RMI::HelloWorld::HelloServiceInterfaceProxy> proxy ;
14   bool ret = DDS_Service::getServerProxy<
14              ::DDS_RMI::HelloWorld::HelloServiceInterfaceProxy>
15     (
16       “HelloServer”, //server name
17       1, //unique proxy instance id
18       proxy  // proxy reference
19     );
20
21   // Calling the services
22   proxy->greet();
23
24   // Runtime stopping
25   ...
26
27 }

Comments below refer to line numbers in the sample code above:

1-2 Include the RMI library header file as well as the generated interface proxy header file.

4 Declare the usage of the RMI library namespace.

10 Start the DDS runtime.

13 Declare a smart pointer of the HelloService interface proxy type.

13-19 Get the HelloServer service proxy.

The getServerProxy function is a template function requiring the proxy class type as a template parameter. This function accepts the service name, a proxy instance id and the smart pointer to the proxy object as parameters. In case of success, the smart pointer is set to the created proxy object. The proxy instance id is a unique identifier that refers to the created proxy. It is important to ensure the uniqueness of the identifiers of all the proxies of the same service.

If the requested service is not found, the getServerProxy operation will raise an org::opensplice::DDS_RMI::SERVICE_NOT_FOUND exception.

22 Invoke the greet operation synchronously using the created proxy.

25 Stop the runtime.

Asynchronous invocation mode

To invoke asynchronously a given non-oneway operation, such as the greet operation in the examples shown here, the client application must:

  • Implement a specific reply handler class to handle the operation out/inout/return parameters if any. This handler must extend a base reply handler class that is generated for each operation and implement the greetReply callback function or method whose parameters are the out/inout/return parameters of the related IDL operation.
  • Use the generated asynchronous function or method that maps to the IDL operation whose name is the concatenation of ‘async_’ and the IDL operation name. This operation is a void operation that accepts only the in and inout IDL parameters, in addition to the eference of the implemented reply handler.

Note that the reply handler class is not re-entrant in the current implementation. It cannot handle concurrent replies. It means that if two successive asynchronous calls are made with the same reply handler instance, this latter will reject the second reply if it has not finished dispatching the first one. In this case the asynchronous call will raise a BAD_PARAM exception.

caution
IMPORTANT: It is strongly recommended not to mix synchronous and asynchronous calls of the same operation without proper synchronization. The application should ensure that the asynchronous call has received its reply before requesting a synchronous one.

cpp

C++ RMI Client with asynchronous invocation

01   #include "ddsrmi.hpp"
02   #include "HelloService_InterfaceProxy.hpp"
03
04   using namespace org::opensplice::DDS_RMI;
05
06   /**
07   * Reply Handler of the 'async_greet' operation
08   *
09   */
10   class MyGreetReplyHandler :
11      public virtual   HelloWorld_HelloService_greet_Reply_Handler
12   {
13      void greet_Reply(DDS::String ret)
14      {
15           std::cout << "Reply received: " << ret << std::endl;
16      }
17   }
18
19   int main (int argc, char * argv [])
20   {
21
22   // Runtime starting
23      ...
24
25   // Getting the interface proxy
26   shared_ptr<::DDS_RMI::HelloWorld::HelloServiceInterfaceProxy> proxy ;
27   bool ret = DDS_Service::getServerProxy<
27              ::DDS_RMI::HelloWorld::HelloServiceInterfaceProxy>
28      (
29        "HelloServer", //server name
30        1, // proxy instance id
31        proxy  // proxy reference
32      );
33
34   // instantiating a reply handler
35   MyGreetReplyHandler handler;
36
37   // Calling the services asynchronously
38   proxy->async_greet(&handler);
39   ...
40
41   // Runtime stopping
42   ...
43
44   }

Comments below refer to line numbers in the sample code above:

10-16 Provide the implementation class of the greet operation reply handler.

21 Start the DDS runtime.

24-31 Get the HelloServer service proxy as for the synchronous mode.

34 Instantiate the greet reply handler class.

37 Invoke the async_greet() operation by providing the reply handler.
This call is a non-blocking call. The application steps immediately to the next instruction. The invocation reply will be delivered to the application by invoking the greet_Reply operation of the reply handler. Note that this operation will be invoked in a middleware-provided thread.
41 Stop the runtime.
Note that some synchronization may be needed to avoid exiting before the async_greet reply is delivered to the application.

Using a specific DDS domain

Using the default RMI CRuntime implies that all the RMI invocations will be performed within the default DDS domain. The default domain id is the one specified by the current Lite DDS configuration, specifically in the Domain Service section of the related XML file. The default Lite DDS configuration files set the domain id to 0. For more information on configuring Vortex Lite please refer to the Vortex Lite Configuration Guide.

If the RMI application operates with a user-defined domain id, using the default CRuntime enables RMI interactions within that domain. In case of an application operating in multiple domains, it should create a CRuntime object for the targeted domain id and get a DDS_ServiceInterface object from that CRuntime. The DDS_ServiceInterface object provides all the convenient methods for server applications to register/unregister services and for client applications to get service proxies on the relevant domain id. These methods are the same as the DDS_Service object ones. The following code snippets show this in C++

cpp

Getting DDS_ServiceInterface in C++

// Getting a CRuntime on my specific domain
CRuntime_ref runtime = CRuntime::getRuntime(my_domain_id);
// Getting a DDS_ServiceInterface object
DDS_ServiceInterface_ref dds_service = runtime->getDDS_ServiceInterface();

Language mapping for Lite RMI

Rmipp compilation follows a set of mapping rules to generate language-specific source code. Most of these rules come from the standard OMG IDL-to-C++ mapping specification but with some specific differences. This chapter focuses on specific parts of this mapping. For more information, please refer to the relevant OMG specifications.

The following figure shows the language mapping of the HelloService IDL interface previously defined.

IDL Interface Mapping

IDL Interface Mapping

Mapping for interfaces

An interface is mapped to two C++ classes that contain public definitions of the operations defined in the interface.

The HelloServiceInterface abstract class is the base class of the HelloService implementation class. The HelloServiceInterfaceProxy class is the proxy object that represents locally the remote service. The client application should get a reference to this class to be able to invoke the remote service.

Mapping for operations

Each IDL operation, if not oneway, is mapped to two C++ functions. The first one, having the same name as the IDL operation, is used for synchronous invocations. The second one, having async_ concatenated to the IDL operation, is used for asynchronous invocations. A oneway operation maps only to the synchronous form of the operations.

The operations parameters and return types obey the same parameter passing rules as for the standard OMG IDL-to-C++ mapping. The asynchronous functions (methods) will return void and take only the in/inout parameters of the IDL operation, as well as a callback object used as a reply handler. This handler class is also generated for each non-void operation as an inner abstract class of the proxy class as depicted in the diagram with the greet_Reply_Handler class. This latter should be implemented by the user to handle the asynchronous invocation reply. Hence, the greet_Reply function (method) provides all the inout/out/return parameters of the corresponding IDL operation.

Mapping for basic types

The table below shows the C++ mapping of the IDL types that can be declared in the RMI services description file.

IDL sequences are mapped as specified by the DDS standard.

Mapping for basic types

IDL type C++
boolean DDS::Boolean
char DDS::Char
octet DDS::Octet
short DDS::Short
unsigned short DDS::UShort
long DDS::Long
unsigned long DDS::ULong
long long DDS::LongLong
unsigned long long DDS::ULongLong
float DDS::Float
double DDS::Double
string DDS::String

RMI Interface to DDS topics mapping rules

This chapter demonstrates the mapping rules driving the transformation of the IDL declarations of the RMI interfaces into the IDL declarations of the implied DDS topics.

  • For each <InterfaceName>, a new module is created with the same name and scope in the module DDS_RMI, where all the topics associated with the interface operations will be made.
  • Each <InterfaceName>.<operation name> creates two data structures, suffixed respectively with _request for the data structure that handles the request, and _reply for the data structure that handles the reply.
  • The <operation name>_request data struct will gather all [in] or [inout] parameters.
  • The <operation name>_reply data struct will gather the return value and all [inout] or [out] parameters.
  • req_info is used to enable the client service handler to pick the reply it is waiting for.
module HelloWorld {
   local interface HelloService : ::DDS_RMI::Services
   {
      void op1 (in string p1, inout short p2, out long p3);
   };
};
rmipp
module DDS_RMI {
  module HelloWorld {
    module HelloService {

   struct op1_request {
           DDS_RMI::Request_Header req_info;
           string p1;
           short p2;
        };
   #pragma keylist op1_request req_info.client_id.client_impl
                   req_info.client_id.client_instance

       struct op1_reply {
           DDS_RMI::Request_Header req_info;
           short p2;
           long p3;
       };
   #pragma keylist op1_reply req_info.client_id.client_impl
                   req_info.client_id.client_instance

    };
  };
};

RMI Runtime Configuration Options

The RMI runtime can be configured by a set of command line options. These options are passed directly to the runtime start operation as described in the section Runtime starting and stopping.

This chapter describes the set of supported options.

RMIServiceDiscoveryTimeout option

--RMIServiceDiscoveryTimeout = <seconds>

This is a client-side option that specifies the maximum duration (in seconds) that a client application can wait to find services. It influences the execution time of the DDS_Service.getServerProxy operation that is used to find a given service. The default value is set to 10 seconds. The need to set this value may come from some specific deployment environments with bad communication conditions.

RMIDurability option

--RMIDurability = <yes/no>

This option specifies whether to enable durability when using RMI in Vortex Lite. As this is currently unsupported in Vortex Lite, the default setting is no and should not be changed. For interoperability with Vortex OpenSplice, you must run your Vortex OpenSplice application with this option set to no, as Vortex OpenSplice will default to yes.

QoS policies XML schema

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            targetNamespace="http://www.omg.org/dds/"
            xmlns="http://www.omg.org/dds/"
            elementFormDefault="qualified">
    <xsd:element name="dcps">
        <xsd:complexType>
            <xsd:all>
                <xsd:element ref="domain" minOccurs="1" maxOccurs="1"/>
            </xsd:all>
        </xsd:complexType>
    </xsd:element>
    <xsd:element name="domain">
        <xsd:complexType>
            <xsd:sequence>
                <xsd:element ref="topic" minOccurs="1" maxOccurs="unbounded"/>
            </xsd:sequence>
            <xsd:attribute name="id" type="xsd:string" use="required"/>
        </xsd:complexType>
    </xsd:element>
    <xsd:element name="topic">
        <xsd:complexType>
            <xsd:all>
                <xsd:element ref="keylist" minOccurs="1" maxOccurs="1"/>
                <xsd:element ref="topic_qos" minOccurs="0" maxOccurs="1"/>
            </xsd:all>
            <xsd:attribute name="name" type="xsd:string" use="required"/>
            <xsd:attribute name="idltype" type="xsd:string" use="required"/>
            <xsd:attribute name="idlfile" type="xsd:string" use="required"/>
        </xsd:complexType>
    </xsd:element>

    <xsd:element name="keylist">
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element ref="keyMember" minOccurs="0" maxOccurs="unbounded"/>
          </xsd:sequence>
        </xsd:complexType>
    </xsd:element>
    <xsd:element name="keyMember" type="xsd:string"/>

     <xsd:element name="topic_qos">
       <xsd:complexType>
        <xsd:all>
            <xsd:element ref="topicDataQosPolicy" minOccurs="0" maxOccurs="1"/>
            <xsd:element ref="durabilityQosPolicy" minOccurs="0" maxOccurs="1"/>
            <xsd:element ref="latencyBudgetQosPolicy" minOccurs="0" maxOccurs="1"/>
            <xsd:element ref="livelinessQosPolicy" minOccurs="0" maxOccurs="1"/>
            <xsd:element ref="reliabilityQosPolicy" minOccurs="0" maxOccurs="1"/>
            <xsd:element ref="destinationOrderQosPolicy" minOccurs="0"
                             maxOccurs="1"/>
            <xsd:element ref="historyQosPolicy" minOccurs="0" maxOccurs="1"/>
            <xsd:element ref="resourceLimitsQosPolicy" minOccurs="0"
                             maxOccurs="1"/>
            <xsd:element ref="transportPriorityQosPolicy" minOccurs="0"
                             maxOccurs="1"/>
            <xsd:element ref="lifespanQosPolicy" minOccurs="0" maxOccurs="1"/>
            <xsd:element ref="ownershipQosPolicy" minOccurs="0" maxOccurs="1"/>
        </xsd:all>
      </xsd:complexType>
    </xsd:element>

     <xsd:element name="topicDataQosPolicy">
        <xsd:complexType>
          <xsd:all>
            <xsd:element name="value" type="xsd:base64Binary" minOccurs="1"
                              maxOccurs="1"/>
          </xsd:all>
        </xsd:complexType>
     </xsd:element>

    <xsd:element name="duration">
      <xsd:complexType>
        <xsd:all>
            <xsd:element name="sec" type="xsd:string" minOccurs="1" maxOccurs="1"/>
            <xsd:element name="nanosec" type="xsd:string" minOccurs="1"
                              maxOccurs="1"/>
        </xsd:all>
      </xsd:complexType>
    </xsd:element>

    <xsd:element name="durabilityQosPolicy">
      <xsd:complexType>
        <xsd:all>
            <xsd:element ref="durabilityKind" minOccurs="1" maxOccurs="1"/>
        </xsd:all>
      </xsd:complexType>
    </xsd:element>

    <xsd:element name="durabilityKind">
     <xsd:simpleType>
        <xsd:restriction base="xsd:string">
            <xsd:enumeration value="VOLATILE_DURABILITY_QOS"/>
            <xsd:enumeration value="TRANSIENT_LOCAL_DURABILITY_QOS"/>
            <xsd:enumeration value="TRANSIENT_DURABILITY_QOS"/>
            <xsd:enumeration value="PERSISTENT_DURABILITY_QOS"/>
        </xsd:restriction>
     </xsd:simpleType>
    </xsd:element>

    <xsd:element name="historyKind">
      <xsd:simpleType>
        <xsd:restriction base="xsd:string">
            <xsd:enumeration value="KEEP_LAST_HISTORY_QOS"/>
            <xsd:enumeration value="KEEP_ALL_HISTORY_QOS"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>

    <xsd:element name="latencyBudgetQosPolicy">
        <xsd:complexType>
          <xsd:all>
            <xsd:element ref="duration" minOccurs="1" maxOccurs="1"/>
          </xsd:all>
        </xsd:complexType>
    </xsd:element>
    <xsd:element name="livelinessQosPolicy">
        <xsd:complexType>
          <xsd:all>
            <xsd:element ref="duration" minOccurs="1" maxOccurs="1"/>
            <xsd:element ref="livelinessKind" minOccurs="1" maxOccurs="1"/>
          </xsd:all>
        </xsd:complexType>
    </xsd:element>

    <xsd:element name="reliabilityQosPolicy">
      <xsd:complexType>
        <xsd:all>
            <xsd:element ref="reliabilityKind" minOccurs="1" maxOccurs="1"/>
            <xsd:element ref="duration" minOccurs="1" maxOccurs="1"/>
        </xsd:all>
      </xsd:complexType>
    </xsd:element>

    <xsd:element name="reliabilityKind">
      <xsd:simpleType>
        <xsd:restriction base="xsd:string">
            <xsd:enumeration value="BEST_EFFORT_RELIABILITY_QOS"/>
            <xsd:enumeration value="RELIABLE_RELIABILITY_QOS"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>

    <xsd:element name="destinationOrderQosPolicy">
      <xsd:complexType>
        <xsd:all>
            <xsd:element ref="destinationOrderKind" minOccurs="1" maxOccurs="1"/>
        </xsd:all>
      </xsd:complexType>
    </xsd:element>

    <xsd:element name="destinationOrderKind">
      <xsd:simpleType>
        <xsd:restriction base="xsd:string">
            <xsd:enumeration value="BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS"/>
            <xsd:enumeration value="BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>

    <xsd:element name="livelinessKind">
      <xsd:simpleType>
        <xsd:restriction base="xsd:string">
            <xsd:enumeration value="AUTOMATIC_LIVELINESS_QOS"/>
            <xsd:enumeration value="MANUAL_BY_PARTICIPANT_LIVELINESS_QOS"/>
            <xsd:enumeration value="MANUAL_BY_TOPIC_LIVELINESS_QOS"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>

    <xsd:element name="historyQosPolicy">
      <xsd:complexType>
        <xsd:all>
            <xsd:element ref="historyKind" minOccurs="1" maxOccurs="1"/>
            <xsd:element name="depth" type="xsd:positiveInteger" default="1"
                              minOccurs="1" maxOccurs="1"/>
        </xsd:all>
      </xsd:complexType>
    </xsd:element>

    <xsd:element name="resourceLimitsQosPolicy">
      <xsd:complexType>
        <xsd:all>
            <xsd:element name="max_samples" type="xsd:positiveInteger"
                              minOccurs="1" maxOccurs="1"/>
            <xsd:element name="max_instances" type="xsd:positiveInteger"
                              minOccurs="1" maxOccurs="1"/>
            <xsd:element name="max_samples_per_instance"
                              type="xsd:positiveInteger" minOccurs="1"
                              maxOccurs="1"/>
            <xsd:element name="initial_samples" type="xsd:positiveInteger"
            minOccurs="1" maxOccurs="1"/>
            <xsd:element name="initial_instances" type="xsd:positiveInteger"
                              minOccurs="1" maxOccurs="1"/>
        </xsd:all>
      </xsd:complexType>
    </xsd:element>

    <xsd:element name="transportPriorityQosPolicy">
      <xsd:complexType>
        <xsd:all>
            <xsd:element name="value" type="xsd:nonNegativeInteger"
                              minOccurs="1" maxOccurs="1"/>
        </xsd:all>
      </xsd:complexType>
    </xsd:element>

    <xsd:element name="lifespanQosPolicy">
      <xsd:complexType>
        <xsd:all>
            <xsd:element ref="duration" minOccurs="1" maxOccurs="1"/>
        </xsd:all>
      </xsd:complexType>
    </xsd:element>

    <xsd:element name="ownershipQosPolicy">
      <xsd:complexType>
        <xsd:all>
            <xsd:element ref="ownershipKind" minOccurs="1" maxOccurs="1"/>
        </xsd:all>
      </xsd:complexType>
    </xsd:element>

    <xsd:element name="ownershipKind">
      <xsd:simpleType>
        <xsd:restriction base="xsd:string">
            <xsd:enumeration value="SHARED_OWNERSHIP_QOS"/>
            <xsd:enumeration value="EXCLUSIVE_OWNERSHIP_QOS"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>
</xsd:schema>

Contacts & Notices

Contacts

ADLINK Technology Corporation
400 TradeCenter
Suite 5900
Woburn, MA
01801
USA
Tel: +1 781 569 5819
ADLINK Technology Limited
The Edge
5th Avenue
Team Valley
Gateshead
NE11 0XA
UK
Tel: +44 (0)191 497 9900
ADLINK Technology SARL
28 rue Jean Rostand
91400 Orsay
France
Tel: +33 (1) 69 015354

Web: http://ist.adlinktech.com/

Contact: http://ist.adlinktech.com

E-mail: ist_info@adlinktech.com

LinkedIn: https://www.linkedin.com/company/79111/

Twitter: https://twitter.com/ADLINKTech_usa

Facebook: https://www.facebook.com/ADLINKTECH

Notices

Copyright © 2017 ADLINK Technology Limited. All rights reserved.

This document may be reproduced in whole but not in part. The information contained in this document is subject to change without notice and is made available in good faith without liability on the part of ADLINK Technology Limited. All trademarks acknowledged.

Indices and tables