Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space FUNCTDEV and version SVC2025.3

...

Protocol

Specifies the protocol used to transmit messages. Options are TCP or UDP.

Default: TCP

Host

Specifies the host where the application is running. You can specify a fixed value or programmatically specify the host by choosing Scripted and clicking Edit Script to access the script editor. See Extensibility or Scripting Basics for additional information.

Default: localhost 

PortSpecifies the port on the host where the client will send messages. You can specify a fixed value or programmatically specify the port number by choosing Scripted and clicking Edit Script to access the script editor. See Extensibility or Scripting Basics for additional information.
Character Set

Specifies the character set used for encoding messages. You can specify a fixed value or programmatically specify the character set by choosing Scripted and clicking Edit Script to access the script editor. See Extensibility or Scripting Basics for additional information.

Default: UTF-8 

Read Mode

Specifies the mode for reading messages.

  • Specify fixed for fixed length messages that are always the same size.
  • Specify prefixed for messages that have an int (4 bytes) length prefix at the beginning of the message.
  • Specify prefixed-string for messages with a series of string digits prefixing the message.
  • Specify token for messages that are delimited by an end character or uni code sequence.
  • Specify none to configure the tool to continue immediately without waiting to read the next message from the server.

You can specify a fixed value or programmatically specify the read mode by choosing Scripted and clicking Edit Script to access the script editor. See Extensibility or Scripting Basics for additional information.

Default: prefixed 

Format

Specifies how the request and response bytes are interpreted. Options are hex-string or byte-array.

Setting the format to byte-array will read and send the bytes as is. Payloads defined in the client’s text editor will be converted into bytes using the configured character set. File inputs will be read as bytes and sent as is.

Setting the format to hex-string will convert both the request and response to hex-encoded strings. In this format, the payload defined in the client should also be provided as a hex-string, which will then be sent as bytes. This format is useful for handling messages with non-printable ASCII characters, as it allows them to be represented as readable hex values (for example, 0A1F03).

Default: byte-array

Fixed Length

Specify the size of the fixed message in the Fixed Length field.

...

Length of the Length Field

Determines the length of the length field. The desired number of bytes will be read and converted to a number to determine the length of the message. You can specify the following values: 1 , 2 , 3 , 4 , or 8.

The default is to read 4 bytes and convert it to an integer.

Include Length Field Size in Length Length 

Indicates if the length read should also include the length field size.

For example, if the option is enabled, a 4-byte message would send a length value of 8. This is because the default length of the length field is 4 bytes and will be added to the message body length. 

Default: true

Format of Static Prefix/Suffix 

Specifies the type of conversion used to convert the static prefix/suffix into bytes.

  • Specify string and the socket will use getBytes with the configured character set to convert to bytes.
  • Specify hex and the string will be parsed as a sequence of hexadecimal values. For example, 0a 0d would be the bytes 10 13.
  • Specify byte and the socket will parse the string as a sequence of bytes in decimal values separated by spaces, for example, 10 13.

Default: hex 

Static Prefix

Specifies a prefix segment to be added to the message that may be required. If specified, the message format will be <PREFIX_BYTES><LENGTH_FIELD_BYTES><MESSAGE_DATA_BYTES>.

Static Suffix

Specifies a suffix segment to be added to the message that may be required. If specified, the message format will be <LENGTH_FIELD_BYTES><MESSAGE_DATA_BYTES><SUFFIX_BYTES>.

...