Interface IControlMessage<T>

A kernel message on the 'control' channel.

Type Parameters

Hierarchy

Properties

buffers?: (ArrayBuffer | ArrayBufferView)[]

An optional list of binary buffers.

channel: "control"

The channel on which the message is transmitted.

content: Record<string, never> | KernelMessage.IInfoReply | {
    wait: boolean;
} | {
    comm_id: string;
    data: JSONObject;
} | IReplyErrorContent | IReplyAbortContent | ICommInfoReply | {
    target_name?: string;
} | {
    comm_id: string;
    data: JSONObject;
} | {
    comm_id: string;
    data: JSONObject;
    target_module?: string;
    target_name: string;
} | ICompleteReply | {
    code: string;
    cursor_pos: number;
} | {
    data: IMimeBundle;
    metadata: PartialJSONObject;
    transient?: {
        display_id?: string;
    };
} | {
    ename: string;
    evalue: string;
    traceback: string[];
} | {
    code: string;
    execution_count: number;
} | IReplyErrorContent & IExecuteCount | IReplyAbortContent & IExecuteCount | IExecuteReply & IExecuteCount | {
    allow_stdin?: boolean;
    code: string;
    silent?: boolean;
    stop_on_error?: boolean;
    store_history?: boolean;
    user_expressions?: JSONObject;
} | {
    data: IMimeBundle;
    execution_count: number;
    metadata: PartialJSONObject;
    transient?: {
        display_id?: string;
    };
} | IHistoryReply | IHistoryRequestRange | IHistoryRequestSearch | IHistoryRequestTail | IInputReply | {
    password: boolean;
    prompt: string;
} | IInspectReply | {
    code: string;
    cursor_pos: number;
    detail_level: 0 | 1;
} | IIsCompleteReplyIncomplete | IIsCompleteReplyOther | {
    code: string;
} | {
    execution_state: Status;
} | {
    name: "stdout" | "stderr";
    text: string;
} | {
    data: IMimeBundle;
    metadata: PartialJSONObject;
    transient?: {
        display_id?: string;
    };
} & {
    transient: {
        display_id: string;
    };
} | {
    arguments?: any;
    command: string;
    seq: number;
    type: "request";
} | {
    body?: any;
    command: string;
    message?: string;
    request_seq: number;
    seq: number;
    success: boolean;
    type: "response";
} | {
    body?: any;
    event: string;
    seq: number;
    type: "event";
}

The content of the message.

header: IHeader<T>

The message header.

metadata: JSONObject

Metadata associated with the message.

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

The parent message

Generated using TypeDoc