Class LocalKernelConnection

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

Implements

IKernelConnection

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:83

Accessors

anyMessage

get anyMessage(): ISignal<this, IAnyMessageArgs>
Signal emitted for any sent or received message.

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

clientId

get clientId(): string
The client session identifier.

Returns string
Implementation of Kernel.IKernelConnection.clientId
- Defined in webview/services/localKernelConnection.ts:223
set clientId(value: string): void
Set the client session identifier.
Parameters
- value: string
Returns void
Implementation of Kernel.IKernelConnection.clientId
- Defined in webview/services/localKernelConnection.ts:230

connectionStatus

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

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

connectionStatusChanged

get connectionStatusChanged(): ISignal<this, ConnectionStatus>
Signal emitted when connection status changes.

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

disposed

get disposed(): ISignal<this, void>
Signal emitted when the kernel is disposed.

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

handleComms

get handleComms(): boolean
Whether this connection handles comm messages.

Returns boolean
Implementation of Kernel.IKernelConnection.handleComms
- Defined in webview/services/localKernelConnection.ts:258
set handleComms(value: boolean): void
Set whether this connection handles comm messages.
Parameters
- value: boolean
Returns void
Implementation of Kernel.IKernelConnection.handleComms
- Defined in webview/services/localKernelConnection.ts:265

hasPendingInput

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

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

id

get id(): string
The unique identifier of this kernel.

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

info

get info(): Promise<IInfoReply>
Promise resolving to kernel info when available.

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

iopubMessage

get iopubMessage(): ISignal<this, IIOPubMessage<IOPubMessageType>>
Signal emitted for IOPub channel messages.

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

isDisposed

get isDisposed(): boolean
Whether this kernel connection has been disposed.

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

model

get model(): IModel
The kernel model containing ID and name.

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

name

get name(): string
The display name of this kernel.

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

pendingInput

get pendingInput(): ISignal<this, boolean>
Signal emitted when pending input state changes.

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

propertyChanged

get propertyChanged(): ISignal<this, "type" | "name" | "path">
Signal emitted when kernel properties change.

Returns ISignal<this, "type" | "name" | "path">
- Defined in webview/services/localKernelConnection.ts:330

serverSettings

get serverSettings(): ISettings
Server connection settings for this kernel.

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

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:476

status

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

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

statusChanged

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

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

subshellId

get subshellId(): string
The current subshell ID, if any.

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

supportsSubshells

get supportsSubshells(): boolean
Whether the kernel supports subshells.

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

unhandledMessage

get unhandledMessage(): ISignal<this, IMessage<MessageType>>
Signal emitted for unhandled kernel messages.

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

username

get username(): string
The username associated with this kernel connection.

Returns string
Implementation of Kernel.IKernelConnection.username
- Defined in webview/services/localKernelConnection.ts:209
set username(value: string): void
Set the username for this kernel connection.
Parameters
- value: string
Returns void
Implementation of Kernel.IKernelConnection.username
- Defined in webview/services/localKernelConnection.ts:216

Methods

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:377

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:916

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:386

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:926

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:494

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:452

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
  Identifier for the comm channel to register.
- _callback: (comm: IComm, msg: ICommOpenMsg) => void | PromiseLike<void>
  Handler invoked when a comm is opened on this target.
Returns void
Implementation of Kernel.IKernelConnection.registerCommTarget
- Defined in webview/services/localKernelConnection.ts:884

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:860

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
  Identifier for the comm channel to unregister.
- _callback: (comm: IComm, msg: ICommOpenMsg) => void | PromiseLike<void>
  Previously registered handler to remove.
Returns void
Implementation of Kernel.IKernelConnection.removeCommTarget
- Defined in webview/services/localKernelConnection.ts:899

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:367

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:872

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:835

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:700

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:589

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:807

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:606

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:762

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:724

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:712

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:823

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:637

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:623

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:558

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:432

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:848

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:408

shutdown

shutdown(): Promise<void>
Terminates the kernel and disposes all associated resources.

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

Class LocalKernelConnection

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns LocalKernelConnection

Accessors

anyMessage

Returns ISignal<this, IAnyMessageArgs>

clientId

Returns string

Parameters

Returns void

connectionStatus

Returns ConnectionStatus

connectionStatusChanged

Returns ISignal<this, ConnectionStatus>

disposed

Returns ISignal<this, void>

handleComms

Returns boolean

Parameters

Returns void

hasPendingInput

Returns boolean

id

Returns string

info

Returns Promise<IInfoReply>

iopubMessage

Returns ISignal<this, IIOPubMessage<IOPubMessageType>>

isDisposed

Returns boolean

model

Returns IModel

name

Returns string

pendingInput

Returns ISignal<this, boolean>

propertyChanged

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

serverSettings

Returns ISettings

spec

Returns Promise<ISpecModel>

status

Returns Status

statusChanged

Returns ISignal<this, Status>

subshellId

Returns string

supportsSubshells

Returns boolean

unhandledMessage

Returns ISignal<this, IMessage<MessageType>>

username

Returns string

Parameters

Returns void

Methods

clone

Parameters

Returns IKernelConnection

Throws

createComm

Parameters

Returns IComm

Throws

dispose

Returns void

hasComm

Parameters

Returns boolean

interrupt

Returns Promise<void>

reconnect