You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Ivan Enderlin 8a6040bae4
3 years ago
Backend Quality: Happy new year! 3 years ago
Bin Quality: Happy new year! 3 years ago
Documentation Core: Remove `Hoa\Core`. 4 years ago
.Mime Fix MIME type format. 7 years ago
.State Add the state of the library. 6 years ago
.gitignore Add a `.gitignore` file 5 years ago Prepare 3 years ago
Exception.php Quality: Happy new year! 3 years ago Documentation: New `` file. 3 years ago
Run.php Quality: Happy new year! 3 years ago
Shared.php Quality: Happy new year! 3 years ago
composer.json Documentation: Update `support` properties. 3 years ago


Build status Code coverage Packagist License

Hoa is a modular, extensible and structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.


Help on IRC Help on Gitter Documentation Board

This library allows to create shared workers in order to lift out some heavy and blocking tasks.

Learn more.


With Composer, to include this library into your dependencies, you need to require hoa/worker:

$ composer require hoa/worker '~3.0'

For more installation procedures, please read the Source page.


Before running the test suites, the development dependencies must be installed:

$ composer install

Then, to run all the test suites:

$ vendor/bin/hoa test:run

For more information, please read the contributor guide.

Quick usage

As a quick overview, we see how to create a worker and how to communicate with it.

Create a worker

First, we need to register the worker (i.e. creating a .wid file), called demorker:

if (false === Hoa\Worker\Run::widExists('demorker')) {
    Hoa\Worker\Run::register('demorker', 'tcp://');

Then, we start the worker (with a password) and we listen to messages:

$worker = new Hoa\Worker\Backend\Shared('demorker', 'iamapassword');
$worker->on('message', function(Hoa\Event\Bucket $bucket) {
    $data = $bucket->getData();
    // compute $data['message'].

The message indicates a task to do (sending an email, create some archives, update the database, send some notifications…).

We are also able to manage all workers from a CLI.

Communicate with a worker

Second, since the worker is running, we can communicate with it from our application. Thus:

$worker = new Hoa\Worker\Shared('demorker');
$worker->postMessage('mail gordon@freeman.hl Hello Gordon!');

We are able to send everything that can be serialized.


The hack book of Hoa\Worker contains detailed information about how to use this library and how it works.

To generate the documentation locally, execute the following commands:

$ composer require --dev hoa/devtools
$ vendor/bin/hoa devtools:documentation --open

More documentation can be found on the project’s website:

Getting help

There are mainly two ways to get help:


Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know.


Hoa is under the New BSD License (BSD-3-Clause). Please, see LICENSE for details.