InitSequenceStart
extends SimpleSequenceStart
in package
Defines a sequence start value for initialization packets, incorporating two sequence numbers.
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructs an InitSequenceStart with specified initial values.
- fromInitValues() : InitSequenceStart
- Creates an InitSequenceStart from two given sequence values, calculating the main sequence start value.
- generate() : InitSequenceStart
- Generates a new InitSequenceStart with randomly determined sequence numbers.
- getSeq1() : int
- Retrieves the first supplementary sequence number.
- getSeq2() : int
- Retrieves the second supplementary sequence number.
- getValue() : int
- A value sent by the server to update the client's sequence start, also known as the 'starting counter ID'.
- zero() : SequenceStart
- Returns an instance of SequenceStart with a value of 0.
Properties
$seq1
private
int
$seq1
$seq2
private
int
$seq2
$value
private
int
$value
Methods
__construct()
Constructs an InitSequenceStart with specified initial values.
public
__construct(int $value, int $seq1, int $seq2) : mixed
Parameters
- $value : int
-
The main sequence start value.
- $seq1 : int
-
The first supplementary sequence number.
- $seq2 : int
-
The second supplementary sequence number.
fromInitValues()
Creates an InitSequenceStart from two given sequence values, calculating the main sequence start value.
public
static fromInitValues(int $seq1, int $seq2) : InitSequenceStart
Parameters
- $seq1 : int
-
The first sequence number.
- $seq2 : int
-
The second sequence number.
Return values
InitSequenceStart —Returns a new instance configured with the calculated sequence start value.
generate()
Generates a new InitSequenceStart with randomly determined sequence numbers.
public
static generate() : InitSequenceStart
Return values
InitSequenceStart —Returns a new instance with random sequence numbers.
getSeq1()
Retrieves the first supplementary sequence number.
public
getSeq1() : int
Return values
int —The first supplementary sequence number.
getSeq2()
Retrieves the second supplementary sequence number.
public
getSeq2() : int
Return values
int —The second supplementary sequence number.
getValue()
A value sent by the server to update the client's sequence start, also known as the 'starting counter ID'.
public
abstract getValue() : int
Return values
int —Returns the sequence start value.
zero()
Returns an instance of SequenceStart with a value of 0.
public
static zero() : SequenceStart
Return values
SequenceStart —An instance of SequenceStart.