lightweight and powerful task load balancing for php
like the nginx load balancing :)
- Support multiple drives for every task.
- Automatically choose a driver to execute task by drivers` weight value.
- Support multiple backup drivers.
- Task lifecycle and hooks system.
composer require 'toplan/task-balancer:~0.2.3'//define a task
Balancer::task('task1', function($task){
//define a driver for current task like this:
$task->driver('driver_1 100 backup', function($driver, $data){
//do something here
...
//set whether run success/failed at last
if ($success) {
$driver->success();
} else {
$driver->failed();
}
//return some data you need
return 'some data here';
});
//or like this:
$task->driver('driver_2', 90, function($driver, $data){
//...same as above..
})->data(['this is data 2']);
//or like this:
$task->driver('driver_3')
->weight(0)->backUp()
->data(['this is data 3'])
->work(function($driver, $data){
//...same as above..
});
});
//run the task
$result = Balancer::run('task1');The $result structure:
[
'success' => true,
'time' => [
'started_at' => timestamp,
'finished_at' => timestamp
],
'logs' => [
'0' => [
'driver' => 'driver_1',
'success' => false,
'time' => [
'started_at' => timestamp,
'finished_at' => timestamp
],
'result' => 'some data here'
],
...
]
]create a task instance, return task instance.
Balancer::task('taskName', $data, function($task){
//task`s ready work, like create drivers
});
$datawill store in task instance.
run the task, and return a results array.
If
$datanot equals tonull/0/''/[]will override task data.
set the data value of task instance, will override origin data.
create a driver instance for $task, return driver instance.
$weightmust be a integer, default value is '1'
$task->driver('driverName 80 backup', function($driver, $data){
//driver`s work
//$driver is driver instance
});set driver`s weight, return current driver, supported chain operation.
$weightmust be a integer
set driver is backup, return current driver, supported chain operation.
$ismust be true of false
set the data value of driver instance, support chain operation.
$datawill store in driver instance.
set driver work, give two arguments: $driver and $data,
support chain operation.
$datais a value try to get from driver instance, if null will continue try to get from task instance.
$dataequals to$driver->getData()
set current driver run failed, support chain operation.
set current driver run successful. support chain operation.
get data value of driver instance.
get data value of task instance.
support multiple handlers for every hook!
###Hooks Table
| Hook name | handler arguments | influence of the last handler`s return value |
|---|---|---|
| beforeCreateDriver | $task, $preReturn, $index, $handlers | no effect |
| afterCreateDriver | $task, $preReturn, $index, $handlers | no effect |
| beforeRun | $task, $preReturn, $index, $handlers | if false will stop run task and return false |
| beforeDriverRun | $task, $preReturn, $index, $handlers | no effect |
| afterDriverRun | $task, $preReturn, $index, $handlers | no effect |
| afterRun | $task, $taskResult, $preReturn, $index, $handlers | if not boolean will override result value |
###Use Hooks
$overridedefault value isfalse, iftruewill override hook handlers.
-
$task->hook($hookName, $handler, $override)
-
$task->beforeCreateDriver($handler, $override)
-
$task->afterCreateDriver($handler, $override)
-
$task->beforeRun($handler, $override)
-
$task->beforeDriverRun($handler, $override)
-
$task->afterDriverRun($handler, $override)
-
$task->afterRun($handler, $override)
//example
$task->beforeRun(function($task, $preReturn, $index, $handlers){
//what is $preReturn?
$preReturn == null; //true
//what is $index?
$index == 0; //true
//what is $handlers?
echo count($handlers); //2
//do something..
return 'beforeRun_1';
}, false);
$task->beforeRun(function($task, $preReturn, $index, $handlers){
//what is $preReturn?
$preReturn == 'beforeRun_1'; //true
//what is $index?
$index == 1; //true
//what is $handlers?
echo count($handlers); //2
//do other something..
}, false);- remember every task`s start time and end time.
- remember every driver`s start time and end time.
- smart parse arguments of method
driver(). - task lifecycle and hooks
- pause/resume task
MIT