Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KernelControlFutureHandler<REQUEST, REPLY>

Type parameters

Hierarchy

Implements

Index

Constructors

constructor

Properties

isDisposed

isDisposed: boolean

Test whether the delegate has been disposed.

Accessors

done

  • get done(): Promise<REPLY>

msg

  • get msg(): REQUEST

onIOPub

  • get onIOPub(): function
  • set onIOPub(cb: function): void

onReply

  • get onReply(): function
  • set onReply(cb: function): void

onStdin

  • get onStdin(): function
  • set onStdin(cb: function): void

Methods

dispose

  • dispose(): void

handleMsg

  • handleMsg(msg: IMessage): Promise<void>

registerMessageHook

  • registerMessageHook(hook: function): void
  • Register hook for IOPub messages.

    Parameters

    • hook: function

      The callback invoked for an IOPub message.

      Notes

      The IOPub hook system allows you to preempt the handlers for IOPub messages handled by the future.

      The most recently registered hook is run first. A hook can return a boolean or a promise to a boolean, in which case all kernel message processing pauses until the promise is fulfilled. If a hook return value resolves to false, any later hooks will not run and the function will return a promise resolving to false. If a hook throws an error, the error is logged to the console and the next hook is run. If a hook is registered during the hook processing, it will not run until the next message. If a hook is removed during the hook processing, it will be deactivated immediately.

    Returns void

removeMessageHook

  • removeMessageHook(hook: function): void

sendInputReply

Generated using TypeDoc