Class SessionManager

An implementation of a session manager.





_connectToKernel: any
_connectionFailure: any
_isReady: any
_kernelManager: any
_models: any
_onChanged: any
_onDisposed: any
_onStarted: any

Handle a session starting.

_pollModels: any
_ready: any
_runningChanged: any
_sessionConnections: any
serverSettings: ServerConnection.ISettings

The server settings for the manager.


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

    Returns ISignal<this, Error>

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

    Returns ISignal<this, void>

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

    Returns boolean

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

    Returns boolean

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

    Returns boolean

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

    Returns Promise<void>


  • Dispose of the resources used by the manager.

    Returns void

  • Force a refresh of the running sessions.

    Returns Promise<void>

    A promise that with the list of running sessions.


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

  • Execute a request to the server to poll running kernels and update state.

    Returns Promise<void>

  • Create an iterator over the most recent running sessions.

    Returns IterableIterator<Session.IModel>

    A new iterator over the running sessions.

  • Shut down a session by id.


    • id: string

    Returns Promise<void>

  • Shut down all sessions.

    Returns Promise<void>

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

  • Find a session associated with a path and stop it if it is the only session using that kernel.


    • path: string

      The path in question.

    Returns Promise<void>

    A promise that resolves when the relevant sessions are stopped.

Generated using TypeDoc