Class NoopManager

A no-op kernel manager to be used when starting kernels.

Hierarchy (View Summary)

KernelManager
- NoopManager

Index

Constructors

constructor

new NoopManager(options?: KernelManager.IOptions): KernelManager.NoopManager
Construct a new kernel manager.
Parameters
- options: KernelManager.IOptions = {}
  The default options for kernel.
Returns KernelManager.NoopManager
Inherited from KernelManager.constructor
- Defined in packages/services/src/kernel/manager.ts:22

Properties

`Readonly`serverSettings

serverSettings: ServerConnection.ISettings

The server settings for the manager.

Accessors

commsOverSubshells

get commsOverSubshells(): CommsOverSubshells
Whether comms are running on subshell or not.

Returns CommsOverSubshells
Inherited from KernelManager.commsOverSubshells
- Defined in packages/services/src/kernel/manager.ts:166
set commsOverSubshells(value: CommsOverSubshells): void
Whether comm messages should be sent to kernel subshells, if the kernel supports it.

Notes
Sending comm messages over subshells allows processing comms whilst processing execute-request on the "main shell". This prevents blocking comm processing. Options are:
- disabled: not using subshells
- one subshell per comm-target (default)
- one subshell per comm (can lead to issues if creating many comms)
Parameters
- value: CommsOverSubshells
Returns void
Inherited from KernelManager.commsOverSubshells
- Defined in packages/services/src/kernel/manager.ts:170

connectionFailure

get connectionFailure(): ISignal<this, Error>
A signal emitted when there is a connection failure.

Returns ISignal<this, Error>
Inherited from KernelManager.connectionFailure
- Defined in packages/services/src/kernel/manager.ts:85

disposed

get disposed(): ISignal<this, void>
A signal emitted when the delegate is disposed.

Returns ISignal<this, void>
Inherited from KernelManager.disposed
- Defined in packages/services/src/basemanager.ts:49

isActive

get isActive(): boolean
Whether the manager is active.

Returns boolean
Overrides KernelManager.isActive
- Defined in packages/services/src/kernel/manager.ts:402

isDisposed

get isDisposed(): boolean
Test whether the delegate has been disposed.

Returns boolean
Inherited from KernelManager.isDisposed
- Defined in packages/services/src/basemanager.ts:61

isReady

get isReady(): boolean
Test whether the manager is ready.

Returns boolean
Inherited from KernelManager.isReady
- Defined in packages/services/src/kernel/manager.ts:64

parentReady

get parentReady(): Promise<void>
Used for testing.

Returns Promise<void>
- Defined in packages/services/src/kernel/manager.ts:409

ready

get ready(): Promise<void>
A promise that fulfills when the manager is ready (never).

Returns Promise<void>
Overrides KernelManager.ready
- Defined in packages/services/src/kernel/manager.ts:449

runningChanged

get runningChanged(): ISignal<this, Kernel.IModel[]>
A signal emitted when the running kernels change.

Returns ISignal<this, Kernel.IModel[]>
Inherited from KernelManager.runningChanged
- Defined in packages/services/src/kernel/manager.ts:78

runningCount

get runningCount(): number
The number of running kernels.

Returns number
Inherited from KernelManager.runningCount
- Defined in packages/services/src/kernel/manager.ts:159

Methods

connectTo

connectTo(
options: Omit<Kernel.IKernelConnection.IOptions, "serverSettings">,
): Kernel.IKernelConnection
Connect to an existing kernel - throws an error since it is not supported.
Parameters
- options: Omit<Kernel.IKernelConnection.IOptions, "serverSettings">
Returns Kernel.IKernelConnection
Overrides KernelManager.connectTo
- Defined in packages/services/src/kernel/manager.ts:431

dispose

dispose(): void
Dispose of the resources used by the manager.

Returns void
Inherited from KernelManager.dispose
- Defined in packages/services/src/kernel/manager.ts:92

findById

findById(id: string): Promise<undefined | Kernel.IModel>
Find a kernel by id.
Parameters
- id: string
  The id of the target kernel.
Returns Promise<undefined | Kernel.IModel>
A promise that resolves with the kernel's model.
Inherited from KernelManager.findById
- Defined in packages/services/src/kernel/manager.ts:255

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.
Inherited from KernelManager.refreshRunning
- Defined in packages/services/src/kernel/manager.ts:187

`Protected`requestRunning

requestRunning(): Promise<void>
Execute a request to the server to poll running kernels and update state.

Returns Promise<void>
Overrides KernelManager.requestRunning
- Defined in packages/services/src/kernel/manager.ts:456

running

running(): IterableIterator<Kernel.IModel>
Create an iterator over the most recent running kernels.

Returns IterableIterator<Kernel.IModel>
A new iterator over the running kernels.
Inherited from KernelManager.running
- Defined in packages/services/src/kernel/manager.ts:152

shutdown

shutdown(id: string): Promise<void>
Shut down a kernel by id - throws an error since it is not supported.
Parameters
- id: string
Returns Promise<void>
Overrides KernelManager.shutdown
- Defined in packages/services/src/kernel/manager.ts:440

shutdownAll

shutdownAll(): Promise<void>
Shut down all kernels.

Returns Promise<void>
A promise that resolves when all of the kernels are shut down.
Inherited from KernelManager.shutdownAll
- Defined in packages/services/src/kernel/manager.ts:235

startNew

startNew(
    createOptions?: Partial<Pick<Kernel.IModel, "name">>,
    connectOptions?: Omit<
        Kernel.IKernelConnection.IOptions,
        "serverSettings"
        | "model",
    >,
): Promise<Kernel.IKernelConnection>
Start a new kernel - throws an error since it is not supported.
Parameters
- createOptions: Partial<Pick<Kernel.IModel, "name">> = {}
- connectOptions: Omit<Kernel.IKernelConnection.IOptions, "serverSettings" | "model"> = {}
Returns Promise<Kernel.IKernelConnection>
Overrides KernelManager.startNew
- Defined in packages/services/src/kernel/manager.ts:416

Class NoopManager

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns KernelManager.NoopManager

Properties

ReadonlyserverSettings

Accessors

commsOverSubshells

Returns CommsOverSubshells

Notes

Parameters

Returns void

connectionFailure

Returns ISignal<this, Error>

disposed

Returns ISignal<this, void>

isActive

Returns boolean

isDisposed

Returns boolean

isReady

Returns boolean

parentReady

Returns Promise<void>

ready

Returns Promise<void>

runningChanged

Returns ISignal<this, Kernel.IModel[]>

runningCount

Returns number

Methods

connectTo

Parameters

Returns Kernel.IKernelConnection

dispose

Returns void

findById

Parameters

Returns Promise<undefined | Kernel.IModel>

refreshRunning

Returns Promise<void>

Notes

ProtectedrequestRunning

Returns Promise<void>

running

Returns IterableIterator<Kernel.IModel>

shutdown

Parameters

Returns Promise<void>

shutdownAll

Returns Promise<void>

startNew

Parameters

Returns Promise<Kernel.IKernelConnection>

Settings

On This Page

`Readonly`serverSettings

`Protected`requestRunning