IPC Namespace

  1. Documentation
  2. Framework
  3. Reference
  4. App
  5. Cluster
  6. Master
  7. IPC

Classes

Logger

constructor

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

Signature

constructor(void) : Object|Logger

Returns

  • Object, Logger
    • A new instance of Logger

log

Log an given worker request with userdefined content.

Signature

log(void) : void


Statistics

constructor

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

Signature

constructor(void) : Object|Statistics

Returns

  • Object, Statistics
    • A new instance of Statistics

notifyMetric

Notification of an worker metric change.

Signature

notifyMetric(Object msg, Mixed options) : void

Parameters

  • msg
    • IPC message object
    • Type: Object
  • options
    • Options/arguments passed to the IPC request
    • Type: Mixed

getMetric

Notification of an worker metric change.

Signature

getMetric(Object msg, Mixed options, Function callback) : void

Parameters

  • msg
    • IPC message object
    • Type: Object
  • options
    • Options/arguments passed to the IPC request
    • Type: Mixed
  • callback
    • Method for responses
    • Type: Function

get

Get all statistics in as object.

Signature

get(Object msg, Mixed options, Function callback) : void

Parameters

  • msg
    • IPC message object
    • Type: Object
  • options
    • Options/arguments passed to the IPC request
    • Type: Mixed
  • callback
    • Method for responses
    • Type: Function

getModuleDeployment

Get deployment information from projects package.json and the greppy version file.

Signature

getModuleDeployment(void) : Object

Returns

  • Object
    • The return value is not further described

getMemoryUsage

Get total cluster memory usage.

Signature

getMemoryUsage(void) : Object

Returns

  • Object
    • The return value is not further described

Worker

constructor

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

Signature

constructor(void) : Object|Worker

Returns

  • Object, Worker
    • A new instance of Worker

annotateContext

Log an given worker request with userdefined content.

Signature

annotateContext(void) : void