ShellSession class abstract

A running process or shell on the node, with byte streams wired to the session channel.

The node relays stdout/stderr to the client and forwards client stdin via writeStdin. Control operations (resize, sendSignal) map to the matching protocol messages. The implementation is provided by a ShellBackend; Stage 1 ships a pipe-based process backend.

Implementers

• ProcessShellSession
• ScriptPtyShellSession
• WinptyShellSession

Constructors

ShellSession()

Properties

exitCode → Future<int>

Completes with the process exit code once it terminates.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

pid → int?

The backend process id, if known.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shellFamily → ShellFamily

The command-language family of the launched shell, so the client can speak the matching marker/command dialect over an interactive session.

no setter

stderr → Stream<Uint8List>

Bytes written by the process to standard error.

no setter

stdout → Stream<Uint8List>

Bytes written by the process to standard output.

no setter

Methods

closeStdin() → Future<void>

Signals end-of-input on standard input (half-close).

kill() → Future<void>

Forcibly terminates the process and releases resources.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

resize({required int cols, required int rows}) → void

Resizes the terminal, where the backend supports it (no-op otherwise).

sendSignal(String signal) → void

Sends a POSIX signal name (e.g. SIGINT, SIGTERM) to the process.

toString() → String

A string representation of this object.

inherited

writeStdin(List<int> data) → void

Writes data to the process's standard input.

Operators

operator ==(Object other) → bool

The equality operator.

inherited