Class TerminalProcessor

Namespace

OneImlx.Terminal.Runtime

Assembly

OneImlx.Terminal.dll

The default implementation of ITerminalProcessor for processing inputs in a terminal environment.

public sealed class TerminalProcessor : ITerminalProcessor, IAsyncDisposable

Inheritance

object

TerminalProcessor

Implements

ITerminalProcessor

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The TerminalProcessor manages a queue of TerminalInputOutput that are processed asynchronously in the background. It routes individual requests to the ICommandRouter for execution. The processor supports handling both single requests and batches of requests, as well as partial streams sent by clients.

Constructors

TerminalProcessor(ICommandRouter, ITerminalExceptionHandler, IOptions<TerminalOptions>, ITerminalTextHandler, ILogger<TerminalProcessor>)

Initializes a new instance of the TerminalProcessor class.

public TerminalProcessor(ICommandRouter commandRouter, ITerminalExceptionHandler terminalExceptionHandler, IOptions<TerminalOptions> terminalOptions, ITerminalTextHandler textHandler, ILogger<TerminalProcessor> logger)

Parameters

commandRouter ICommandRouter

The command router to process commands.

terminalExceptionHandler ITerminalExceptionHandler

The handler for exceptions thrown during command processing.

terminalOptions IOptions<TerminalOptions>

Configuration options for the terminal.

textHandler ITerminalTextHandler

The terminal text handler.

logger ILogger<TerminalProcessor>

Logger for logging operations within the queue.

Properties

IsBackground

Gets a value indicating whether the processor is running in the background.

public bool IsBackground { get; }

Property Value

bool

IsProcessing

Gets a value indicating whether the processor is actively handling requests.

public bool IsProcessing { get; }

Property Value

bool

UnprocessedIOs

Retrieves a snapshot of inputs that are pending processing.

public IReadOnlyCollection<TerminalInputOutput> UnprocessedIOs { get; }

Property Value

IReadOnlyCollection<TerminalInputOutput>

Remarks

The returned collection represents the state of unprocessed inputs at the time of retrieval. The actual state may change by the time the caller processes it.

Methods

AddAsync(TerminalInputOutput)

Asynchronously adds a TerminalInputOutput for processing.

public Task AddAsync(TerminalInputOutput terminalIO)

Parameters

terminalIO TerminalInputOutput

The input to add.

Returns

Task

A task representing the asynchronous operation.

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

public ValueTask DisposeAsync()

Returns

ValueTask

ExecuteAsync(TerminalInputOutput)

Asynchronously executes the input and populates the output.

public Task ExecuteAsync(TerminalInputOutput terminalIO)

Parameters

terminalIO TerminalInputOutput

The input to execute.

Returns

Task

Remarks

The ExecuteAsync(TerminalInputOutput) method processes the input immediately and returns the output. For background processing, use AddAsync(TerminalInputOutput).

StartProcessing(TerminalRouterContext, bool, Func<TerminalInputOutput, Task>?)

Starts processing terminal inputs with the specified context and configuration.

public void StartProcessing(TerminalRouterContext terminalRouterContext, bool background, Func<TerminalInputOutput, Task>? responseHandler = null)

Parameters

terminalRouterContext TerminalRouterContext

The context for the terminal router.

background bool

If true, the processor operates in the background, handling multiple requests asynchronously. If false, it processes individual requests and sends responses asynchronously.

responseHandler Func<TerminalInputOutput, Task>

An optional handler for processing responses.

StopProcessingAsync(int)

Attempts to stop background processing within a specified timeout period.

public Task<bool> StopProcessingAsync(int timeout)

Parameters

timeout int

The timeout duration in milliseconds.

Returns

Task<bool>

A task representing the asynchronous operation, returning true if processing stopped within the timeout; otherwise, false.

StreamAsync(byte[], int, string, string?)

Asynchronously streams a continuous flow of TerminalInputOutput as a byte array.

public Task StreamAsync(byte[] bytes, int bytesLength, string senderId, string? senderEndpoint)

Parameters

bytes byte[]

The data to stream.

bytesLength int

The length of the data to process. Use the total length to process all bytes.

senderId string

The identifier of the sender.

senderEndpoint string

An optional endpoint of the sender.

Returns

Task

Remarks

The StreamAsync(byte[], int, string, string?) method is optimized for handling continuous streams of data. The bytesLength parameter specifies the portion of the input to process, avoiding unnecessary duplication of data.

WaitUntilCanceledAsync(CancellationToken)

Initiates a task that delays indefinitely until cancellation is requested.

public Task WaitUntilCanceledAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token to trigger termination.

Returns

Task