Class BasicChannel

A very basic AbstractChannel implementation which takes a function for retrieving the WriteBuffer as constructor argument.

Hierarchy

AbstractChannel
- BasicChannel

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new BasicChannel(writeBufferProvider: (() => WriteBuffer)): BasicChannel

Overrides AbstractChannel.constructor
- Defined in packages/core/src/common/message-rpc/channel.ts:110
Parameters
- writeBufferProvider: (() => WriteBuffer)
  - - (): WriteBuffer
    - Returns WriteBuffer
Returns BasicChannel

Properties

onCloseEmitter

onCloseEmitter: Emitter<ChannelCloseEvent> = ...

onErrorEmitter

onErrorEmitter: Emitter<unknown> = ...

onMessageEmitter

onMessageEmitter: Emitter<MessageProvider> = ...

Protected toDispose

toDispose: DisposableCollection = ...

Protected writeBufferProvider

writeBufferProvider: (() => WriteBuffer)

Type declaration

- (): WriteBuffer
- Returns WriteBuffer

Accessors

onClose

get onClose(): Event<ChannelCloseEvent>

Inherited from AbstractChannel.onClose
- Defined in packages/core/src/common/message-rpc/channel.ts:77
Returns Event<ChannelCloseEvent>

onError

get onError(): Event<unknown>

Inherited from AbstractChannel.onError
- Defined in packages/core/src/common/message-rpc/channel.ts:82
Returns Event<unknown>

onMessage

get onMessage(): Event<MessageProvider>

Inherited from AbstractChannel.onMessage
- Defined in packages/core/src/common/message-rpc/channel.ts:87
Returns Event<MessageProvider>

Methods

close

close(): void

Inherited from AbstractChannel.close
- Defined in packages/core/src/common/message-rpc/channel.ts:97
Close this channel. No onClose event should be sent

Returns void

getWriteBuffer

getWriteBuffer(): WriteBuffer

Overrides AbstractChannel.getWriteBuffer
- Defined in packages/core/src/common/message-rpc/channel.ts:114
Obtain a WriteBuffer to write a message to the channel.

Returns WriteBuffer