Class PluginChannel

A channel communicating with a counterpart in a plugin host.

Hierarchy

PluginChannel

Implements

DebugChannel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PluginChannel(id: string, connection: ConnectionExt | ConnectionMain): PluginChannel

- Defined in packages/plugin-ext/src/common/connection.ts:28
Parameters
- id: string
- connection: ConnectionExt | ConnectionMain
Returns PluginChannel

Properties

Private closedEmitter

closedEmitter: Emitter<void> = ...

Protected Readonly connection

connection: ConnectionExt | ConnectionMain

Private errorEmitter

errorEmitter: Emitter<unknown> = ...

Protected Readonly id

id: string

Private messageEmitter

messageEmitter: Emitter<string> = ...

Methods

close

close(): void

Implementation of DebugChannel.close
- Defined in packages/plugin-ext/src/common/connection.ts:61
Returns void

fireClosed

fireClosed(): void

- Defined in packages/plugin-ext/src/common/connection.ts:44
Returns void

fireError

fireError(error: unknown): void

- Defined in packages/plugin-ext/src/common/connection.ts:40
Parameters
- error: unknown
Returns void

fireMessageReceived

fireMessageReceived(msg: string): void

- Defined in packages/plugin-ext/src/common/connection.ts:36
Parameters
- msg: string
Returns void

onClose

onClose(cb: ((code: number, reason: string) => void)): void

Implementation of DebugChannel.onClose
- Defined in packages/plugin-ext/src/common/connection.ts:57
Parameters
- cb: ((code: number, reason: string) => void)
  - - (code: number, reason: string): void
    - Parameters
      - code: number
      - reason: string
      Returns void
Returns void

onError

onError(cb: ((reason: any) => void)): void

Implementation of DebugChannel.onError
- Defined in packages/plugin-ext/src/common/connection.ts:53
Parameters
- cb: ((reason: any) => void)
  - - (reason: any): void
    - Parameters
      - reason: any
      Returns void
Returns void

onMessage

onMessage(cb: ((message: string) => void)): void

Implementation of DebugChannel.onMessage
- Defined in packages/plugin-ext/src/common/connection.ts:48
Parameters
- cb: ((message: string) => void)
  - - (message: string): void
    - Parameters
      - message: string
      Returns void
Returns void

send

send(content: string): void

Implementation of DebugChannel.send
- Defined in packages/plugin-ext/src/common/connection.ts:32
Parameters
- content: string
Returns void