"cluster" | typescript

Module "cluster"

Index

Classes

Worker

Interfaces

Variables

Functions

Variables

isMaster

isMaster: boolean

isWorker

isWorker: boolean

settings

settings: ClusterSettings

worker

worker: Worker

workers

workers: object

Type declaration

[index: string]: Worker

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

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1007
events.EventEmitter
1. disconnect
2. exit
3. fork
4. listening
5. message
6. online
7. setup
Parameters
- event: string
- listener: Function
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1008
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1009
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1010
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1011
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1012
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1013
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1014
Parameters
- event: "setup"
- listener: function
  - - (settings: any): void
    - Parameters
      - settings: any
      Returns void
Returns Cluster

disconnect

disconnect(callback?: Function): void

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:985
Parameters
- Optional callback: Function
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean
emit(event: "disconnect", listener: function): boolean
emit(event: "exit", listener: function): boolean
emit(event: "fork", listener: function): boolean
emit(event: "listening", listener: function): boolean
emit(event: "message", listener: function): boolean
emit(event: "online", listener: function): boolean
emit(event: "setup", listener: function): boolean

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1016
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1017
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns boolean
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1018
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns boolean
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1019
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns boolean
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1020
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns boolean
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1021
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns boolean
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1022
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns boolean
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1023
Parameters
- event: "setup"
- listener: function
  - - (settings: any): void
    - Parameters
      - settings: any
      Returns void
Returns boolean

eventNames

eventNames(): string[]

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1068
Returns string[]

fork

fork(env?: any): Worker

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:986
Parameters
- Optional env: any
Returns Worker

getMaxListeners

getMaxListeners(): number

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1046
Returns number

listenerCount

listenerCount(type: string): number

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1048
Parameters
- type: string
Returns number

listeners

listeners(event: string): Function[]

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1047
Parameters
- event: string
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

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1025
Parameters
- event: string
- listener: Function
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1026
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1027
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1028
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1029
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1030
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1031
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1032
Parameters
- event: "setup"
- listener: function
  - - (settings: any): void
    - Parameters
      - settings: any
      Returns void
Returns Cluster

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

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1034
Parameters
- event: string
- listener: Function
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1035
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1036
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1037
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1038
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1039
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1040
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1041
Parameters
- event: "setup"
- listener: function
  - - (settings: any): void
    - Parameters
      - settings: any
      Returns void
Returns Cluster

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

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1050
Parameters
- event: string
- listener: Function
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1051
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1052
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1053
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1054
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1055
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1056
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1057
Parameters
- event: "setup"
- listener: function
  - - (settings: any): void
    - Parameters
      - settings: any
      Returns void
Returns Cluster

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

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1059
Parameters
- event: string
- listener: Function
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1060
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1061
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1062
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1063
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1064
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1065
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1066
Parameters
- event: "setup"
- listener: function
  - - (settings: any): void
    - Parameters
      - settings: any
      Returns void
Returns Cluster

removeAllListeners

removeAllListeners(event?: string): Cluster

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1044
Parameters
- Optional event: string
Returns Cluster

removeListener

removeListener(event: string, listener: Function): Cluster

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1043
Parameters
- event: string
- listener: Function
Returns Cluster

setMaxListeners

setMaxListeners(n: number): Cluster

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:1045
Parameters
- n: number
Returns Cluster

setupMaster

setupMaster(settings?: ClusterSetupMasterSettings): void

- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:991
Parameters
- Optional settings: ClusterSetupMasterSettings
Returns void

Generated using TypeDoc

Index

Classes

Interfaces

Variables

Functions

Variables

isMaster

isWorker

settings

worker

workers

Type declaration

[index: string]: Worker

Functions

addListener

Parameters

event: string

listener: Function

Returns Cluster

Parameters

event: "disconnect"

listener: function

Parameters

worker: Worker

Returns void

Returns Cluster

Parameters

event: "exit"

listener: function

Parameters

worker: Worker

code: number

signal: string

Returns void

Returns Cluster

Parameters

event: "fork"

listener: function

Parameters

worker: Worker

Returns void

Returns Cluster

Parameters

event: "listening"

listener: function

Parameters

worker: Worker

address: Address

Returns void

Returns Cluster

Parameters

event: "message"

listener: function

Parameters

worker: Worker

message: any

handle: Socket | Server

Returns void

Returns Cluster

Parameters

event: "online"

listener: function

Parameters

worker: Worker

Returns void

Returns Cluster

Parameters

event: "setup"

listener: function

Parameters

settings: any

Returns void

Returns Cluster

disconnect

Parameters

Optional callback: Function

Returns void

emit

Parameters

event: string | symbol