AdvancedSockets aims to help handling connectivity issues from the client side when using ColdFusion WebSocket solution.
Below is a simple example of how to implement. The data attributes defined in the body are the default values and do not have to be set but can be overridden. For more information on how and where they are set refer to the Attributes / Properties section.
<div id="status-message" class="hide"></div>
<cfwebsocket name ="ws"
Properties / Attributes
Controls the auto connect feature of the AdvancedSocket.
true but can be managed by the
data-auto-connect attribute in the body tag. It also requires a pingURL to be defined.
The name of your global websocket variable name.
ws but can be managed by the
data-name attribute in the body tag.
- channels<br/ >
Comma separated list of channels to subscribe to.
Managed by the
data-channels attribute in the body tag.
The subscriber ID returned from ColdFusion on a succesful connection. This is used when the autoConnect feature is enabled to make sure that we are still an active subscriber.
This is a key-value object that is passed when creating a connection. By default AdvancedSocket uses a third party request to find out additional geo-based data of the request. This is also used to pass in a username and any additional info you may want to.
Defines the global function to run on a succesful message. Defaults to
doMessage. If the function is not defined or does not exists a log message will be displayed (if debug is enabled).
doMessage but can be managed by the
data-do-message attribute in the body tag.
Used for the check AdvancedSocket.checkConnection setTimeout
The URL that will be used to ping if we are still a good connection. Should return a JSON object with a success value of true or false.
Managed by the
data-ping-url attribute in the body tag.
The timeout value to ping if autoConnect is enabled while we have a good connection.
30 seconds but can be managed by the
data-online-timer attribute in the body tag.
The timeout value to ping if autoConnect is enabled while we have a bad connection.
5 seconds but can be managed by the
data-offline-timer attribute in the body tag.
The timeout value call a reconnect attempt when a
FORCE-RECONNECT value is received from the server.
500ms but can be managed by the
data-reconnect-timer attribute in the body tag.
The timeout value that is used on reconnect calls. It is automally updated to either the online or offline value based on current state.
Boolean value to display log messages.
false but can be managed by the
data-debug attribute in the body tag.
The status document element defined by an id of status-message.
status-message but can be managed by the
data-status-label attribute in the body tag.
Sets up all required EventListeners to handle window connection events (connectionerror, goodconnection, requireconnection, offline, online). Sets up the timerCount to the onlineCount and then request the checkConnection() function.
Sets up timer and request first ping() call if autoConnect is enabled.
Creates and dispatches custom events.
Polls request to the server to check if connection is still valid.
Handles messages returned. On
welcome, authenticate and/or subscribe messages it auto fires the AdvancedSocket.connected() function. On
FORCE-RECONNECT messages fires the AdvancedSocket.forceReconnect() funciton based on the reconnectCount. On a regular messages passes to the Global Function that will handle your message.
Fired onced the connection is open. If authentication is required, it calls the authenticate() WS function if not passes to the AdvancedSocket.getIPInfo() function, which is the last step before subscribing.
Fired on connection close
Fired on connection errors
Makes a request to ip-api.com to request Geo Based IP data. On response or if jQuery is not available it will call AdvancedSocket.connectWS(), the final step which handles all connections.
Loops thru your defined channels and calls the WS subscribe() function.
Fired when a
FORCE-RECONNECT message is received. Calls the WS closeConnection() and openConnection() functions which in turn when the socket is open again fires the AdvancedSocket.onOpen() function.
Handles setting the timer that fires off the check connection event using window.setTimeout
Outputs console logs if debug is set to true. This can be defined with the body data-debug attribute.
- disconnected :metal: (overwrite to customize)
Fired when a socket is disconnected. Updates the status label.
- connecting :metal: (overwrite to customize)
Fired when the socket is connecting. Updates the status label.
- connected :metal: (overwrite to customize)
Fired when the socket is connected. Updates the status label.