KernelConnection | @jupyterlab (original) (raw)

clone

• clone(
  options?: Pick<
  Kernel.IKernelConnection.IOptions,
  "username"
  | "clientId"
  | "handleComms",
  >,
  ): Kernel.IKernelConnection

• Parameters

  • options: Pick<Kernel.IKernelConnection.IOptions, "username" | "clientId" | "handleComms"> = {}

Returns Kernel.IKernelConnection

createComm

• createComm(targetName: string, commId?: string): IComm

• Parameters

  • targetName: string
  • commId: string = ...

Returns IComm

dispose

• dispose(): void

• Returns void

handleShutdown

• handleShutdown(): void

• Returns void

hasComm

• hasComm(commId: string): boolean

• Returns boolean

interrupt

• interrupt(): Promise<void>

• Returns Promise<void>

reconnect

• reconnect(): Promise<void>

• Returns Promise<void>

registerCommTarget

• registerCommTarget(
  targetName: string,
  callback: (
  comm: IComm,
  msg: ICommOpenMsg<"iopub" | "shell">,
  ) => void | PromiseLike<void>,
  ): void

• Parameters

  • targetName: string
  • callback: (comm: IComm, msg: ICommOpenMsg<"iopub" | "shell">) => void | PromiseLike<void>

Returns void

A disposable used to unregister the comm target.

Notes

Only one comm target can be registered to a target name at a time, an existing callback for the same target name will be overridden. A registered comm target handler will take precedence over a comm which specifies atarget_module.
If the callback returns a promise, kernel message processing will pause until the returned promise is fulfilled.

registerMessageHook

• registerMessageHook(
  msgId: string,
  hook: (
  msg: IIOPubMessage<IOPubMessageType>,
  ) => boolean | PromiseLike<boolean>,
  ): void

• Parameters

  • msgId: string
  • hook: (msg: IIOPubMessage<IOPubMessageType>) => boolean | PromiseLike<boolean>

Returns void

removeCommTarget

• removeCommTarget(
  targetName: string,
  callback: (
  comm: IComm,
  msg: ICommOpenMsg<"iopub" | "shell">,
  ) => void | PromiseLike<void>,
  ): void

• Parameters

  • targetName: string
  • callback: (comm: IComm, msg: ICommOpenMsg<"iopub" | "shell">) => void | PromiseLike<void>

Returns void

removeInputGuard

• removeInputGuard(): void

• Returns void

removeMessageHook

• removeMessageHook(
  msgId: string,
  hook: (
  msg: IIOPubMessage<IOPubMessageType>,
  ) => boolean | PromiseLike<boolean>,
  ): void

• Parameters

  • msgId: string
  • hook: (msg: IIOPubMessage<IOPubMessageType>) => boolean | PromiseLike<boolean>

Returns void

requestCommInfo

• requestCommInfo(content: { target_name?: string }): Promise<ICommInfoReplyMsg>

• Parameters

  • content: { target_name?: string }
    * ##### Optionaltarget_name?: string

Returns Promise<ICommInfoReplyMsg>

requestComplete

• requestComplete(
  content: { code: string; cursor_pos: number },
  ): Promise<ICompleteReplyMsg>

• Parameters

  • content: { code: string; cursor_pos: number }

Returns Promise<ICompleteReplyMsg>

requestCreateSubshell

• requestCreateSubshell(
  content: Record<string, unknown>,
  disposeOnDone?: boolean,
  ): IControlFuture<ICreateSubshellRequestMsg, ICreateSubshellReplyMsg>

• Parameters

  • content: Record<string, unknown>
  • disposeOnDone: boolean = true

Returns IControlFuture<ICreateSubshellRequestMsg, ICreateSubshellReplyMsg>

requestDeleteSubshell

• requestDeleteSubshell(
  content: { subshell_id: string },
  disposeOnDone?: boolean,
  ): IControlFuture<IDeleteSubshellRequestMsg, IDeleteSubshellReplyMsg>

• Parameters

  • content: { subshell_id: string }
  • disposeOnDone: boolean = true

Returns IControlFuture<IDeleteSubshellRequestMsg, IDeleteSubshellReplyMsg>

requestExecute

• requestExecute(
  content: {
  allow_stdin?: boolean;
  code: string;
  silent?: boolean;
  stop_on_error?: boolean;
  store_history?: boolean;
  user_expressions?: JSONObject;
  },
  disposeOnDone?: boolean,
  metadata?: JSONObject,
  ): IShellFuture<IExecuteRequestMsg, IExecuteReplyMsg>

• Parameters

  • content: {
    allow_stdin?: boolean;
    code: string;
    silent?: boolean;
    stop_on_error?: boolean;
    store_history?: boolean;
    user_expressions?: JSONObject;
    }
    * ##### Optionalallow_stdin?: boolean
    * ##### code: string
    * ##### Optionalsilent?: boolean
    * ##### Optionalstop_on_error?: boolean
    * ##### Optionalstore_history?: boolean
    * ##### Optionaluser_expressions?: JSONObject
  • disposeOnDone: boolean = true
  • Optionalmetadata: JSONObject

Returns IShellFuture<IExecuteRequestMsg, IExecuteReplyMsg>

requestHistory

• requestHistory(
  content:
  | IHistoryRequestRange
  | IHistoryRequestSearch
  | IHistoryRequestTail,
  ): Promise<IHistoryReplyMsg>

• Returns Promise<IHistoryReplyMsg>

requestInspect

• requestInspect(
  content: { code: string; cursor_pos: number; detail_level: 0 | 1 },
  ): Promise<IInspectReplyMsg>

• Parameters

  • content: { code: string; cursor_pos: number; detail_level: 0 | 1 }

Returns Promise<IInspectReplyMsg>

requestIsComplete

• requestIsComplete(content: { code: string }): Promise<IIsCompleteReplyMsg>

• Parameters

  • content: { code: string }

Returns Promise<IIsCompleteReplyMsg>

requestKernelInfo

• requestKernelInfo(): Promise<undefined | IInfoReplyMsg>

• Returns Promise<undefined | IInfoReplyMsg>

requestListSubshell

• requestListSubshell(
  content: Record<string, unknown>,
  disposeOnDone?: boolean,
  ): IControlFuture<IListSubshellRequestMsg, IListSubshellReplyMsg>

• Parameters

  • content: Record<string, unknown>
  • disposeOnDone: boolean = true

Returns IControlFuture<IListSubshellRequestMsg, IListSubshellReplyMsg>

restart

• restart(): Promise<void>

• Returns Promise<void>

sendControlMessage

• sendControlMessage<T extends ControlMessageType>(
  msg: IControlMessage<T>,
  expectReply?: boolean,
  disposeOnDone?: boolean,
  ): IControlFuture<IControlMessage<T>, IControlMessage<ControlMessageType>>

• Type Parameters

  • T extends ControlMessageType

Parameters

• msg: IControlMessage<T>
• expectReply: boolean = false
• disposeOnDone: boolean = true

Returns IControlFuture<IControlMessage<T>, IControlMessage<ControlMessageType>>

sendInputReply

• sendInputReply(
  content: ReplyContent<IInputReply>,
  parent_header: IHeader<"input_request">,
  ): void

• Returns void

sendShellMessage

• sendShellMessage<T extends ShellMessageType>(
  msg: IShellMessage<T>,
  expectReply?: boolean,
  disposeOnDone?: boolean,
  ): IShellFuture<IShellMessage<T>, IShellMessage<ShellMessageType>>

• Type Parameters

  • T extends ShellMessageType

Parameters

• msg: IShellMessage<T>
• expectReply: boolean = false
• disposeOnDone: boolean = true

Returns IShellFuture<IShellMessage<T>, IShellMessage<ShellMessageType>>

shutdown

• shutdown(): Promise<void>

• Returns Promise<void>