hoa/eventsource

The Hoa\Eventsource library.

Tuesday, January 10, 2017
by Hoa
Repository
16 Watchers
76 Stars
7,965 Installations

PHP
2 Dependents
0 Suggesters
17 Forks
1 Open issues
15 Versions
23 % Grown

The README.md

Hoa , _(*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\Eventsource

, _(*4)

This library allows to manipulate the EventSource (aka Server-Sent Events) technology by creating a server., _(*5)

Learn more., _(*6)

Installation

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

$ composer require hoa/eventsource '~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

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:, _(*12)

$server = new Hoa\Eventsource\Server();

while (true) {
    // “tick” is the event name.
    $server->tick->send(time());
    sleep(1);
}

And in index.html, our client:, _(*13)

Start your HTTP server and then open index.html., _(*14)

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., _(*15)

Awecode

The following awecodes show this library in action:, _(*16)

Hoa\Eventsource: 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 contains detailed information about how to use this library and how it works., _(*17)

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

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

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

Getting help

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

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., _(*21)

License

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

The Versions

10/01 2017

dev-master

9999999-dev https://hoa-project.net/

The Hoa\Eventsource library.

library eventsource

The Hoa\Eventsource library.

hoa/eventsource

The README.md

Hoa\Eventsource

Installation

Testing

Quick usage

Awecode

Documentation

Getting help

Contribution

License

The Versions

dev-master

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

3.17.01.10

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

3.16.11.19

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

3.16.01.14

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

3.16.01.11

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.15.08.13

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.15.05.29

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.15.04.13

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.15.02.19

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.14.12.10

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.14.11.26

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.14.11.09

The Requires

by Ivan Enderlin

by Hoa community

2.14.09.23

The Requires

by Ivan Enderlin

by Hoa community

2.14.09.17

The Requires

by Ivan Enderlin