Class ExecInteractiveSession

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

A running interactive command. Read ReadEventsAsync(CancellationToken) (once) for output, write stdin and resize the terminal concurrently, and await WaitForExitAsync(CancellationToken) for the exit code.

public sealed class ExecInteractiveSession : IAsyncDisposable

Inheritance

object

ExecInteractiveSession

Implements

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ExitCode

Completes with the exit code once the command finished; faults if the stream failed first.

public Task<int> ExitCode { get; }

Property Value

Task<int>

Methods

CancelAsync()

Cancels the command and releases the stream.

public ValueTask CancelAsync()

Returns

ValueTask

CompleteStdinAsync()

Closes standard input (EOF) while output keeps flowing.

public ValueTask CompleteStdinAsync()

Returns

ValueTask

DisposeAsync()

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

public ValueTask DisposeAsync()

Returns

ValueTask

A task that represents the asynchronous dispose operation.

ReadEventsAsync(CancellationToken)

Streams output and finally the exit event. May be enumerated once. If the gateway closes the stream without an exit event the enumeration throws, so a failing command cannot be missed.

public IAsyncEnumerable<ExecEvent> ReadEventsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

IAsyncEnumerable<ExecEvent>

ResizeAsync(uint, uint, CancellationToken)

Tells the command's terminal about a new window size.

public ValueTask ResizeAsync(uint columns, uint rows, CancellationToken cancellationToken = default)

Parameters

columns uint

rows uint

cancellationToken CancellationToken

Returns

ValueTask

WaitForExitAsync(CancellationToken)

Waits for the exit code. When nobody is reading ReadEventsAsync(CancellationToken), output is drained and discarded.

public ValueTask<int> WaitForExitAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

ValueTask<int>

WriteStdinAsync(ReadOnlyMemory<byte>, CancellationToken)

Sends bytes to the command's standard input.

public ValueTask WriteStdinAsync(ReadOnlyMemory<byte> data, CancellationToken cancellationToken = default)

Parameters

data ReadOnlyMemory<byte>

cancellationToken CancellationToken

Returns

ValueTask