Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IManager

Object which manages session instances.

Notes

The manager is responsible for maintaining the state of running sessions and the initial fetch of kernel specs.

Hierarchy

  • IDisposable
    • IManager

Implemented by

Index

Properties

Methods

Properties

connectionFailure

connectionFailure: ISignal<IManager, NetworkError>

A signal emitted when there is a connection failure.

isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

isReady

isReady: boolean

Test whether the manager is ready.

ready

ready: Promise<void>

A promise that is fulfilled when the manager is ready.

runningChanged

runningChanged: ISignal<this, IModel[]>

A signal emitted when the running sessions change.

Optional serverSettings

serverSettings: ISettings

The server settings for the manager.

specs

specs: ISpecModels | null

The cached kernel specs.

Notes

This value will be null until the manager is ready.

specsChanged

specsChanged: ISignal<this, ISpecModels>

A signal emitted when the kernel specs change.

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

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

  • Find a session by id.

    Parameters

    • id: string

      The id of the target session.

    Returns Promise<IModel>

    A promise that resolves with the session's model.

findByPath

  • findByPath(path: string): Promise<IModel>

  • Find a session by path.

    Parameters

    • path: string

      The path of the target session.

    Returns Promise<IModel>

    A promise that resolves with the session's model.

refreshRunning

  • refreshRunning(): Promise<void>

  • Force a refresh of the running sessions.

    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.

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.

running

  • running(): IIterator<IModel>

  • Create an iterator over the known running sessions.

    Returns IIterator<IModel>

    A new iterator over the running sessions.

shutdown

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

  • Shut down a session by id.

    Parameters

    • id: string

      The id of the target kernel.

    Returns Promise<void>

    A promise that resolves when the operation is complete.

shutdownAll

  • shutdownAll(): Promise<void>

  • Shut down all sessions.

    Returns Promise<void>

    A promise that resolves when all of the sessions are shut down.

startNew

  • Start a new session.

    Parameters

    • options: IOptions

      The session options to use.

    Returns Promise<ISession>

    A promise that resolves with the session instance.

    Notes

    The serverSettings of the manager will be used.

stopIfNeeded

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

  • Find a session associated with a path and stop it is the only session using that kernel.

    Parameters

    • path: string

      The path in question.

    Returns Promise<void>

    A promise that resolves when the relevant sessions are stopped.

Generated using TypeDoc