Class TerminalRouterContext

Namespace

OneImlx.Terminal.Runtime

Assembly

OneImlx.Terminal.dll

The ITerminalRouter<TContext> context.

public abstract class TerminalRouterContext

Inheritance

object

TerminalRouterContext

Derived

TerminalConsoleRouterContext

TerminalCustomRouterContext

TerminalGrpcRouterContext

TerminalHttpRouterContext

TerminalTcpRouterContext

TerminalUdpRouterContext

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TerminalRouterContext(TerminalStartMode, Dictionary<string, object>?, string[]?)

Initializes a new TerminalRouterContext instance.

protected TerminalRouterContext(TerminalStartMode startMode, Dictionary<string, object>? customProperties = null, string[]? arguments = null)

Parameters

startMode TerminalStartMode

The terminal start mode.

customProperties Dictionary<string, object>

The custom properties.

arguments string[]

The command line arguments.

Properties

Arguments

The terminal driver arguments or command line arguments.

public string[]? Arguments { get; }

Property Value

string[]

Remarks

These arguments are the command line inputs provided at the application's main entry point when starting a terminal session via a driver or via Process. This allows for dynamic and flexible terminal session configuration, adapting to different operational parameters and user-defined settings. It's particularly useful for modifying startup behaviors and handling various runtime environments, ensuring the terminal adapts to specific needs and contexts.

CustomProperties

The custom properties.

public Dictionary<string, object>? CustomProperties { get; }

Property Value

Dictionary<string, object>

Remarks

A collection of key-value pairs that can be used to pass additional information or configuration settings to the terminal session. These properties offer a way to extend the functionality and behavior of the terminal without modifying the core implementation.

StartMode

The terminal start mode.

public TerminalStartMode StartMode { get; }

Property Value

TerminalStartMode

TerminalCancellationToken

The cancellation token to cancel the global terminal routing.

public CancellationToken TerminalCancellationToken { get; }

Property Value

CancellationToken

Remarks

This cancellation token is used for global control over the entire terminal routing. When triggered, it cancels the entire terminal routing, effectively stopping the routing any further commands. This is particularly useful in scenarios where a complete shutdown of the terminal's operational context is required, such as during application termination or critical error handling.