Cluster | typescript

Interface Cluster

Hierarchy

EventEmitter
- Cluster

Index

Properties

Methods

Properties

Worker

Worker: Worker

isMaster

isMaster: boolean

isWorker

isWorker: boolean

settings

settings: ClusterSettings

worker

worker: Worker

workers

workers: object

Type declaration

[index: string]: Worker

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string, listener: Function): this
addListener(event: "disconnect", listener: function): this
addListener(event: "exit", listener: function): this
addListener(event: "fork", listener: function): this
addListener(event: "listening", listener: function): this
addListener(event: "message", listener: function): this
addListener(event: "online", listener: function): this
addListener(event: "setup", listener: function): this

Overrides EventEmitter.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:929
events.EventEmitter
1. disconnect
2. exit
3. fork
4. listening
5. message
6. online
7. setup
Parameters
- event: string
- listener: Function
Returns this
Overrides EventEmitter.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:930
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:931
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:932
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:933
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:934
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:935
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:936
Parameters
- event: "setup"
- listener: function
  - - (settings: any): void
    - Parameters
      - settings: any
      Returns void
Returns this

disconnect

disconnect(callback?: Function): void

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

Overrides EventEmitter.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:938
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Overrides EventEmitter.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:939
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns boolean
Overrides EventEmitter.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:940
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns boolean
Overrides EventEmitter.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:941
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns boolean
Overrides EventEmitter.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:942
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns boolean
Overrides EventEmitter.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:943
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
Overrides EventEmitter.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:944
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns boolean
Overrides EventEmitter.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:945
Parameters
- event: "setup"
- listener: function
  - - (settings: any): void
    - Parameters
      - settings: any
      Returns void
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:627
Returns (string | symbol)[]

fork

fork(env?: any): Worker

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

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

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

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:628
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:625
Parameters
- event: string | symbol
Returns Function[]

on

on(event: string, listener: Function): this
on(event: "disconnect", listener: function): this
on(event: "exit", listener: function): this
on(event: "fork", listener: function): this
on(event: "listening", listener: function): this
on(event: "message", listener: function): this
on(event: "online", listener: function): this
on(event: "setup", listener: function): this

Overrides EventEmitter.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:947
Parameters
- event: string
- listener: Function
Returns this
Overrides EventEmitter.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:948
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:949
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:950
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:951
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:952
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:953
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:954
Parameters
- event: "setup"
- listener: function
  - - (settings: any): void
    - Parameters
      - settings: any
      Returns void
Returns this

once

once(event: string, listener: Function): this
once(event: "disconnect", listener: function): this
once(event: "exit", listener: function): this
once(event: "fork", listener: function): this
once(event: "listening", listener: function): this
once(event: "message", listener: function): this
once(event: "online", listener: function): this
once(event: "setup", listener: function): this

Overrides EventEmitter.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:956
Parameters
- event: string
- listener: Function
Returns this
Overrides EventEmitter.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:957
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:958
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:959
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:960
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:961
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:962
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:963
Parameters
- event: "setup"
- listener: function
  - - (settings: any): void
    - Parameters
      - settings: any
      Returns void
Returns this

prependListener

prependListener(event: string, listener: Function): this
prependListener(event: "disconnect", listener: function): this
prependListener(event: "exit", listener: function): this
prependListener(event: "fork", listener: function): this
prependListener(event: "listening", listener: function): this
prependListener(event: "message", listener: function): this
prependListener(event: "online", listener: function): this
prependListener(event: "setup", listener: function): this

Overrides EventEmitter.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:965
Parameters
- event: string
- listener: Function
Returns this
Overrides EventEmitter.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:966
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:967
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:968
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:969
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:970
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:971
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:972
Parameters
- event: "setup"
- listener: function
  - - (settings: any): void
    - Parameters
      - settings: any
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string, listener: Function): this
prependOnceListener(event: "disconnect", listener: function): this
prependOnceListener(event: "exit", listener: function): this
prependOnceListener(event: "fork", listener: function): this
prependOnceListener(event: "listening", listener: function): this
prependOnceListener(event: "message", listener: function): this
prependOnceListener(event: "online", listener: function): this
prependOnceListener(event: "setup", listener: function): this

Overrides EventEmitter.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:974
Parameters
- event: string
- listener: Function
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:975
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:976
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:977
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:978
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:979
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:980
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:981
Parameters
- event: "setup"
- listener: function
  - - (settings: any): void
    - Parameters
      - settings: any
      Returns void
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:622
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:621
Parameters
- event: string | symbol
- listener: Function
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:623
Parameters
- n: number
Returns this

setupMaster

setupMaster(settings?: ClusterSetupMasterSettings): void

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

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:613
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc

Hierarchy

Index

Properties

Methods

Properties

Worker

isMaster

isWorker

settings

worker

workers

Type declaration

[index: string]: Worker

Static defaultMaxListeners

Methods

addListener

Parameters

event: string

listener: Function

Returns this

Parameters

event: "disconnect"

listener: function

Parameters

worker: Worker

Returns void

Returns this

Parameters

event: "exit"

listener: function

Parameters

worker: Worker

code: number

signal: string

Returns void

Returns this

Parameters

event: "fork"

listener: function

Parameters

worker: Worker

Returns void

Returns this

Parameters

event: "listening"

listener: function

Parameters

worker: Worker

address: Address

Returns void

Returns this

Parameters

event: "message"

listener: function

Parameters

worker: Worker

message: any

handle: Socket | Server

Returns void

Returns this

Parameters

event: "online"

listener: function

Parameters

worker: Worker

Returns void

Returns this

Parameters

event: "setup"

listener: function

Parameters

settings: any

Returns void

Returns this

disconnect

Parameters

Optional callback: Function

Returns void

emit

Parameters