RemoteTerminal
One terminal connection. Output is UTF-8 text containing VT sequences.
- Kind:
Class - Namespace: Repl.Remote
- Assembly:
Repl.Remote - Source: src/Repl.Remote/RemoteTerminal.cs
Signature
Section titled “Signature”public sealed class RemoteTerminal : IAsyncDisposableInheritance
Section titled “Inheritance”Implements
Section titled “Implements”Methods
Section titled “Methods”DisposeAsync()
Section titled “DisposeAsync()”Closes the remote session without stopping the server process.
public ValueTask DisposeAsync()Returns
Section titled “Returns”InputAsync(string, CancellationToken)
Section titled “InputAsync(string, CancellationToken)”Sends text or VT input.
public Task InputAsync(string text, CancellationToken cancellationToken = default)Parameters
Section titled “Parameters”text(string)cancellationToken(CancellationToken)
Returns
Section titled “Returns”InterruptAsync(CancellationToken)
Section titled “InterruptAsync(CancellationToken)”Interrupts the remote command.
public Task InterruptAsync(CancellationToken cancellationToken = default)Parameters
Section titled “Parameters”cancellationToken(CancellationToken)
Returns
Section titled “Returns”ResizeAsync(int, int, CancellationToken)
Section titled “ResizeAsync(int, int, CancellationToken)”Changes the remote terminal size.
public Task ResizeAsync(int columns, int rows, CancellationToken cancellationToken = default)Parameters
Section titled “Parameters”columns(int)rows(int)cancellationToken(CancellationToken)
Returns
Section titled “Returns”Properties
Section titled “Properties”Completion
Section titled “Completion”Gets the remote exit code, or a transport failure if the connection was lost.
public Task<int> Completion { get; }Returns
Section titled “Returns”Task<int>
Output
Section titled “Output”Gets terminal output in arrival order. A slow consumer disconnects rather than losing text.
public ChannelReader<string> Output { get; }Returns
Section titled “Returns”ChannelReader<string>