The OpenSplice Tools are Java applications. In order to start these tools you need to have Java installed and set up correctly. The easiest way to start any tool is through the OpenSplice Launcher, however they can also be started from command line as follows.
Please note that the JAVA_HOME variable must be set and pointed to an appropriate JDK/JRE for these applications to work. See “why do the launcher options appear greyed out” for more information.
Command Line
Posix
Before any OpenSplice operations can be performed the DDS environment needs to be set up correctly. This is done by starting a shell and sourcing the release.com script which is located in the root directory of the OpenSplice installation. For example:
demo-dev:/opt/ZettaScale/OpenSplice/7.0.0/HDE/x86_64.linux$ source release.com
The following will be output to terminal:
<<< OpenSplice HDE Release X.X.X For x86_64.linux, Date 20XX-XX-XX >>>
Confirm the environment has been set up correctly:
$ ospl -version
OpenSplice version : X.X.X
At this stage in a Posix environment you can start the Launcher and navigate to all OpenSplice tools, documentation, examples and more via:
$ ospllauncher
Tester can be started using the command:
$ ospltest
Tuner can be started using the command:
$ ospltun
Configurator
$ osplconf
Memory statistics can be started using the command:
$ mmstat
Mmstat arguments:
Usage:
mmstat -h
mmstat [-M|m] [-e] [-a] [-i interval] [-s sample_count] [URI]
mmstat [-t|T] [-i interval] [-s sample_count] [-l limit] [-o C|S|T] [-n nrEntries] [-f filter_expression] [URI]Show the memory statistics of the OpenSplice system identified by the specified URI. If no URI is specified, the environment variable OSPL_URI will be used. If the environment variable is not set either, the default domain will be selected. The default display interval is 3 seconds.
Mode:
-m Show memory statistics (default mode)
-M Show memory statistics difference
-t Show meta object references
-T Show meta object references differenceOptions:
-h Show this help
-e Extended mode, shows bar for allocated memory
-a Show pre-allocated memory as well.
-i <interval> Display interval (in milliseconds)
-s <sample_count> Stop after sample_count samples
-l <limit> Show only object count >= limit
-o <C|S|T> Order by object[C]ount/object[S]ize/[T]otalSize
-n <nrEntries> Display only the top nrEntries items (useful only in combination with ordering)
-f <filter_expression> Show only meta objects which name passes the filter expressionUse ‘q‘ to terminate the monitor
Use ‘t‘ to immediately show statistics
Windows
All windows installations of OpenSplice after v6.3 install a Launcher from which all OpenSplice tools can be launched. The tools can also be launched from command prompt if required.
Before any OpenSplice operations can be performed the DDS environment needs to be set up correctly. This is done by starting a shell and sourcing the release.bat script which is located in the root directory of the OpenSplice installation. For example:
C:\Program Files\ZettaScale\OpenSplice\X.X.X\HDE\x86_64.win64>release.bat
“<<< OpenSplice HDE Release X.X.X For x86_64.win64, Date 20XX-XX-XX >>>”
Confirm the environment has been set up correctly:
> ospl -version
OpenSplice version : X.X.X
At this stage you can start the Launcher and navigate to all OpenSplice tools, documentation, examples and more via:
> ospllauncher
Tester can be started using the command:
> ospltest
Tuner can be started using the command:
> ospltun
Configurator
> osplconf
Memory statistics can be started using the command:
> mmstat
Tester and Memory Statistics command line arguments
Tester Arguments:
Usage:
-ns Do not display the splash screen on startup-uri <URI> Run OpenSplice Tester with the provided URI. In case the URI starts with http: a soap connection is assumed. The URL can be followed by the URI (starting with ftp:) if no URI is provided the OSPL_URI environment variable is used e.g. -uri http://127.0.0.1:8000, ftp:///<uri file name> when using soap also use the -nc option since no local OSPL is available when used locally, the domain name or the URI of the configuration can be specified in the URI parameter.
-dsl <language> The default script language for test scripts, js (javascript) is default
-nac Do not automatically connect to OpenSplice
-noplugins Do not automatically load plugins at startup
-s <script> automatically start the execution of <script> after startup
-b <script> automatically start the execution of <batchscript> after startup
-plugindir <dir> extra plugin directory to search
-e exit the application after running the first (batch)script
-headless run ospltest without a GUI
-slogdir <dir> Place script log files in the specified <dir> for the current headless session. Option is ignored if -headless is not specified.
-dumpcsv <dir> enable auto dumping of the sample list to the specified <dir> after every script execution
-rc <port> enable remote control via <port>
-l <topicsfile> create readers/writers for topics listed in topicsfile. topicfile is a file with a list of topics, see the F1 help in the Tester GUI for the syntax of the file.
-c <classname> create an instance of <classname> which can introduce extra functionality (like interpreted fields)
-j <jarname> jar (not on classpath) which can be used to create extra classes (-c or -t options)
Mmstat arguements:
Usage:
mmstat -h
mmstat [-M|m] [-e] [-a] [-i interval] [-s sample_count] [URI]
mmstat [-t|T] [-i interval] [-s sample_count] [-l limit] [-o C|S|T] [-n nrEntries] [-f filter_expression] [URI]Show the memory statistics of the OpenSplice system identified by the specified URI. If no URI is specified, the environment variable OSPL_URI will be used. If the environment variable is not set either, the default domain will be selected. The default display interval is 3 seconds.
Mode:
-m Show memory statistics (default mode)
-M Show memory statistics difference
-t Show meta object references
-T Show meta object references differenceOptions:
-h Show this help
-e Extended mode, shows bar for allocated memory
-a Show pre-allocated memory as well.
-i <interval> Display interval (in milliseconds)
-s <sample_count> Stop after sample_count samples
-l <limit> Show only object count >= limit
-o <C|S|T> Order by object[C]ount/object[S]ize/[T]otalSize
-n <nrEntries> Display only the top nrEntries items (useful only in combination with ordering)
-f <filter_expression> Show only meta objects which name passes the filter expressionUse ‘q‘ to terminate the monitor
Use ‘t‘ to immediately show statistics