SSE

此功能要求workerman>=4.0.0

SSE亦即為伺服器推送事件,是一種伺服器推送技術。其本質是當客戶端發送一個攜帶Accept: text/event-stream 標頭的http請求後,連接不會關閉,伺服器可以持續在這個連接上向客戶端推送數據。

它與websocket的區別在於:

  • SSE只能伺服器向客戶端推送;Websocket可以雙向通訊。
  • SSE默認支持斷線重連;WebSocket 需要自行實現。
  • SSE只能傳輸utf8文本,二進制數據需要編碼成utf8後傳送;WebSocket 默認支持傳送utf8和二進制數據。
  • 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
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);