Variables
Const isMaster
isMaster: boolean
Const isWorker
isWorker: boolean
Const settings
Const worker
Const workers
workers: object
Type declaration
-
[index: string]: Worker | undefined
Functions
addListener
- addListener(event: string, listener: function): Cluster
- addListener(event: "disconnect", listener: function): Cluster
- addListener(event: "exit", listener: function): Cluster
- addListener(event: "fork", listener: function): Cluster
- addListener(event: "listening", listener: function): Cluster
- addListener(event: "message", listener: function): Cluster
- addListener(event: "online", listener: function): Cluster
- addListener(event: "setup", listener: function): Cluster
-
Parameters
-
event: string
-
listener: function
-
Parameters
-
event: "disconnect"
-
listener: function
-
Parameters
-
event: "exit"
-
listener: function
-
- (worker: Worker, code: number, signal: string): void
-
Parameters
-
-
code: number
-
signal: string
Returns void
-
Parameters
-
event: "fork"
-
listener: function
-
Parameters
-
event: "listening"
-
listener: function
-
Parameters
-
event: "message"
-
listener: function
-
Parameters
-
event: "online"
-
listener: function
-
Parameters
-
event: "setup"
-
listener: function
disconnect
- disconnect(callback?: undefined | function): void
-
Parameters
-
Optional callback: undefined | function
Returns void
emit
- emit(event: string | symbol, ...args: any[]): boolean
- emit(event: "disconnect", worker: Worker): boolean
- emit(event: "exit", worker: Worker, code: number, signal: string): boolean
- emit(event: "fork", worker: Worker): boolean
- emit(event: "listening", worker: Worker, address: Address): boolean
- emit(event: "message", worker: Worker, message: any, handle: Socket | Server): boolean
- emit(event: "online", worker: Worker): boolean
- emit(event: "setup", settings: ClusterSettings): boolean
-
Parameters
-
event: string | symbol
-
Rest ...args: any[]
Returns boolean
-
Parameters
Returns boolean
-
Parameters
-
event: "exit"
-
-
code: number
-
signal: string
Returns boolean
-
Parameters
Returns boolean
-
Parameters
Returns boolean
-
Parameters
-
event: "message"
-
-
message: any
-
Returns boolean
-
Parameters
Returns boolean
-
Parameters
Returns boolean
eventNames
-
Returns string[]
fork
-
Parameters
getMaxListeners
- getMaxListeners(): number
-
Returns number
listenerCount
- listenerCount(type: string): number
-
Parameters
Returns number
listeners
- listeners(event: string): Function[]
-
Parameters
Returns Function[]
on
- on(event: string, listener: function): Cluster
- on(event: "disconnect", listener: function): Cluster
- on(event: "exit", listener: function): Cluster
- on(event: "fork", listener: function): Cluster
- on(event: "listening", listener: function): Cluster
- on(event: "message", listener: function): Cluster
- on(event: "online", listener: function): Cluster
- on(event: "setup", listener: function): Cluster
-
Parameters
-
event: string
-
listener: function
-
Parameters
-
event: "disconnect"
-
listener: function
-
Parameters
-
event: "exit"
-
listener: function
-
- (worker: Worker, code: number, signal: string): void
-
Parameters
-
-
code: number
-
signal: string
Returns void
-
Parameters
-
event: "fork"
-
listener: function
-
Parameters
-
event: "listening"
-
listener: function
-
Parameters
-
event: "message"
-
listener: function
-
Parameters
-
event: "online"
-
listener: function
-
Parameters
-
event: "setup"
-
listener: function
once
- once(event: string, listener: function): Cluster
- once(event: "disconnect", listener: function): Cluster
- once(event: "exit", listener: function): Cluster
- once(event: "fork", listener: function): Cluster
- once(event: "listening", listener: function): Cluster
- once(event: "message", listener: function): Cluster
- once(event: "online", listener: function): Cluster
- once(event: "setup", listener: function): Cluster
-
Parameters
-
event: string
-
listener: function
-
Parameters
-
event: "disconnect"
-
listener: function
-
Parameters
-
event: "exit"
-
listener: function
-
- (worker: Worker, code: number, signal: string): void
-
Parameters
-
-
code: number
-
signal: string
Returns void
-
Parameters
-
event: "fork"
-
listener: function
-
Parameters
-
event: "listening"
-
listener: function
-
Parameters
-
event: "message"
-
listener: function
-
Parameters
-
event: "online"
-
listener: function
-
Parameters
-
event: "setup"
-
listener: function
prependListener
- prependListener(event: string, listener: function): Cluster
- prependListener(event: "disconnect", listener: function): Cluster
- prependListener(event: "exit", listener: function): Cluster
- prependListener(event: "fork", listener: function): Cluster
- prependListener(event: "listening", listener: function): Cluster
- prependListener(event: "message", listener: function): Cluster
- prependListener(event: "online", listener: function): Cluster
- prependListener(event: "setup", listener: function): Cluster
-
Parameters
-
event: string
-
listener: function
-
Parameters
-
event: "disconnect"
-
listener: function
-
Parameters
-
event: "exit"
-
listener: function
-
- (worker: Worker, code: number, signal: string): void
-
Parameters
-
-
code: number
-
signal: string
Returns void
-
Parameters
-
event: "fork"
-
listener: function
-
Parameters
-
event: "listening"
-
listener: function
-
Parameters
-
event: "message"
-
listener: function
-
Parameters
-
event: "online"
-
listener: function
-
Parameters
-
event: "setup"
-
listener: function
prependOnceListener
- prependOnceListener(event: string, listener: function): Cluster
- prependOnceListener(event: "disconnect", listener: function): Cluster
- prependOnceListener(event: "exit", listener: function): Cluster
- prependOnceListener(event: "fork", listener: function): Cluster
- prependOnceListener(event: "listening", listener: function): Cluster
- prependOnceListener(event: "message", listener: function): Cluster
- prependOnceListener(event: "online", listener: function): Cluster
- prependOnceListener(event: "setup", listener: function): Cluster
-
Parameters
-
event: string
-
listener: function
-
Parameters
-
event: "disconnect"
-
listener: function
-
Parameters
-
event: "exit"
-
listener: function
-
- (worker: Worker, code: number, signal: string): void
-
Parameters
-
-
code: number
-
signal: string
Returns void
-
Parameters
-
event: "fork"
-
listener: function
-
Parameters
-
event: "listening"
-
listener: function
-
Parameters
-
event: "message"
-
listener: function
-
Parameters
-
event: "online"
-
listener: function
-
Parameters
-
event: "setup"
-
listener: function
removeAllListeners
- removeAllListeners(event?: undefined | string): Cluster
-
Parameters
-
Optional event: undefined | string
removeListener
- removeListener(event: string, listener: function): Cluster
-
Parameters
-
event: string
-
listener: function
setMaxListeners
- setMaxListeners(n: number): Cluster
-
Parameters
setupMaster
-
Parameters
Returns void
events.EventEmitter