Class BeakerCellFuture

Hierarchy

KernelFutureHandler<IBeakerShellMessage, IBeakerShellMessage>
- BeakerCellFuture

Index

Constructors

constructor

new BeakerCellFuture(
    msg: IBeakerShellMessage,
    expectReply: boolean,
    disposeOnDone: boolean,
    kernel?: null | IKernelConnection,
    cell?: BeakerCodeCell,
): BeakerCellFuture
Construct a new KernelFutureHandler.
Parameters
- msg: IBeakerShellMessage
- expectReply: boolean
- disposeOnDone: boolean
- Optionalkernel: null | IKernelConnection
- Optionalcell: BeakerCodeCell
Returns BeakerCellFuture
Overrides KernelFutureHandler<IBeakerShellMessage, IBeakerShellMessage>.constructor
- Defined in src/util.ts:62

Accessors

done

get done(): Promise<REPLY>
A promise that resolves when the future is done.

Returns Promise<REPLY>
Inherited from KernelFutureHandler.done
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:24

isDisposed

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

Returns boolean
Inherited from KernelFutureHandler.isDisposed
- Defined in node_modules/@lumino/disposable/types/index.d.ts:52

msg

get msg(): REQUEST
Get the original outgoing message.

Returns REQUEST
Inherited from KernelFutureHandler.msg
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:20

onIOPub

get onIOPub(): (msg: IIOPubMessage) => void | PromiseLike<void>
Get the iopub handler.

Returns (msg: IIOPubMessage) => void | PromiseLike<void>
Inherited from KernelFutureHandler.onIOPub
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:36
set onIOPub(cb: (msg: IIOPubMessage) => void | PromiseLike<void>): void
Set the iopub handler.
Parameters
- cb: (msg: IIOPubMessage) => void | PromiseLike<void>
Returns void
Inherited from KernelFutureHandler.onIOPub
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:40

onReply

get onReply(): (msg: REPLY) => void | PromiseLike<void>
Get the reply handler.

Returns (msg: REPLY) => void | PromiseLike<void>
Inherited from KernelFutureHandler.onReply
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:28
set onReply(cb: (msg: REPLY) => void | PromiseLike<void>): void
Set the reply handler.
Parameters
- cb: (msg: REPLY) => void | PromiseLike<void>
Returns void
Inherited from KernelFutureHandler.onReply
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:32

onStdin

get onStdin(): (msg: IStdinMessage) => void | PromiseLike<void>
Get the stdin handler.

Returns (msg: IStdinMessage) => void | PromiseLike<void>
Inherited from KernelFutureHandler.onStdin
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:44
set onStdin(cb: (msg: IStdinMessage) => void | PromiseLike<void>): void
Set the stdin handler.
Parameters
- cb: (msg: IStdinMessage) => void | PromiseLike<void>
Returns void
Inherited from KernelFutureHandler.onStdin
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:48

Methods

dispose

dispose(): void
Dispose and unregister the future.

Returns void
Inherited from KernelFutureHandler.dispose
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:85

handleMsg

handleMsg(msg: IMessage): Promise<void>
Handle an incoming kernel message.
Parameters
- msg: IMessage
Returns Promise<void>
Inherited from KernelFutureHandler.handleMsg
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:89

registerMessageHook

registerMessageHook(
hook: (msg: IIOPubMessage) => boolean | PromiseLike<boolean>,
): void
Register hook for IOPub messages.
Parameters
- hook: (msg: IIOPubMessage) => boolean | PromiseLike<boolean>
  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
Inherited from KernelFutureHandler.registerMessageHook
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:68

removeMessageHook

removeMessageHook(
hook: (msg: IIOPubMessage) => boolean | PromiseLike<boolean>,
): void
Remove a hook for IOPub messages.
Parameters
- hook: (msg: IIOPubMessage) => boolean | PromiseLike<boolean>
  The hook to remove.
  
  Notes
  If a hook is removed during the hook processing, it will be deactivated immediately.
Returns void
Inherited from KernelFutureHandler.removeMessageHook
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:77

sendInputReply

sendInputReply(
content: ReplyContent<IInputReply>,
parent_header: IHeader<"input_request">,
): void
Send an input_reply message.
Parameters
- content: ReplyContent<IInputReply>
- parent_header: IHeader<"input_request">
Returns void
Inherited from KernelFutureHandler.sendInputReply
- Defined in node_modules/@jupyterlab/services/lib/kernel/future.d.ts:81

Class BeakerCellFuture

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns BeakerCellFuture

Accessors

done

Returns Promise<REPLY>

isDisposed

Returns boolean

msg

Returns REQUEST

onIOPub

Returns (msg: IIOPubMessage) => void | PromiseLike<void>

Parameters

Returns void

onReply

Returns (msg: REPLY) => void | PromiseLike<void>

Parameters

Returns void

onStdin

Returns (msg: IStdinMessage) => void | PromiseLike<void>

Parameters

Returns void

Methods

dispose

Returns void

handleMsg

Parameters

Returns Promise<void>

registerMessageHook

Parameters

Notes

Returns void

removeMessageHook

Parameters

Notes

Returns void

sendInputReply

Parameters

Returns void

Settings

On This Page