Next Topic

Previous Topic

Book Contents

The "Socket" Message Source

The socket message source allows any external tool to send text messages over a TCP socket. These messages are then processed using the corresponding rules.

An example configuration file is located at <TRAVERSE_HOME>/etc/messages/ism/00_src_socket_ism.xml:

<message-handler>

<source type="socket" name="ism">

<enabled>true</enabled>

<duplicateEventInterval>60</duplicateEventInterval>

<logunmatched>false</logunmatched> <!-- log unmatched messages -->

<port>7659</port> <!-- TCP port for incoming connections -->

<connections>4</connections> <!-- maximum concurrent connections -->

<timeout>60</timeout> <!-- idle timeout, in seconds -->

<username>ismuser</username> <!-- username to use for login -->

<password>fixme</password> <!-- password to use for login -->

</source>

</message-handler>

The various parameters control the number of concurrent connections, port number, login username and password for the socket interface.

In order to connect and send messages over the TCP socket, the client must first log in to the socket source using the configured username and password. After logging in, the client can send text strings in free text format (terminated with a \r\n).

The commands sent by a client and responses sent back by the server must adhere to the following formatting conventions:

In This Section

Client Command Format

Server Response Format

Client Commands