Interface IManager

Object which manages kernel instances for a given base url.

Notes

The manager is responsible for maintaining the state of kernel specs.

interface IManager {
    connectionFailure: ISignal<IManager, NetworkError>;
    disposed: ISignal<KernelSpec.IManager, void>;
    isActive: boolean;
    isDisposed: boolean;
    isReady: boolean;
    ready: Promise<void>;
    serverSettings: ServerConnection.ISettings;
    specs: null | ISpecModels;
    specsChanged: ISignal<KernelSpec.IManager, ISpecModels>;
    dispose(): void;
    refreshSpecs(): Promise<void>;
}

Hierarchy (view full)

Implemented by

Properties

connectionFailure disposed isActive isDisposed isReady ready serverSettings specs specsChanged

Methods

dispose refreshSpecs

Properties

connectionFailure

connectionFailure: ISignal<IManager, NetworkError>

A signal emitted when there is a connection failure.

Readonly disposed

disposed: ISignal<KernelSpec.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.

Readonly serverSettings

serverSettings: ServerConnection.ISettings

The server settings for the manager.

Readonly specs

specs: null | ISpecModels

The kernel spec models.

Notes

The value will be null until the manager is ready.

specsChanged

specsChanged: ISignal<KernelSpec.IManager, ISpecModels>

A signal emitted when the kernel specs change.

Methods

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

refreshSpecs

Settings

Member Visibility

Theme

On This Page

connectionFailuredisposedisActiveisDisposedisReadyreadyserverSettingsspecsspecsChangeddisposerefreshSpecs