Command Usage

Synopsis

esp_rmds -f mapFile -p host:port/workspace/project [ OPTION ...]

Description

esp_rmds can operate as either an input or an output adapter. An input adapter passes data from RMDS in to the Event Stream Processor. An output adapter passes data from the Event Stream Processor out to RMDS. A single adapter instance cannot operate both ways. To have an input adapter and an output adapter, you must run two separate adapter instances.

The metadata describing the connection has several parts, including a map file, a configuration file, and possibly a configuration stream resident on a running instance of the Event Stream Processor.

Only limited Level 2 data is available via RMDS Marketfeed. For full order book depth, use the Reuters OMM adapter (esp_rmdsomm).

The Marketfeed adapter process runs as a daemon, getting its configuration from a map file. It handles SIGHUP; so you can enter kill -s SIGHUP pid on Linux or kill -s HUP pid on Solaris (where pid is the process ID of the esp_rmds daemon, which you can obtain using the ps command) to gracefully shut down the adapter. Using the KILL signal rather than the HUP signal may prevent a complete clean up of system resources.

There are three directories containing additional information underneath the directory where the adapter is installed: doc, examples, and config. The doc directory contains Reuters README files that describe various configuration options. The examples directory contains several example map files that demonstrate many features. The config directory contains example RMDS configuration files. Minimally, you must modify the RMDS config file with your site's specific information. Typically, you must also modify the map file to match the Event Stream Processor.

Required Arguments

• -f mapFile – specify the map file containing the metadata required to map the market data to/from RMDS.
• -p host:port/workspace/project – specify the URI to connect to the server (cluster manager). For example, -p localhost:19011/default/prj1 specifies a project called prj1 in the default workspace of an ESP cluster server using port 19011 on the machine at which you entered the command.

Options

• -a in|out – specify whether the RMDS Marketfeed adapter instance is passing data in to the Event Stream Processor or receiving data passed out from it. Valid values are in and out. Since the default value is in, this option is typically omitted when subscribing to market data.

  For backward compatibility, "subscribe" (in) and "publish" (out) are still allowed, but these options have been deprecated.

• -c user:password – if you are using an authentication method that requires credentials (such as Kerberos, PAM, or RSA), this option passes those authentication credentials to Event Stream Processor. If Event Stream Processor successfully authenticates with these credentials, the connection is maintained, otherwise Event Stream Processor immediately closes the connection.
• -d debugLevel – set the debug level. The valid range is 0 - 7, with 0 being minimal and 7 being verbose. By default, the debug level is 4.
• -e – negotiate encrypted OpenSSL sockets for all communication with the Event Stream Processor, which must be started in encrypted mode when using this option.
• -F configFile – specify the RMDS configuration file, overriding the configuration file specified in the map file.
• -g gatewayHost – explicitly specify the Event Stream Processor gateway host.
• -G – use Kerberos authentication. This option is required when the Event Stream Processor is started with the -V gssapi option.
• -h – print a short help message describing the syntax of this command.
• -k privateRSAKeyFile – perform authentication using the RSA private key file mechanism instead of password authentication. The privateRSAKeyFile must specify the absolute path file name of the private RSA key file. With this option enabled, the user name must be specified with the -c option, but the password is not required. In addition, Event Stream Processor must be started with the -k option.
• -l 0|1|2|3 – specify the location to which log messages are sent. Use 0 for no log messages, 1 to send to stderr only (the default), 2 to send to syslog only, and 3 to send to both stderr and syslog.
• -r subscribeRetryInterval – specify how many seconds to wait (default is 300) between attempts to resubscribe to a RIC. (If a subscription to a RIC is marked CLOSED or CLOSEDRECOVER, you must resubscribe to that RIC for data to flow.) To disable resubscription attempts, specify 0 as the value. Periodically resubscribing can compensate for a temporary condition where the source is not ready for subscribers. Each unsuccessful resubscribe attempt generates a failure event which may result in a status update marking the item stale.
• -s streamName – specify the stream to be used when running in discovery mode. This option is used by the connector start mechanism and specifies the single stream for which mapped columns have been discovered.
• -v – print the version of the RMDS Marketfeed Adapter and exit.
• -w retrySeconds – specify the number of seconds to wait between retries when connecting to the Event Stream Processor. The default is 5. Specify 0 to try only once.
• -x optName – specify various extra settings; use -x help to see a list of possible values.
• -z publishCount – specify the number of values to pass to the Event Stream Processor before terminating. By default this is 0, which means never terminate.
• -Z subscribeCount – specify the number of values to pass to RMDS before terminating. By default this is 0, which means never terminate.

Examples

To start an input adapter, using the map file subexample.map.xml, running a project named project1 in a workspace named ws1 on port 19011 of the localhost machine, enter:

esp_rmds -c user:pw -p localhost:19011/ws1/project1 -a in -f subexample.map.xml