Class SessionManager

constructor

• new SessionManager(options: SessionManager.IOptions): SessionManager

• Construct a new session manager.

  Parameters

  • options: SessionManager.IOptions

    The default options for each session.

  Returns SessionManager

ReadonlyserverSettings

connectionFailure

• get connectionFailure(): ISignal<this, Error>

• A signal emitted when there is a connection failure.

  Returns ISignal<this, Error>

isReady

• get isReady(): boolean

• Test whether the manager is ready.

  Returns boolean

ready

• get ready(): Promise<void>

• A promise that fulfills when the manager is ready.

  Returns Promise<void>

runningChanged

• get runningChanged(): ISignal<this, Session.IModel[]>

• A signal emitted when the running sessions change.

  Returns ISignal<this, Session.IModel[]>

connectTo

• connectTo(
      options: Omit<
          Session.ISessionConnection.IOptions,
          "serverSettings"
          | "connectToKernel",
      >,
  ): Session.ISessionConnection

• Connect to a running session.

  Parameters

  • options: Omit<Session.ISessionConnection.IOptions, "serverSettings" | "connectToKernel">

    The session options to use.

  Returns Session.ISessionConnection

  The new session instance.

dispose

• dispose(): void

• Dispose of the resources used by the manager.

  Returns void

findById

• findById(id: string): Promise<undefined | Session.IModel>

• Find a session by id.

  Parameters

  • id: string

  Returns Promise<undefined | Session.IModel>

findByPath

• findByPath(path: string): Promise<undefined | Session.IModel>

• Find a session by path.

  Parameters

  • path: string

  Returns Promise<undefined | Session.IModel>

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.

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.

shutdown

• shutdown(id: string): Promise<void>

• Shut down a session by id.

  Parameters

  • id: string

  Returns Promise<void>

shutdownAll

• shutdownAll(): Promise<void>

• Shut down all sessions.

  Returns Promise<void>

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

startNew

• startNew(
      createOptions: ISessionOptions,
      connectOptions?: Omit<
          Session.ISessionConnection.IOptions,
          "serverSettings"
          | "model"
          | "connectToKernel",
      >,
  ): Promise<Session.ISessionConnection>

• Start a new session. See also [[startNewSession]].

  Parameters

  • createOptions: ISessionOptions

    Options for creating the session
  • connectOptions: Omit<
        Session.ISessionConnection.IOptions,
        "serverSettings"
        | "model"
        | "connectToKernel",
    > = {}

    Options for connecting to the session

  Returns Promise<Session.ISessionConnection>

stopIfNeeded

• stopIfNeeded(path: string): 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.