Interface ITerminalProcessor

Namespace

OneImlx.Terminal.Runtime

Assembly

OneImlx.Terminal.dll

An abstraction for processing the TerminalInputOutput individually or in batches, with optional asynchronous handling of responses in the background.

public interface ITerminalProcessor : IAsyncDisposable

Inherited Members

IAsyncDisposable.DisposeAsync()

Remarks

The ITerminalProcessor supports processing inputs, executing commands with responses, and managing streaming workflows efficiently in background tasks.

Properties

IsBackground

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

bool IsBackground { get; }

Property Value

bool

IsProcessing

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

bool IsProcessing { get; }

Property Value

bool

UnprocessedIOs

Retrieves a snapshot of inputs that are pending processing.

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.

Task AddAsync(TerminalInputOutput terminalIO)

Parameters

terminalIO TerminalInputOutput

The input to add.

Returns

Task

A task representing the asynchronous operation.

ExecuteAsync(TerminalInputOutput)

Asynchronously executes the input and populates the output.

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.

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.

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.

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.

Task WaitUntilCanceledAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token to trigger termination.

Returns

Task