, (*1)
MyCLabs\Work is a work queue library letting you run tasks in background using a generic abstraction., (*2)
It's intent is to be compatible with classic work queue solutions (RabbitMQ, Beanstalkd, …) while offering a high level abstraction., (*3)
Current implementations:, (*4)
- InMemory: synchronous implementation, task are executed directly (useful for tests or dev environments)
- RabbitMQ
- Beanstalkd
Feel free to contribute and submit other implementations (Gearman, …)., (*5)
Extended guides:, (*6)
How it works
In you code (HTTP request for example), you can run a task in background:, (*7)
$workDispatcher = new RabbitMQWorkDispatcher(/* parameters */);
$workDispatcher->run(new MyTask());
Separately, you set up a worker to run continuously on the command line (like a deamon):, (*8)
$ php my-worker.php
This worker simply calls:, (*9)
// my-worker.php
$worker = new RabbitMQWorker(/* parameters */);
// Will loop continuously and execute tasks
$worker->work();
Defining tasks
Define a task:, (*10)
class BigComputation implements MyCLabs\Work\Task\Task
{
public $parameter1;
}
And define the code that executes the task:, (*11)
class BigComputationExecutor implements MyCLabs\Work\TaskExecutor\TaskExecutor
{
public function execute(Task $task)
{
if (! $task instanceof BigComputation) {
throw new \Exception("Invalid task type provided");
}
// Perform the action (here we just multiply the parameter by 2)
return $task->parameter1 * 2;
}
}
Execute a task and wait for its result
The run($task) method runs a task in background., (*12)
If you want to wait for the result of that task, you have to use a WorkDispatcher that implements the
\MyCLabs\Work\Dispatcher\SynchronousWorkDispatcher interface.
For example, the RabbitMQ adapter implements this interface., (*13)
That interface offers the runAndWait method:, (*14)
interface SynchronousWorkDispatcher extends WorkDispatcher
{
/**
* Run a task in background.
*
* You can use $wait to wait a given time for the task to complete.
* If the task hasn't finished during this time, $timedout will be
* called and this method will return.
* If the task has finished, $completed will be called.
*
* @param Task $task
* @param int $wait Number of seconds to wait for the task to complete.
* If 0, doesn't wait.
* @param callable $completed Called (if $wait > 0) when the task has completed.
* @param callable $timedout Called (if $wait > 0) if we hit the timeout while
* waiting.
* @param callable $errored Called (if $wait > 0) if the task errors. Takes 1
* parameter which is the exception.
*
* @return void No results
*/
public function runAndWait(
Task $task,
$wait = 0,
callable $completed = null,
callable $timedout = null,
callable $errored = null
);
}
Read more
Read more in the docs., (*15)
Contributing
You can run the tests with PHPUnit:, (*16)
$ composer install
$ vendor/bin/phpunit
Some functional tests need external programs like RabbitMQ or Beanstalkd. For practical reasons,
you can boot a VM very quickly using Vagrant and the included configuration.
You can then run the tests in the VM:, (*17)
$ vagrant up
$ vagrant ssh
$ cd /vagrant
$ composer install
$ vendor/bin/phpunit
Wallogit.com
