Versions Compared

Key

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

...

If multiple custom listeners are available, you can select the one you want to use from the Select Implementation boxmenu.

Configuration

You can configure the following settings.

...

Protocol

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

Default: TCP

Port

Specifies the port that the socket listener will listen on for incoming connections. Specify 0 to automatically select an open port. After the asset is deployed, the selected port will be printed in the console.

Acceptor Threads

Specifies the number of acceptor threads used to receive messages. Not applicable if Protocol is set to UDP.

1 is the minimum value allowed.

Default: 2

Worker Threads

Specifies the number of worker threads used to process messages.

1 is the minimum value allowed.

Default: 50 

Character Set

Specifies the character set used to decode and encode bytes.

Default: UTF-8 

Connection BacklogSpecifies the number of connections allowed in the backlog before new connections will be rejected. This configuration is optional. Leaving the field empty is recommended.
Read Mode

Specifies the listener 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.

Default: prefixed 

...

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 

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 listener will use getBytes with 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 listener will parse the string as a sequence of bytes in decimal values separated by spaces, e.g., 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 of the message that may be required by the socket. If specified, the message format will be <LENGTH_FIELD_BYTES><MESSAGE_DATA_BYTES><SUFFIX_BYTES>.

...

  • Enter 1 to only log errors
  • Enter 2 to log errors and warnings.
  • Enter 3 to log errors, warnings, and info.
  • Enter 4 to log errors, warnings, info, and debug.

Default is 3 

Change Log

1.1

  • Added support for UDP.

1.0

  • Initial release.