In progress

Currently the server library only supports RFC 6455 (aka WebSocket v13)

Browser compatibility (source):

Connection

[scheme]://[cluster].broadcastt.xyz:[port]/app/[key]

Options

scheme

• ws Indicates the use of WebSocket protocol
• wss Indicates the use of secure WebSocket protocol

cluster

The name of the cluster of your application

port

Default WebSocket ports are 80 for ws and 443 for wss connections

key

The key of your application

Data messages

Data is sent bidirectionally over a WebSocket as text data containing UTF8 encoded JSON.

Ping and pong messages

RFC 6455 natively supports Ping and Pong frames. These frames helps determine if the connection lost.

Connection closure

Clients may close the WebSocket connection at any time.

The server may close the connection when an error happens. In most cases a code and a reason will be sent.

The error code indicates the following rules

• 4000-4099: The connection SHOULD NOT be re-established.
• 4100-4199: The connection SHOULD be re-established after backing off.
• 4200-4299: The connection SHOULD be re-established immediately.

Events

Events are WebSocket frames with a predefined structure. The frame has to be a JSON object which has to have an event property and can have a data property.

For consistency the optional data property must be a string which means JSON objects must be serialized.

Connection Events

broadcastt::connection_established From channel to client

This event is triggered when a client successfully connected to the application. When this event has been triggered subscriptions can be made to channels using the WebSocket connection.

{
  "event": "broadcastt:connection_established",
  "data": String
}

Here the data property is a is a JSON-encoded hash of following format:

{
  "socket_id": String // A unique identifier for the connected client
  "activity_timeout": Number // The number of seconds between ping attempts
}

Error Events

broadcastt:error From channel to client

In progress

Subscription Events

broadcastt:subscribe From client to channel

In progress

broadcastt:unsubscribe From client to channel

In progress

broadcastt:subscription_succeeded From channel to client

broadcastt_internal:subscription_succeeded

In progress

Channel Events

These type of messages are sent from a channel to clients.

Channel events are associated with a single channel.

In progress