Versions Compared

Key

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

...

Scroll Table Layout
sortDirectionASC
repeatTableHeadersdefault
widths30%,70%
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

Port [0 - 65535]
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.

Worker
Threads [minimum: 1, default: 50]
Threads

Specifies the number of worker threads used to process messages.

1 is the minimum value allowed.

Default is 50 

Character Set
[default: UTF-8]

Specifies the character set used to decode and encode bytes.

Default is UTF-8 

Connection Backlog
[optional]
Specifies the number of connections allowed in the backlog before new connections will be rejected.
Recommended to leave at the default
This configuration is optional. Leaving the field empty is recommended.
Read Mode
[fixed, prefixed, prefixed-string, token][default: prefixed]

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 is prefixed 

Fixed Length

Specify the size of the fixed message in the Fixed Length [default: 1024] field.

...

Scroll Table Layout
sortDirectionASC
repeatTableHeadersdefault
widths30%,70%
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

Token Delimiter [default: byte 23, End-Of-Transmission-Block]

Specifies the token that delimits messages.

Default is byte 23, End-Of-Transmission-Block 

Token Type [string, hex, byte] [default: hex]

Specifies the type of conversion used to get bytes from the token.

  • Specify string and the listener 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 listener will parse the string as a sequence of bytes in decimal values separated by spaces, e.g., 10 13 

Default is hex 

...

Scroll Table Layout
sortDirectionASC
repeatTableHeadersdefault
widths30%,70%
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

Length of the Length Field
(1, 2, 3, 4, or 8) [default: 4, int]

Determines the length of the length field. The desired number of bytes will be read and converted to a number to determine

how long

the length of the message

is.

. 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
Prefix in Length [true, false] [default: true]
Length Field Size in Length 

Indicates if the length read

from the prefix

should also include the length

of the prefix

field size.

For example, if the option is enabled, a 4-byte message would send a

prefix that had a value

length value of 8. This is because

the int prefix is 4

the default length of the length field is 4 bytes and will be added to the message body length. 

Default is true

Static Prefix [optional]
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 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 is 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
[optional]

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>.

Prefixed Variable-Length (Number) Configuration Example

...

Scroll Table Layout
sortDirectionASC
repeatTableHeadersdefault
widths30%,70%
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

String Prefix Length [the number of string digits to read in] [default: 4]

Specifies the size of the message length prefix. The number of bytes to read is calculated based on the number of digits converted into bytes. The listener encodes 0 into bytes and multiplies the number by the number provided in this field.

Default is 4 

Include Prefix in Length [true, false] [default: true]

Setting to true indicates that the length reads from the prefix should also include the length of the prefix.

Default is true 

Prefixed Variable-Length (String) Configuration Example

...