hoa/worker

The Hoa\Worker library.

, _(*1)

, _(*2)

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

Hoa\Worker

, _(*4)

This library allows to create shared workers in order to lift out some heavy and blocking tasks., _(*5)

Learn more., _(*6)

Installation

With Composer, to include this library into your dependencies, you need to require hoa/worker:, _(*7)

$ composer require hoa/worker '~3.0'

For more installation procedures, please read the Source page., _(*8)

Testing

Before running the test suites, the development dependencies must be installed:, _(*9)

$ composer install

Then, to run all the test suites:, _(*10)

$ vendor/bin/hoa test:run

For more information, please read the contributor guide., _(*11)

Quick usage

As a quick overview, we see how to create a worker and how to communicate with it., _(*12)

Create a worker

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

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

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

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

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

We are also able to manage all workers from a CLI., _(*16)

Communicate with a worker

Second, since the worker is running, we can communicate with it from our application. Thus:, _(*17)

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

We are able to send everything that can be serialized., _(*18)

Documentation

The hack book of Hoa\Worker contains detailed information about how to use this library and how it works., _(*19)

To generate the documentation locally, execute the following commands:, _(*20)

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

More documentation can be found on the project's website: hoa-project.net., _(*21)

Getting help

There are mainly two ways to get help:, _(*22)

• On the #hoaproject IRC channel,
• On the forum at users.hoa-project.net.

Contribution

Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know., _(*23)

License

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