Class OperationErrorPacket

Notification of a code operation error.

Hierarchy (View Summary)

BoksRXPacket
- OperationErrorPacket

Index

Constructors

Properties

_opcode _rawPayload? errorCode rawPayload opcode

Accessors

Methods

encode toPayload fromPayload

Constructors

constructor

new OperationErrorPacket(
errorCode?: number,
rawPayload?: Uint8Array<ArrayBufferLike>,
): OperationErrorPacket
Parameters
- errorCode: number = 0
- OptionalrawPayload: Uint8Array<ArrayBufferLike>
Returns OperationErrorPacket
Overrides BoksRXPacket.constructor
- Defined in src/protocol/uplink/OperationErrorPacket.ts:10

Properties

`Protected` `Readonly`_opcode

_opcode: BoksOpcode

`Protected` `Optional` `Readonly`_rawPayload

_rawPayload?: Uint8Array<ArrayBufferLike>

`Readonly`errorCode

errorCode: number = 0

`Protected`rawPayload

rawPayload: Uint8Array = ...

`Static` `Readonly`opcode

opcode: CODE_OPERATION_ERROR = BoksOpcode.CODE_OPERATION_ERROR

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): OperationErrorPacket
Static factory method to create an instance from a payload. This MUST be implemented by leaf classes for strict parsing.
Parameters
- payload: Uint8Array
Returns OperationErrorPacket
Overrides BoksRXPacket.fromPayload
- Defined in src/protocol/uplink/OperationErrorPacket.ts:17