Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DefaultTerminalSession

An implementation of a terminal interface. The static namespace for DefaultTerminalSession.

Hierarchy

  • DefaultTerminalSession

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _disconnected

_disconnected: boolean = false

Private _isDisposed

_isDisposed: boolean = false

Private _isReady

_isReady: boolean = false

Private _messageReceived

_messageReceived: Signal<this, IMessage> = new Signal<this, TerminalSession.IMessage>(this)

Private _name

_name: string

Private _readyPromise

_readyPromise: Promise<void>

Private _reconnectAttempt

_reconnectAttempt: number = 0

Private _reconnectLimit

_reconnectLimit: number = 7

Private _terminated

_terminated: Signal<this, void> = new Signal<this, void>(this)

Private _url

_url: string

Private _ws

_ws: WebSocket | null = null

serverSettings

serverSettings: ISettings

The server settings for the session.

Accessors

isDisposed

  • get isDisposed(): boolean

isReady

  • get isReady(): boolean

messageReceived

  • get messageReceived(): ISignal<this, IMessage>

model

name

  • get name(): string

ready

  • get ready(): Promise<void>

terminated

  • get terminated(): Signal<this, void>

  • A signal emitted when the session is shut down.

    Returns Signal<this, void>

Methods

Private _initializeSocket

  • _initializeSocket(): Promise<void>

Private _noOp

  • _noOp(): void

Private _reconnectSocket

  • _reconnectSocket(): void

clone

dispose

  • dispose(): void

reconnect

  • reconnect(): Promise<void>

send

shutdown

  • shutdown(): Promise<void>

Static connectTo

Static isAvailable

  • isAvailable(): boolean

Static listRunning

  • List the running terminal sessions.

    Parameters

    • Optional settings: ISettings

      The server settings to use.

    Returns Promise<IModel[]>

    A promise that resolves with the list of running session models.

Static shutdown

  • shutdown(name: string, settings?: ISettings): Promise<void>

  • Shut down a terminal session by name.

    Parameters

    • name: string

      The name of the target session.

    • Optional settings: ISettings

      The server settings to use.

    Returns Promise<void>

    A promise that resolves when the session is shut down.

Static shutdownAll

  • shutdownAll(settings?: ISettings): Promise<void>

  • Shut down all terminal sessions.

    Parameters

    • Optional settings: ISettings

      The server settings to use.

    Returns Promise<void>

    A promise that resolves when all the sessions are shut down.

Static startNew

  • Start a new terminal session.

    Parameters

    • Default value options: IOptions = {}

      The session options to use.

    Returns Promise<ISession>

    A promise that resolves with the session instance.

Generated using TypeDoc