yidas / worker-dispatcher
PHP multi-processing task dispatcher with managing workers
Requires
- php: >=5.4
This package is auto-updated.
Last update: 2024-10-24 04:12:58 UTC
README
PHP Worker Dispatcher
PHP multi-processing task dispatcher with managing workers
Features
-
Multi-Processing implementation on native PHP-CLI
-
Tasks Dispatching to each worker process
-
Elegant Interface for setup and use
OUTLINE
DEMONSTRATION
Use multi-processing to dispatch tasks with generating workers based on CPU cores:
\yidas\WorkerDispatcher::run([ 'tasks' => ["R4NEJ1", "F5KH83", "..."], 'callbacks' => [ // The callback is for each forked process with decentralized tasks 'task' => function ($config, $workderId, $task) { // $task is one of the `tasks` assigned to each worker, ex. "F5KH83" for $workderId is 2 $token = $task; $result = file_get_contents("https://example/v1/register-by-token/{$token}"); }, ], ]);
Use multi-processing to digest jobs from queue:
\yidas\WorkerDispatcher::run([ 'tasks' => false, 'callbacks' => [ // The callback is for each forked process 'process' => function ($config, $workderId, $task) { // Get and handle each job from queue in inifite loop (You need to define your own function) while (true) { $result = handleOneJobFromQueue(); if ($result === null) { break; } } }, ], ]);
INTRODUCTION
This library is implemented by PHP PCNTL control, which provides a main PHP-CLI to fork multiple child processes to share tasks, and even can use for high concurrency application with infinite loop setting.
Since PHP has no shared variables or queue mechanism natively, if you don’t have an external job queue, this library provides a task average dispatcher to simply solve the core distributed processing problem.
REQUIREMENTS
This library requires the following:
- PHP PCNTL
- PHP CLI 5.4.0+
INSTALLATION
Run Composer in your project:
composer require yidas/worker-dispatcher ~1.0.0
Then you could use the class after Composer is loaded on your PHP project:
require __DIR__ . '/vendor/autoload.php'; use yidas\WorkerDispatcher;
USAGE
Calling the run()
method statically with options as argument, WorkerDispatcher will start to dispatch tasks (if any), and then fork the number of workers according to the environment or settings, and wait for all forked processes to complete or terminate the main process.
The setting example with all options is as following:
\yidas\WorkerDispatcher::run([ 'debug' => true, 'workers' => 4, 'config' => ['uri' => "/v1/resource"], 'tasks' => ["R4NEJ1", "F5KH83", "..."], 'callbacks' => [ 'process' => function ($config, $workerId, $tasks) { echo "The number of tasks in forked process - {$workerId}: " . count($tasks[$workerId - 1]) . "\n"; }, 'task' => function ($config, $workerId, $task) { echo "Forked process - {$workerId}: Request to {$config['uri']} with token {$task}\n"; }, ], ]);
Options
callbacks.process
Callback function called after each forked process is created
function (multitype $config, integer $workerId, array $tasks)
callbacks.task
Callback function called in each task loop of each forked process
function (multitype $config, integer $workerId, multitype $task)