apollo / yii2-gearman
Gearman handler for PHP (fork)
Installs: 212
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 29
Type:yii2-extension
Requires
- php: >=5.4.0
- psr/log: ~1
- react/event-loop: 0.4.*
- yiisoft/yii2: *
Requires (Dev)
- phpunit/phpunit: ~4
Suggests
- ext-gearman: This library needs Gearman
This package is not auto-updated.
Last update: 2024-10-30 08:10:19 UTC
README
This extension built on this and this and this The goal of the project is opportunity of starting multiple worker processes on one machine. Work only as process(fork). In config you can set count of nodes, look 'Configuration'
Installation
It is recommended that you install the Gearman library through composer. To do so, add the following lines to your composer.json
file.
{ "require": { "apollo/yii2-gearman": "dev-master" } }
Configuration
'components' => [ 'gearman' => [ 'class' => 'apollo\yii2\gearman\GearmanComponent', 'servers' => [ ['host' => '127.0.0.1', 'port' => 4730], ], 'user' => 'www-data', 'jobs' => [ 'syncCalendar' => [ 'class' => 'common\jobs\SyncCalendar', 'count'=>10 // default count 1 ], ... ] ] ], ... 'controllerMap' => [ 'gearman' => [ 'class' => 'apollo\yii2\gearman\GearmanController', 'gearmanComponent' => 'gearman', ], ... ],
Job example
namespace common\jobs; use apollo\yii2-gearman\JobBase; class SyncCalendar extends JobBase { public function execute(\GearmanJob $job = null) { // Do something } }
Manage workers
yii gearman/start // start the worker
yii gearman/restart // restart worker
yii gearman/stop // stop worker
Example using Dispatcher
Yii::$app->gearman->getDispatcher()->background('syncCalendar', new JobWorkload([ 'params' => [ 'data' => 'value' ] ])); // run in background Yii::$app->gearman->getDispatcher()->execute('syncCalendar', new JobWorkload([ 'params' => [ 'data' => 'value' ] ])); // run synchronize
Example of Supervisor config to manage multiple workers
[program:yii-gearman-worker]
command=php [path_to_your_app]/yii gearman/start %(process_num)s
process_name=gearman-worker-%(process_num)s
priority=1
numprocs=5
numprocs_start=1
autorestart=true