Interface IManager

connectionFailure

Readonly isReady

Readonly ready

runningChanged

Optional serverSettings

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.

findById

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

• Find a session by id.

  Parameters

  • id: string

    The id of the target session.

  Returns Promise<Session.IModel>

  A promise that resolves with the session's model.

findByPath

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

• Find a session by path.

  Parameters

  • path: string

    The path of the target session.

  Returns Promise<Session.IModel>

  A promise that resolves with the session's model.

refreshRunning

• refreshRunning(): Promise<void>

• Force a refresh of the running sessions.

  Returns Promise<void>

  A promise that resolves when the models are refreshed.

  Notes

  This is intended to be called only in response to a user action, since the manager maintains its internal state.

running

• running(): IterableIterator<Session.IModel>

• Create an iterator over the known running sessions.

  Returns IterableIterator<Session.IModel>

  A new iterator over the running sessions.

shutdown

• shutdown(id): Promise<void>

• Shut down a session by id.

  Parameters

  • id: string

    The id of the target kernel.

  Returns Promise<void>

  A promise that resolves when the operation is complete.

shutdownAll

• shutdownAll(): Promise<void>

• Shut down all sessions.

  Returns Promise<void>

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

startNew

• startNew(createOptions, connectOptions?): Promise<ISessionConnection>

• Start a new session.

  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>

  A promise that resolves with a session connection instance.

  Notes

  The serverSettings and connectToKernel options of the manager will be used.

stopIfNeeded

• stopIfNeeded(path): Promise<void>

• Find a session associated with a path and stop 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.