Class TerminalManager

A terminal session manager.

Hierarchy

BaseManager
- TerminalManager
  - TerminalManager.NoopManager

Implements

Terminal.IManager

Index

Constructors

Properties

_connectionFailure _isReady _names _onDisposed _onStarted _pollModels _ready _runningChanged _terminalConnections serverSettings

Accessors

_models connectionFailure disposed isActive isDisposed isReady ready runningChanged

Methods

connectTo dispose isAvailable refreshRunning requestRunning running shutdown shutdownAll startNew

Constructors

constructor

new TerminalManager(options?): TerminalManager
Construct a new terminal manager.
Parameters
- Optional options: TerminalManager.IOptions
Returns TerminalManager
Overrides BaseManager.constructor
- Defined in packages/services/lib/terminal/manager.d.ts:13

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: ServerConnection.ISettings

The server settings of the manager.

Accessors

`Private` _models

get _models(): any
Returns any
- Defined in packages/services/lib/terminal/manager.d.ts:95

connectionFailure

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

Returns ISignal<this, Error>
Implementation of IManager.connectionFailure

Overrides BaseManager.connectionFailure
- Defined in packages/services/lib/terminal/manager.d.ts:33

disposed

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

Returns ISignal<this, void>
Implementation of IManager.disposed

Inherited from BaseManager.disposed
- Defined in packages/services/lib/basemanager.d.ts:37

isActive

get isActive(): boolean
Whether the manager is active.

Returns boolean
Implementation of IManager.isActive

Inherited from BaseManager.isActive
- Defined in packages/services/lib/basemanager.d.ts:57

isDisposed

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

Returns boolean
Implementation of IManager.isDisposed

Inherited from BaseManager.isDisposed
- Defined in packages/services/lib/basemanager.d.ts:45

isReady

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

Returns boolean
Implementation of IManager.isReady

Overrides BaseManager.isReady
- Defined in packages/services/lib/terminal/manager.d.ts:21

ready

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

Returns Promise<void>
Implementation of IManager.ready

Overrides BaseManager.ready
- Defined in packages/services/lib/terminal/manager.d.ts:25

runningChanged

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

Returns ISignal<this, Terminal.IModel[]>
Implementation of IManager.runningChanged
- Defined in packages/services/lib/terminal/manager.d.ts:29

Methods

connectTo

connectTo(options): ITerminalConnection
Parameters
- options: Omit<Terminal.ITerminalConnection.IOptions, "serverSettings">
Returns ITerminalConnection
Implementation of IManager.connectTo
- Defined in packages/services/lib/terminal/manager.d.ts:42

dispose

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

Returns void
Implementation of IManager.dispose

Overrides BaseManager.dispose
- Defined in packages/services/lib/terminal/manager.d.ts:37

isAvailable

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

Returns boolean
Implementation of IManager.isAvailable
- Defined in packages/services/lib/terminal/manager.d.ts:41

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.
Implementation of IManager.refreshRunning
- Defined in packages/services/lib/terminal/manager.d.ts:58

`Protected` requestRunning

requestRunning(): Promise<void>
Execute a request to the server to poll running terminals and update state.

Returns Promise<void>
- Defined in packages/services/lib/terminal/manager.d.ts:84

running

running(): IterableIterator<Terminal.IModel>
Create an iterator over the most recent running terminals.

Returns IterableIterator<Terminal.IModel>
A new iterator over the running terminals.
Implementation of IManager.running
- Defined in packages/services/lib/terminal/manager.d.ts:48

shutdown

shutdown(name): Promise<void>
Shut down a terminal session by name.
Parameters
- name: string
Returns Promise<void>
Implementation of IManager.shutdown
- Defined in packages/services/lib/terminal/manager.d.ts:74

shutdownAll

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

Returns Promise<void>
A promise that resolves when all of the sessions are shut down.
Implementation of IManager.shutdownAll
- Defined in packages/services/lib/terminal/manager.d.ts:80

startNew

startNew(options?): Promise<ITerminalConnection>
Create a new terminal session.
Parameters
- Optional options: Terminal.ITerminal.IOptions
  
  The options used to create the terminal.
Returns Promise<ITerminalConnection>
A promise that resolves with the terminal connection instance.

Notes
The manager serverSettings will be used unless overridden in the options.
Implementation of IManager.startNew
- Defined in packages/services/lib/terminal/manager.d.ts:70

Generated using TypeDoc