Class BaseSessionManager`Abstract`

Abstract base class for session manager implementations.

Implements common Session.IManager interface methods that are identical across all manager types.

This class implements the standard JupyterLab Session.IManager interface for managing notebook sessions across different execution environments.

Example

class MySessionManager extends BaseSessionManager {
  readonly managerType = 'custom' as const;

  async startNew(options: Session.ISessionOptions): Promise<Session.ISessionConnection> {
    // Custom session creation logic
  }
}

Implements

IManager

Constructors

constructor

new BaseSessionManager(serverSettings: ISettings): BaseSessionManager
Creates a new session manager instance.
Parameters
- serverSettings: ISettings
  Jupyter server connection settings
Returns BaseSessionManager
- Defined in webview/services/base/baseSessionManager.ts:142

Properties

`Protected`_activeSession

_activeSession: ISessionConnection = null

Currently active session connection. Most custom managers support only one session at a time.

`Protected`_connectionFailure

_connectionFailure: Signal<BaseSessionManager, NetworkError> = ...

Signal emitted when connection to session fails.

`Protected`_disposed

_disposed: Signal<BaseSessionManager, void> = ...

Signal emitted when manager is disposed.

`Protected`_isDisposed

_isDisposed: boolean = false

Disposal state flag.

`Protected`_isReady

_isReady: boolean = true

Ready state flag.

`Protected`_ready

_ready: Promise<void> = ...

Ready promise that resolves immediately.

`Protected`_runningChanged

_runningChanged: Signal<BaseSessionManager, IModel[]> = ...

Signal emitted when running sessions change.

`Abstract` `Readonly`managerType

managerType: SessionManagerType

Type identifier for this session manager.

serverSettings

serverSettings: ISettings

Jupyter server connection settings

Accessors

connectionFailure

get connectionFailure(): ISignal<this, NetworkError>
Signal emitted when session connection fails.

Returns ISignal<this, NetworkError>
Implementation of Session.IManager.connectionFailure
- Defined in webview/services/base/baseSessionManager.ts:168

disposed

get disposed(): ISignal<this, void>
Signal emitted when manager is disposed.

Returns ISignal<this, void>
- Defined in webview/services/base/baseSessionManager.ts:182

isActive

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

Returns boolean
- Defined in webview/services/base/baseSessionManager.ts:189

isDisposed

get isDisposed(): boolean
Whether the manager has been disposed.

Returns boolean
Implementation of Session.IManager.isDisposed
- Defined in webview/services/base/baseSessionManager.ts:175

isReady

get isReady(): boolean
Whether the manager is ready.

Returns boolean
Implementation of Session.IManager.isReady
- Defined in webview/services/base/baseSessionManager.ts:147

ready

get ready(): Promise<void>
Promise that resolves when manager is ready.

Returns Promise<void>
Implementation of Session.IManager.ready
- Defined in webview/services/base/baseSessionManager.ts:154

runningChanged

get runningChanged(): ISignal<this, IModel[]>
Signal emitted when running sessions change.

Returns ISignal<this, IModel[]>
Implementation of Session.IManager.runningChanged
- Defined in webview/services/base/baseSessionManager.ts:161

Methods

connectTo

connectTo(_options: IOptions): ISessionConnection
Connect to an existing session.
Parameters
- _options: IOptions
  Connection options (unused in base implementation)
Returns ISessionConnection
Session connection
Implementation of Session.IManager.connectTo
- Defined in webview/services/base/baseSessionManager.ts:382

dispose

dispose(): void
Dispose of the session manager and all resources.

Returns void
Implementation of Session.IManager.dispose
- Defined in webview/services/base/baseSessionManager.ts:307

findById

findById(id: string): Promise<IModel>
Find a session by ID.
Parameters
- id: string
  Session identifier
Returns Promise<IModel>
Session model if found
Implementation of Session.IManager.findById
- Defined in webview/services/base/baseSessionManager.ts:231

findByPath

findByPath(path: string): Promise<IModel>
Find a session by path.
Parameters
- path: string
  Notebook path
Returns Promise<IModel>
Session model if found
Implementation of Session.IManager.findByPath
- Defined in webview/services/base/baseSessionManager.ts:243

getModel

getModel(id: string): IModel
Get session model by ID.
Parameters
- id: string
  Session identifier
Returns IModel
Session model or undefined
- Defined in webview/services/base/baseSessionManager.ts:255

`Protected`log

log(message: string, ...args: unknown[]): void
Unified logging helper.
Parameters
- message: string
  Log message
- ...args: unknown[]
  Additional arguments
Returns void
- Defined in webview/services/base/baseSessionManager.ts:335

refreshRunning

refreshRunning(): Promise<void>
Refresh the list of running sessions. No-op for custom managers.

Returns Promise<void>
Implementation of Session.IManager.refreshRunning
- Defined in webview/services/base/baseSessionManager.ts:221

requestRunning

requestRunning(): Promise<IModel[]>
Request the list of running sessions from the server.

For custom managers (mock, local, Pyodide), returns the current active session. Remote managers should override this to query the actual Jupyter server.

Returns Promise<IModel[]>
Promise resolving to array of running session models
- Defined in webview/services/base/baseSessionManager.ts:212

running

running(): IterableIterator<IModel>
Iterate over running session models.

Returns IterableIterator<IModel>
Yields
Running session models
Implementation of Session.IManager.running
- Defined in webview/services/base/baseSessionManager.ts:198

shutdown

shutdown(id: string): Promise<void>
Shut down a specific session by ID.
Parameters
- id: string
  Session identifier
Returns Promise<void>
Implementation of Session.IManager.shutdown
- Defined in webview/services/base/baseSessionManager.ts:266

shutdownAll

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

Returns Promise<void>
Implementation of Session.IManager.shutdownAll
- Defined in webview/services/base/baseSessionManager.ts:281

`Abstract`startNew

startNew(
    options: ISessionOptions,
    connectOptions?: Omit<
        Session.ISessionConnection.IOptions,
        "model"
        | "serverSettings",
    >,
): Promise<ISessionConnection>
Start a new session. Must be implemented by subclasses.
Parameters
- options: ISessionOptions
  Session creation options
- OptionalconnectOptions: Omit<Session.ISessionConnection.IOptions, "model" | "serverSettings">
Returns Promise<ISessionConnection>
Promise resolving to the new session connection
Implementation of Session.IManager.startNew
- Defined in webview/services/base/baseSessionManager.ts:368

stopIfNeeded

stopIfNeeded(path: string): Promise<void>
Stop session if needed (for compatibility).
Parameters
- path: string
  Notebook path
Returns Promise<void>
Implementation of Session.IManager.stopIfNeeded
- Defined in webview/services/base/baseSessionManager.ts:296

`Protected`validateSessionId

validateSessionId(id: string): void
Validate that a session with the given ID exists.
Parameters
- id: string
  Session ID to validate
Returns void
Throws
If no active session or ID doesn't match
- Defined in webview/services/base/baseSessionManager.ts:350

Class BaseSessionManagerAbstract

Example

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BaseSessionManager

Properties

Protected_activeSession

Protected_connectionFailure

Protected_disposed

Protected_isDisposed

Protected_isReady

Protected_ready

Protected_runningChanged

Abstract ReadonlymanagerType

serverSettings

Accessors

connectionFailure

Returns ISignal<this, NetworkError>

disposed

Returns ISignal<this, void>

isActive

Returns boolean

isDisposed

Returns boolean

isReady

Returns boolean

ready

Returns Promise<void>

runningChanged

Returns ISignal<this, IModel[]>

Methods

connectTo

Parameters

Returns ISessionConnection

dispose

Returns void

findById

Parameters

Returns Promise<IModel>

findByPath

Parameters

Returns Promise<IModel>

getModel

Parameters

Returns IModel

Protectedlog

Parameters

Returns void

refreshRunning

Returns Promise<void>

requestRunning

Returns Promise<IModel[]>

running

Returns IterableIterator<IModel>

Yields

shutdown

Parameters

Returns Promise<void>

shutdownAll

Returns Promise<void>

AbstractstartNew

Parameters

Returns Promise<ISessionConnection>

stopIfNeeded

Parameters

Returns Promise<void>

ProtectedvalidateSessionId

Parameters

Returns void

Throws

Settings

On This Page

Class BaseSessionManager`Abstract`

`Protected`_activeSession

`Protected`_connectionFailure

`Protected`_disposed

`Protected`_isDisposed

`Protected`_isReady

`Protected`_ready

`Protected`_runningChanged

`Abstract` `Readonly`managerType

`Protected`log

`Abstract`startNew

`Protected`validateSessionId