Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KernelManager

An implementation of a kernel manager. The namespace for KernelManager class statics.

Hierarchy

  • KernelManager

Implements

Index

Interfaces

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _connectionFailure

_connectionFailure: Signal<this, Error> = new Signal<this, Error>(this)

Private _isDisposed

_isDisposed: boolean = false

Private _isReady

_isReady: boolean = false

Private _kernels

_kernels: Set<IKernel> = new Set<Kernel.IKernel>()

Private _models

_models: IModel[] = []

Private _pollModels

_pollModels: Poll

Private _pollSpecs

_pollSpecs: Poll

Private _ready

_ready: Promise<void>

Private _runningChanged

_runningChanged: Signal<this, IModel[]> = new Signal<this, Kernel.IModel[]>(this)

Private _specs

_specs: ISpecModels | null = null

Private _specsChanged

_specsChanged: Signal<this, ISpecModels> = new Signal<this, Kernel.ISpecModels>(this)

serverSettings

serverSettings: ISettings

The server settings for the manager.

Accessors

connectionFailure

  • get connectionFailure(): ISignal<this, Error>

  • A signal emitted when there is a connection failure.

    Returns ISignal<this, Error>

isDisposed

  • get isDisposed(): boolean

isReady

  • get isReady(): boolean

ready

  • get ready(): Promise<void>

  • A promise that fulfills when the manager is ready.

    Returns Promise<void>

runningChanged

  • get runningChanged(): ISignal<this, IModel[]>

specs

specsChanged

Methods

Private _onStarted

  • _onStarted(kernel: IKernel): void

Private _onTerminated

  • _onTerminated(id: string): void

connectTo

dispose

  • dispose(): void

findById

  • findById(id: string): Promise<IModel>

  • Find a kernel by id.

    Parameters

    • id: string

      The id of the target kernel.

    Returns Promise<IModel>

    A promise that resolves with the kernel's model.

refreshRunning

  • refreshRunning(): Promise<void>

  • Force a refresh of the running kernels.

    Returns Promise<void>

    A promise that resolves when the running list has been refreshed.

    Notes

    This is not typically meant to be called by the user, since the manager maintains its own internal state.

refreshSpecs

  • refreshSpecs(): Promise<void>

  • Force a refresh of the specs from the server.

    Returns Promise<void>

    A promise that resolves when the specs are fetched.

    Notes

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

Protected requestRunning

  • requestRunning(): Promise<void>

  • Execute a request to the server to poll running kernels and update state.

    Returns Promise<void>

Protected requestSpecs

  • requestSpecs(): Promise<void>

  • Execute a request to the server to poll specs and update state.

    Returns Promise<void>

running

  • running(): IIterator<IModel>

shutdown

  • shutdown(id: string): Promise<void>

  • Shut down a kernel by id.

    Parameters

    • id: string

      The id of the target kernel.

    Returns Promise<void>

    A promise that resolves when the operation is complete.

    Notes

    This will emit runningChanged if the running kernels list changes.

shutdownAll

  • shutdownAll(): Promise<void>

startNew

  • Start a new kernel.

    Parameters

    • Default value options: IOptions = {}

      The kernel options to use.

    Returns Promise<IKernel>

    A promise that resolves with the kernel instance.

    Notes

    The manager serverSettings will be always be used.

Generated using TypeDoc