Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoaproject/Eventsource
The Hoa\Eventsource library.
https://github.com/hoaproject/Eventsource
eventsource hoa http library php server-sent-events
Last synced: 3 months ago
JSON representation
The Hoa\Eventsource library.
- Host: GitHub
- URL: https://github.com/hoaproject/Eventsource
- Owner: hoaproject
- Archived: true
- Created: 2012-08-24T10:31:02.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2019-02-20T14:50:16.000Z (over 5 years ago)
- Last Synced: 2024-03-22T07:02:48.628Z (3 months ago)
- Topics: eventsource, hoa, http, library, php, server-sent-events
- Language: PHP
- Homepage: https://hoa-project.net/
- Size: 53.7 KB
- Stars: 110
- Watchers: 17
- Forks: 24
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Lists
- awesome-php-zh_CN - Hoa EventSource - 一个事件源库 (事件 Event)
- awesome-php - Hoa EventSource - 一个事件源库 (事件( Event ))
- awesome-php - Hoa EventSource - 一个事件源库 (事件( Event ))
- awesome-php - Hoa EventSource - An event source library. (Event)
- awesome-php-cn - 官网
- awesome-php - Hoa EventSource - 一个事件源库 (URL)
- awesome-php-new - Hoa EventSource - An event source library. (Table of Contents / Event)
- awesome-php-cn - 官网
- awesome-php - Hoa EventSource - An event source library. (Event)
- awesome-php - Hoa EventSource - An event source library. (Table of Contents / Event)
- awesome-php - Hoa EventSource - An event source library. (Table of Contents / Event)
- awesome-stripe - Hoa EventSource - An event source library. (Table of Contents / Event)
- PHP_awesome-directus-duh-REKT-iss- - Hoa EventSource - An event source library. (Table of Contents / Event)
- awesome-php - Hoa EventSource - An event source library. (Table of Contents / Event)
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\Eventsource
[](https://webchat.freenode.net/?channels=#hoaproject)
[](https://gitter.im/hoaproject/central)
[](https://central.hoa-project.net/Documentation/Library/Eventsource)
[](https://waffle.io/hoaproject/eventsource)
This library allows to manipulate the
[EventSource](http://w3.org/TR/eventsource/) (aka Server-Sent Events) technology
by creating a server.
[Learn more](https://central.hoa-project.net/Documentation/Library/Eventsource).
## Installation
With [Composer](https://getcomposer.org/), to include this library into
your dependencies, you need to
require [`hoa/eventsource`](https://packagist.org/packages/hoa/eventsource):
```sh
$ composer require hoa/eventsource '~3.0'
```
For more installation procedures, please read [the Source
page](https://hoa-project.net/Source.html).
## Testing
Before running the test suites, the development dependencies must be installed:
```sh
$ composer install
```
Then, to run all the test suites:
```sh
$ vendor/bin/hoa test:run
```
For more information, please read the [contributor
guide](https://hoa-project.net/Literature/Contributor/Guide.html).
## Quick usage
We propose as a quick overview to send an unlimited number of events from the
server to the client. The client will display all received events. Thus, in
`Server.php`:
```php
$server = new Hoa\Eventsource\Server();
while (true) {
// “tick” is the event name.
$server->tick->send(time());
sleep(1);
}
```
And in `index.html`, our client:
```html
var output = document.getElementById('output');
try {
var source = new EventSource('Server.php');
source.onopen = function () {
output.appendChild(document.createElement('hr'));
return;
};
source.addEventListener('tick', function (evt) {
var samp = document.createElement('samp');
samp.innerHTML = evt.data + '\n';
output.appendChild(samp);
return;
});
} catch (e) {
console.log(e);
}
```
Start your HTTP server and then open `index.html`.
The `Hoa\Eventsource\Server::setReconnectionTime` method allows to redefine the
time before the client will reconnect after a disconnection. The
`Hoa\Eventsource\Server::getLastId` method allows to retrieve the last ID sent
to the client.
## Awecode
The following awecodes show this library in action:
* [`Hoa\Eventsource`](http://hoa-project.net/Awecode/Eventsource.html):
*why and how to use `Hoa\Eventsource\Server`? A simple and daily useful
example will illustrate the EventSource technology (or Server-Send Events)*.
## Documentation
The
[hack book of `Hoa\Eventsource`](https://central.hoa-project.net/Documentation/Library/Eventsource) contains
detailed information about how to use this library and how it works.
To generate the documentation locally, execute the following commands:
```sh
$ composer require --dev hoa/devtools
$ vendor/bin/hoa devtools:documentation --open
```
More documentation can be found on the project's website:
[hoa-project.net](https://hoa-project.net/).
## Getting help
There are mainly two ways to get help:
* On the [`#hoaproject`](https://webchat.freenode.net/?channels=#hoaproject)
IRC channel,
* On the forum at [users.hoa-project.net](https://users.hoa-project.net).
## Contribution
Do you want to contribute? Thanks! A detailed [contributor
guide](https://hoa-project.net/Literature/Contributor/Guide.html) explains
everything you need to know.
## License
Hoa is under the New BSD License (BSD-3-Clause). Please, see
[`LICENSE`](https://hoa-project.net/LICENSE) for details.