travail / parallel-prefork
A simple prefork server framework
Installs: 168 510
Dependents: 1
Suggesters: 0
Security: 0
Stars: 39
Watchers: 4
Forks: 8
Open Issues: 1
Requires
- php: >=5.3
- ext-pcntl: *
- ext-posix: *
Requires (Dev)
- phpunit/phpunit: 3.7.*
This package is auto-updated.
Last update: 2024-10-14 20:14:22 UTC
README
NAME
Parallel\Prefork - A simple prefork server framework
SYNOPSIS
<?php use \Parallel\Prefork; require_once '/path/to/vendor/autoload.php'; $pp = new Prefork([ 'max_workers' => 5, 'trap_signals' => [ SIGHUP => SIGTERM, SIGTERM => SIGTERM, ], ]); while ($pp->signalReceived() !== SIGTERM) { if ($pp->start()) { continue; } // ... do some work within the child process ... $pp->finish(); } $pp->waitAllChildren();
INSTALLATION
To install this package into your project via composer, add the following snippet to your composer.json
. Then run composer install
.
"require": {
"travail/parallel-prefork": "dev-master"
}
If you want to install from github, add the following:
"repositories": [
{
"type": "vcs",
"url": "git@github.com:travail/php-Parallel-Prefork.git"
}
]
DESCRIPTION
Parallel\Prefork
supports graceful shutdown and run-time reconfiguration.
DEPENDENCIES
- posix
- pcntl
METHODS
__construct
Parallel\Prefork __construct([ 'max_workers' => int $max_workers, 'err_respawn_interval' => int $err_respawn_interval, 'trap_signals' => [int $signal_trapped_in_parent_process => int $signal_sent_to_child_processes], ])
Instantiation. Takes an array as an argument. Recognized parameters are as follows.
max_workers
Number of worker processes (default: 3)
trap_signals
Array of signals to be trapped. Manager process will trap the signals listed in the keys of the array, and send the signal specified in the associated value (if any) to all worker processes.
err_respawn_interval
Number of seconds to deter spawning of child processes after a worker exits abnormally (default: 1)
start
bool start()
The main routine. Returns undef in child processes. Returns a true
within manager process upon receiving a signal specified in the trapSignals
array.
finish
void finish(int $exit_code)
Child processes should call this function for termination. Takes exit code as an optional argument. Only usable from child processes.
signalAllChildren
void signalAllChildren(int $signal)
Sends signal to all worker processes. Only usable from manager process.
waitAllChildren
void waitAllChildren()
Blocks until all worker processes exit. Only usable from manager process.
signalReceived
int signalReceived()
Returns a signal manager process trapped.
THANKS TO
AUTHOR
travail
LICENSE
This library is free software. You can redistribute it and/or modify it under the same terms as PHP itself.