Option | Description |
-h | --help | Displays usage information. Optional. |
-n host | --hostname host | Name of the host on which the event correlator is running. Optional. The default is localhost. Non-ASCII characters are not allowed in host names. |
-p port | --port port | Port on which the event correlator is listening. Optional. The default is 15903. |
-c channel | --channel channel | Named channel on which to listen for output events from the correlator. Optional. The default is to listen for all output events. You can specify the -c option multiple times to listen on multiple channels. |
-f file | --filename file | Dumps all received events in the specified file. Optional. The default is to write the events to stdout. |
-s | --suppressBatch | --suppressbatch | Omits BATCH timestamps from the output events. Optional. The default is to preserve BATCH timestamps in events. |
-z | --zeroAtFirstBatch | --zeroatfirstbatch | Records the first received batch of events as being received at 0 milliseconds after the engine_receive tool was started. Optional. The default is that the first received batch of events is received at the number of milliseconds since engine_receive actually started. |
-C | --logChannels | Specifies that you want engine_receive output to include the channel that an event arrives on. If you then use the engine_receive output as input to engine_send, events are delivered back to the same-named channels. See Event association with a channel. |
-r | --reconnect | Automatically (re)connect to the server when available. |
-x | --qdisconnect | Disconnect from the correlator if the engine_receive tool cannot keep up with the events from the correlator. |
-v | --verbose | Requests verbose output during engine_receive execution. Optional. |
-u | --utf8 | Indicates that received event files are in UTF-8 encoding. This specifies that the engine_receive tool should not convert the input to any other encoding. |
-V | --version | Displays version information for the engine_receive tool. Optional. |
-Xconfig file | --configFile file | Specifies a special configuration file that the correlator uses to initialize its networking. Specify this option only as directed by Apama Technical Support to troubleshoot networking problems. For more information, see Using the Apama component extended configuration file. |
Value | Description |
0 | All events were received successfully. |
1 | No connection to the event correlator was possible or the connection failed. |
2 | Other error(s) occurred while receiving events. |