Interface IManager

Object which manages kernel instances for a given base url.

Notes

The manager is responsible for maintaining the state of running kernels through polling the server. Use a manager if you want to be notified of changes to kernels.

interface IManager {
    connectionFailure: ISignal<Kernel.IManager, NetworkError>;
    disposed: ISignal<Kernel.IManager, void>;
    isActive: boolean;
    isDisposed: boolean;
    isReady: boolean;
    ready: Promise<void>;
    runningChanged: ISignal<Kernel.IManager, Kernel.IModel[]>;
    serverSettings: ServerConnection.ISettings;
    connectTo(options): IKernelConnection;
    dispose(): void;
    findById(id): Promise<undefined | Kernel.IModel>;
    refreshRunning(): Promise<void>;
    running(): IterableIterator<Kernel.IModel>;
    shutdown(id): Promise<void>;
    shutdownAll(): Promise<void>;
    startNew(createOptions?, connectOptions?): Promise<IKernelConnection>;
}

Hierarchy (view full)

Implemented by

Properties

connectionFailure disposed isActive isDisposed isReady ready runningChanged serverSettings

Methods

connectTo dispose findById refreshRunning running shutdown shutdownAll startNew

Properties

connectionFailure

connectionFailure: ISignal<Kernel.IManager, NetworkError>

A signal emitted when there is a server API connection failure.

Readonly disposed

disposed: ISignal<Kernel.IManager, void>

A signal emitted when the object is disposed.

Readonly isActive

isActive: boolean

Whether the manager is active.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly isReady

isReady: boolean

Whether the manager is ready.

Readonly ready

ready: Promise<void>

A promise that resolves when the manager is initially ready.

runningChanged

runningChanged: ISignal<Kernel.IManager, Kernel.IModel[]>

A signal emitted when the running kernels change.

Readonly serverSettings

serverSettings: ServerConnection.ISettings

The server settings for the manager.

Methods

connectTo

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

findById

refreshRunning

  • refreshRunning(): Promise<void>

  • Force a refresh of the running kernels.

    Returns Promise<void>

    A promise that resolves when the models are refreshed.

    Notes

    This is intended to be called only in response to a user action, since the manager maintains its internal state.

running

shutdown

shutdownAll

startNew

Settings

Member Visibility

Theme

On This Page

connectionFailuredisposedisActiveisDisposedisReadyreadyrunningChangedserverSettingsconnectTodisposefindByIdrefreshRunningrunningshutdownshutdownAllstartNew