Class KernelConnector

Connector class that handles execute request to a kernel

Constructors

constructor

Properties

_kernel _kernelRestarted

Accessors

iopubMessage kernelLanguage kernelName kernelRestarted ready

Methods

execute fetch

Constructors

constructor

Properties

Private _kernel

_kernel: Kernel

Private _kernelRestarted

_kernelRestarted: Signal<KernelConnector, Promise<void>> = ...

Accessors

iopubMessage

kernelLanguage

kernelName

kernelRestarted

ready

Methods

execute

  • execute(content): IShellFuture<IExecuteRequestMsg, IExecuteReplyMsg>

  • Parameters

    • content: {
          allow_stdin?: boolean;
          code: string;
          silent?: boolean;
          stop_on_error?: boolean;
          store_history?: boolean;
          user_expressions?: JSONObject;
      }
      • Optional allow_stdin?: boolean

        Whether to allow stdin requests. The default is true.

      • code: string

        The code to execute.

      • Optional silent?: boolean

        Whether to execute the code as quietly as possible. The default is false.

      • Optional stop_on_error?: boolean

        Whether to the abort execution queue on an error. The default is false.

      • Optional store_history?: boolean

        Whether to store history of the execution. The default true if silent is False. It is forced to false if silent is true.

      • Optional user_expressions?: JSONObject

        A mapping of names to expressions to be evaluated in the kernel's interactive namespace.

    Returns IShellFuture<IExecuteRequestMsg, IExecuteReplyMsg>

fetch

  • fetch(content, ioCallback): Promise<IExecuteReplyMsg>

  • Executes the given request on the kernel associated with the connector.

    Parameters

    • content: {
          allow_stdin?: boolean;
          code: string;
          silent?: boolean;
          stop_on_error?: boolean;
          store_history?: boolean;
          user_expressions?: JSONObject;
      }
      • Optional allow_stdin?: boolean

        Whether to allow stdin requests. The default is true.

      • code: string

        The code to execute.

      • Optional silent?: boolean

        Whether to execute the code as quietly as possible. The default is false.

      • Optional stop_on_error?: boolean

        Whether to the abort execution queue on an error. The default is false.

      • Optional store_history?: boolean

        Whether to store history of the execution. The default true if silent is False. It is forced to false if silent is true.

      • Optional user_expressions?: JSONObject

        A mapping of names to expressions to be evaluated in the kernel's interactive namespace.

    • ioCallback: ((msg) => any)
        • (msg): any

        • Parameters

          • msg: IIOPubMessage<IOPubMessageType>

          Returns any

    Returns Promise<IExecuteReplyMsg>

    Promise<KernelMessage.IExecuteReplyMsg>

Settings

Member Visibility

Theme

On This Page

constructor_kernel_kernelRestartediopubMessagekernelLanguagekernelNamekernelRestartedreadyexecutefetch