silofarm v1.0.1

SiloFarm

SiloFarm is a Node library to add, remove and view running worker threads, an experimental feature introduced by Node v10.5.0 onwards.

Here, each worker thread is a silo in the farm, containing grains of code.

IMPORTANT

Since this is an experimental feature, it is not meant to be used on enterprise applications. I shall update once Node releases a stable version.

CONTENTS

• INSTALLATION
• HOW TO USE
• EXPLANATION

INSTALLATION

$ npm install silofarm

HOW TO USE

A new farm instance can be create by calling new Farm(logging [optional], limit [optional]) method. Logging means if you want SiloFarm to log all events occuring, where default is false. Limit is the maximum number of concurrent worker threads running to be allowed, default is 10. In order to remove the limit, set it to Infinity.

var { Farm } = require('silofarm')

let farm = new Farm(true, 5)

In order to create a silo, create a separate file running the code, and import parentPort and workerData to pass in values from the main thread, and send messages to the thread.

var { parentPort, workerData } = require('silofarm')

workerData.list.forEach(element => {
    element.split(' ').forEach((elem, i) => {
        if (elem === 'Vatsal' && elem !== undefined) {
            parentPort.postMessage('Found instance at ' + i + ' instance')
        }
    })
})

In the main program, call the farm.addSilo(path, data [optional], events [optional], name [optional]) function with path as the absolute or relative path to the file.

farm.addSilo('path/to/file.js', { list: ['Vatsal Kandoi', 'Some other name', 'Third name'] }, {
    error: (err) => {
        console.log(err)
    },
    message: (data) => {
        console.log(data)
    }
}, 'checkNameInstance')

DOCUMENTATION

CREATING A NEW FARM INSTANCE

In order to create a new farm instance, responsible for creating the silos (workers)

    let { Farm } = require('silofarm');

    let farm = new Farm(logging [optional], limit [optional]);

Variables to be passed in the constructor

ADDING A SILO

This method is called to add a new silo (worker) to the farm.

    farm.addSilo(path,
        data [optional],
        events [optional],
        name [optional],
        options [optional],
        callback [optional]
    )

Variables to be passed in the function.

Variable meanings.

IMPORTANT

If path doesn't exits, SiloFarm assumes the string to be a JavaScript code, and is run in the silo.

More on options

FORCE REMOVING A SILO

If you want to force stop a silo, run farm.destroySilo() to force quit the worker thread.

farm.destroySilo(name, callback)

CHECKING SILO BY STATUS

In order to check silos by status, farm.checkSilo() is to be used.

This function returns or logs the silo of the particular status passed as a variable. status can be active or inactive

farm.checkSilo(status, log, callback)

CHECKING PARTICULAR SILO

In order to check running silos, farm.getSilo() is to be used.

This function returns or logs the silo of the particular name passed as a variable, or returns /logs all silos created, including inactive ones.

farm.getSilo(name, log, callback)

CHECKING PENDING SILOS

This function logs or returns a list of all pending silos to be created

farm.checkPendingSilos(log, callback)

CLEARING PENDING SILOS

This function removes all pending silo creation of a given name, or all by default.

farm.removePendingSilo(name)