Class PacketBuffer

A wrapper class for providing read/write methods on top of a Buffer.

Hierarchy

PacketBuffer

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new PacketBuffer(size?: number): PacketBuffer

- Defined in net/src/packet-buffer.ts:34
Creates a new PacketBuffer and initalizes the wrapped buffer to the given size.

Parameters
- Default value size: number = DEFAULT_SIZE
  
  The size of the buffer.
Returns PacketBuffer

Properties

Private _length

_length: number

bufferIndex

bufferIndex: number

The current index of the buffer.

data

data: Buffer

The wrapped buffer.

Accessors

length

get length(): number

- Defined in net/src/packet-buffer.ts:23
The length of the buffer.

Returns number

remaining

get remaining(): number

- Defined in net/src/packet-buffer.ts:30
The number of bytes between the end of the buffer and the current index.

Returns number

Methods

readBoolean

readBoolean(): boolean

- Defined in net/src/packet-buffer.ts:164
Reads a single byte from the buffer, returns true if the byte is 1 and false otherwise.

Returns boolean

readByte

readByte(): number

- Defined in net/src/packet-buffer.ts:126
Reads a 1 byte integer from the buffer.

Returns number

readByteArray

readByteArray(): number[]

- Defined in net/src/packet-buffer.ts:202
Reads 2 bytes to get the length, then reads length bytes from the buffer.

Returns number[]

readFloat

readFloat(): number

- Defined in net/src/packet-buffer.ts:183
Reads a 4 byte floating point number from the buffer.

Returns number

readInt32

readInt32(): number

- Defined in net/src/packet-buffer.ts:50
Reads a 4 byte integer from the buffer.

Returns number

readShort

readShort(): number

- Defined in net/src/packet-buffer.ts:88
Reads a 2 byte integer from the buffer.

Returns number

readString

readString(): string

- Defined in net/src/packet-buffer.ts:229
Reads 2 bytes to get the length, reads length bytes from the buffer, then converts the result to a utf8 string.

Returns string

readStringUTF32

readStringUTF32(): string

- Defined in net/src/packet-buffer.ts:250
The same as readString(), but reads 4 bytes for the length.

Returns string

readUInt32

readUInt32(): number

- Defined in net/src/packet-buffer.ts:69
Reads a 4 byte unsigned integer from the buffer.

Returns number

readUnsignedByte

readUnsignedByte(): number

- Defined in net/src/packet-buffer.ts:145
Reads a 1 byte unsigned integer from the buffer.

Returns number

readUnsignedShort

readUnsignedShort(): number

- Defined in net/src/packet-buffer.ts:107
Reads a 2 byte unsigned integer from the buffer.

Returns number

reset

reset(): void

- Defined in net/src/packet-buffer.ts:282
Resets the bufferIndex to 0 and allocates a fresh buffer of length DEFAULT_SIZE to the underlying buffer.

Returns void

resizeBuffer

resizeBuffer(newSize: number): void

- Defined in net/src/packet-buffer.ts:272
Changes the size of the buffer without affecting the contents.

Parameters
- newSize: number
  
  The new size of the buffer.
Returns void

writeBoolean

writeBoolean(value: boolean): void

- Defined in net/src/packet-buffer.ts:172
Writes a single byte to the buffer. Writes 1 if the value is true and 0 otherwise.

Parameters
- value: boolean
  
  The value to write.
Returns void

writeByte

writeByte(value: number): void

- Defined in net/src/packet-buffer.ts:135
Writes a 1 byte integer to the buffer.

Parameters
- value: number
  
  The value to write.
Returns void

writeByteArray

writeByteArray(value: number[]): void

- Defined in net/src/packet-buffer.ts:214
Writes the length of the array as a 2 byte integer, then writes length bytes to the buffer.

Parameters
- value: number[]
  
  The value to write.
Returns void

writeFloat

writeFloat(value: number): void

- Defined in net/src/packet-buffer.ts:192
Writes a 4 byte floating point value to the buffer.

Parameters
- value: number
  
  The value to write.
Returns void

writeInt32

writeInt32(value: number): void

- Defined in net/src/packet-buffer.ts:59
Writes a 4 byte integer to the buffer.

Parameters
- value: number
  
  The value to write.
Returns void

writeShort

writeShort(value: number): void

- Defined in net/src/packet-buffer.ts:97
Writes a 2 byte integer to the buffer.

Parameters
- value: number
  
  The value to write.
Returns void

writeString

writeString(value: string): void

- Defined in net/src/packet-buffer.ts:238
Writes the length of the string as a 2 byte integer, then writes the string to the buffer.

Parameters
- value: string
  
  The value to write.
Returns void

writeStringUTF32

writeStringUTF32(value: string): void

- Defined in net/src/packet-buffer.ts:259
The same as writeString(), but writes 4 bytes for the length.

Parameters
- value: string
  
  The value to write.
Returns void

writeUInt32

writeUInt32(value: number): void

- Defined in net/src/packet-buffer.ts:78
Writes a 4 byte unsigned integer to the buffer.

Parameters
- value: number
  
  The value to write.
Returns void

writeUnsignedByte

writeUnsignedByte(value: number): void

- Defined in net/src/packet-buffer.ts:154
Writes a 1 byte unsigned integer to the buffer.

Parameters
- value: number
  
  The value to write.
Returns void

writeUnsignedShort

writeUnsignedShort(value: number): void

- Defined in net/src/packet-buffer.ts:116
Writes a 2 byte unsigned integer to the buffer.

Parameters
- value: number
  
  The value to write.
Returns void

Generated using TypeDoc