Hoa is a modular, extensible and
structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.
This library allows to manipulate the WebSocket protocol and proposes a server and a client. It supports two specifications RFC6455 and Hybi (at the same time).
With Composer, to include this library into
your dependencies, you need to
require hoa/websocket:
$ composer require hoa/websocket '~3.0'For more installation procedures, please read the Source page.
Before running the test suites, the development dependencies must be installed:
$ composer installThen, to run all the test suites:
$ vendor/bin/hoa test:runFor more information, please read the contributor guide.
As a quick overview, we propose to start a websocket server and echo messages.
The class Hoa\Websocket\Server proposes six listeners: open, message,
binary-message, ping, close and error. Thus:
$websocket = new Hoa\Websocket\Server(
new Hoa\Socket\Server('ws://127.0.0.1:8889')
);
$websocket->on('open', function (Hoa\Event\Bucket $bucket) {
echo 'new connection', "\n";
return;
});
$websocket->on('message', function (Hoa\Event\Bucket $bucket) {
$data = $bucket->getData();
echo '> message ', $data['message'], "\n";
$bucket->getSource()->send($data['message']);
echo '< echo', "\n";
return;
});
$websocket->on('close', function (Hoa\Event\Bucket $bucket) {
echo 'connection closed', "\n";
return;
});
$websocket->run();Finally, we have to write a client in HTML and Javascript:
<input type="text" id="input" placeholder="Message…" />
<hr />
<pre id="output"></pre>
<script>
var host = 'ws://127.0.0.1:8889';
var socket = null;
var input = document.getElementById('input');
var output = document.getElementById('output');
var print = function (message) {
var samp = document.createElement('samp');
samp.innerHTML = message + '\n';
output.appendChild(samp);
return;
};
input.addEventListener('keyup', function (evt) {
if (13 === evt.keyCode) {
var msg = input.value;
if (!msg) {
return;
}
try {
socket.send(msg);
input.value = '';
input.focus();
} catch (e) {
console.log(e);
}
return;
}
});
try {
socket = new WebSocket(host);
socket.onopen = function () {
print('connection is opened');
input.focus();
return;
};
socket.onmessage = function (msg) {
print(msg.data);
return;
};
socket.onclose = function () {
print('connection is closed');
return;
};
} catch (e) {
console.log(e);
}
</script>Here we are. All sent messages are echoed.
The following awecodes show this library in action:
Hoa\Websocket: why and how to useHoa\Websocket\ServerandHoa\Websocket\Client? A simple example will illustrate the WebSocket protocol.
The
hack book of Hoa\Websocket 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 --openMore documentation can be found on the project's website: hoa-project.net.
There are mainly two ways to get help:
- On the
#hoaprojectIRC channel, - On the forum at users.hoa-project.net.
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.
The following projects are using this library:
- Marvirc, A dead simple, extremely modular and blazing fast IRC bot,
- WellCommerce, Modern e-commerce engine built on top of Symfony 3 full-stack framework.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent
