Class BoksPacket`Abstract`

Base class for all Boks packets

Index

Constructors

Properties

Accessors

Methods

encode toPayload fromPayload

Constructors

constructor

new BoksPacket(): BoksPacket
Returns BoksPacket

Properties

`Protected`rawPayload

rawPayload: Uint8Array = ...

Accessors

`Abstract`opcode

get opcode(): BoksOpcode
Returns BoksOpcode
- Defined in src/protocol/_BoksPacketBase.ts:21

Methods

encode

encode(): Uint8Array
Encodes the full packet: [Opcode, Length, ...Payload, Checksum]

Returns Uint8Array
- Defined in src/protocol/_BoksPacketBase.ts:35

`Abstract`toPayload

toPayload(): Uint8Array
Returns Uint8Array
- Defined in src/protocol/_BoksPacketBase.ts:22

`Static`fromPayload

fromPayload(_payload: Uint8Array): BoksPacket
Static factory method to create an instance from a payload. This MUST be implemented by leaf classes for strict parsing.
Parameters
- _payload: Uint8Array
Returns BoksPacket
- Defined in src/protocol/_BoksPacketBase.ts:28