Class RuntimeBridgeService

Bridges runtime lifecycle operations between webviews and the extension. Encapsulates runtime selection, termination, and expiration logic shared by providers.

Hierarchy (View Summary)

BaseService
- RuntimeBridgeService

Index

Constructors

constructor

new RuntimeBridgeService(): RuntimeBridgeService
Creates a new RuntimeBridgeService instance.

Returns RuntimeBridgeService
Overrides BaseService.constructor
- Defined in src/services/bridges/runtimeBridge.ts:44

Properties

`Private` `Optional`_kernelSelectionFallback

_kernelSelectionFallback?: KernelSelectionFallback

`Protected` `Readonly`logger

logger: ILogger

Logger instance for this service

`Protected` `Readonly`name

name: string

Service name for logging

Accessors

state

get state(): ServiceState
Gets the current service state.

Returns ServiceState
Inherited from BaseService.state
- Defined in src/services/core/baseService.ts:88

Methods

`Protected`assertReady

assertReady(): void
Asserts that the service is ready for use. Throws an error if the service is not in the Ready state.

Returns void
Throws
Error if service is not ready
Inherited from BaseService.assertReady
- Defined in src/services/core/baseService.ts:148

dispose

dispose(): Promise<void>
Disposes the service and cleans up resources. Ensures disposal only happens once.

Returns Promise<void>
Inherited from BaseService.dispose
- Defined in src/services/core/baseService.ts:123

`Private`handleRuntimeExpiration

handleRuntimeExpiration(
message: ExtensionMessage,
context: DocumentContext,
): Promise<void>
Handles runtime expiration notifications.
Parameters
- message: ExtensionMessage
  Extension message containing runtime info
- context: DocumentContext
  Document context
Returns Promise<void>
- Defined in src/services/bridges/runtimeBridge.ts:221

`Private`handleRuntimeSelection

handleRuntimeSelection(context: DocumentContext): Promise<void>
Handles runtime/kernel selection requests.
Parameters
- context: DocumentContext
  Document context
Returns Promise<void>
- Defined in src/services/bridges/runtimeBridge.ts:116

`Private`handleRuntimeTermination

handleRuntimeTermination(
message: ExtensionMessage,
context: DocumentContext,
): Promise<void>
Handles runtime termination requests.
Parameters
- message: ExtensionMessage
  Extension message containing runtime info
- context: DocumentContext
  Document context
Returns Promise<void>
- Defined in src/services/bridges/runtimeBridge.ts:151

initialize

initialize(): Promise<void>
Initializes the service. Ensures initialization only happens once and tracks state.

Returns Promise<void>
Inherited from BaseService.initialize
- Defined in src/services/core/baseService.ts:96

`Protected`onDispose

onDispose(): Promise<void>
Cleans up runtime bridge resources.

Returns Promise<void>
Overrides BaseService.onDispose
- Defined in src/services/bridges/runtimeBridge.ts:62

`Protected`onInitialize

onInitialize(): Promise<void>
Initializes the runtime bridge service. No-op for now as the service is stateless.

Returns Promise<void>
Overrides BaseService.onInitialize
- Defined in src/services/bridges/runtimeBridge.ts:55

registerRuntimeHandlers

registerRuntimeHandlers(
    router: {
        registerHandler: (
            type: string,
            handler: (
                message: ExtensionMessage,
                context: DocumentContext,
            ) => Promise<void>,
        ) => void;
    },
): void
Registers runtime-related message handlers with the DocumentMessageRouter.
Parameters
- router: {
      registerHandler: (
          type: string,
          handler: (
              message: ExtensionMessage,
              context: DocumentContext,
          ) => Promise<void>,
      ) => void;
  }
  The message router to register handlers with
Returns void
- Defined in src/services/bridges/runtimeBridge.ts:81

setKernelSelectionFallback

setKernelSelectionFallback(fallback: KernelSelectionFallback): void
Sets the fallback handler for kernel selection failures. Only used by notebookProvider for Datalayer runtime selector.
Parameters
- fallback: KernelSelectionFallback
  Callback to invoke when kernel selector fails
Returns void
- Defined in src/services/bridges/runtimeBridge.ts:72

Class RuntimeBridgeService

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns RuntimeBridgeService

Properties

Private Optional_kernelSelectionFallback

Protected Readonlylogger

Protected Readonlyname

Accessors

state

Returns ServiceState

Methods

ProtectedassertReady

Returns void

Throws

dispose

Returns Promise<void>

PrivatehandleRuntimeExpiration

Parameters

Returns Promise<void>

PrivatehandleRuntimeSelection

Parameters

Returns Promise<void>

PrivatehandleRuntimeTermination

Parameters

Returns Promise<void>

initialize

Returns Promise<void>

ProtectedonDispose

Returns Promise<void>

ProtectedonInitialize

Returns Promise<void>

registerRuntimeHandlers

Parameters

Returns void

setKernelSelectionFallback

Parameters

Returns void

Settings

On This Page

`Private` `Optional`_kernelSelectionFallback

`Protected` `Readonly`logger

`Protected` `Readonly`name

`Protected`assertReady

`Private`handleRuntimeExpiration

`Private`handleRuntimeSelection

`Private`handleRuntimeTermination

`Protected`onDispose

`Protected`onInitialize