Interface IFuture<REQUEST, REPLY>

A Future interface for responses from the kernel.

When a message is sent to a kernel, a Future is created to handle any responses that may come from the kernel.

interface IFuture<
    REQUEST extends IShellControlMessage,
    REPLY extends IShellControlMessage,
> {
    done: Promise<REPLY>;
    isDisposed: boolean;
    msg: REQUEST;
    onIOPub: (msg: IIOPubMessage<IOPubMessageType>) => void | PromiseLike<void>;
    onReply: (msg: REPLY) => void | PromiseLike<void>;
    onStdin: (msg: IStdinMessage<StdinMessageType>) => void | PromiseLike<void>;
    dispose(): void;
    registerMessageHook(
        hook: (
            msg: IIOPubMessage<IOPubMessageType>,
        ) => boolean | PromiseLike<boolean>,
    ): void;
    removeMessageHook(
        hook: (
            msg: IIOPubMessage<IOPubMessageType>,
        ) => boolean | PromiseLike<boolean>,
    ): void;
    sendInputReply(
        content: ReplyContent<IInputReply>,
        parent_header: IHeader<"input_request">,
    ): void;
}

Type Parameters

Hierarchy (View Summary)

Properties

done isDisposed msg onIOPub onReply onStdin

Methods

dispose registerMessageHook removeMessageHook sendInputReply

Properties

Readonlydone

done: Promise<REPLY>

A promise that resolves when the future is done.

Notes

The future is done when there are no more responses expected from the kernel.

The done promise resolves to the reply message.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonlymsg

msg: REQUEST

The original outgoing message.

onIOPub

onIOPub: (msg: IIOPubMessage<IOPubMessageType>) => void | PromiseLike<void>

The iopub handler for the kernel future.

Notes

If the handler returns a promise, all kernel message processing pauses until the promise is resolved.

onReply

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

The reply handler for the kernel future.

Notes

If the handler returns a promise, all kernel message processing pauses until the promise is resolved. If there is a reply message, the future done promise also resolves to the reply message after this handler has been called.

onStdin

onStdin: (msg: IStdinMessage<StdinMessageType>) => void | PromiseLike<void>

The stdin handler for the kernel future.

Notes

If the handler returns a promise, all kernel message processing pauses until the promise is resolved.

Methods

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

registerMessageHook

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

  • Register hook for IOPub messages.

    Parameters

    • hook: (msg: IIOPubMessage<IOPubMessageType>) => 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

removeMessageHook

sendInputReply

Settings

Member Visibility

On This Page

Properties
Methods