Class PacketIO

A utility class which implements the RotMG messaging protocol on top of a Socket.

Hierarchy

EventEmitter
- PacketIO

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new PacketIO(socket?: Socket, rc4Config?: RC4Config): PacketIO

- Defined in net/src/packetio.ts:59
Creates a new PacketIO on top of the given socket.

Parameters
- Optional socket: Socket
  
  The socket to implement the protocol on top of.
- Default value rc4Config: RC4Config = DEFAULT_RC4
Returns PacketIO

Properties

Private _lastIncomingPacket

_lastIncomingPacket: Packet

Private _lastOutgoingPacket

_lastOutgoingPacket: Packet

Private eventHandlers

eventHandlers: Map<string, function>

Private outgoingBuffer

outgoingBuffer: PacketBuffer

Private packetBuffer

packetBuffer: PacketBuffer

Private receiveRC4

receiveRC4: RC4

Private sendRC4

sendRC4: RC4

socket

socket: Socket

The socket this packet interface is attached to.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

lastIncomingPacket

get lastIncomingPacket(): Packet

- Defined in net/src/packetio.ts:40
The last packet which was received.

Returns Packet

lastOutgoingPacket

get lastOutgoingPacket(): Packet

- Defined in net/src/packetio.ts:47
The last packet which was sent.

Returns Packet

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1051
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

attach

attach(socket: Socket): void

- Defined in net/src/packetio.ts:87
Attaches this Packet IO to the socket.

Parameters
- socket: Socket
  
  The socket to attach to.
Returns void

Private checkBuffer

checkBuffer(): void

- Defined in net/src/packetio.ts:209
Returns void

Private constructPacket

constructPacket(): Packet

- Defined in net/src/packetio.ts:177
Returns Packet

detach

detach(): void

- Defined in net/src/packetio.ts:103
Detaches this Packet IO from its Socket.

Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1063
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

Private emitError

emitError(error: Error): void

- Defined in net/src/packetio.ts:228
Parameters
- error: Error
Returns void

emitPacket

emitPacket(packet: Packet): void

- Defined in net/src/packetio.ts:148
Emits a packet from this PacketIO instance. This will only emit the packet to the clients subscribed to this particular PacketIO.

Parameters
- packet: Packet
  
  The packet to emit.
Returns void

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1064
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1060
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1065
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1061
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1057
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1052
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Private onConnect

onConnect(): void

- Defined in net/src/packetio.ts:158
Returns void

Private onData

onData(data: Buffer): void

- Defined in net/src/packetio.ts:164
Parameters
- data: Buffer
Returns void

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1053
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1054
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1055
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1062
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1058
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1056
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Private resetBuffer

resetBuffer(): void

- Defined in net/src/packetio.ts:223
Returns void

send

send(packet: Packet): void

- Defined in net/src/packetio.ts:116
Sends a packet.

Parameters
- packet: Packet
  
  The packet to send.
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1059
Parameters
- n: number
Returns this

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in C:/Users/Tom/Documents/dev/rotmg/n2/node_modules/@types/node/index.d.ts:1048
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc