An 'interrupt_request' message.

The interrupt messages can only be used for kernels which specify interrupt_mode: 'message'. By default JupyterLab interrupts kernels via jupyter-server Kernels REST API instead.

See Messaging in Jupyter.

See also: [[IInterruptReplyMsg]], [[[IKernel.interrupt]]]

interface IInterruptRequestMsg {
    buffers?: (ArrayBuffer | ArrayBufferView)[];
    channel: "control";
    content: Record<string, never>;
    header: IHeader<"interrupt_request">;
    metadata: JSONObject;
    parent_header: IHeader<KernelMessage.MessageType> | Record<string, never>;
}

Hierarchy (View Summary)

Properties

buffers?: (ArrayBuffer | ArrayBufferView)[]

An optional list of binary buffers.

channel: "control"

The channel on which the message is transmitted.

content: Record<string, never>

The content of the message.

header: IHeader<"interrupt_request">

The message header.

metadata: JSONObject

Metadata associated with the message.

parent_header: IHeader<KernelMessage.MessageType> | Record<string, never>

The parent message