Class PacketSequencer

A class for generating packet sequences.

Hierarchy

PacketSequencer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

new PacketSequencer(start: SequenceStart): PacketSequencer
Constructs a new PacketSequencer with the provided SequenceStart.
Parameters
- start: SequenceStart
  
  the sequence start
Returns PacketSequencer
- Defined in src/packet/packet-sequencer.ts:13

Properties

`Private` counter

counter: number = 0

`Private` start

start: SequenceStart

Accessors

sequenceStart

set sequenceStart(start: SequenceStart): void
Sets the sequence start, also known as the "starting counter ID".

Remarks
This does not reset the sequence counter.
Parameters
- start: SequenceStart
  
  the new sequence start
Returns void
- Defined in src/packet/packet-sequencer.ts:39

Methods

nextSequence

nextSequence(): number
Returns the next sequence value, updating the sequence counter in the process.

Remarks
This is not a monotonic operation. The sequence counter increases from 0 to 9 before looping back around to 0.

Returns
the next sequence value

Returns number
- Defined in src/packet/packet-sequencer.ts:25

Generated using TypeDoc