Class NoopManager

A no-op session manager to be used when starting sessions is not supported.

Hierarchy

SessionManager
- NoopManager

Index

Constructors

Properties

_readyPromise serverSettings

Accessors

connectionFailure disposed isActive isDisposed isReady parentReady ready runningChanged

Methods

connectTo dispose findById findByPath refreshRunning requestRunning running shutdown shutdownAll startNew stopIfNeeded

Constructors

constructor

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

Properties

`Private` _readyPromise

_readyPromise: 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>
Inherited from SessionManager.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 SessionManager.disposed
- Defined in packages/services/lib/basemanager.d.ts:37

isActive

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

Returns boolean
Overrides SessionManager.isActive
- Defined in packages/services/lib/session/manager.d.ts:137

isDisposed

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

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

isReady

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

Returns boolean
Inherited from SessionManager.isReady
- Defined in packages/services/lib/session/manager.d.ts:24

parentReady

get parentReady(): Promise<void>
Used for testing.

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

ready

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

Returns Promise<void>
Overrides SessionManager.ready
- Defined in packages/services/lib/session/manager.d.ts:150

runningChanged

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

Returns ISignal<this, Session.IModel[]>
Inherited from SessionManager.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.
Overrides SessionManager.connectTo
- Defined in packages/services/lib/session/manager.d.ts:146

dispose

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

Returns void
Inherited from SessionManager.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>
Inherited from SessionManager.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>
Inherited from SessionManager.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.
Inherited from SessionManager.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 sessions and update state.

Returns Promise<void>
Overrides SessionManager.requestRunning
- Defined in packages/services/lib/session/manager.d.ts:158

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.
Inherited from SessionManager.running
- Defined in packages/services/lib/session/manager.d.ts:47

shutdown

shutdown(id): Promise<void>
Shut down a session by id - throw an error since it is not supported.
Parameters
- id: string
Returns Promise<void>
Overrides SessionManager.shutdown
- Defined in packages/services/lib/session/manager.d.ts:154

shutdownAll

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

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

startNew

startNew(createOptions, connectOptions?): Promise<ISessionConnection>
Start a new session - throw an error since it is not supported.
Parameters
- createOptions: ISessionOptions
- Optional connectOptions: Omit<Session.ISessionConnection.IOptions, "model" | "serverSettings" | "connectToKernel">
Returns Promise<ISessionConnection>
Overrides SessionManager.startNew
- Defined in packages/services/lib/session/manager.d.ts:145

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.
Inherited from SessionManager.stopIfNeeded
- Defined in packages/services/lib/session/manager.d.ts:84

Generated using TypeDoc