Class BatchingChannel

Wraps and underlying channel to send/receive multiple messages in one go:

multiple messages to be sent from one stack get sent in bulk at process.nextTick.
each incoming message is handled in a separate process.nextTick.

Implements

Channel

Index

Constructors

Properties

messagesToSend onClose onError onMessageEmitter underlyingChannel

Accessors

Methods

close commitSingleMessage getWriteBuffer handleMessages sendAccumulated

Constructors

constructor

new BatchingChannel(underlyingChannel: Channel): BatchingChannel
Parameters
- underlyingChannel: Channel
Returns BatchingChannel
- Defined in packages/plugin-ext/src/common/rpc-protocol.ts:194

Properties

`Protected`messagesToSend

messagesToSend: Uint8Array[] = []

`Readonly`onClose

onClose: Event<ChannelCloseEvent> = ...

The remote side has closed the channel

`Readonly`onError

onError: Event<unknown> = ...

An error has occurred while writing to or reading from the channel

`Protected`onMessageEmitter

onMessageEmitter: Emitter<MessageProvider> = ...

`Protected`underlyingChannel

underlyingChannel: Channel

Accessors

onMessage

get onMessage(): Event<MessageProvider>
A message has arrived and can be read by listeners using a MessageProvider.

Returns Event<MessageProvider>
Implementation of Channel.onMessage
- Defined in packages/plugin-ext/src/common/rpc-protocol.ts:199

Methods

close

close(): void
Close this channel. No onClose event should be sent

Returns void
Implementation of Channel.close
- Defined in packages/plugin-ext/src/common/rpc-protocol.ts:206

`Protected`commitSingleMessage

commitSingleMessage(msg: Uint8Array): void
Parameters
- msg: Uint8Array
Returns void
- Defined in packages/plugin-ext/src/common/rpc-protocol.ts:218

getWriteBuffer

getWriteBuffer(): WriteBuffer
Obtain a WriteBuffer to write a message to the channel.

Returns WriteBuffer
Implementation of Channel.getWriteBuffer
- Defined in packages/plugin-ext/src/common/rpc-protocol.ts:212

`Protected`handleMessages

handleMessages(buffer: ReadBuffer): void
Parameters
- buffer: ReadBuffer
Returns void
- Defined in packages/plugin-ext/src/common/rpc-protocol.ts:245

`Protected`sendAccumulated

sendAccumulated(): void
Returns void
- Defined in packages/plugin-ext/src/common/rpc-protocol.ts:230