Socket Output Transporter Module Configuration

The Socket Output transporter obtains data from the previous module configured in the adapter configuration file, and outputs it using the socket interface. Set values for this transporter in the adapter configuration file.

XML Element Description
Host

Type: string

(Required if EpFile is set to null) If the transporter is acting as a socket client, specify the socket server name. If the transporter is acting as a socket server, do not set this element. No default value.

Port

Type: integer

(Required if EpFile is set to null) Specify the socket server port. If you set this to -1, the adapter reads from the ephemeral port file, which is specified in the EpFile element. The default value is 12345.

EpFile

Type: string

(Required if Host and Port are set to null) Specify the file that contains the socket server name/IP and port number. No default value.

Retryperiod

Type: integer

(Advanced) When the transporter is acting as a socket server, this element designates the length of time to wait for the first incoming connection before switching to the continuous state.

When the transporter is acting as a socket client, this element designates the time period for attempting to re-establish an outgoing connection, in seconds. The default value is 0.

KeepAlive

Type: boolean

(Advanced) If set to true, the adapter disconnects from the socket server if there are no data transports for the duration of time specified in your router configuration. For example, if you set your router configuration to two hours and there are no messages during that time, the adapter disconnects from the socket server.

The default value is false.