ReplWebSocketSession
Runs a REPL session over a raw WebSocket connection.
- Kind:
Class - Namespace: Repl.WebSocket
- Assembly:
Repl.WebSocket - Source: src/Repl.WebSocket/ReplWebSocketSession.cs
Signature
Section titled “Signature”public static class ReplWebSocketSessionInheritance
Section titled “Inheritance”Methods
Section titled “Methods”RunAsync(ReplApp, WebSocket, ReplRunOptions?, Action<TerminalControlMessage>?, CancellationToken)
Section titled “RunAsync(ReplApp, WebSocket, ReplRunOptions?, Action<TerminalControlMessage>?, CancellationToken)”Runs a REPL app session over a WebSocket-backed host using explicit run options and receives parsed terminal control messages as they arrive.
public static ValueTask<int> RunAsync(ReplApp app, WebSocket socket, ReplRunOptions? options, Action<TerminalControlMessage>? onControlMessage, CancellationToken cancellationToken = default)Parameters
Section titled “Parameters”app(ReplApp): Configured REPL app instance.socket(WebSocket): Connected WebSocket.options(ReplRunOptions): Run options.onControlMessage(Action<TerminalControlMessage>): Optional observer for parsed terminal control messages.cancellationToken(CancellationToken): Cancellation token.
Returns
Section titled “Returns”ValueTask<int> - Execution exit code.
RunAsync(ReplApp, WebSocket, ReplRunOptions?, CancellationToken)
Section titled “RunAsync(ReplApp, WebSocket, ReplRunOptions?, CancellationToken)”Runs a REPL app session over a WebSocket-backed host using explicit run options.
public static ValueTask<int> RunAsync(ReplApp app, WebSocket socket, ReplRunOptions? options, CancellationToken cancellationToken = default)Parameters
Section titled “Parameters”app(ReplApp): Configured REPL app instance.socket(WebSocket): Connected WebSocket.options(ReplRunOptions): Run options.cancellationToken(CancellationToken): Cancellation token.
Returns
Section titled “Returns”ValueTask<int> - Execution exit code.
RunAsync(ReplApp, WebSocket, CancellationToken)
Section titled “RunAsync(ReplApp, WebSocket, CancellationToken)”Runs a REPL app session over a WebSocket-backed host.
public static ValueTask<int> RunAsync(ReplApp app, WebSocket socket, CancellationToken cancellationToken = default)Parameters
Section titled “Parameters”app(ReplApp): Configured REPL app instance.socket(WebSocket): Connected WebSocket.cancellationToken(CancellationToken): Cancellation token.
Returns
Section titled “Returns”ValueTask<int> - Execution exit code.