hoa / worker
The Hoa\Worker library.
Installs: 255
Dependents: 0
Suggesters: 0
Security: 0
Stars: 25
Watchers: 14
Forks: 10
Open Issues: 1
Requires
- hoa/consistency: ~1.0
- hoa/event: ~1.0
- hoa/exception: ~1.0
- hoa/fastcgi: ~3.0
- hoa/file: ~1.0
- hoa/socket: ~1.0
- hoa/zombie: ~3.0
This package is auto-updated.
Last update: 2021-09-20 08:33:54 UTC
README
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
This library allows to create shared workers in order to lift out some heavy and blocking tasks.
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:
- 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.
License
Hoa is under the New BSD License (BSD-3-Clause). Please, see
LICENSE
for details.