Cluster Namespace

  1. Documentation
  2. Framework
  3. Reference
  4. App
  5. Cluster

Sub-namespaces


Master


Worker

Classes

Master

constructor

With the help of this method you can create a new instance of Master.

Signature

constructor(Object options) : Object

Parameters

  • options
    • Options object
    • Type: Object

Returns

  • Object
    • Options object

configure

Setup the master.

Signature

configure(Object options, Function callback) : void

Parameters

  • options
    • Options object
    • Type: Object
  • callback
    • Function to call on finish
    • Type: Function

getIPC

Get the master IPC implementation object.

Signature

getIPC(void) : Object

Returns

  • Object
    • The IPC Object

getCluster

Get the master cluster object.

Signature

getCluster(void) : Object

Returns

  • Object
    • The Cluster Object

getCliArgs

Get the master commandline interface arguments.

Signature

getCliArgs(void) : Object

Returns

  • Object
    • All passed commandline arguments

Worker

constructor

With the help of this method you can create a new instance of Worker.

Signature

constructor(Object options, Function callback) : Object, Function

Parameters

  • options
    • Options object
    • Type: Object
  • callback
    • Function to call on finish
    • Type: Function

Returns

  • Object
    • Options object
  • Function
    • Function to call on finish

configure

Setup the worker.

Signature

configure(Object app, Object server, Function callback) : void

Parameters

  • app
    • Express application object
    • Type: Object
  • server
    • HTTP(S) server object
    • Type: Object
  • callback
    • Function to call on finish
    • Type: Function

getIPC

Get the worker IPC implementation object.

Signature

getIPC(void) : Object

Returns

  • Object
    • The IPC Object