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

...

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 and 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 and Scripting Basics for additional information.
Character setSet

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 and Scripting Basics for additional information.

Default is UTF-8 .

Read modeMode

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 and Scripting Basics for additional information.

Default is prefixed 

Fixed

...

Length

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

...

Each four-byte message from the client would be considered a message.

Token

...

Delimited

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

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

Specifies the token that delimits messages.

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

Token type 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)

The settings in this section only apply if the read mode is set to prefixed

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

Length of the length field 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 message is. The default is to read 4 bytes and convert it to an integer.
Include prefix Prefix in length Length [true, false] [default: true] 

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

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

Default is true.

Prefixed

...

Variable-

...

Length (

...

String)

The settings in this section only apply if the read mode is set to prefixed-string.

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

String prefix length 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 Prefix in length 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 the SSL enabled Enabled [ default:false ] to true to listen over SSL. 

...