Interface ICommInfoRequestMsg

A 'comm_info_request' message on the 'shell' channel.

See Messaging in Jupyter.

See also: [[ICommInfoReplyMsg]], [[IKernel.commInfo]]

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

Hierarchy (View Summary)

Properties

buffers? channel content header metadata parent_header

Properties

Optionalbuffers

buffers?: (ArrayBuffer | ArrayBufferView)[]

An optional list of binary buffers.

channel

channel: "shell"

The channel on which the message is transmitted.

content

content: { target_name?: string }

The content of the message.

Type declaration

  • Optionaltarget_name?: string

    The comm target name to filter returned comms

header

header: IHeader<"comm_info_request">

The message header.

metadata

metadata: JSONObject

Metadata associated with the message.

parent_header

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

The parent message

Settings

Member Visibility

On This Page

Properties