clue/sse-react

Streaming, async HTML5 Server-Sent Events server (aka. SSE or EventSource)

dev-master 2024-07-04 08:05 UTC

Requires

• php: >=5.3
• react/event-loop: ^1.0
• react/http: ^1.0
• react/stream: ^1.0

Requires (Dev)

• clue/redis-react: ^2.4
• phpunit/phpunit: ^9.6 || ^7.5 || ^4.8.36

MIT

• Christian Lück

• async
• event-driven
• eventsource
• reactphp
• sse
• Server-Sent Events

README

clue/sse-react

Streaming, async HTML5 Server-Sent Events server (aka. SSE or EventSource), built on top of React PHP.

Note: This project is in early alpha stage! Feel free to report any issues you encounter.

Quickstart example

See the examples.

Install

The recommended way to install this library is through Composer. New to Composer?

Once released, this project will follow SemVer. At the moment, this will install the latest development version:

{
    "require": {
        "clue/sse-react": "dev-master"
    }
}

This project aims to run on any platform and thus does not require any PHP extensions and supports running on legacy PHP 5.3 through PHP 7.3. It's highly recommended to use the latest supported PHP version for this project.

Tests

To run the test suite, you first need to clone this repo and then install all dependencies through Composer:

composer install

To run the test suite, go to the project root and run:

php vendor/bin/phpunit

License

MIT, see LICENSE file.