Interface SocketOptions

The optional authentication token to be exposed on the server under the :auth_token connect_info key.

The binary type to use for binary WebSocket frames.

Defaults to "arraybuffer"

When true, enables debug logging. Default false.

The function to decode incoming messages.

Defaults to JSON:

(payload, callback) => callback(JSON.parse(payload))
Copy

The function to encode outgoing messages.

Defaults to JSON encoder.

The millisec interval to send a heartbeat message.

Defaults to 30000.

The optional function for specialized logging, ie:

function(kind, msg, data) {
  console.log(`${kind}: ${msg}`, data)
}
Copy

The maximum timeout of a long poll AJAX request.

Defaults to 20s (double the server long poll timer).

The millisecond time to attempt the primary transport before falling back to the LongPoll transport. Disabled by default.

The optional params to pass when connecting.

The optional function that returns the socket reconnect interval, in milliseconds.

Defaults to stepped backoff of:

function(tries){
  return [10, 50, 100, 150, 200, 250, 500, 1000, 2000][tries - 1] || 5000
}
Copy

The optional function that returns the millisec rejoin interval for individual channels.

function(tries){
  return [1000, 2000, 5000][tries - 1] || 10000
}
Copy

An optional Storage compatible object Phoenix uses sessionStorage for longpoll fallback history. Overriding the store is useful when Phoenix won't have access to sessionStorage. For example, This could happen if a site loads a cross-domain channel in an iframe. Example usage:

class InMemoryStorage {
  constructor() { this.storage = {} }
  getItem(keyName) { return this.storage[keyName] || null }
  removeItem(keyName) { delete this.storage[keyName] }
  setItem(keyName, keyValue) { this.storage[keyName] = keyValue }
}

The default timeout in milliseconds to trigger push timeouts.

Defaults to 10000

The Websocket Transport, for example WebSocket or Phoenix.LongPoll.

Defaults to WebSocket with automatic LongPoll fallback if WebSocket is not defined. To fallback to LongPoll when WebSocket attempts fail, use longPollFallbackMs: 2500.

The serializer's protocol version to send on connect.

Defaults to "2.0.0".