Class MessageBase

Base type for any message sent or received on a Channel.

Subclasses MUST set a unique MSGTYPE (< 0xf000; values >= 0xf000 are system-reserved) and implement pack / unpack. The class must also be constructable with no arguments (used to validate registration and to instantiate on receive).

Hierarchy (View Summary)

MessageBase
- StreamDataMessage

Index

Constructors

Properties

Methods

Constructors

constructor

new MessageBase(): MessageBase

Returns MessageBase

Properties

`Static`MSGTYPE

MSGTYPE: number | null = null

Unique identifier for this message class within a Channel. Must be < 0xf000.

Methods

pack

pack(): Uint8Array<ArrayBufferLike>
Returns Uint8Array<ArrayBufferLike>
binary representation of the message body.
- Defined in packages/core/src/transport/channel.js:100

unpack

unpack(_raw: Uint8Array<ArrayBufferLike>): void
Populate this message from its binary body.
Parameters
- _raw: Uint8Array<ArrayBufferLike>
Returns void
- Defined in packages/core/src/transport/channel.js:108