elws

1.1.2 • Public • Published

elws

Simple auto-reconnect WebSocket adapter

Install

npm i elws -S

Usage

const RWS = require('elws');
 
const client = new RWS('ws://echo.websocket.org;ws://localhost:8080');
 
client.onopen = function () {
    // as soon as we are connected
    // just send an Hello World! to the server
    client.send('Hello World!');
};
 
client.onmessage = function (event) {
    // because the server is echo.websocket.org we should receive
    // "Hello World!" right after connection
    console.log('', event.data);
};
 
// connect
client.connect();
 
//close
setTimeout(function(){
    console.log('timeout ');
    client.forceClose(1000);
},10000);

If ws://echo.websocket.org is unreachable, RWebSocket will try to reconnect once every 3 seconds (default) and try 3 times, then switch another url

See example.js for detailed usage.

API

The only modifications to the API are:

  • the ability to give a 3rd argument to the constructor to set the retryInterval in ms
  • the ability to give a 4rth argument to the constructor to set the retryCount
  • the #connect() method to actually create a WebSocket and connect to the server
const client = new RWS('ws://echo.websocket.org;ws://localhost:8080', null, 25000,5);

Reconnection attempts will be made once every 25 seconds, and try 5 times then switch another url. NB: the 'null' param is for the protocol because the constructor is the same as the WebSocket RFC + retryInterval

the ability to give a one argument to the constructor to set the close event 'code'

client.forceClose(1000);

Package Sidebar

Install

npm i elws

Weekly Downloads

1

Version

1.1.2

License

MIT

Last publish

Collaborators

  • wangky