1.1.2 • Published 6 years ago

@cuties/cluster v1.1.2

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

cutie-cluster

NPM Version Build Status codecov

Cutie extension for cluster module in Node. It's based on the Async Tree Pattern.

Examples

You can find examples of using this library in the test directory.

Install

npm install @cuties/cluster

Run test

npm test

Run build

npm run build

Usage

const {
  // Needed async objects here from the table below
} = require('@cuties/cluster');

For more information about parameters in the async objects visit docs of Node for cluster module.

cluster

Async ObjectAsync/sync callParameters(default value/description)Representation result
ClusterWithDisconnectEventcluster.on('disconnect', event)cluster, event (Event with definedBody(worker))cluster
ClusterWithExitEventcluster.on('exit', event)cluster, event (Event with definedBody(worker, code, signal))cluster
ClusterWithForkedWorkersfor (let i = 0; i < num; i++) {cluster.fork(env);}cluster, num(number of workers), envcluster
ClusterWithForkEventcluster.on('fork', event)cluster, event (Event with definedBody(worker))cluster
ClusterWithListeningEventcluster.on('listening', event)cluster, event (Event with definedBody(worker, address))cluster
ClusterWithMessageEventcluster.on('message', event)cluster, event (Event with definedBody(worker, message, handle))cluster
ClusterWithOnlineEventcluster.on('online', event)cluster, event (Event with definedBody(worker))cluster
HasWorkersObject.keys(cluster.workers) > 0clusterboolean

worker

Async ObjectAsync/sync callParameters(default value/description)Representation result
DisconnectedWorkerworker.disconnectworkerworker
ForkedWorkercluster.forkcluster, envworker
IsConnectedworker.isConnectedworkerboolean
IsDeadworker.isDeadworkerboolean
IsExitedAfterDisconnectworker.exitedAfterDisconnectworkerboolean
KilledWorkerworker.killworker, signal('SIGTERM')worker
SentMessageworker.sendworker, message[, sendHandle][, callback]message(string)
Workercluster.workerclusterworker
WorkerIdworker.idworkernumber
WorkerProcessworker.processworkerprocess
Workerscluster.workersclusterobject
WorkerWithDisconnectEventworker.on('disconnect', event)worker, event(Event with definedBody())worker
WorkerWithErrorEventworker.on('error', event)worker, event(Event with definedBody(error))worker
WorkerWithExitEventworker.on('exit', event)worker, event(Event with definedBody(code, signal))worker
WorkerWithListeningEventworker.on('listening', event)worker, event(Event with definedBody(address))worker
WorkerWithMessageEventworker.on('message', event)worker, event(Event with definedBody(msg))worker
WorkerWithOnlineEventworker.on('online', event)worker, event (Event with definedBody())worker

common

Async ObjectAsync/sync callParameters(default value/description)Representation result
IsMastercluster.isMasterclusterboolean
IsWorkercluster.isWorkerclusterboolean
SchedulingPolicycluster.schedulingPolicyclusternumber
Settingscluster.settingsclusterobject
SetupMasterclustercluster, settingsprocess