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<IManager, void>;
    isActive: boolean;
    isDisposed: boolean;
    isReady: boolean;
    ready: Promise<void>;
    serverSettings: ServerConnection.ISettings;
    dispose(): void;
}

Hierarchy (view full)

Implemented by

Properties

connectionFailure: ISignal<IManager, NetworkError>

A signal emitted when there is a connection failure.

disposed: ISignal<IManager, void>

A signal emitted when the object is disposed.

isActive: boolean

Whether the manager is active.

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

isReady: boolean

Whether the manager is ready.

ready: Promise<void>

A promise that resolves when the manager is initially ready.

serverSettings: ServerConnection.ISettings

The server settings for the manager.

Methods

  • 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