Interface IManager

The interface for a terminal manager.

Notes

The manager is responsible for maintaining the state of running terminal sessions.

interface IManager {
    connectionFailure: ISignal<Terminal.IManager, NetworkError>;
    disposed: ISignal<Terminal.IManager, void>;
    isActive: boolean;
    isDisposed: boolean;
    isReady: boolean;
    ready: Promise<void>;
    runningChanged: ISignal<Terminal.IManager, Terminal.IModel[]>;
    serverSettings: ServerConnection.ISettings;
    connectTo(
        options: Omit<Terminal.ITerminalConnection.IOptions, "serverSettings">,
    ): Terminal.ITerminalConnection;
    dispose(): void;
    isAvailable(): boolean;
    refreshRunning(): Promise<void>;
    running(): IterableIterator<Terminal.IModel>;
    shutdown(name: string): Promise<void>;
    shutdownAll(): Promise<void>;
    startNew(
        options?: Terminal.ITerminal.IOptions,
    ): Promise<Terminal.ITerminalConnection>;
}

Hierarchy (View Summary)

Implemented by

Properties

connectionFailure disposed isActive isDisposed isReady ready runningChanged serverSettings

Methods

connectTo dispose isAvailable refreshRunning running shutdown shutdownAll startNew

Properties

connectionFailure

connectionFailure: ISignal<Terminal.IManager, NetworkError>

A signal emitted when there is a connection failure.

Readonlydisposed

disposed: ISignal<Terminal.IManager, void>

A signal emitted when the object is disposed.

ReadonlyisActive

isActive: boolean

Whether the manager is active.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

ReadonlyisReady

isReady: boolean

Test whether the manager is ready.

Readonlyready

ready: Promise<void>

A promise that fulfills when the manager is ready.

runningChanged

runningChanged: ISignal<Terminal.IManager, Terminal.IModel[]>

A signal emitted when the running terminals change.

ReadonlyserverSettings

serverSettings: ServerConnection.ISettings

The server settings for the manager.

Methods

connectTo

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

isAvailable

refreshRunning

  • refreshRunning(): Promise<void>

  • Force a refresh of the running terminal sessions.

    Returns Promise<void>

    A promise that with the list of running sessions.

    Notes

    This is not typically meant to be called by the user, since the manager maintains its own internal state.

running

shutdown

shutdownAll

startNew

Settings

Member Visibility

On This Page

Notes
Properties
Methods