SSE

この機能は workerman >= 4.0.0 が必要です

SSE(Server-sent Events)は、サーバープッシュ技術の一つです。その本質は、クライアントが Accept: text/event-stream ヘッダーを持つHTTPリクエストを送信した後、接続を閉じずに、サーバーがこの接続を通じてクライアントにデータを継続的にプッシュできることです。

これはWebSocketとの違いがあります:

  • SSEはサーバーからクライアントへの一方向のみ;WebSocketは双方向通信が可能です。
  • SSEはデフォルトで再接続をサポートしています;WebSocketは自分で実装する必要があります。
  • SSEはUTF-8テキストのみを送信可能で、バイナリデータはUTF-8にエンコードして送信する必要があります;WebSocketはデフォルトでUTF-8およびバイナリデータの送信をサポートしています。
  • SSEはメッセージタイプを自動的に持っています;WebSocketは自分で実装する必要があります。

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)
{
    // Acceptヘッダーがtext/event-streamである場合、SSEリクエストであることを示します
    if ($request->header('accept') === 'text/event-stream') {
        // 最初にContent-Type: text/event-streamヘッダーのレスポンスを送信します
        $connection->send(new Response(200, ['Content-Type' => 'text/event-stream'], "\r\n"));
        // 定期的にクライアントにデータをプッシュします
        $timer_id = Timer::add(2, function () use ($connection, &$timer_id){
            // 接続が閉じられた場合は、タイマーを削除して、タイマーが蓄積され続けてメモリリークを引き起こすのを防ぎます
            if ($connection->getStatus() !== TcpConnection::STATUS_ESTABLISHED) {
                Timer::del($timer_id);
                return;
            }
            // messageイベントを送信し、イベントに含まれるデータはhelloで、メッセージIDは省略可能です
            $connection->send(new ServerSentEvents(['event' => 'message', 'data' => 'hello', 'id'=>1]));
        });
        return;
    }
    $connection->send('ok');
};

// ワーカーを実行
Worker::runAll();

クライアントのJavaScriptコード

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