ReplAppRemoteBackend
Adapts an existing ReplApp, borrowing its application and root service provider.
- Kind:
Class - Namespace: Repl.Remote
- Assembly:
Repl.Remote.Defaults - Source: src/Repl.Remote.Defaults/ReplAppRemoteBackend.cs
Signature
Section titled “Signature”public sealed class ReplAppRemoteBackend : IRemoteReplBackend, IAsyncDisposableInheritance
Section titled “Inheritance”Implements
Section titled “Implements”Constructors
Section titled “Constructors”ReplAppRemoteBackend(ReplApp, IServiceProvider?)
Section titled “ReplAppRemoteBackend(ReplApp, IServiceProvider?)”Creates an adapter. The caller retains application and root-provider ownership.
public ReplAppRemoteBackend(ReplApp app, IServiceProvider? services = null)Parameters
Section titled “Parameters”app(ReplApp)services(IServiceProvider)
Methods
Section titled “Methods”DescribeAsync(CancellationToken)
Section titled “DescribeAsync(CancellationToken)”Describes the exposed command graph.
public ValueTask<RemoteCommandGraph> DescribeAsync(CancellationToken cancellationToken)Parameters
Section titled “Parameters”cancellationToken(CancellationToken)
Returns
Section titled “Returns”ValueTask<RemoteCommandGraph>
DisposeAsync()
Section titled “DisposeAsync()”Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.
public ValueTask DisposeAsync()Returns
Section titled “Returns”ValueTask - A task that represents the asynchronous dispose operation.
ExecuteAsync(RemoteInvocationRequest, CancellationToken)
Section titled “ExecuteAsync(RemoteInvocationRequest, CancellationToken)”Runs a command using the application’s ordinary invocation pipeline.
public ValueTask<RemoteExecutionResult> ExecuteAsync(RemoteInvocationRequest request, CancellationToken cancellationToken)Parameters
Section titled “Parameters”request(RemoteInvocationRequest)cancellationToken(CancellationToken)
Returns
Section titled “Returns”ValueTask<RemoteExecutionResult>
OpenTerminalAsync(RemoteTerminalOptions, Func<string, CancellationToken, ValueTask>, CancellationToken)
Section titled “OpenTerminalAsync(RemoteTerminalOptions, Func<string, CancellationToken, ValueTask>, CancellationToken)”Starts a terminal whose output is delivered through the supplied asynchronous sink.
public ValueTask<IRemoteTerminalSession> OpenTerminalAsync(RemoteTerminalOptions options, Func<string, CancellationToken, ValueTask> writeOutput, CancellationToken cancellationToken)Parameters
Section titled “Parameters”options(RemoteTerminalOptions)writeOutput(Func<string, CancellationToken, ValueTask>)cancellationToken(CancellationToken)
Returns
Section titled “Returns”ValueTask<IRemoteTerminalSession>