Client side of SocketCluster
SocketCluster Client is the client-side component of SocketCluster.
To install, run:
npm install socketcluster-client
The socketcluster-client script is called socketcluster.js (located in the main socketcluster-client directory)
- You should include it in your HTML page using a <script> tag in order to interact with SocketCluster.
To build SocketCluster Client with browserify, use:
browserify -s socketCluster index.js > socketcluster.js
Embed in your HTML page using (Note that the src attribute may be different depending on how you setup your HTTP server):
Once you have embedded the client socketcluster.js into your page, you will gain access to a global socketCluster object. Then, to begin interacting with the SocketCluster cluster, you will need to establish a connection. Once that's done, you will be able to emit events to the server and listen to incoming events (example code):
var options =port: 8000;// Initiate the connection to the servervar socket = socketClusterconnectoptions;socketon'connect'console.log'CONNECTED';;// Listen to an event called 'rand' from the serversocketon'rand'console.log'RANDOM: ' + num;var curHTML = documentbodyinnerHTML;curHTML += 'RANDOM: ' + num + '<br />';documentbodyinnerHTML = curHTML;;
Example with HTTPS:
var options =protocol: 'https'hostname: 'example.com'port: 443;// Initiate the connection to the servervar socket = socketClusterconnectoptions;