Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IManager

The interface for a terminal manager.

Notes

The manager is responsible for maintaining the state of running terminal sessions.

Hierarchy

  • IBaseManager
    • IManager

Implemented by

Index

Properties

Methods

Properties

connectionFailure

connectionFailure: ISignal<IManager, NetworkError>

A signal emitted when there is a connection failure.

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.

Readonly isReady

isReady: boolean

Test whether the manager is ready.

Readonly ready

ready: Promise<void>

A promise that fulfills when the manager is ready.

runningChanged

runningChanged: ISignal<IManager, IModel[]>

A signal emitted when the running terminals change.

Readonly serverSettings

serverSettings: ISettings

The server settings for the manager.

Methods

connectTo

  • Parameters

    • options: Omit<IOptions, "serverSettings">

    Returns ITerminalConnection

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

isAvailable

  • isAvailable(): boolean

  • Whether the terminal service is available.

    Returns boolean

refreshRunning

  • refreshRunning(): Promise<void>

  • Force a refresh of the running terminal sessions.

    Returns Promise<void>

    A promise that with the list of running sessions.

    Notes

    This is not typically meant to be called by the user, since the manager maintains its own internal state.

running

  • running(): IIterator<IModel>

  • Create an iterator over the known 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

      The name of the terminal session.

    Returns Promise<void>

    A promise that resolves when the session is shut down.

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.

    Parameters

    • Optional options: IOptions

      The options used to create the session.

    Returns Promise<ITerminalConnection>

    A promise that resolves with the terminal instance.

    Notes

    The manager serverSettings will be always be used.

Generated using TypeDoc