Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ITerminalConnection

An interface for a terminal session.

Hierarchy

  • IObservableDisposable
    • ITerminalConnection

Index

Properties

Methods

Properties

Readonly connectionStatus

connectionStatus: ConnectionStatus

The current connection status of the terminal.

connectionStatusChanged

connectionStatusChanged: ISignal<this, ConnectionStatus>

A signal emitted when the terminal connection status changes.

Readonly disposed

disposed: ISignal<this, 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, IMessage>

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

Readonly model

model: IModel

The model associated with the session.

Readonly name

name: string

Get the name of the terminal session.

Readonly serverSettings

serverSettings: 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

  • reconnect(): Promise<void>

  • Reconnect to the terminal.

    Returns Promise<void>

    A promise that resolves when the terminal has reconnected.

send

  • Send a message to the terminal session.

    Parameters

    Returns void

shutdown

  • shutdown(): Promise<void>

  • Shut down the terminal session.

    Returns Promise<void>

Generated using TypeDoc