Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TerminalManager

A terminal session manager.

Hierarchy

  • BaseManager
    • TerminalManager

Implements

Index

Constructors

constructor

  • Construct a new terminal manager.

    Parameters

    Returns TerminalManager

Properties

Private _connectionFailure

_connectionFailure: any

Private _isReady

_isReady: any

Private _names

_names: any

Private _onDisposed

_onDisposed: any

Handle a session terminating.

Private _onStarted

_onStarted: any

Handle a session starting.

Private _pollModels

_pollModels: any

Private _ready

_ready: any

Private _runningChanged

_runningChanged: any

Private _terminalConnections

_terminalConnections: any

Readonly serverSettings

serverSettings: ISettings

The server settings of the manager.

Accessors

_models

  • get _models(): any
  • Returns any

connectionFailure

  • get connectionFailure(): ISignal<this, Error>
  • A signal emitted when there is a connection failure.

    Returns ISignal<this, Error>

disposed

  • get disposed(): ISignal<this, void>
  • A signal emitted when the delegate is disposed.

    Returns ISignal<this, void>

isDisposed

  • get isDisposed(): boolean
  • Test whether the delegate has been disposed.

    Returns boolean

isReady

  • get isReady(): boolean
  • Test whether the manager is ready.

    Returns boolean

ready

  • get ready(): Promise<void>
  • A promise that fulfills when the manager is ready.

    Returns Promise<void>

runningChanged

  • get runningChanged(): ISignal<this, IModel[]>
  • A signal emitted when the running terminals change.

    Returns ISignal<this, IModel[]>

Methods

connectTo

dispose

  • dispose(): void
  • Dispose of the resources used by the manager.

    Returns void

isAvailable

  • isAvailable(): boolean
  • Whether the terminal service is available.

    Returns boolean

refreshRunning

  • refreshRunning(): Promise<void>
  • Force a refresh of the running terminals.

    Returns Promise<void>

    A promise that with the list of running terminals.

    Notes

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

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>
  • Create an iterator over the most recent running terminals.

    Returns IIterator<IModel>

    A new iterator over the running terminals.

shutdown

  • shutdown(name: string): Promise<void>
  • Shut down a terminal session by name.

    Parameters

    • name: string

    Returns Promise<void>

shutdownAll

  • shutdownAll(): Promise<void>
  • Shut down all terminal sessions.

    Returns Promise<void>

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

startNew

  • Create a new terminal session.

    Returns Promise<ITerminalConnection>

    A promise that resolves with the terminal instance.

    Notes

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

Generated using TypeDoc