Class NetworkBridgeService

Bridges network communication between webviews and the extension. Encapsulates all HTTP and WebSocket handling logic shared by providers.

Hierarchy (View Summary)

BaseService
- NetworkBridgeService

Index

Constructors

constructor

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

Returns NetworkBridgeService
Overrides BaseService.constructor
- Defined in src/services/bridges/networkBridge.ts:33

Properties

`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:73

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:133

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:108

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:81

`Protected`onDispose

onDispose(): Promise<void>
Cleans up network service resources.

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

`Protected`onInitialize

onInitialize(): Promise<void>
Initializes the network bridge service. No-op for now as NotebookNetworkService doesn't require initialization.

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

registerNetworkHandlers

registerNetworkHandlers(
    router: {
        registerHandler: (
            type: string,
            handler: (
                message: ExtensionMessage,
                context: DocumentContext,
            ) => Promise<void>,
        ) => void;
    },
): void
Registers network-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.
  - registerHandler: (
        type: string,
        handler: (
            message: ExtensionMessage,
            context: DocumentContext,
        ) => Promise<void>,
    ) => void
    Method to register a message type handler.
Returns void
- Defined in src/services/bridges/networkBridge.ts:64

Class NetworkBridgeService

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns NetworkBridgeService

Properties

`Protected` `Readonly`logger

`Protected` `Readonly`name

Accessors

state

Returns ServiceState

Methods

`Protected`assertReady

Returns void

Throws

dispose

Returns Promise<void>

initialize

Returns Promise<void>

`Protected`onDispose

Returns Promise<void>

`Protected`onInitialize

Returns Promise<void>

registerNetworkHandlers

Parameters

registerHandler: (
    type: string,
    handler: (
        message: ExtensionMessage,
        context: DocumentContext,
    ) => Promise<void>,
) => void

Returns void

Settings

On This Page

Class NetworkBridgeService

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns NetworkBridgeService

Properties

Protected Readonlylogger

Protected Readonlyname

Accessors

state

Returns ServiceState

Methods

ProtectedassertReady

Returns void

Throws

dispose

Returns Promise<void>

initialize

Returns Promise<void>

ProtectedonDispose

Returns Promise<void>

ProtectedonInitialize

Returns Promise<void>

registerNetworkHandlers

Parameters

registerHandler: ( type: string, handler: ( message: ExtensionMessage, context: DocumentContext, ) => Promise<void>,) => void

Returns void

Settings

On This Page

`Protected` `Readonly`logger

`Protected` `Readonly`name

`Protected`assertReady

`Protected`onDispose

`Protected`onInitialize

registerHandler: (
type: string,
handler: (
message: ExtensionMessage,
context: DocumentContext,
) => Promise<void>,
) => void