herod

var Herod  = require( 'herod' );

 
/*
 * Hash of alive child processes:
 * {
 *  'pid123': {
 *      name: 'cmd,
 *      process : .. 
 *   },
 *   ...
 * }
 * 
 */
Herod.childrens : Object
 
/*
 * Number of alive handled childrens.
 * ( it holds the cardinality of Herod.childrens object )
 */
Herod.alive : Number
 
/*
 * Enable console logging for Herod notice messages,
 * it defaults to false.
 */
Herod.debug : Boolean
 
// last received signal, like 'SIGINT', 'SIGTERM', ..
Herod.lsignal : String

/*
 * Create a child process through ChildProcess#spawn, then automatically
 * enlist / register it to Herod.
 * 
 * It returns the child process or undefined if no child was added.
 * ( a ChildProcess is an instance of EventEmitter ).
 * 
 * - cargs defaults to : [].
 * - copt defaults to : {
 *      cwd : '/tmp',
 *      stdio : 'pipe',
 *      detached : false
 *   }
 *
 * Note : { detached : true } to create a long-running child process.
 */
Herod#spawn( String cmd [, Array cargs [, Object copt ] ] ) : EventEmitter
 
/*
 * Adding a child process to handle.
 * It returns the child pid or undefined, if no child was added 
 */
Herod#enlist( EventEmitter child [, String name [, Array args [, Object copt ] ] ] ) : String
 
/*
 * Kill a child process through its pid.
 * The signal defaults to 'SIGKILL'.
 */
Herod#kill( Number pid, [ String signal [, Function cback ] ] ) : Boolean
 
/*
 * Kill all child processes sending them the same signal.
 * The signal defaults to 'SIGKILL'.
 * It returns the number of alive processes.
 */
Herod#genocide( [ String signal [, Function cback  ] ) : undefined
 
/*
 * Specify a signal to send for killing all enlisted child processes
 * and the main process itself.
 * 'cback' will called on main process 'exit' event.
 */
Herod#suicide( [ String signal [, Function cback ] ] ) : undefined
 
/*
 * Spawn a daemon process for current script, exiting the main parent process.
 * It reloads / spawn the script in which Herod#daemonize is called, as a 
 * long-running child process.
 *
 * default options are:
 * {
 *    stdin : 'ignore',
 *    stdout : 'ignore',
 *    stderr : 'ignore',
 *    env : process.env
 * }
 * for debugging, use process.stdin and process.stdout streams.
 */
Herod#daemonize( [ Object options ] ) : undefined