Interface IOptions

The options object used to initialize a kernel.

interface IOptions {
    clientId?: string;
    commsOverSubshells?: CommsOverSubshells;
    handleComms?: boolean;
    kernelAPIClient?: IKernelAPIClient;
    kernelSpecAPIClient?: IKernelSpecAPIClient;
    model: Kernel.IModel;
    serverSettings?: ServerConnection.ISettings;
    subshellId?: string;
    username?: string;
}

Properties

clientId? commsOverSubshells? handleComms? kernelAPIClient? kernelSpecAPIClient? model serverSettings? subshellId? username?

Properties

OptionalclientId

clientId?: string

The unique identifier for the kernel client.

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)

OptionalhandleComms

handleComms?: 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

kernelAPIClient?: IKernelAPIClient

The kernel API client.

OptionalkernelSpecAPIClient

kernelSpecAPIClient?: IKernelSpecAPIClient

The kernel spec API client.

model

model: Kernel.IModel

The kernel model.

OptionalserverSettings

serverSettings?: ServerConnection.ISettings

The server settings for the kernel.

OptionalsubshellId

subshellId?: string

The subshell ID.

Optionalusername

username?: string

The username of the kernel client.

Settings

Member Visibility

On This Page

Properties