Class EndHistoryPacket

End of history transfer marker.

Hierarchy (View Summary)

BoksRXPacket
- EndHistoryPacket

Index

Constructors

Properties

_opcode _rawPayload? rawPayload opcode

Accessors

Methods

encode toPayload fromPayload

Constructors

constructor

new EndHistoryPacket(rawPayload?: Uint8Array<ArrayBufferLike>): EndHistoryPacket
Parameters
- OptionalrawPayload: Uint8Array<ArrayBufferLike>
Returns EndHistoryPacket
Overrides BoksRXPacket.constructor
- Defined in src/protocol/uplink/EndHistoryPacket.ts:10

Properties

`Protected` `Readonly`_opcode

_opcode: BoksOpcode

`Protected` `Optional` `Readonly`_rawPayload

_rawPayload?: Uint8Array<ArrayBufferLike>

`Protected`rawPayload

rawPayload: Uint8Array = ...

`Static` `Readonly`opcode

opcode: LOG_END_HISTORY = BoksOpcode.LOG_END_HISTORY

Accessors

opcode

get opcode(): BoksOpcode
Returns BoksOpcode
Inherited from BoksRXPacket.opcode
- Defined in src/protocol/uplink/_BoksRXPacketBase.ts:18

Methods

encode

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

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

toPayload

toPayload(): Uint8Array<ArrayBufferLike>
For RX packets, toPayload returns the raw payload received.

Returns Uint8Array<ArrayBufferLike>
Inherited from BoksRXPacket.toPayload
- Defined in src/protocol/uplink/_BoksRXPacketBase.ts:25

`Static`fromPayload

fromPayload(payload: Uint8Array): EndHistoryPacket
Static factory method to create an instance from a payload. This MUST be implemented by leaf classes for strict parsing.
Parameters
- payload: Uint8Array
Returns EndHistoryPacket
Overrides BoksRXPacket.fromPayload
- Defined in src/protocol/uplink/EndHistoryPacket.ts:14