Class Network

Hierarchy

Service
- Network

Implements

IService

Index

Constructors

constructor

Properties

Constructors

constructor

new Network(kaptan: Kaptan, options?: object): Network

Overrides Service.constructor
- Defined in network/network.ts:15
Parameters
- kaptan: Kaptan
- Default value options: object = {}
Returns Network

Properties

Protected clientLogger

clientLogger: Logger

Protected kaptan

kaptan: Kaptan

Protected logger

logger: Logger

Protected options

options: object

Type declaration

[key: string]: any

Protected server

server: NetServer

Protected serverLogger

serverLogger: Logger

Static defaultMaxListeners

defaultMaxListeners: number

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/network.ts:47
Parameters
- handler: PacketHandler | IPacketHandler
Returns void

connect

connect(addr: string, port: number): Socket

- Defined in network/network.ts:64
Parameters
- addr: string
- port: number
Returns Socket

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

emitIntercepted

emitIntercepted(event: string | symbol, ...args: any[]): Promise<any>

Inherited from Events.emitIntercepted
- Defined in util/events.ts:19
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns Promise<any>

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

Private onConnection

onConnection(netSock: NetSocket): void

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

onIntercepted

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

Inherited from Events.onIntercepted
- Defined in util/events.ts:13
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

onceIntercepted

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

Inherited from Events.onceIntercepted
- Defined in util/events.ts:6
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/network.ts:59
Parameters
- handler: PacketHandler
Returns void

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

start

start(): Promise<void>

Implementation of IService.start

Overrides Service.start
- Defined in network/network.ts:33
Returns Promise<void>

stop

stop(): Promise<void>

Implementation of IService.stop

Overrides Service.stop
- Defined in network/network.ts:39
Returns Promise<void>

Static copy

copy(name: string, service: ServiceConstructor): ServiceConstructor

Inherited from Service.copy
- Defined in service/service.ts:31
Parameters
- name: string
- service: ServiceConstructor
Returns ServiceConstructor

Static create

create(name: string, handlers: IService): ServiceConstructor

Inherited from Service.create
- Defined in service/service.ts:37
Parameters
- name: string
- handlers: IService
Returns ServiceConstructor

Static getServiceName

getServiceName(service: ServiceConstructor | Service | string): string

Inherited from Service.getServiceName
- Defined in service/service.ts:52
Parameters
- service: ServiceConstructor | Service | string
Returns string

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

Static runIntercepted

runIntercepted(eventList: Function[], ...args: any[]): Promise<Object>

Inherited from Events.runIntercepted
- Defined in util/events.ts:32
Parameters
- eventList: Function[]
- Rest ...args: any[]
Returns Promise<Object>

Static spawn

spawn(service: ServiceConstructor, container: ServiceContainer, options?: object): Service

Inherited from Service.spawn
- Defined in service/service.ts:46
Parameters
- service: ServiceConstructor
- container: ServiceContainer
- Default value options: object = {}
Returns Service

Generated using TypeDoc