EXAMPLES

Lifecycle

1) Description

The Lifecycle example is used to illustrate the different lifecycle states of the sample and the instance.

The autodispose_unregistered_instances flag of the Lifecycle publisher determines whether an invocation of unregister_instance on this publisher will cause the instance to become disposed.

2) Design

It consists of 2 units:

3) Scenario

The Publisher and the Subscriber processes communicate using the following topic:

   struct Msg
   {
      long userID;         // User ID
      string message;      // content;
      string writerStates; // the different state of the writer
    };

The writerStates field contains the different states of the writer :

  usage : LifecyclePublisher [autodispose_flag] [writer_action]
   autodispose_flag =  false | true
   writer_action = dispose | unregister | stoppub

The LifecyclePublisher :
Depending on the user's choice as the second parameter passed on command line (dispose | unregister | stoppub), it will either:

  • Case 1 : second parameter passed on command line "dispose"
    • publish the Msg Sample.
    • Dispose the instance.
    • Delete the DataWriter.
    • Stop the Subscriber.
  • Case 2 : second parameter passed on command line "unregister"
    • publish the Msg Sample.
    • Unregister the instance.
    • Delete the DataWriter.
    • Stop the Subscriber.
  • Case 3 : second parameter passed on command line "stoppub"
    • publish the Msg Sample.
    • Delete the DataWriter.
    • Stop the Subscriber.

For any of those actions, it will output on its console:

  • "SAMPLE SENT"
  • "INSTANCE DISPOSED"
  • "INSTANCE UNREGISTERED"
  • "DATAWRITER DELETED"
  • "STOPPING SUBSCRIBER"

The LifecycleSubscriber :

  • Reads the (same unique) Msg Topic Sample.
  • Display the Sample's information:
    • The 2 fields of Msg Topic : message and writerStates
    • The States :
      • The "sample_state", possible values are:
        • "NOT_READ_SAMPLE_STATE"
        • "READ_SAMPLE_STATE"
      • The "view_state", possible values are:
        • "NEW_VIEW_STATE"
        • "NOT_NEW_VIEW_STATE"
      • The "instance_state", possible values are
        • "ALIVE_INSTANCE_STATE"
        • "NOT_ALIVE_DISPOSED_INSTANCE_STATE"
        • "NOT_ALIVE_NO_WRITERS"

Running of examples

Running the examples in a Posix environment

Environment Setup

Let's call OpenSplice_install_dir the OpenSplice installation directory.

The OpenSplice environment variables must be set in order for the examples to build/run correctly. To do this, open a terminal and source the "OpenSplice_install_dir/release.com" script supplied with the distribution.

C Executables

Building the examples is described on the Summary page

Two executables are generated in the bin directory when the example is built:

For C

Java5 executables

Building the examples is described on the Summary page

Two jars are generated in the java5 directory when the example is built:

For Java5

ISO C++ 2 Executables

Building the examples is described on the Summary page

Two executables are generated in the isocpp2 directory when the example is built:

Running the example

Ensure that the environment for OpenSplice is set up correctly as described above for each new terminal used.

It is recommended that you run the subscriber and publisher in separate terminals to avoid mixing the output

Running in single process (heap memory) configuration : the application starts OpenSplice middleware

Running in multiple process shared memory configuration

To enable deployment in this mode, an OpenSplice configuration file must be selected that has shared memory support e.g. one of the ospl_shmem xml configuration files found in the OpenSplice_install_dir/etc/config directory.

Starting the subscriber and publisher

        usage : LifecycleDataPublisher [autodispose_flag] [writer_action]
                Where
                . autodispose_flag = false | true
                . writer_action = dispose | unregister | stoppub

Running C/C#/Java5 examples on Windows

Environment Setup

Let's call OpenSplice_install_dir the OpenSplice installation directory.

The OpenSplice environment variables must be set in order for the examples to run correctly. To do this open an OpenSplice Command Prompt which will set up the environment variables for OpenSplice automatically. The OpenSplice Command Prompt can be selected from the launcher. Alternatively, open a windows Command Prompt and execute the "OpenSplice_install_dir\release.bat" batch script supplied with the distribution.

C/C# Executables

Building the examples is described on the Summary page

Two executables are generated in the bin directory when the example is built:

For C

For C#

Java5 Executables

Building the examples is described on the Summary page

Two jars are generated in the java5 directory when the example is built:

For Java5

ISO C++ 2 Executables

Building the examples is described on the Summary page

Two executables are generated in the bin directory when the example is built:

Running the C/C++/C#/Java Examples

Ensure that the environment for OpenSplice is set up correctly as described above for each new command prompt used.

The following steps describe how to run the examples:

Running in single process (heap memory) configuration : the application starts OpenSplice middleware

Running in multiple process shared memory configuration

To enable deployment in this mode, an OpenSplice configuration file must be selected that has shared memory support e.g. one of the ospl_shmem xml configuration files found in the OpenSplice_install_dir\etc\config directory.

Starting the subscriber and publisher

        usage : LifecycleDataPublisher [autodispose_flag] [writer_action]
                Where
                . autodispose_flag = false | true
                . writer_action = dispose | unregister | stoppub