Class PluginMessageWriter

Support for writing string message through RPC protocol.

Hierarchy

AbstractMessageWriter
- PluginMessageWriter

Implements

MessageWriter

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new PluginMessageWriter(id: string, proxy: ConnectionMain | ConnectionExt): PluginMessageWriter

Overrides AbstractMessageWriter.constructor
- Defined in packages/plugin-ext/src/common/plugin-message-writer.ts:52
Parameters
- id: string
- proxy: ConnectionMain | ConnectionExt
Returns PluginMessageWriter

Properties

Protected closeEmitter

closeEmitter: Emitter<void> = ...

Protected errorEmitter

errorEmitter: Emitter<[Error, undefined | Message, undefined | number]> = ...

Protected Readonly id

id: string

Protected Readonly proxy

proxy: ConnectionMain | ConnectionExt

Accessors

onClose

get onClose(): Event<void>

- Defined in packages/plugin-ext/src/common/plugin-message-writer.ts:33
Returns Event<void>

onError

get onError(): Event<[Error, undefined | Message, undefined | number]>

- Defined in packages/plugin-ext/src/common/plugin-message-writer.ts:27
Returns Event<[Error, undefined | Message, undefined | number]>

Methods

asError

asError(error: any): Error

Inherited from AbstractMessageWriter.asError
- Defined in packages/plugin-ext/src/common/plugin-message-writer.ts:40
Parameters
- error: any
Returns Error

dispose

dispose(): void

Implementation of MessageWriter.dispose

Inherited from AbstractMessageWriter.dispose
- Defined in packages/plugin-ext/src/common/plugin-message-writer.ts:23
Returns void

fireClose

fireClose(): void

Inherited from AbstractMessageWriter.fireClose
- Defined in packages/plugin-ext/src/common/plugin-message-writer.ts:36
Returns void

fireError

fireError(error: Error, message: undefined | Message, count: undefined | number): void

Inherited from AbstractMessageWriter.fireError
- Defined in packages/plugin-ext/src/common/plugin-message-writer.ts:30
Parameters
- error: Error
- message: undefined | Message
- count: undefined | number
Returns void

write

write(message: string): void
write(message: Message): void

Implementation of MessageWriter.write
- Defined in packages/plugin-ext/src/common/plugin-message-writer.ts:59
Parameters
- message: string
Returns void
Implementation of MessageWriter.write
- Defined in packages/plugin-ext/src/common/plugin-message-writer.ts:60
Parameters
- message: Message
Returns void