Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TerminalManager

A terminal session manager. The namespace for TerminalManager statics.

Hierarchy

  • TerminalManager

Implements

Index

Interfaces

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _connectionFailure

_connectionFailure: Signal<this, Error> = new Signal<this, Error>(this)

Private _isDisposed

_isDisposed: boolean = false

Private _isReady

_isReady: boolean = false

Private _models

_models: IModel[] = []

Private _pollModels

_pollModels: Poll

Private _ready

_ready: Promise<void>

Private _runningChanged

_runningChanged: Signal<this, IModel[]> = new Signal<this, TerminalSession.IModel[]>(this)

Private _sessions

_sessions: Set<ISession> = new Set<TerminalSession.ISession>()

serverSettings

serverSettings: ISettings

The server settings of the manager.

Accessors

connectionFailure

  • get connectionFailure(): ISignal<this, Error>

  • A signal emitted when there is a connection failure.

    Returns ISignal<this, Error>

isDisposed

  • get isDisposed(): boolean

isReady

  • get isReady(): boolean

ready

  • get ready(): Promise<void>

runningChanged

  • get runningChanged(): ISignal<this, IModel[]>

Methods

Private _getOptions

Private _onStarted

Private _onTerminated

  • _onTerminated(name: string): void

connectTo

dispose

  • dispose(): void

isAvailable

  • isAvailable(): boolean

refreshRunning

  • refreshRunning(): Promise<void>

  • Force a refresh of the running sessions.

    Notes

    This is intended to be called only in response to a user action, since the manager maintains its internal state.

    Returns Promise<void>

Protected requestRunning

  • requestRunning(): Promise<void>

  • Execute a request to the server to poll running terminals and update state.

    Returns Promise<void>

running

  • running(): IIterator<IModel>

shutdown

  • shutdown(name: string): Promise<void>

shutdownAll

  • shutdownAll(): Promise<void>

startNew

  • Create a new terminal session.

    Parameters

    • Optional options: IOptions

      The options used to connect to the session.

    Returns Promise<ISession>

    A promise that resolves with the terminal instance.

    Notes

    The manager serverSettings will be used unless overridden in the options.

Generated using TypeDoc