Skip to content
The Hoa\Worker library.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Backend
Bin
Documentation
.Mime
.State
.gitignore
CHANGELOG.md
Exception.php
README.md
Run.php
Shared.php
composer.json

README.md

Hoa


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.

Hoa\Worker

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.

Installation

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.

Testing

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://127.0.0.1:123456');
}

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'].
});
$worker->run();

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.

Documentation

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: hoa-project.net.

Getting help

There are mainly two ways to get help:

Contribution

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

License

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

You can’t perform that action at this time.