Class AuthPacket`Abstract`

Base for packets requiring authentication (Config Key)

Hierarchy (View Summary)

BoksPacket
- AuthPacket

Index

Constructors

Properties

configKey rawPayload

Accessors

Methods

encode toPayload extractConfigKey fromPayload

Constructors

constructor

new AuthPacket(configKey: string): AuthPacket
Parameters
- configKey: string
Returns AuthPacket
Overrides BoksPacket.constructor
- Defined in src/protocol/downlink/_AuthPacketBase.ts:11

Properties

`Readonly`configKey

configKey: string

`Protected`rawPayload

rawPayload: Uint8Array = ...

Accessors

`Abstract`opcode

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

Methods

encode

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

Returns Uint8Array
Inherited from BoksPacket.encode
- Defined in src/protocol/_BoksPacketBase.ts:35

`Abstract`toPayload

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

`Static`extractConfigKey

extractConfigKey(payload: Uint8Array): string
Helper to quickly extract the config key string from a standard AuthPacket payload.
Parameters
- payload: Uint8Array
Returns string
- Defined in src/protocol/downlink/_AuthPacketBase.ts:24

`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
Inherited from BoksPacket.fromPayload
- Defined in src/protocol/_BoksPacketBase.ts:28