4.1. Usage¶
This section explains how to run Replay Service from a command line. In particular, it describes:
- How to Start Replay Service (Section 4.1.1).
- How to Stop Replay Service (Section 4.1.2).
- Replay Service command-line parameters (Section 4.1.3).
4.1.1. Starting Replay Service¶
Replay Service runs as a separate application. The script to run the executable is in <NDDSHOME>/bin. (See Section 1.3 for the path to NDDSHOME.)
rtireplayservice [options]
To start Replay Service with a default configuration, enter:
$NDDSHOME/bin/rtireplayservice
This command will run Replay Service indefinitely until you stop it.
Note
Replay Service is pre-loaded with a built-in configuration that has default settings.
4.1.2. Stopping Replay Service¶
To stop Replay Service, press Ctrl-c. Replay Service will perform a clean shutdown.
4.1.3. Replay Service Command-Line Parameters¶
The following table describes all the command-line parameters available in
Replay Service. To list the available parameters, run rtireplayservice -help
.
All command-line parameters are optional; if specified, they override the values of any corresponding settings in the loaded XML configuration. See Section 4.2.3 for the XML elements that can be overridden with command-line parameters.
Parameter | Description |
---|---|
-appName <string> | Application name used to identify this execution for remote administration, and to name the Connext DDS participant. |
-cfgFile <string> | Semicolon-separated list of configuration file paths. Default: Unspecified |
-cfgName | Configuration name
Used to find a <replay_service>
matching tag in the configuration file. |
-domainIdBase <int> | This value is added to the domain IDs in the <domain_participant>
tag in the configuration file. For example, if you set
-domainIdBase to 50 and use domain IDs 0 and 1 in the
configuration file, Replay Service will read domains 0 and 1
from the database, but will replay that data into domains
50 and 51. Default: 0 |
-D<name>=<value> | Defines a variable that can be used as an alternate replacement for
XML environment variables, specified in the form $(VAR_NAME). Note that definitions in the environment take precedence over these definitions. |
-help | Shows this help. |
-heapSnapshotDir | Output directory where the heap monitoring snapshots are dumped.
The filename format is: RTI_heap_<appName>_<processId>_<index>.log |
-heapSnapshotPeriod <sec> | Period at which heap monitoring snapshots are dumped.
Enables heap monitoring if > 0. Default: 0 (disabled) |
-logFormat <format> | A mask to configure the format of the log messages for both Replay Service and Connext DDS.
Default: DEFAULT |
-maxObjectsPerThread <int> | Maximum number of Thread-specific
objects that can be created. Default: 1024. |
-remoteAdministrationDomainId <int> | Enables remote administration and
sets the domain ID for communication. Default: Remote administration is not enabled. |
-remoteMonitoringDomainId <int> | Enables remote monitoring and
sets the domain ID for status publication. Default: Remote monitoring is not enabled. |
-verbosity [0-6] |
Default: 1 (exceptions) |
-version | Prints the program version and exits. |
4.1.4. Replay Service Runtime Behavior¶
Replay Service currently does not delete DataWriters, even if all original DataWriters were deleted in the recorded database.