socketcluster-client/README.md

SocketCluster JavaScript Client
======

SocketCluster Client is the client-side component of SocketCluster.

## Usage Overview

* [How to use](https://github.com/SocketCluster/socketcluster-client#how-to-use)
* [Connect Options](https://github.com/SocketCluster/socketcluster-client#connect-options)
* [Events](https://github.com/SocketCluster/socketcluster-client#events)
* [Developing](https://github.com/SocketCluster/socketcluster-client#developing)

To install, run:

```bash
npm install socketcluster-client
```


## How to use

The socketcluster-client script is called `socketcluster.js` (located in the main socketcluster-client directory).
Embed it in your HTML page like that:

```html
<script type="text/javascript" src="/socketcluster.js"></script>
```
- 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):

```js
var options = {
  port: 8000
};

// Initiate the connection to the server
var socket = socketCluster.create(options);

socket.on('connect', function () {
  console.log('CONNECTED');
});

// Listen to an event called 'rand' from the server
socket.on('rand', function (num) {
  console.log('RANDOM: ' + num);
  var curHTML = document.body.innerHTML;
  curHTML += 'RANDOM: ' + num + '<br />';
  document.body.innerHTML = curHTML;
});
```

Example with HTTPS:

```js
var options = {
  hostname: 'securedomain.com',
  secure: true,
  port: 443,
  rejectUnauthorized: false // Only necessary during debug if using a self-signed certificate
};
// Initiate the connection to the server
var socket = socketCluster.create(options);
```

## Connect Options

See all available options : https://socketcluster.io/#!/docs/api-socketcluster-client

```js
var options = {
  path: '/socketcluster/',
  port: 8000,
  hostname: '127.0.0.1',
  autoConnect: true,
  secure: false,
  rejectUnauthorized: false,
  connectTimeout: 10000, //milliseconds
  ackTimeout: 10000, //milliseconds
  channelPrefix: null,
  disconnectOnUnload: true,
  multiplex: true,
  autoReconnectOptions: {
    initialDelay: 10000, //milliseconds
    randomness: 10000, //milliseconds
    multiplier: 1.5, //decimal
    maxDelay: 60000 //milliseconds
  },
  authEngine: null,
  codecEngine: null,
  subscriptionRetryOptions: {},
  query: {
    yourparam: 'hello'
  }
};
```

## Events

```js
socket.on('subscribe', function(channelname) {
  console.log('subscribe:' + channelname);
});

socket.on('subscribeFail', function(channelname) {
  console.log('subscribeFail:' + channelname);
});

socket.on('unsubscribe', function(channelname) {
  console.log('unsubscribe:' + channelname);
});

socket.on('subscribeStateChange', function(data) {
  console.log('subscribeStateChange:' + JSON.stringify(data));
});

socket.on('message', function(data) {
  console.log('message:' + data);
});
```

## Developing

#### Install all dependencies

```bash
cd socketcluster-client

npm install -g gulp gulp-cli browserify uglify-js

npm install
```

#### Building

#### Via Browserify

To build SocketCluster Client with browserify, use:

```bash
./browserify-build.sh
```

Or use

```bash
browserify -s socketCluster index.js > socketcluster.js && uglifyjs socketcluster.js -o socketcluster.min.js
```

#### Via Gulp

To build SocketCluster Client with Gulp, use:

```bash
./gulp-build.sh
```

## Change log

See the 'releases' section for changes: https://github.com/SocketCluster/socketcluster-client/releases

## License

(The MIT License)

Copyright (c) 2013-2017 SocketCluster.io

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.