Class HPacket

Hierarchy

HPacket

Index

Constructors

Accessors

identifier identifierDirection readIndex

Methods

append appendBoolean appendByte appendBytes appendDouble appendFloat appendInt appendLong appendLongString appendShort appendString appendUShort canComplete canReadString canSendToClient canSendToServer completePacket constructFromString equals fixLength getBytesLength headerId insert insertBoolean insertByte insertBytes insertDouble insertFloat insertInt insertLong insertShort insertString insertUShort isCorrupted isEOF isPacketComplete isReplaced length overrideEditedField read readBoolean readByte readBytes readDouble readFloat readInteger readLong readLongString readShort readString readUShort replaceAllIntegers replaceAllStrings replaceAllSubstrings replaceBoolean replaceByte replaceBytes replaceDouble replaceFirstString replaceFirstSubstring replaceFloat replaceInt replaceLong replaceShort replaceString replaceUShort replaceXStrings replaceXSubstrings resetReadIndex stringify toBytes toExpression toString

Constructors

constructor

new HPacket(bytes): HPacket
Parameters
- bytes: Uint8Array
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:5
new HPacket(packet): HPacket
Parameters
- packet: HPacket
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:6
new HPacket(packet): HPacket
Parameters
- packet: string | String
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:7
new HPacket(headerId): HPacket
Parameters
- headerId: number
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:8
new HPacket(headerId, bytes): HPacket
Parameters
- headerId: number
- bytes: Uint8Array
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:9
new HPacket(identifier, direction): HPacket
Parameters
- identifier: string | String
- direction: HDirection
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:10

Accessors

identifier

get identifier(): string
Get private parameter #identifier

Returns string
- Defined in lib/protocol/hpacket.d.ts:40
set identifier(val): void
Change the private parameter #identifier
Parameters
- val: string
  
  String identifier
Returns void
- Defined in lib/protocol/hpacket.d.ts:31

identifierDirection

get identifierDirection(): HDirection
Get private parameter #identifierDirection

Returns HDirection
- Defined in lib/protocol/hpacket.d.ts:44
set identifierDirection(val): void
Change the private parameter #direction
Parameters
- val: HDirection
  
  HDirection (TOSERVER or TOCLIENT)
Returns void
- Defined in lib/protocol/hpacket.d.ts:36

readIndex

get readIndex(): number
Return the private parameter #readIndex

Returns number
- Defined in lib/protocol/hpacket.d.ts:68
set readIndex(val): void
Change the private parameter #readIndex
Parameters
- val: number
  
  Read index
Returns void
- Defined in lib/protocol/hpacket.d.ts:73

Methods

append

append(structure, ...objects): HPacket
Append objects to packet in given structure
b: byte / UInt8
i: int / Int32
s: short / Int16
u: ushort / UInt16
l: long / Int64
d: double / Float64
f: float / Float32
B: boolean
S: string
Parameters
- structure: string
  
  String of objects structure
- Rest ...objects: any[]
  
  Array of objects to append
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:368

appendBoolean

appendBoolean(b): HPacket
Append boolean at end of packet
Parameters
- b: boolean
  
  boolean value to append
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:326

appendByte

appendByte(b): HPacket
Append byte/UInt8 at end of packet
Parameters
- b: number
  
  byte/UInt8 value to append
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:314

appendBytes

appendBytes(bytes): HPacket
Append byte[]/UInt8Array at end of packet
Parameters
- bytes: Uint8Array
  
  byte[]/UInt8Array value to append
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:320

appendDouble

appendDouble(d): HPacket
Append double/Float64 at end of packet
Parameters
- d: number
  
  double/Float64 value to append
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:302

appendFloat

appendFloat(f): HPacket
Append float/Float32 at end of packet
Parameters
- f: number
  
  float/Float32 value to append
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:308

appendInt

appendInt(i): HPacket
Append int/Int32 at end of packet
Parameters
- i: number
  
  int/Int32 value to append
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:290

appendLong

appendLong(l): HPacket
Append long/Int64 at end of packet
Parameters
- l: number
  
  long/Int64 value to append
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:296

appendLongString

appendLongString(s, charset?): HPacket
Append long string at end of packet
Parameters
- s: string | String
  
  long string value to append
- Optional charset: BufferEncoding
  
  Optional encoding charset (default: "latin1")
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:352

appendShort

appendShort(s): HPacket
Append short/Int16 at end of packet
Parameters
- s: number
  
  short/Int16 value to append
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:338

appendString

appendString(s, charset?): HPacket
Append string at end of packet
Parameters
- s: string | String
  
  string value to append
- Optional charset: BufferEncoding
  
  Optional encoding charset (default: "latin1")
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:345

appendUShort

appendUShort(ushort): HPacket
Append unsigned short/UInt16 at end of packet
Parameters
- ushort: number
  
  unsigned short/UInt16 value to append
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:332

canComplete

canComplete(packetInfoManager): boolean
Parameters
- packetInfoManager: PacketInfoManager
Returns boolean
- Defined in lib/protocol/hpacket.d.ts:56

canReadString

canReadString(index): boolean
Check if string can be read at index
Parameters
- index: number
Returns boolean
- Defined in lib/protocol/hpacket.d.ts:283

canSendToClient

canSendToClient(): boolean
Checks whether packet can be send to client

Returns boolean
- Defined in lib/protocol/hpacket.d.ts:50

canSendToServer

canSendToServer(): boolean
Checks whether packet can be send to server

Returns boolean
- Defined in lib/protocol/hpacket.d.ts:54

completePacket

completePacket(packetInfoManager): void
Parameters
- packetInfoManager: PacketInfoManager
Returns void
- Defined in lib/protocol/hpacket.d.ts:46

constructFromString

constructFromString(str): void
Read packet arguments from a string
Parameters
- str: string | String
  
  packet string
Returns void
- Defined in lib/protocol/hpacket.d.ts:492

equals

equals(packet): boolean
Compare other hPacket to hPacket (compares private parameter #packetInBytes and private parameter #isEdited)
Parameters
- packet: HPacket
  
  hPacket to compare with current hPacket
Returns boolean
- Defined in lib/protocol/hpacket.d.ts:498

fixLength

fixLength(): void
Fix packet length bytes

Returns void
- Defined in lib/protocol/hpacket.d.ts:469

getBytesLength

getBytesLength(): number
Get entire length of packet

Returns number
- Defined in lib/protocol/hpacket.d.ts:93

headerId

headerId(): number
Read the headerId from packet

Returns number
- Defined in lib/protocol/hpacket.d.ts:85

insert

insert(index, structure, ...objects): HPacket
Insert objects to packet in given structure at index
b: byte / UInt8
i: int / Int32
s: short / Int16
u: ushort / UInt16
l: long / Int64
d: double / Float64
f: float / Float32
B: boolean
S: string
Parameters
- index: number
  
  Index to insert at
- structure: string
  
  String of objects structure
- Rest ...objects: any[]
  
  Array of objects to insert
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:458

insertBoolean

insertBoolean(index, b): HPacket
Insert boolean at index
Parameters
- index: number
  
  Index to insert at
- b: boolean
  
  boolean value to insert
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:419

insertByte

insertByte(index, b): HPacket
Insert byte/UInt8 at index
Parameters
- index: number
  
  Index to insert at
- b: number
  
  byte/UInt8 value to insert
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:405

insertBytes

insertBytes(index, bytes): HPacket
Insert byte[]/UInt8Array at index
Parameters
- index: number
  
  Index to insert at
- bytes: Uint8Array
  
  byte[]/UInt8Array value to insert
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:412

insertDouble

insertDouble(index, d): HPacket
Insert double/Float64 at index
Parameters
- index: number
  
  Index to insert at
- d: number
  
  double/Float64 value to insert
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:391

insertFloat

insertFloat(index, f): HPacket
Insert float/Float32 at index
Parameters
- index: number
  
  Index to insert at
- f: number
  
  float/Float32 value to insert
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:398

insertInt

insertInt(index, i): HPacket
Insert int/Int32 at index
Parameters
- index: number
  
  Index to insert at
- i: number
  
  int/Int32 value to insert
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:377

insertLong

insertLong(index, l): HPacket
Insert long/Int64 at index
Parameters
- index: number
  
  Index to insert at
- l: number
  
  long/Int64 value to insert
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:384

insertShort

insertShort(index, s): HPacket
Insert short/Int16 at index
Parameters
- index: number
  
  Index to insert at
- s: number
  
  short/Int16 value to insert
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:433

insertString

insertString(index, s, charset?): HPacket
Insert string at index
Parameters
- index: number
  
  Index to insert at
- s: string | String
  
  string value to insert
- Optional charset: BufferEncoding
  
  Optional encoding charset (default: "latin1")
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:441

insertUShort

insertUShort(index, ushort): HPacket
Insert unsigned short/UInt16 at index
Parameters
- index: number
  
  Index to insert at
- ushort: number
  
  unsigned short/UInt16 value to insert
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:426

isCorrupted

isCorrupted(): boolean
Check if packet is corrupted

Returns boolean
- Defined in lib/protocol/hpacket.d.ts:81

isEOF

isEOF(): number
isEOF

Returns number
- Defined in lib/protocol/hpacket.d.ts:26

isPacketComplete

isPacketComplete(): boolean
Checks whether packet is complete

Returns boolean
- Defined in lib/protocol/hpacket.d.ts:60

isReplaced

isReplaced(): boolean
Check if packet has been edited

Returns boolean
- Defined in lib/protocol/hpacket.d.ts:464

length

length(): number
Read the length from packet

Returns number
- Defined in lib/protocol/hpacket.d.ts:89

overrideEditedField

overrideEditedField(edited): void
Change private parameter #isEdited to value
Parameters
- edited: boolean
  
  boolean value to set
Returns void
- Defined in lib/protocol/hpacket.d.ts:475

read

read(structure): any[]
Read from packet in given structure:
b: byte / UInt8
i: int / Int32
s: short / Int16
u: ushort / UInt16
l: long / Int64
d: double / Float64
f: float / Float32
B: boolean
S: string
Parameters
- structure: string
  
  Structure string to read
Returns any[]
- Defined in lib/protocol/hpacket.d.ts:166

readBoolean

readBoolean(index?): boolean
Read boolean from packet
Parameters
- Optional index: number
  
  Optional read index
Returns boolean
- Defined in lib/protocol/hpacket.d.ts:152

readByte

readByte(index?): number
Read byte/UInt8 from packet
Parameters
- Optional index: number
  
  Optional read index
Returns number
- Defined in lib/protocol/hpacket.d.ts:99

readBytes

readBytes(length, index?): Uint8Array
Read byte[]/UInt8Array from packet
Parameters
- length: number
  
  Length to read
- Optional index: number
  
  Optional read index
Returns Uint8Array
- Defined in lib/protocol/hpacket.d.ts:130

readDouble

readDouble(index?): number
Read double/Float64 from packet
Parameters
- Optional index: number
  
  Optional read index
Returns number
- Defined in lib/protocol/hpacket.d.ts:124

readFloat

readFloat(index?): number
Read float/Float32 from packet
Parameters
- Optional index: number
  
  Optional read index
Returns number
- Defined in lib/protocol/hpacket.d.ts:119

readInteger

readInteger(index?): number
Read integer/Int32 from packet
Parameters
- Optional index: number
  
  Optional read index
Returns number
- Defined in lib/protocol/hpacket.d.ts:114

readLong

readLong(index?): bigint
Read long/Int64 from packet
Parameters
- Optional index: number
  
  Optional read index
Returns bigint
- Defined in lib/protocol/hpacket.d.ts:135

readLongString

readLongString(index?, charset?): string
Read long string from packet
Parameters
- Optional index: number
  
  Optional read index
- Optional charset: BufferEncoding
  
  Optional encoding charset (default: "latin1")
Returns string
- Defined in lib/protocol/hpacket.d.ts:147

readShort

readShort(index?): number
Read short/Int16 from packet
Parameters
- Optional index: number
  
  Optional read index
Returns number
- Defined in lib/protocol/hpacket.d.ts:104

readString

readString(index?, charset?): string
Read string from packet
Parameters
- Optional index: number
  
  Optional read index
- Optional charset: BufferEncoding
  
  Optional encoding charset (default: "latin1")
Returns string
- Defined in lib/protocol/hpacket.d.ts:141

readUShort

readUShort(index?): number
Read unsigned short/UInt16 from packet
Parameters
- Optional index: number
  
  Optional read index
Returns number
- Defined in lib/protocol/hpacket.d.ts:109

replaceAllIntegers

replaceAllIntegers(val, replacement): any
Replace all found integers of val by value
Parameters
- val: number
  
  int/Int32 value to be replaced
- replacement: number
  
  int/Int32 value to place
Returns any
- Defined in lib/protocol/hpacket.d.ts:277

replaceAllStrings

replaceAllStrings(oldS, newS): HPacket
Replace all found strings by value
Parameters
- oldS: string | String
  
  string value to be replaced
- newS: string | String
  
  string value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:248

replaceAllSubstrings

replaceAllSubstrings(oldS, newS): HPacket
Replace all found substrings by value
Parameters
- oldS: string | String
  
  string value to be replaced
- newS: string | String
  
  string value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:270

replaceBoolean

replaceBoolean(index, b): HPacket
Replace boolean by value
Parameters
- index: number
  
  Replacing index
- b: boolean
  
  Boolean value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:173

replaceByte

replaceByte(index, b): HPacket
Replace byte/UInt8 by value
Parameters
- index: number
  
  Replacing index
- b: number
  
  byte/UInt8 value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:203

replaceBytes

replaceBytes(index, bytes): HPacket
Replace byte[]/UInt8Array by value
Parameters
- index: number
  
  Replacing index
- bytes: Uint8Array
  
  byte[]/UInt8Array value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:209

replaceDouble

replaceDouble(index, d): HPacket
Replace double/Float64 by value
Parameters
- index: number
  
  Replacing index
- d: number
  
  double/Float64 value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:191

replaceFirstString

replaceFirstString(oldS, newS): HPacket
Replace first found string by value
Parameters
- oldS: string | String
  
  string value to be replaced
- newS: string | String
  
  string value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:234

replaceFirstSubstring

replaceFirstSubstring(oldS, newS): HPacket
Replace first found substring by value
Parameters
- oldS: string | String
  
  string value to be replaced
- newS: string | String
  
  string value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:255

replaceFloat

replaceFloat(index, f): HPacket
Replace float/Float32 by value
Parameters
- index: number
  
  Replacing index
- f: number
  
  float/Float32 value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:197

replaceInt

replaceInt(index, i): HPacket
Replace int/Int32 by value
Parameters
- index: number
  
  Replacing index
- i: number
  
  int/Int32 value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:179

replaceLong

replaceLong(index, l): HPacket
Replace long/Int64 by value
Parameters
- index: number
  
  Replacing index
- l: number
  
  long/Int64 value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:185

replaceShort

replaceShort(index, s): HPacket
Replace short/Int16 by value
Parameters
- index: number
  
  Replacing index
- s: number
  
  short/Int16 value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:221

replaceString

replaceString(index, s, charset?): HPacket
Replace string by value
Parameters
- index: number
  
  Replacing index
- s: string | String
  
  string value to place
- Optional charset: BufferEncoding
  
  Optional encoding charset (default: "latin1")
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:228

replaceUShort

replaceUShort(index, ushort): HPacket
Replace unsigned short/UInt16 by value
Parameters
- index: number
  
  Replacing index
- ushort: number
  
  unsigned short/UInt16 value to place
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:215

replaceXStrings

replaceXStrings(oldS, newS, amount): HPacket
Replace x found strings by value
Parameters
- oldS: string | String
  
  string value to be replaced
- newS: string | String
  
  string value to place
- amount: number
  
  amount of strings to be replaced (-1 = all)
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:241

replaceXSubstrings

replaceXSubstrings(oldS, newS, amount): HPacket
Replace x found substrings by value
Parameters
- oldS: string | String
  
  string value to be replaced
- newS: string | String
  
  string value to place
- amount: number
  
  amount of strings to be replaced (-1 = all)
Returns HPacket
- Defined in lib/protocol/hpacket.d.ts:263

resetReadIndex

resetReadIndex(): void
Reset the private parameter #readIndex to it's starting value (6)

Returns void
- Defined in lib/protocol/hpacket.d.ts:77

stringify

stringify(): string
Convert the packet to a string

Returns string
- Defined in lib/protocol/hpacket.d.ts:486

toBytes

toBytes(): Uint8Array
Return the private parameter #packetInBytes

Returns Uint8Array
- Defined in lib/protocol/hpacket.d.ts:64

toExpression

toExpression(structure): string
Get the expression of the packet with given structure
Parameters
- structure: string
  
  Structure of packet
Returns string
- Defined in lib/protocol/hpacket.d.ts:481

toString

toString(): string
Get the packet as a string

Returns string
- Defined in lib/protocol/hpacket.d.ts:15

Class HPacket

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

bytes: Uint8Array

Returns HPacket

Parameters

packet: HPacket

Returns HPacket

Parameters

packet: string | String

Returns HPacket

Parameters

headerId: number

Returns HPacket

Parameters

headerId: number

bytes: Uint8Array

Returns HPacket

Parameters

identifier: string | String

direction: HDirection

Returns HPacket

Accessors

identifier

Returns string

Parameters

val: string

Returns void

identifierDirection

Returns HDirection

Parameters

val: HDirection

Returns void

readIndex

Returns number

Parameters

val: number

Returns void

Methods

append

Parameters

structure: string

Rest ...objects: any[]

Returns HPacket

appendBoolean

Parameters

b: boolean

Returns HPacket

appendByte

Parameters

b: number

Returns HPacket

appendBytes

Parameters

bytes: Uint8Array

Returns HPacket

appendDouble

Parameters

d: number

Returns HPacket

appendFloat

Parameters

f: number

Returns HPacket

appendInt

Parameters

i: number

Returns HPacket

appendLong

Parameters

l: number

Returns HPacket

appendLongString

Parameters

`Rest` ...objects: any[]

`Optional` charset: BufferEncoding

`Optional` charset: BufferEncoding

`Rest` ...objects: any[]