Class LocalKernelConnection

A custom KernelConnection that wraps a local kernel WebSocket. This bypasses the session management and provides a pre-connected kernel.

Implements

IKernelConnection

Index

Constructors

constructor

Constructors

constructor

new LocalKernelConnection(
    options: {
        clientId: string;
        handleComms?: boolean;
        id: string;
        model: IModel;
        name: string;
        serverSettings: ISettings;
        username?: string;
    },
): LocalKernelConnection
Parameters
- options: {
      clientId: string;
      handleComms?: boolean;
      id: string;
      model: IModel;
      name: string;
      serverSettings: ISettings;
      username?: string;
  }
Returns LocalKernelConnection
- Defined in webview/services/localKernelConnection.ts:82

Properties

`Private`_anyMessage

_anyMessage: Signal<LocalKernelConnection, IAnyMessageArgs> = ...

Signal emitted for any message (sent or received).

`Private`_clientId

_clientId: string

The client session ID.

`Private`_connectionStatus

_connectionStatus: ConnectionStatus = "connected"

The current connection status of the kernel.

`Private`_connectionStatusChanged

_connectionStatusChanged: Signal<LocalKernelConnection, ConnectionStatus> = ...

Signal emitted when connection status changes.

`Private`_disposed

_disposed: Signal<LocalKernelConnection, void> = ...

Signal emitted when the kernel is disposed.

`Private`_handleComms

_handleComms: boolean = true

Whether this connection should handle comm (widget) messages.

`Private`_id

_id: string

The unique identifier of the kernel.

`Private`_infoPromise

_infoPromise: Promise<IInfoReply>

Promise that resolves when kernel info is received.

`Private`_infoReply

_infoReply: IInfoReply = null

The cached kernel info reply.

`Private`_iopubMessage

_iopubMessage: Signal<LocalKernelConnection, IIOPubMessage<IOPubMessageType>> = ...

Signal emitted when an iopub message is received.

`Private`_isDisposed

_isDisposed: boolean = false

Whether the kernel connection has been disposed.

`Private`_model

_model: IModel

The kernel model containing kernel specifications.

`Private`_name

_name: string

The name of the kernel.

`Private`_pendingMessages

_pendingMessages: Signal<LocalKernelConnection, boolean> = ...

Signal emitted when pending input state changes.

`Private`_propertyChanged

_propertyChanged: Signal<LocalKernelConnection, "name" | "type" | "path"> = ...

Signal emitted when kernel properties change.

`Private`_resolveInfo

_resolveInfo: (value: IInfoReply) => void

Function to resolve the kernel info promise.

`Private`_serverSettings

_serverSettings: ISettings

Server settings for the kernel connection.

`Private`_status

_status: Status = "unknown"

The current execution status of the kernel.

`Private`_statusChanged

_statusChanged: Signal<LocalKernelConnection, Status> = ...

Signal emitted when kernel status changes.

`Private`_unhandledMessage

_unhandledMessage: Signal<LocalKernelConnection, IMessage<MessageType>> = ...

Signal emitted when an unhandled message is received.

`Private`_username

_username: string = ""

The username associated with the kernel.

`Private`_ws

_ws: ProxiedWebSocket

The WebSocket connection to the local kernel.

Accessors

anyMessage

get anyMessage(): ISignal<this, IAnyMessageArgs>
A signal emitted when any kernel message is sent or received.

Notes

This signal is emitted before any message handling has happened. The message should be treated as read-only.

Returns ISignal<this, IAnyMessageArgs>
Implementation of Kernel.IKernelConnection.anyMessage
- Defined in webview/services/localKernelConnection.ts:257

clientId

get clientId(): string
The client unique id.

Notes

This should be unique for a particular kernel connection object.

Returns string
Implementation of Kernel.IKernelConnection.clientId
- Defined in webview/services/localKernelConnection.ts:199
set clientId(value: string): void
The client unique id.

Notes

This should be unique for a particular kernel connection object.
Parameters
- value: string
Returns void
Implementation of Kernel.IKernelConnection.clientId
- Defined in webview/services/localKernelConnection.ts:203

connectionStatus

get connectionStatus(): ConnectionStatus
The current connection status of the kernel.

Returns ConnectionStatus
Implementation of Kernel.IKernelConnection.connectionStatus
- Defined in webview/services/localKernelConnection.ts:211

connectionStatusChanged

get connectionStatusChanged(): ISignal<this, ConnectionStatus>
A signal emitted when the kernel connection status changes.

Returns ISignal<this, ConnectionStatus>
Implementation of Kernel.IKernelConnection.connectionStatusChanged
- Defined in webview/services/localKernelConnection.ts:241

disposed

get disposed(): ISignal<this, void>
A signal emitted when the object is disposed.

Returns ISignal<this, void>
Implementation of Kernel.IKernelConnection.disposed
- Defined in webview/services/localKernelConnection.ts:245

handleComms

get handleComms(): boolean
Whether the kernel connection handles 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

Returns boolean
Implementation of Kernel.IKernelConnection.handleComms
- Defined in webview/services/localKernelConnection.ts:219
set handleComms(value: boolean): void
Whether the kernel connection handles 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
Parameters
- value: boolean
Returns void
Implementation of Kernel.IKernelConnection.handleComms
- Defined in webview/services/localKernelConnection.ts:223

hasPendingInput

get hasPendingInput(): boolean
Whether the kernel connection has pending input.

Notes

This is a guard to avoid deadlock is the user asks input as second time before submitting his first input

Returns boolean
Implementation of Kernel.IKernelConnection.hasPendingInput
- Defined in webview/services/localKernelConnection.ts:265

id

get id(): string
The id of the server-side kernel.

Returns string
Implementation of Kernel.IKernelConnection.id
- Defined in webview/services/localKernelConnection.ts:179

info

get info(): Promise<IInfoReply>
The kernel info

Notes

This promise only resolves at startup, and is not refreshed on every restart.

Returns Promise<IInfoReply>
Implementation of Kernel.IKernelConnection.info
- Defined in webview/services/localKernelConnection.ts:215

iopubMessage

get iopubMessage(): ISignal<this, IIOPubMessage<IOPubMessageType>>
A signal emitted after an iopub kernel message is handled.

Returns ISignal<this, IIOPubMessage<IOPubMessageType>>
Implementation of Kernel.IKernelConnection.iopubMessage
- Defined in webview/services/localKernelConnection.ts:249

isDisposed

get isDisposed(): boolean
Test whether the object has been disposed.

Notes

This property is always safe to access.

Returns boolean
Implementation of Kernel.IKernelConnection.isDisposed
- Defined in webview/services/localKernelConnection.ts:231

model

get model(): IModel
The kernel model, for convenience.

Returns IModel
Implementation of Kernel.IKernelConnection.model
- Defined in webview/services/localKernelConnection.ts:187

name

get name(): string
The name of the server-side kernel.

Returns string
Implementation of Kernel.IKernelConnection.name
- Defined in webview/services/localKernelConnection.ts:183

pendingInput

get pendingInput(): ISignal<this, boolean>
A signal emitted when a kernel has pending inputs from the user.

Returns ISignal<this, boolean>
Implementation of Kernel.IKernelConnection.pendingInput
- Defined in webview/services/localKernelConnection.ts:269

propertyChanged

get propertyChanged(): ISignal<this, "name" | "type" | "path">
Returns ISignal<this, "name" | "type" | "path">
- Defined in webview/services/localKernelConnection.ts:261

serverSettings

get serverSettings(): ISettings
The server settings for the kernel.

Returns ISettings
Implementation of Kernel.IKernelConnection.serverSettings
- Defined in webview/services/localKernelConnection.ts:227

spec

get spec(): Promise<ISpecModel>
Get the kernel specification.

Returns Promise<ISpecModel>
A promise that resolves to the kernel spec model.
Implementation of Kernel.IKernelConnection.spec
- Defined in webview/services/localKernelConnection.ts:388

status

get status(): Status
The current status of the kernel.

Returns Status
Implementation of Kernel.IKernelConnection.status
- Defined in webview/services/localKernelConnection.ts:207

statusChanged

get statusChanged(): ISignal<this, Status>
A signal emitted when the kernel status changes.

Returns ISignal<this, Status>
Implementation of Kernel.IKernelConnection.statusChanged
- Defined in webview/services/localKernelConnection.ts:237

subshellId

get subshellId(): string
The subshell ID, main shell has null.

Returns string
Implementation of Kernel.IKernelConnection.subshellId
- Defined in webview/services/localKernelConnection.ts:277

supportsSubshells

get supportsSubshells(): boolean
Check if this kernel supports JEP 91 kernel subshells.

Returns boolean
Implementation of Kernel.IKernelConnection.supportsSubshells
- Defined in webview/services/localKernelConnection.ts:273

unhandledMessage

get unhandledMessage(): ISignal<this, IMessage<MessageType>>
A signal emitted for unhandled non-iopub kernel messages that claimed to be responses for messages we sent using this kernel object.

Returns ISignal<this, IMessage<MessageType>>
Implementation of Kernel.IKernelConnection.unhandledMessage
- Defined in webview/services/localKernelConnection.ts:253

username

get username(): string
The client username.

Returns string
Implementation of Kernel.IKernelConnection.username
- Defined in webview/services/localKernelConnection.ts:191
set username(value: string): void
The client username.
Parameters
- value: string
Returns void
Implementation of Kernel.IKernelConnection.username
- Defined in webview/services/localKernelConnection.ts:195

Methods

`Private`_onWSMessage

_onWSMessage(...args: unknown[]): void
Handles incoming WebSocket messages and emits appropriate signals.
Parameters
- ...args: unknown[]
Returns void
- Defined in webview/services/localKernelConnection.ts:127

clone

clone(_options?: Partial<Kernel.IKernelConnection.IOptions>): IKernelConnection
Clone the kernel connection (not supported for local kernels).
Parameters
- Optional_options: Partial<Kernel.IKernelConnection.IOptions>
  Optional clone options.
Returns IKernelConnection
Throws
Always throws as cloning is not implemented.
Implementation of Kernel.IKernelConnection.clone
- Defined in webview/services/localKernelConnection.ts:295

createComm

createComm(_targetName: string, _commId?: string): IComm
Create a comm (not supported for local kernels).
Parameters
- _targetName: string
  The name of the comm target.
- Optional_commId: string
  Optional comm ID.
Returns IComm
Throws
Always throws as comm creation is not implemented.
Implementation of Kernel.IKernelConnection.createComm
- Defined in webview/services/localKernelConnection.ts:808

dispose

dispose(): void
Dispose of the kernel connection and clean up resources.

Returns void
Implementation of Kernel.IKernelConnection.dispose
- Defined in webview/services/localKernelConnection.ts:304

hasComm

hasComm(_commId: string): boolean
Check if a comm with the given ID exists.
Parameters
- _commId: string
  The comm ID to check.
Returns boolean
Always returns false for local kernels.
Implementation of Kernel.IKernelConnection.hasComm
- Defined in webview/services/localKernelConnection.ts:817

interrupt

interrupt(): Promise<void>
Interrupt the kernel execution. Sends both an extension message (for local kernels via SIGINT) and an interrupt_request message to the kernel via the control channel (for remote kernels).

Returns Promise<void>
A promise that resolves when the interrupt request is sent.
Implementation of Kernel.IKernelConnection.interrupt
- Defined in webview/services/localKernelConnection.ts:406

reconnect

reconnect(): Promise<void>
Reconnect to the kernel (no-op for local kernels).

Returns Promise<void>
A resolved promise.
Implementation of Kernel.IKernelConnection.reconnect
- Defined in webview/services/localKernelConnection.ts:367

registerCommTarget

registerCommTarget(
_targetName: string,
_callback: (comm: IComm, msg: ICommOpenMsg) => void | PromiseLike<void>,
): void
Register a comm target (no-op for local kernels).
Parameters
- _targetName: string
  The name of the comm target.
- _callback: (comm: IComm, msg: ICommOpenMsg) => void | PromiseLike<void>
  The callback to invoke when a comm is opened.
Returns void
Implementation of Kernel.IKernelConnection.registerCommTarget
- Defined in webview/services/localKernelConnection.ts:777

registerMessageHook

registerMessageHook(
_msgId: string,
_hook: (msg: IIOPubMessage) => boolean | PromiseLike<boolean>,
): void
Register a message hook for IOPub messages (no-op for local kernels).
Parameters
- _msgId: string
  The message ID to hook.
- _hook: (msg: IIOPubMessage) => boolean | PromiseLike<boolean>
  The hook function to register.
Returns void
Implementation of Kernel.IKernelConnection.registerMessageHook
- Defined in webview/services/localKernelConnection.ts:753

removeCommTarget

removeCommTarget(
_targetName: string,
_callback: (comm: IComm, msg: ICommOpenMsg) => void | PromiseLike<void>,
): void
Remove a comm target (no-op for local kernels).
Parameters
- _targetName: string
  The name of the comm target.
- _callback: (comm: IComm, msg: ICommOpenMsg) => void | PromiseLike<void>
  The callback to remove.
Returns void
Implementation of Kernel.IKernelConnection.removeCommTarget
- Defined in webview/services/localKernelConnection.ts:792

removeInputGuard

removeInputGuard(): void
Remove input guard from the kernel (no-op for local kernels).

Returns void
Implementation of Kernel.IKernelConnection.removeInputGuard
- Defined in webview/services/localKernelConnection.ts:286

removeMessageHook

removeMessageHook(
_msgId: string,
_hook: (msg: IIOPubMessage) => boolean | PromiseLike<boolean>,
): void
Remove a message hook (no-op for local kernels).
Parameters
- _msgId: string
  The message ID to unhook.
- _hook: (msg: IIOPubMessage) => boolean | PromiseLike<boolean>
  The hook function to remove.
Returns void
Implementation of Kernel.IKernelConnection.removeMessageHook
- Defined in webview/services/localKernelConnection.ts:765

requestCommInfo

requestCommInfo(_content: {}): Promise<ICommInfoReplyMsg>
Request comm information (not supported for local kernels).
Parameters
- _content: {}
  The comm info request content.
Returns Promise<ICommInfoReplyMsg>
Throws
Always throws as comm info is not implemented.
Implementation of Kernel.IKernelConnection.requestCommInfo
- Defined in webview/services/localKernelConnection.ts:729

requestComplete

requestComplete(_content: {}): Promise<ICompleteReplyMsg>
Request code completion (not supported for local kernels).
Parameters
- _content: {}
  The completion request content.
Returns Promise<ICompleteReplyMsg>
Throws
Always throws as completion is not implemented.
Implementation of Kernel.IKernelConnection.requestComplete
- Defined in webview/services/localKernelConnection.ts:602

requestCreateSubshell

requestCreateSubshell(
_content: Record<string, unknown>,
_disposeOnDone?: boolean,
): IControlFuture<ICreateSubshellRequestMsg, ICreateSubshellReplyMsg>
Request creation of a subshell (not supported for local kernels).
Parameters
- _content: Record<string, unknown>
  The subshell creation request content.
- Optional_disposeOnDone: boolean
  Whether to dispose after completion.
Returns IControlFuture<ICreateSubshellRequestMsg, ICreateSubshellReplyMsg>
Throws
Always throws as subshells are not supported.
Implementation of Kernel.IKernelConnection.requestCreateSubshell
- Defined in webview/services/localKernelConnection.ts:495

requestDebug

requestDebug(
_content: {},
_disposeOnDone?: boolean,
): IControlFuture<IDebugRequestMsg, IDebugReplyMsg>
Request debugging information (not supported for local kernels).
Parameters
- _content: {}
  The debug request content.
- Optional_disposeOnDone: boolean
  Whether to dispose after completion.
Returns IControlFuture<IDebugRequestMsg, IDebugReplyMsg>
Throws
Always throws as debugging is not implemented.
Implementation of Kernel.IKernelConnection.requestDebug
- Defined in webview/services/localKernelConnection.ts:703

requestDeleteSubshell

requestDeleteSubshell(
_content: {},
_disposeOnDone?: boolean,
): IControlFuture<IDeleteSubshellRequestMsg, IDeleteSubshellReplyMsg>
Request deletion of a subshell (not supported for local kernels).
Parameters
- _content: {}
  The subshell deletion request content.
- Optional_disposeOnDone: boolean
  Whether to dispose after completion.
Returns IControlFuture<IDeleteSubshellRequestMsg, IDeleteSubshellReplyMsg>
Throws
Always throws as subshells are not supported.
Implementation of Kernel.IKernelConnection.requestDeleteSubshell
- Defined in webview/services/localKernelConnection.ts:511

requestExecute

requestExecute(
    content: {},
    disposeOnDone?: boolean,
    metadata?: unknown,
): IShellFuture<IExecuteRequestMsg, IExecuteReplyMsg>
Execute code in the kernel.
Parameters
- content: {}
  The code execution request content.
- OptionaldisposeOnDone: boolean
  Whether to dispose the future after completion.
- Optionalmetadata: unknown
  Optional metadata to include with the request.
Returns IShellFuture<IExecuteRequestMsg, IExecuteReplyMsg>
A shell future that will resolve with the execution reply.
Implementation of Kernel.IKernelConnection.requestExecute
- Defined in webview/services/localKernelConnection.ts:660

requestHistory

requestHistory(
    _content:
        | IHistoryRequestRange
        | IHistoryRequestSearch
        | IHistoryRequestTail,
): Promise<IHistoryReplyMsg>
Request command history (returns empty history).
Parameters
- _content: IHistoryRequestRange | IHistoryRequestSearch | IHistoryRequestTail
  The history request content.
Returns Promise<IHistoryReplyMsg>
A promise that resolves with an empty history reply.
Implementation of Kernel.IKernelConnection.requestHistory
- Defined in webview/services/localKernelConnection.ts:624

requestInspect

requestInspect(_content: {}): Promise<IInspectReplyMsg>
Request object inspection (not supported for local kernels).
Parameters
- _content: {}
  The inspection request content.
Returns Promise<IInspectReplyMsg>
Throws
Always throws as inspection is not implemented.
Implementation of Kernel.IKernelConnection.requestInspect
- Defined in webview/services/localKernelConnection.ts:613

requestIsComplete

requestIsComplete(_content: {}): Promise<IIsCompleteReplyMsg>
Check if code is complete (not supported for local kernels).
Parameters
- _content: {}
  The is_complete request content.
Returns Promise<IIsCompleteReplyMsg>
Throws
Always throws as is_complete is not implemented.
Implementation of Kernel.IKernelConnection.requestIsComplete
- Defined in webview/services/localKernelConnection.ts:718

requestKernelInfo

requestKernelInfo(): Promise<IInfoReplyMsg>
Request kernel information.

Returns Promise<IInfoReplyMsg>
A promise that resolves with the kernel info reply.
Implementation of Kernel.IKernelConnection.requestKernelInfo
- Defined in webview/services/localKernelConnection.ts:541

requestListSubshell

requestListSubshell(
_content: Record<string, unknown>,
_disposeOnDone?: boolean,
): IControlFuture<IListSubshellRequestMsg, IListSubshellReplyMsg>
Request listing of subshells (not supported for local kernels).
Parameters
- _content: Record<string, unknown>
  The subshell list request content.
- Optional_disposeOnDone: boolean
  Whether to dispose after completion.
Returns IControlFuture<IListSubshellRequestMsg, IListSubshellReplyMsg>
Throws
Always throws as subshells are not supported.
Implementation of Kernel.IKernelConnection.requestListSubshell
- Defined in webview/services/localKernelConnection.ts:527

restart

restart(): Promise<void>
Restart the kernel. Sends a message to the extension host to restart the kernel process.

Returns Promise<void>
A resolved promise.
Implementation of Kernel.IKernelConnection.restart
- Defined in webview/services/localKernelConnection.ts:467

sendControlMessage

sendControlMessage<T extends ControlMessageType>(
    msg: IControlMessage<T>,
    _expectReply?: boolean,
    _disposeOnDone?: boolean,
): IControlFuture<IControlMessage<T>, IControlMessage<ControlMessageType>>
Send a control message to the kernel.
Type Parameters
- T extends ControlMessageType
Parameters
- msg: IControlMessage<T>
  The control message to send.
- Optional_expectReply: boolean
  Whether a reply is expected.
- Optional_disposeOnDone: boolean
  Whether to dispose after completion.
Returns IControlFuture<IControlMessage<T>, IControlMessage<ControlMessageType>>
A control future that will resolve with the reply.
Implementation of Kernel.IKernelConnection.sendControlMessage
- Defined in webview/services/localKernelConnection.ts:347

sendInputReply

sendInputReply(
_content: ReplyContent<IInputReply>,
_parent_header: unknown,
): void
Send an input reply to the kernel (not supported for local kernels).
Parameters
- _content: ReplyContent<IInputReply>
  The input reply content.
- _parent_header: unknown
  The parent message header.
Returns void
Throws
Always throws as input reply is not implemented.
Implementation of Kernel.IKernelConnection.sendInputReply
- Defined in webview/services/localKernelConnection.ts:741

sendShellMessage

sendShellMessage<T extends ShellMessageType>(
    msg: IShellMessage<T>,
    _expectReply?: boolean,
    _disposeOnDone?: boolean,
): IShellFuture<IShellMessage<T>, IShellMessage<ShellMessageType>>
Send a shell message to the kernel.
Type Parameters
- T extends ShellMessageType
Parameters
- msg: IShellMessage<T>
  The shell message to send.
- Optional_expectReply: boolean
  Whether a reply is expected.
- Optional_disposeOnDone: boolean
  Whether to dispose after completion.
Returns IShellFuture<IShellMessage<T>, IShellMessage<ShellMessageType>>
A shell future that will resolve with the reply.
Implementation of Kernel.IKernelConnection.sendShellMessage
- Defined in webview/services/localKernelConnection.ts:324

shutdown

shutdown(): Promise<void>
Shutdown the kernel connection.

Returns Promise<void>
A resolved promise.
Implementation of Kernel.IKernelConnection.shutdown
- Defined in webview/services/localKernelConnection.ts:378

Class LocalKernelConnection

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LocalKernelConnection

Properties

Private_anyMessage

Private_clientId

Private_connectionStatus

Private_connectionStatusChanged

Private_disposed

Private_handleComms

Private_id

Private_infoPromise

Private_infoReply

Private_iopubMessage

Private_isDisposed

Private_model

Private_name

Private_pendingMessages

Private_propertyChanged

Private_resolveInfo

Private_serverSettings

Private_status

Private_statusChanged

Private_unhandledMessage

Private_username

Private_ws

Accessors

anyMessage

Notes

Returns ISignal<this, IAnyMessageArgs>

clientId

Notes

Returns string

Notes

Parameters

Returns void

connectionStatus

Returns ConnectionStatus

connectionStatusChanged

Returns ISignal<this, ConnectionStatus>

disposed

Returns ISignal<this, void>

handleComms

Notes

Returns boolean

Notes

Parameters

Returns void

hasPendingInput

Notes

Returns boolean

id

Returns string

info

Notes

Returns Promise<IInfoReply>

iopubMessage

Returns ISignal<this, IIOPubMessage<IOPubMessageType>>

isDisposed

Notes

Returns boolean

model

Returns IModel

name

Returns string

pendingInput

Returns ISignal<this, boolean>

propertyChanged

Returns ISignal<this, "name" | "type" | "path">

serverSettings

Returns ISettings

spec

`Private`_anyMessage

`Private`_clientId

`Private`_connectionStatus

`Private`_connectionStatusChanged

`Private`_disposed

`Private`_handleComms

`Private`_id

`Private`_infoPromise

`Private`_infoReply

`Private`_iopubMessage

`Private`_isDisposed

`Private`_model

`Private`_name

`Private`_pendingMessages

`Private`_propertyChanged

`Private`_resolveInfo

`Private`_serverSettings

`Private`_status

`Private`_statusChanged

`Private`_unhandledMessage

`Private`_username

`Private`_ws

`Private`_onWSMessage