Class KernelManager

constructor

• new KernelManager(options?: KernelManager.IOptions): KernelManager

• Construct a new kernel manager.

  Parameters

  • options: KernelManager.IOptions = {}

    The default options for kernel.

  Returns KernelManager

ReadonlyserverSettings

commsOverSubshells

• get commsOverSubshells(): CommsOverSubshells

• Whether comms are running on subshell or not.

  Returns CommsOverSubshells
• set commsOverSubshells(value: CommsOverSubshells): void

• Whether comm messages should be sent to kernel subshells, if the kernel supports it.

  Notes

  Sending comm messages over subshells allows processing comms whilst processing execute-request on the "main shell". This prevents blocking comm processing. Options are:

  • disabled: not using subshells
  • one subshell per comm-target (default)
  • one subshell per comm (can lead to issues if creating many comms)

  Parameters

  • value: CommsOverSubshells

  Returns void

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, Kernel.IModel[]>

• A signal emitted when the running kernels change.

  Returns ISignal<this, Kernel.IModel[]>

runningCount

• get runningCount(): number

• The number of running kernels.

  Returns number

connectTo

• connectTo(
      options: Omit<Kernel.IKernelConnection.IOptions, "serverSettings">,
  ): Kernel.IKernelConnection

• Connect to an existing kernel.

  Parameters

  • options: Omit<Kernel.IKernelConnection.IOptions, "serverSettings">

  Returns Kernel.IKernelConnection

  The new kernel connection.

  Notes

  This will use the manager's server settings and ignore any server settings passed in the options.

dispose

• dispose(): void

• Dispose of the resources used by the manager.

  Returns void

findById

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

• Find a kernel by id.

  Parameters

  • id: string

    The id of the target kernel.

  Returns Promise<undefined | Kernel.IModel>

  A promise that resolves with the kernel's model.

refreshRunning

• refreshRunning(): Promise<void>

• Force a refresh of the running kernels.

  Returns Promise<void>

  A promise that resolves when the running list has been refreshed.

  Notes

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

running

• running(): IterableIterator<Kernel.IModel>

• Create an iterator over the most recent running kernels.

  Returns IterableIterator<Kernel.IModel>

  A new iterator over the running kernels.

shutdown

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

• Shut down a kernel 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 kernels.

  Returns Promise<void>

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

startNew

• startNew(
      createOptions?: Partial<Pick<Kernel.IModel, "name">>,
      connectOptions?: Omit<
          Kernel.IKernelConnection.IOptions,
          "serverSettings"
          | "model",
      >,
  ): Promise<Kernel.IKernelConnection>

• Start a new kernel.

  Parameters

  • createOptions: Partial<Pick<Kernel.IModel, "name">> = {}

    The kernel creation options
  • connectOptions: Omit<Kernel.IKernelConnection.IOptions, "serverSettings" | "model"> = {}

    The kernel connection options

  Returns Promise<Kernel.IKernelConnection>

  A promise that resolves with the kernel connection.

  Notes

  The manager serverSettings will be always be used.