Interface IManager

Object which manages kernel instances for a given base url.

Notes

The manager is responsible for maintaining the state of running kernels through polling the server. Use a manager if you want to be notified of changes to kernels.

interface IManager {
    commsOverSubshells?: CommsOverSubshells;
    connectionFailure: ISignal<Kernel.IManager, NetworkError>;
    disposed: ISignal<Kernel.IManager, void>;
    isActive: boolean;
    isDisposed: boolean;
    isReady: boolean;
    ready: Promise<void>;
    runningChanged: ISignal<Kernel.IManager, Kernel.IModel[]>;
    runningCount: number;
    serverSettings: ServerConnection.ISettings;
    connectTo(
        options: Kernel.IKernelConnection.IOptions,
    ): Kernel.IKernelConnection;
    dispose(): void;
    findById(id: string): Promise<undefined | Kernel.IModel>;
    refreshRunning(): Promise<void>;
    running(): IterableIterator<Kernel.IModel>;
    shutdown(id: string): Promise<void>;
    shutdownAll(): Promise<void>;
    startNew(
        createOptions?: Partial<Pick<Kernel.IModel, "name">>,
        connectOptions?: Omit<
            Kernel.IKernelConnection.IOptions,
            "serverSettings"
            | "model",
        >,
    ): Promise<Kernel.IKernelConnection>;
}

Hierarchy (View Summary)

Implemented by

Properties

commsOverSubshells? connectionFailure disposed isActive isDisposed isReady ready runningChanged runningCount serverSettings

Methods

connectTo dispose findById refreshRunning running shutdown shutdownAll startNew

Properties

OptionalcommsOverSubshells

commsOverSubshells?: CommsOverSubshells

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)

connectionFailure

connectionFailure: ISignal<Kernel.IManager, NetworkError>

A signal emitted when there is a server API connection failure.

Readonlydisposed

disposed: ISignal<Kernel.IManager, void>

A signal emitted when the object is disposed.

ReadonlyisActive

isActive: boolean

Whether the manager is active.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

ReadonlyisReady

isReady: boolean

Whether the manager is ready.

Readonlyready

ready: Promise<void>

A promise that resolves when the manager is initially ready.

runningChanged

runningChanged: ISignal<Kernel.IManager, Kernel.IModel[]>

A signal emitted when the running kernels change.

ReadonlyrunningCount

runningCount: number

The number of running kernels.

ReadonlyserverSettings

serverSettings: ServerConnection.ISettings

The server settings for the manager.

Methods

connectTo

  • connectTo(options: Kernel.IKernelConnection.IOptions): Kernel.IKernelConnection

  • Connect to an existing kernel.

    Parameters

    • options: Kernel.IKernelConnection.IOptions

      The options for connecting to the kernel

      The options object used to initialize a kernel.

      • OptionalclientId?: string

        The unique identifier for the kernel client.

      • OptionalcommsOverSubshells?: CommsOverSubshells

        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)
      • OptionalhandleComms?: boolean

        Whether the kernel connection should handle comm messages

        Notes

        The comm message protocol currently has implicit assumptions that only one kernel connection is handling comm messages. This option allows a kernel connection to opt out of handling comms.

        See https://github.com/jupyter/jupyter_client/issues/263

      • OptionalkernelAPIClient?: IKernelAPIClient

        The kernel API client.

      • OptionalkernelSpecAPIClient?: IKernelSpecAPIClient

        The kernel spec API client.

      • model: Kernel.IModel

        The kernel model.

      • OptionalserverSettings?: ServerConnection.ISettings

        The server settings for the kernel.

      • OptionalsubshellId?: string

        The subshell ID.

      • Optionalusername?: string

        The username of the kernel client.

    Returns Kernel.IKernelConnection

    A promise that resolves with the new kernel instance.

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

findById

refreshRunning

  • refreshRunning(): Promise<void>

  • Force a refresh of the running kernels.

    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

shutdown

shutdownAll

startNew

Settings

Member Visibility

On This Page

Notes
Properties
Methods