Class Sequence

Hierarchy

Sequence

Index

Enumerations

Interfaces

SequenceOptions

Type aliases

NextSequenceOptions

Constructors

constructor

Properties

Methods

Type aliases

Static NextSequenceOptions

NextSequenceOptions: Omit<SequenceOptions, "sequence">

Constructors

constructor

new Sequence(props: SequenceOptions): Sequence

- Defined in src/transport/protocol/Sequence.ts:6
Parameters
- props: SequenceOptions
Returns Sequence

Properties

Readonly origin

origin: Origin

Readonly sequence

sequence: number

Readonly type

type: Type

Static MAX_SEQUENCE_NUMBER

MAX_SEQUENCE_NUMBER: number = 1073741823

Methods

nextSequence

nextSequence(opts: NextSequenceOptions): Sequence

- Defined in src/transport/protocol/Sequence.ts:15
retrieves the next sequence number

Parameters
- opts: NextSequenceOptions
Returns Sequence

toBuffer

toBuffer(): Buffer

- Defined in src/transport/protocol/Sequence.ts:24
returns a copy of the word as buffer

Returns Buffer

Static from

from(buffer: Buffer): Sequence

- Defined in src/transport/protocol/Sequence.ts:34
parses a sequence from a buffer

Parameters
- buffer: Buffer
Returns Sequence

Static getOrigin

getOrigin(uint: number): SERVER | CLIENT

- Defined in src/transport/protocol/Sequence.ts:63
Parameters
- uint: number
Returns SERVER | CLIENT

Static getSequenceNumber

getSequenceNumber(uint: number): number

- Defined in src/transport/protocol/Sequence.ts:79
Parameters
- uint: number
Returns number

Static getType

getType(uint: number): REQUEST | RESPONSE

- Defined in src/transport/protocol/Sequence.ts:71
Parameters
- uint: number
Returns REQUEST | RESPONSE

Static setOrigin

setOrigin(sequence: Buffer, origin: Origin): void

- Defined in src/transport/protocol/Sequence.ts:43
Parameters
- sequence: Buffer
- origin: Origin
Returns void

Static setType

setType(sequence: Buffer, type: Type): void

- Defined in src/transport/protocol/Sequence.ts:53
Parameters
- sequence: Buffer
- type: Type
Returns void

Generated using TypeDoc