The Socket Input transporter reads binary data from the socket interface, wraps it with ByteBuffer, and sends it to the next module that is configured in the adapter configuration file. Set values for this transporter in the adapter configuration file.
Parameter | 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 parameter. 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 parameter. 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 parameter 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 parameter designates the time period for attempting to re-establish an outgoing connection, in seconds. The default value is 0. |
BlockSize |
Type: integer (Advanced) Define the size of the data block when transporting data from the socket server to the socket client. The default value is 1024. |
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. |