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()

Fields

StreamDelimiter

Represents the delimiter used to identify individual TerminalInputOutput within a continuous stream of bytes. The delimiter is set to 0x1E (ASCII "Record Separator"), a non-printable control character commonly used to separate data and unlikely to appear in standard text.

public byte StreamDelimiter

Field Value

byte

Properties

Caret

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

public string Caret { get; set; }

Property Value

string

DisableResponse

Gets or sets a value indicating whether responses are disabled. The default value is false.

public bool DisableResponse { get; set; }

Property Value

bool

Remarks

When disabled or set to true, the terminal server or host application operates in a request-processing-only mode. In this mode, the server executes incoming requests but does not send back any responses to the client.

MaxClients

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

public int MaxClients { get; set; }

Property Value

int

MaxLength

The maximum length of a single unprocessed command or batch. The default value is 1024 characters.

public int MaxLength { get; set; }

Property Value

int

Remarks

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

Name

The terminal router name. The default value is console.

public string Name { get; set; }

Property Value

string

Remarks

This value is used for licensing checks and should match the router's Name. Set this value to tcp, udp, grpc, http, console, or a custom value prefixed with custom_ based on the type of router being used.

RouteDelay

Define the route delay in milliseconds. The default value is 50 milliseconds.

public int RouteDelay { get; set; }

Property Value

int

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 request starts at a request to execute the command and ends when the command run is complete or at an error.