Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

multi-child-process

1.1.4 • Public • Published

multi-child-process

NPM version Downloads

NPM

A multi-child-process module for Node.js job.

Usage

Installation

You can install using npm.

npm install multi-child-process

Run tests

npm test

Examples:

The process pool needs to be initialized before using child processes. The default size of the process pool is the number of cpus. The parameter passed must be a positive integer, but capped at 10. If you do need a larger process pool size, you can modify the source code.

var pool = require('multi-child-process');
var procPool = new pool.initPool(3);//default: the number of cpus

Now init child process, these arguments must be passed:

pool.initChildProc(workPath, jobname, jobArgObject, cb);
  • workPath(string) : workModule of absolute path, like __dirname+'/logic.js'
  • jobname(string) : like 'module.exports.jobname=jobname' in the workPath
  • jobArgObject(Object): arguments that job function need, like {key:value}
  • cb(function) : callback function
//./main.js
pool.initChildProc(__dirname+'/logic.js', jobname, jobArgObject, function(err,ret){
//err: error of child process or job 
//ret: result of job function callback 
});
 
//./logic.js
function jobname(jobArgObject,callback){}
module.exports.jobname=jobname;

If child processes pool has been inited, this pool.isInited() will be true.

pool.isInited();

If all child processes are all available, this message event 'isAllAvail' will be emitted.

procPool.on('isAllAvail',cb);

If all child processes are all available, this pool.isAllAvail() will be true.

pool.isAllAvail();

Return the number of occupied processes.

pool.actiProcNum();

Return the size of child process pool.

pool.totalProcNum();

After finishing child process jobs, if you are sure that process pool is no longer needed, pool.closePool(cb) can be used. But it is suggested that you are listening to the message event 'isAllAvail' before using pool.closePool(cb). Argument cb is callback function.

pool.closePool(cb);

Install

npm i multi-child-process

DownloadsWeekly Downloads

1

Version

1.1.4

License

ISC

Unpacked Size

13.7 kB

Total Files

9

Last publish

Collaborators

  • avatar