Class SessionManager

An implementation of a session manager.

Hierarchy

BaseManager
- SessionManager
  - SessionManager.NoopManager

Implements

Session.IManager

Index

Constructors

constructor

new SessionManager(options): SessionManager
Construct a new session manager.
Parameters
- options: SessionManager.IOptions
  
  The default options for each session.
Returns SessionManager
Overrides BaseManager.constructor
- Defined in packages/services/lib/session/manager.d.ts:16

Properties

`Private` `Readonly` _connectToKernel

_connectToKernel: any

`Private` _connectionFailure

_connectionFailure: any

`Private` _isReady

_isReady: any

`Private` _kernelManager

_kernelManager: any

`Private` _models

_models: any

`Private` _onChanged

_onChanged: any

`Private` _onDisposed

_onDisposed: any

`Private` _onStarted

_onStarted: any

Handle a session starting.

`Private` _pollModels

_pollModels: any

`Private` _ready

_ready: any

`Private` _runningChanged

_runningChanged: any

`Private` _sessionConnections

_sessionConnections: any

`Readonly` serverSettings

serverSettings: ServerConnection.ISettings

The server settings for the manager.

Accessors

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/session/manager.d.ts:36

disposed

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

Returns ISignal<this, void>
Inherited from BaseManager.disposed
- Defined in packages/services/lib/basemanager.d.ts:37

isActive

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

Returns boolean
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/session/manager.d.ts:24

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/session/manager.d.ts:28

runningChanged

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

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

Methods

connectTo

connectTo(options): ISessionConnection
Connect to a running session.
Parameters
- options: Omit<Session.ISessionConnection.IOptions, "serverSettings" | "connectToKernel">
  
  The session options to use.
Returns ISessionConnection
The new session instance.
Implementation of IManager.connectTo
- Defined in packages/services/lib/session/manager.d.ts:41

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/session/manager.d.ts:40

findById

findById(id): Promise<Session.IModel>
Find a session by id.
Parameters
- id: string
Returns Promise<Session.IModel>
Implementation of IManager.findById
- Defined in packages/services/lib/session/manager.d.ts:88

findByPath

findByPath(path): Promise<Session.IModel>
Find a session by path.
Parameters
- path: string
Returns Promise<Session.IModel>
Implementation of IManager.findByPath
- Defined in packages/services/lib/session/manager.d.ts:92

refreshRunning

refreshRunning(): Promise<void>
Force a refresh of the running 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.
Implementation of IManager.refreshRunning
- Defined in packages/services/lib/session/manager.d.ts:57

`Protected` requestRunning

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

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

running

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

Returns IterableIterator<Session.IModel>
A new iterator over the running sessions.
Implementation of IManager.running
- Defined in packages/services/lib/session/manager.d.ts:47

shutdown

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

shutdownAll

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

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

startNew

startNew(createOptions, connectOptions?): Promise<ISessionConnection>
Start a new session. See also [[startNewSession]].
Parameters
- createOptions: ISessionOptions
  
  Options for creating the session
- Optional connectOptions: Omit<Session.ISessionConnection.IOptions, "model" | "serverSettings" | "connectToKernel">
  
  Options for connecting to the session
Returns Promise<ISessionConnection>
Implementation of IManager.startNew
- Defined in packages/services/lib/session/manager.d.ts:65

stopIfNeeded

stopIfNeeded(path): Promise<void>
Find a session associated with a path and stop it if it is the only session using that kernel.
Parameters
- path: string
  
  The path in question.
Returns Promise<void>
A promise that resolves when the relevant sessions are stopped.
Implementation of IManager.stopIfNeeded
- Defined in packages/services/lib/session/manager.d.ts:84

Generated using TypeDoc