Server-Sent Events (SSE), with bidirectional emulation

Server-Sent Events or EventSource is a well-known HTTP-based transport available in all modern browsers and loved by many developers. It's unidirectional in its nature but with Centrifugo bidirectional emulation layer it may be used as a fallback or alternative to WebSocket.

How to enable

{
  "sse": {
    "enabled": true
  }
}

Default endpoint

SSE (EventSource) connection endpoint in Centrifugo is:

/connection/sse

How to use

info

This transport is only implemented by our Javascript SDK at this point.

Here is an example how to use JavaScript SDK with WebSocket as the main transport and SSE transport fallback:

Use SSE with bidirectional emulation as a fallback for WebSocket in JS SDK

const transports = [
    {
        transport: 'websocket',
        endpoint: 'ws://localhost:8000/connection/websocket'
    },
    {
        transport: 'sse',
        endpoint: 'http://localhost:8000/connection/sse'
    }
];
const centrifuge = new Centrifuge(transports);
centrifuge.connect()

danger

Make sure allowed_origins are properly configured.

sse

sse.enabled

Boolean, default: false.

Enables SSE (EventSource) endpoint. And enables emulation endpoint (/emulation by default) to accept emulation HTTP requests from clients.

config.json

{
    ...
    "sse": {
        "enabled": true
    }
}

When enabling sse you can connect to /connection/sse from centrifuge-js. Note that our bidirectional emulation also uses /emulation endpoint of Centrifugo to send requests from client to server. This is required because Server-Sent Events / EventSource is a unidirectional transport in its nature. So we use HTTP call to send data from client to server and proxy this call to the correct Centrifugo node which handles the connection. Thus achieving bidirectional behaviour - see details about Centrifugo bidirectional emulation layer. Make sure /emulation endpoint is available for requests from the client side too. If required, you can also control both SSE connection url prefix and emulation endpoint prefix, see customizing endpoints.

sse.max_request_body_size

Default: 65536 (64KB)

Maximum allowed size of a initial HTTP POST request in bytes when using HTTP POST requests to connect (browsers are using GET so it's not applied).