SSE

Cette fonctionnalité nécessite workerman>=4.0.0

SSE, ou Server-sent Events, est une technologie de push depuis le serveur. Essentiellement, après qu'un client envoie une requête http avec un en-tête Accept: text/event-stream, la connexion ne se ferme pas, et le serveur peut continuellement envoyer des données au client sur cette connexion.

Les différences avec WebSocket sont :

  • SSE ne permet que l'envoi du serveur vers le client ; WebSocket permet une communication bidirectionnelle.
  • SSE prend en charge par défaut la reconnexion automatique ; WebSocket doit être implémenté manuellement.
  • SSE ne peut transmettre que des textes UTF-8, les données binaires doivent être encodées en UTF-8 avant d'être envoyées ; WebSocket prend en charge par défaut l'envoi de textes UTF-8 et de données binaires.
  • SSE possède des types de messages intégrés ; WebSocket nécessite une implémentation manuelle.

Exemple

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
use Workerman\Protocols\Http\Request;
use Workerman\Protocols\Http\ServerSentEvents;
use Workerman\Protocols\Http\Response;
use Workerman\Timer;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('http://0.0.0.0:8080');

$worker->onMessage = function(TcpConnection $connection, Request $request)
{
    // Si l'en-tête Accept est text/event-stream, cela signifie qu'il s'agit d'une requête SSE
    if ($request->header('accept') === 'text/event-stream') {
        // D'abord, envoyer une réponse avec un en-tête Content-Type: text/event-stream
        $connection->send(new Response(200, ['Content-Type' => 'text/event-stream'], "\r\n"));
        // Envoyer périodiquement des données au client
        $timer_id = Timer::add(2, function () use ($connection, &$timer_id){
            // Lors de la fermeture de la connexion, il est nécessaire de supprimer le minuteur pour éviter une accumulation qui pourrait entraîner une fuite de mémoire
            if ($connection->getStatus() !== TcpConnection::STATUS_ESTABLISHED) {
                Timer::del($timer_id);
                return;
            }
            // Envoyer l'événement message, avec les données hello, l'identifiant du message peut ne pas être transmis
            $connection->send(new ServerSentEvents(['event' => 'message', 'data' => 'hello', 'id'=>1]));
        });
        return;
    }
    $connection->send('ok');
};

// Exécuter le worker
Worker::runAll();

Code JavaScript côté client

var source = new EventSource('http://127.0.0.1:8080');
source.addEventListener('message', function (event) {
  var data = event.data;
  console.log(data); // Affiche hello
}, false);