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.
A promise that resolves when the future is done.
The future is done when there are no more responses expected from the kernel.
done promise resolves to the reply message.
Test whether the object has been disposed.
This property is always safe to access.
The original outgoing message.
The reply handler for the kernel future.
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
Dispose of the resources held by the object.
If the object's
dispose method is called more than once, all
calls made after the first will be a no-op.
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.
Register hook for IOPub messages.
The callback invoked for an IOPub message.
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.
Remove a hook for IOPub messages.
The hook to remove.
If a hook is removed during the hook processing, it will be deactivated immediately.
Generated using TypeDoc