toplan/task-balancer

lightweight and powerful task load balancing.

Intro

, _(*1)

Lightweight and powerful task load balancing., _(*2)

like the nginx load balancing :smile:, _(*3)

Features

• 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.

Install

composer require toplan/task-balancer:~0.5

Usage

//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/failure at last
        if ($success) {
            $driver->success();
        } else {
            $driver->failure();
        }
        //return some data you need
        return 'some data you need';
    });

    //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:, _(*4)

[
    '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 you need'
        ],
        ...
    ]
]

API

Balancer

Balancer::task($name[, $data][, Closure $ready]);

Create a task instance, and return it. The closure $ready immediately called with argument $task., _(*5)

Balancer::task('taskName', $data, function($task){
    //task's ready work, such as create drivers.
});

$data will store in the task instance., _(*6)

Balancer::run($name[, array $options])

Run the task by name, and return the result data., _(*7)

The keys of $options: - data - driver, _(*8)

Task

name($name)

set the name of task., _(*9)

data($data)

Set the data of task., _(*10)

driver($config[, $weight][, 'backup'], Closure $work)

Create a driver for the task. The closure $work will been called with arguments $driver and $data., _(*11)

Expected $weight to be a integer, default 1., _(*12)

$task->driver('driverName 80 backup', function($driver, $data){
    //driver's job content.
});

hasDriver($name)

Whether has the specified driver., _(*13)

getDriver($name)

Get driver by name., _(*14)

removeDriver($name)

Remove driver from drivers' pool by name., _(*15)

Driver

weight($weight)

Set the weight value of driver., _(*16)

backup($is)

Set whether backup driver., _(*17)

Expected $is to be boolean, default true., _(*18)

data($data)

Set the data of driver., _(*19)

$data will store in driver instance., _(*20)

work(Closure $work);

Set the job content of driver., _(*21)

$data equals to $driver->getData(), _(*22)

reset($config[, $weight][, 'backup'], Closure $work)

Reset driver's weight value, job content and reset whether backup., _(*23)

destroy()

Remove the driver from task which belongs to., _(*24)

failure()

Set the driver running failure., _(*25)

success()

Set the driver run successfully., _(*26)

getDriverData()

Get the data which store in driver instance., _(*27)

getTaskData()

Get the data which store in task instance., _(*28)

Lifecycle & Hooks

Support multiple handlers for every hooks!, _(*29)

Hooks

Usage

• $task->hook($hookName, $handler, $override), _(*30)

• $task->beforeCreateDriver($handler, $override), _(*31)

• $task->afterCreateDriver($handler, $override), _(*32)

• $task->beforeRun($handler, $override), _(*33)

• $task->beforeDriverRun($handler, $override), _(*34)

• $task->afterDriverRun($handler, $override), _(*35)

• $task->afterRun($handler, $override), _(*36)

$override default false., _(*37)

//example
$task->beforeRun(function($task, $index, $handlers, $prevReturn){
    //what is $prevReturn?
    echo $prevReturn == null; //true
    //what is $index?
    echo $index == 0; //true
    //what is $handlers?
    echo count($handlers); //2
    //do something..
    return 'beforeRun_1';
}, false);

$task->beforeRun(function($task, $index, $handlers, $prevReturn){
    //what is $prevReturn?
    echo $prevReturn == 'beforeRun_1'; //true
    //what is $index?
    echo $index == 1; //true
    //what is $handlers?
    echo count($handlers); //2
    //do other something..
}, false);

Dependents

• phpsms

License

MIT, _(*38)