worker-manager

worker-manager

Have long running tasks that you want to perform without blocking your main process?

Use: worker-manager

The manager with handle all the scaryness of "threading" or using "forked processes".
Just created a worker file that has all your long runing tasks on it.  The manager
will supply a woker object that will handle all thread communications, just use
"worker.on(taskName, taskFunction);" in your worker file to redgestor your tasks.

To use worker-manager:

npm install worker-manager

Documentation:

    var manager = require('worker-manager');

    var man = manager.createManager(workerFilename, workerLimit, keepAlive)

        workerFilename: String{file path to worker file}
        workerLimit:    Number{maximun number of worker}
        keepAlive:      Boolean{keep workers alive when not in uses}

        properties:

            manager.workers:       Number{number of worker}
            manager.activeWorkers: Number{number of worker doing tasks}
            manager.tasks:         Number{number of unfinished tasks}

        methods:

            manager.send(taskName, [...data], [callback])
                arguments:
                    taskName: String{name given to task in worker file}
                    data:     Arguments{arguments supplied to worker task}
                    callback: Function{what gets called when task is completed}
                        args: err, data, mess
                            err:  Error{if worker has error completing task}
                            data: Returns{what the worker task returns}
                            mess: Object{full details of task at hand}

                returns:
                    Number{id assigned to task by manager}

                does:
                    creates a new task and sends it to a worker to be done, calls
                    the callback give on task completetion.

            manager.clear(taskId)
                arguments:
                    taskId: Number{id assigned to task by manager}

                returns:
                    Boolean{true if task was cleared false otherwise}

                does:
                    clears task if task hasn't being completed.

Example Worker file: 'worker.js'

    var worker = require('worker-manager').createWorker();

    worker.on('add', function (a, b) {
        return a + b;
    });

    worker.on('minus', function (a, b) {
        return a - b;
    });

Example in app file:

    var manager = require('worker-manager');

    var man = manager.createManager('./worker.js', 10, false);

    man.send('add', [2, 4], function (err, data, mess) {
        if (err) {
            // handle errors here
            console.log(err);
        } else {
            // do stuff with data here
            console.log(data, mess);
        }
    });

    man.send('minus', [2, 4], function (err, data, mess) {
        if (err) {
            // handle errors here
            console.log(err);
        } else {
            // do stuff with data here
            console.log(data, mess);
        }
    });

Created By:

Michaelangelo Jong