API Management
API Management
Breadcrumbs

Socket Client

Socket Client Policy helps in sending data to sockets and receiving data from sockets.

When a socket connection is established, the socket can be used to communicate with the server.

Configuration

The properties that have to be configured to use the policy are described below.

image2025-4-16_18-2-33.png

Property

Description

Port

Port number of the socket

Server IP

IP address of the socket

Sending Message Type

Mode of the message transfer while sending a message is classified as below:

  • Text Message: Messages will be encoded as string.

  • Byte Message: Messages will be encoded as bytes.

Receiving Message Type

Mode of the message transfer while receiving a message is classified as below:

  • Text Message: Messages will be decoded as string.

  • Byte Message: Messages will be decoded as bytes.

DecodingType

Messages received in the communication will be decoded in the following ways:

  • None: All messages present in the stream are fetched.

  • ISO: Messages are decoded based on the ISO standards.
    If the Decoding Type property value is 'ISO', then the following properties will be visible above the Decoding Type property:

    • Message Length Numeric Type: This property specifies the numeric type in which the total message length is present in the message.
      Numeric types available are:

      • Hexadecimal

      • Decimal

      • Bytes
        Decimal is the default value.

    • No of Chars in Message Length Field: This property specifies the number of characters to be present in the ISO message length field.

      This property is visible only when the Message Length Numeric Type property is set to either 'Hexadecimal' or 'Decimal'.

    • Includes Header Length: Select this property if the Header length (in bytes) needs to be included in the input message.

Suspended Timeout

If the message sent by a client takes more time than the Suspend Timeout to execute, then the next message is sent.