# Reliable Signaler [![npm](https://img.shields.io/npm/v/reliable-signaler.svg)](https://npmjs.org/package/reliable-signaler) [![downloads](https://img.shields.io/npm/dm/reliable-signaler.svg)](https://npmjs.org/package/reliable-signaler) It is a node.js and socket.io based reliable signaling implementation. Remember, reliable doesn't mean "scalable"; reliable simply means that it auto reconnects in any kind of failure or internet disconnect. It is having following features: 1. Auto reconnects if node.js gets down out of any reason. 2. Auto reconnects if internet connection disconnects. 3. It provides [custom-signaling](https://github.com/muaz-khan/RTCMultiConnection/wiki/Custom-Private-Servers#signaling-servers) for your [RTCMultiConnection](https://github.com/muaz-khan/RTCMultiConnection) and [DataChannel](https://github.com/muaz-khan/WebRTC-Experiment/tree/master/DataChannel) applications! ``` npm install reliable-signaler ``` # How it works? 1. You can store a room-id on server using `createNewRoomOnServer` method. 2. You can get that room-id using `getRoomFromServer` method. # How to use? 1. In your Node.js server, invoke `require('reliable-signaler')` and pass HTTP-Server object. 2. In your HTML file, link this script: `/reliable-signaler/signaler.js` 3. In your ` ``` And your client-side javascript code: ```javascript var connection = new RTCMultiConnection(); // invoke "initReliableSignaler" and pass "connection" or "channel" object var signaler = initReliableSignaler(connection, 'http://domain:port/'); ``` Call `createNewRoomOnServer` method as soon as you'll call `open` method. You can even call `createNewRoomOnServer` earlier than `open` however it isn't suggested: For RTCMultiConnection: ```javascript // for data-only sessions connection.open(); signaler.createNewRoomOnServer(connection.sessionid); // or (not recommended) signaler.createNewRoomOnServer(connection.sessionid, function() { connection.open(); }); // or --- recommended. connection.open({ onMediaCaptured: function() { signaler.createNewRoomOnServer(connection.sessionid); } }); ``` For DataChannel: ```javascript channel.open('room-id'); signaler.createNewRoomOnServer('room-id', successCallback); ``` For participants, call `getRoomFromServer` method: ```javascript // RTCMultiConnection signaler.getRoomFromServer('sessioin-id', function(roomid) { // invoke "join" in callback connection.join({ sessionid: roomid, userid: roomid, extra: {}, session: connection.session }); // or simply connection.join(roomid); // or connection.connect(roomid); }); // DataChannel signaler.getRoomFromServer('sessioin-id', function(roomid) { channel.join({ id: roomid, owner: roomid }); // or channel.connect(roomid); }); ``` # Complete Client-Side Example for RTCMultiConnection ```html ``` # Complete Client-Side Example for DataChannel ```html ``` ## API Reference Constructor takes either `RTCMultiConnection` instance or a `config` object: ```javascript # 1st option: Pass RTCMultiConnection object var signaler = initReliableSignaler(connection); # 2nd option: Pass "config" object var signaler = initReliableSignaler(connection, '/'); ``` `initReliableSignaler` global-function exposes/returns 3-objects: 1. `socket` 2. `createNewRoomOnServer` 3. `getRoomFromServer` ```javascript // "socket" object signaler.socket.emit('message', 'hello'); // "createNewRoomOnServer" method signaler.createNewRoomOnServer(connection.sessionid, successCallback); // "getRoomFromServer" object signaler.getRoomFromServer('sessioin-id', callback); ``` ## `createNewRoomOnServer` This method simply takes `sessioin-id` and stores in node.js server. You can even pass `successCallback`. ```javascript signaler.createNewRoomOnServer(roomid, successCallback); ``` ## `getRoomFromServer` This method looks for active `sessioin-id` in node.js server. Node.js server will fire callback only when session is found. If session is absent, then node.js server will wait until someone opens that session; and node.js will fire `getRoomFromServer-callback` as soon a session is opened. ```javascript signaler.getRoomFromServer(roomid, successCallback); ``` ## License [Reliable-Signaler](https://github.com/muaz-khan/Reliable-Signaler) is released under [MIT licence](https://www.webrtc-experiment.com/licence/) . Copyright (c) [Muaz Khan](https://plus.google.com/+MuazKhan).