Class Socket

Hierarchy

EventEmitter
- Socket

Index

Constructors

constructor

Properties

Constructors

constructor

new Socket(remote: Address | NetSocket): Socket

- Defined in network/socket.ts:14
Parameters
- remote: Address | NetSocket
Returns Socket

Properties

client

client: NetSocket

remoteAddr

remoteAddr: Address

Static defaultMaxListeners

defaultMaxListeners: number

Static Protected logger

logger: Logger

Methods

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:909
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

addPacketHandler

addPacketHandler(handler: PacketHandler | IPacketHandler): void

- Defined in network/socket.ts:56
Parameters
- handler: PacketHandler | IPacketHandler
Returns void

bindNetSocket

bindNetSocket(netSock: NetSocket): void

- Defined in network/socket.ts:35
Parameters
- netSock: NetSocket
Returns void

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:919
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:920
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:917
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:921
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:918
Parameters
- event: string | symbol
Returns Function[]

on

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

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:910
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:911
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 /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:912
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 /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:913
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:915
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:914
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

removePacketHandler

removePacketHandler(handler: PacketHandler): void

- Defined in network/socket.ts:65
Parameters
- handler: PacketHandler
Returns void

send

send(packet: Packet<any> | IPacketOptions<any> | string): Promise<Packet<any> | null>

- Defined in network/socket.ts:88
Parameters
- packet: Packet<any> | IPacketOptions<any> | string
Returns Promise<Packet<any> | null>

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:916
Parameters
- n: number
Returns this

wait

wait(filter: IPacketFilter | PacketFilter): Promise<Packet<any>>

- Defined in network/socket.ts:70
Parameters
- filter: IPacketFilter | PacketFilter
Returns Promise<Packet<any>>

Static fromNetSocket

fromNetSocket(netSock: NetSocket): Socket

- Defined in network/socket.ts:105
Parameters
- netSock: NetSocket
Returns Socket

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in /mnt/c/Users/ibrah/Desktop/node-kaptan/node_modules/@types/node/index.d.ts:906
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc