Class RouterOptions

Namespace

OneImlx.Terminal.Configuration.Options

Assembly

OneImlx.Terminal.dll

The command router options.

public sealed class RouterOptions

Inheritance

object

RouterOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Caret

The terminal caret to show in the console. The default value is >.

public string Caret { get; set; }

Property Value

string

EnableRemoteDelimiters

Indicates whether to enable the remote delimiters. The actual delimiter values can be set by RemoteCommandDelimiter and RemoteMessageDelimiter.

public bool? EnableRemoteDelimiters { get; set; }

Property Value

bool?

Remarks

When enabled, remote senders can transmit multiple commands to the server as a single message, with each command separated by a delimiter. It's important to note that even if only a single command is sent, the message must be delimited for consistent message processing on the server side.

To construct a correct a delimited message, use the DelimitedMessage(TerminalOptions, params string[])

See Also

RemoteCommandDelimiter

RemoteMessageDelimiter

MaxRemoteClients

The maximum number of active remote client connections the router can accept. The default value is 5.

public int MaxRemoteClients { get; set; }

Property Value

int

RemoteCommandDelimiter

The delimiter to identify a complete command. The default value is \(c\).

public string RemoteCommandDelimiter { get; set; }

Property Value

string

Remarks

A RemoteCommandDelimiter is used while streaming a long command string from a remote source such as a network stream.

RemoteMessageDelimiter

The delimiter to identify a complete message. The default value is \(m\).

public string RemoteMessageDelimiter { get; set; }

Property Value

string

Remarks

A RemoteMessageDelimiter is used while streaming a multiple command string from a remote source such as a network stream.

RemoteMessageMaxLength

The maximum length of a single unprocessed remote message. The default value is 1024 characters.

public int RemoteMessageMaxLength { get; set; }

Property Value

int

Remarks

This is not the actual command string length, but the length of the message that is being streamed from a remote source.

Timeout

The command router timeout in milliseconds. The default value is 25 seconds. Use Infinite for infinite timeout.

public int Timeout { get; set; }

Property Value

int

Remarks

A command route starts at a request to execute the command and ends when the command run is complete or at an error.