Class Index | File Index

Classes


Class faces.push-Socket


Defined in: faces.js.

Class Summary
Constructor Attributes Constructor Name and Description
<inner>  
faces.push-Socket(channelToken, url, channel)
Creates a reconnecting web socket.
Class Detail
<inner> faces.push-Socket(channelToken, url, channel)
Creates a reconnecting web socket. When the web socket successfully connects on first attempt, then it will automatically reconnect on timeout with cumulative intervals of 500ms with a maximum of 25 attempts (~3 minutes). The onclose function will be called with the error code of the last attempt.
Parameters:
{string} channelToken
the channel token associated with this websocket connection
{string} url
The URL of the web socket
{string} channel
The name of the web socket channel.

Documentation generated by JsDoc Toolkit 2.1.0 on Mon Dec 19 2022 22:46:41 GMT-0500 (EST)