Versions Compared

Key

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

...

Scroll Table Layout
widths30%,70%

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 is 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 is UTF-8 

Read Mode

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

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

Default is hex 

Prefixed Variable-Length (Number)

...

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

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

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

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

Prefixed Variable-Length (Number) Configuration Example

If the client sends a request containing request1 that was prefixed with an int using the character set CP037 and the length includes the prefix length, then the request would be represented by the following bytes:

[0, 0, 0, 12, 114, 101, 113, 117, 101, 115, 116, 49]

The first four bytes ([0, 0, 0, 12]) are the integer 12, which is the length of the entire message including the first 4 bytes of the prefix. The remaining bytes are the string request1 as encoded by the configured character set.

Prefixed Variable-Length (String)

...

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 transport encodes 0 into bytes and multiplies the number by the number provided in this field.
Include Prefix in Length [true, false] [default: true]

Indicates if the length read from the prefix should also include the length of the prefix.

Default is true

SSL

Set SSL Enabled [ default:false ] to true to listen over SSL. 

...