Interface ISessionConnection

Interface of a session object.

A session object represents a live connection to a session kernel.

This represents a persistent kernel connection with a particular key, that persists across changing kernels and kernels getting terminated. As such, a number of signals are proxied from the current kernel for convenience.

The kernel is owned by the session, in that the session creates the kernel and manages its lifecycle.

interface ISessionConnection {
    anyMessage: ISignal<Session.ISessionConnection, IAnyMessageArgs>;
    connectionStatusChanged: ISignal<
        Session.ISessionConnection,
        Kernel.ConnectionStatus,
    >;
    disposed: ISignal<Session.ISessionConnection, void>;
    id: string;
    iopubMessage: ISignal<
        Session.ISessionConnection,
        IIOPubMessage<IOPubMessageType>,
    >;
    isDisposed: boolean;
    kernel: null | Kernel.IKernelConnection;
    kernelChanged: ISignal<
        Session.ISessionConnection,
        IChangedArgs<
            null
            | Kernel.IKernelConnection,
            null | Kernel.IKernelConnection,
            "kernel",
        >,
    >;
    model: Session.IModel;
    name: string;
    path: string;
    pendingInput: ISignal<Session.ISessionConnection, boolean>;
    propertyChanged: ISignal<
        Session.ISessionConnection,
        "name"
        | "type"
        | "path",
    >;
    serverSettings: ServerConnection.ISettings;
    statusChanged: ISignal<Session.ISessionConnection, Kernel.Status>;
    type: string;
    unhandledMessage: ISignal<
        Session.ISessionConnection,
        KernelMessage.IMessage<KernelMessage.MessageType>,
    >;
    changeKernel(
        options: Partial<Kernel.IModel>,
    ): Promise<null | Kernel.IKernelConnection>;
    dispose(): void;
    setName(name: string): Promise<void>;
    setPath(path: string): Promise<void>;
    setType(type: string): Promise<void>;
    shutdown(): Promise<void>;
}

Hierarchy

Properties

anyMessage connectionStatusChanged disposed id iopubMessage isDisposed kernel kernelChanged model name path pendingInput propertyChanged serverSettings statusChanged type unhandledMessage

Methods

changeKernel dispose setName setPath setType shutdown

Properties

anyMessage

anyMessage: ISignal<Session.ISessionConnection, IAnyMessageArgs>

The kernel anyMessage signal, proxied from the current kernel.

connectionStatusChanged

connectionStatusChanged: ISignal<
    Session.ISessionConnection,
    Kernel.ConnectionStatus,
>

The kernel connectionStatusChanged signal, proxied from the current kernel.

Readonlydisposed

disposed: ISignal<Session.ISessionConnection, void>

A signal emitted when the object is disposed.

Readonlyid

id: string

Unique id of the session.

iopubMessage

iopubMessage: ISignal<
    Session.ISessionConnection,
    IIOPubMessage<IOPubMessageType>,
>

The kernel iopubMessage signal, proxied from the current kernel.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonlykernel

kernel: null | Kernel.IKernelConnection

The kernel.

Notes

This is a read-only property, and can be altered by [changeKernel].

A number of kernel signals are proxied through the session from whatever the current kernel is for convenience.

kernelChanged

kernelChanged: ISignal<
    Session.ISessionConnection,
    IChangedArgs<
        null
        | Kernel.IKernelConnection,
        null | Kernel.IKernelConnection,
        "kernel",
    >,
>

A signal emitted when the kernel changes.

Readonlymodel

model: Session.IModel

The model associated with the session.

Readonlyname

name: string

The current name associated with the session.

Readonlypath

path: string

The current path associated with the session.

pendingInput

pendingInput: ISignal<Session.ISessionConnection, boolean>

The kernel pendingInput signal, proxied from the current kernel.

ReadonlypropertyChanged

propertyChanged: ISignal<Session.ISessionConnection, "name" | "type" | "path">

A signal emitted when a session property changes.

ReadonlyserverSettings

serverSettings: ServerConnection.ISettings

The server settings of the session.

statusChanged

statusChanged: ISignal<Session.ISessionConnection, Kernel.Status>

The kernel statusChanged signal, proxied from the current kernel.

Readonlytype

type: string

The type of the session.

unhandledMessage

unhandledMessage: ISignal<
    Session.ISessionConnection,
    KernelMessage.IMessage<KernelMessage.MessageType>,
>

The kernel unhandledMessage signal, proxied from the current kernel.

Methods

changeKernel

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

setName

  • setName(name: string): Promise<void>

  • Change the session name.

    Parameters

    • name: string

    Returns Promise<void>

    A promise that resolves when the session has renamed.

    Notes

    This uses the Jupyter REST API, and the response is validated. The promise is fulfilled on a valid response and rejected otherwise.

setPath

  • setPath(path: string): Promise<void>

  • Change the session path.

    Parameters

    • path: string

      The new session path.

    Returns Promise<void>

    A promise that resolves when the session has renamed.

    Notes

    This uses the Jupyter REST API, and the response is validated. The promise is fulfilled on a valid response and rejected otherwise.

setType

  • setType(type: string): Promise<void>

  • Change the session type.

    Parameters

    • type: string

    Returns Promise<void>

    A promise that resolves when the session has renamed.

    Notes

    This uses the Jupyter REST API, and the response is validated. The promise is fulfilled on a valid response and rejected otherwise.

shutdown

  • shutdown(): Promise<void>

  • Kill the kernel and shutdown the session.

    Returns Promise<void>

    A promise that resolves when the session is shut down.

    Notes

    This uses the Jupyter REST API, and the response is validated. The promise is fulfilled on a valid response and rejected otherwise.

Settings

Member Visibility

On This Page

Properties
Methods