Interface ITerminalConnection

An interface for a terminal session.

interface ITerminalConnection {
    connectionStatus: Terminal.ConnectionStatus;
    connectionStatusChanged: ISignal<ITerminalConnection, Terminal.ConnectionStatus>;
    disposed: ISignal<ITerminalConnection, void>;
    isDisposed: boolean;
    messageReceived: ISignal<ITerminalConnection, Terminal.IMessage>;
    model: Terminal.IModel;
    name: string;
    serverSettings: ServerConnection.ISettings;
    dispose(): void;
    reconnect(): Promise<void>;
    send(message): void;
    shutdown(): Promise<void>;
}

Hierarchy

Properties

connectionStatus connectionStatusChanged disposed isDisposed messageReceived model name serverSettings

Methods

dispose reconnect send shutdown

Properties

Readonly connectionStatus

connectionStatus: Terminal.ConnectionStatus

The current connection status of the terminal.

connectionStatusChanged

connectionStatusChanged: ISignal<ITerminalConnection, Terminal.ConnectionStatus>

A signal emitted when the terminal connection status changes.

Readonly disposed

disposed: ISignal<ITerminalConnection, void>

A signal emitted when the object is disposed.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

messageReceived

messageReceived: ISignal<ITerminalConnection, Terminal.IMessage>

A signal emitted when a message is received from the server.

Readonly model

model: Terminal.IModel

The model associated with the session.

Readonly name

name: string

Get the name of the terminal session.

Readonly serverSettings

serverSettings: ServerConnection.ISettings

The server settings for the session.

Methods

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

reconnect

send

shutdown

Settings

Member Visibility

Theme

On This Page

connectionStatusconnectionStatusChangeddisposedisDisposedmessageReceivedmodelnameserverSettingsdisposereconnectsendshutdown