Implements interfaces for data channel communication

JitsiConference.js

@@ -1228,4 +1228,24 @@ JitsiConference.prototype._fireIncompatibleVersionsEvent = function () {
         JitsiConferenceErrors.INCOMPATIBLE_SERVER_VERSIONS);
 };
 
+/**
+ * Sends message via the datachannels.
+ * @param to {string} the id of the endpoint that should receive the message.
+ * If "" the message will be sent to all participants.
+ * @param payload {object} the payload of the message.
+ */
+JitsiConference.prototype.sendEndpointMessage = function (to, payload) {
+    if(this.rtc) {
+        this.rtc.sendDataChannelMessage(to, payload);
+    }
+}
+
+/**
+ * Sends broadcast message via the datachannels.
+ * @param payload {object} the payload of the message.
+ */
+JitsiConference.prototype.broadcastEndpointMessage = function (payload) {
+    this.sendEndpointMessage("", payload);
+}
+
 module.exports = JitsiConference;

JitsiConferenceEventManager.js

@@ -394,6 +394,10 @@ JitsiConferenceEventManager.prototype.setupChatRoomListeners = function () {
  */
 JitsiConferenceEventManager.prototype.setupRTCListeners = function () {
     var conference = this.conference;
+
+    this.rtcForwarder = new EventEmitterForwarder(conference.rtc,
+        this.conference.eventEmitter);
+
     conference.rtc.addListener(RTCEvents.DOMINANTSPEAKER_CHANGED,
         function (id) {
             if(conference.lastDominantSpeaker !== id && conference.room) {
@@ -413,23 +417,23 @@ JitsiConferenceEventManager.prototype.setupRTCListeners = function () {
         conference.room.connectionTimes["data.channel.opened"] = now;
     });
 
-    conference.rtc.addListener(RTCEvents.LASTN_CHANGED,
-        function (oldValue, newValue) {
-            conference.eventEmitter.emit(
-                JitsiConferenceEvents.IN_LAST_N_CHANGED, oldValue, newValue);
-        });
+    this.rtcForwarder.forward(RTCEvents.LASTN_CHANGED,
+        JitsiConferenceEvents.IN_LAST_N_CHANGED);
 
-    conference.rtc.addListener(RTCEvents.LASTN_ENDPOINT_CHANGED,
-        function (lastNEndpoints, endpointsEnteringLastN) {
-            conference.eventEmitter.emit(
-                JitsiConferenceEvents.LAST_N_ENDPOINTS_CHANGED,
-                lastNEndpoints, endpointsEnteringLastN);
-        });
+    this.rtcForwarder.forward(RTCEvents.LASTN_ENDPOINT_CHANGED,
+        JitsiConferenceEvents.LAST_N_ENDPOINTS_CHANGED);
 
     conference.rtc.addListener(RTCEvents.AVAILABLE_DEVICES_CHANGED,
         function (devices) {
             conference.room.updateDeviceAvailability(devices);
         });
+
+    conference.rtc.addListener(RTCEvents.ENDPOINT_MESSAGE_RECEIVED,
+        function (from, payload) {
+            conference.eventEmitter.emit(
+                JitsiConferenceEvents.ENDPOINT_MESSAGE_RECEIVED,
+                conference.getParticipantById(from), payload);
+        });
 };
 
 /**

JitsiConferenceEvents.js

@@ -135,7 +135,13 @@ var JitsiConferenceEvents = {
      * Indicates that a the value of a specific property of a specific
      * participant has changed.
      */
-    PARTICIPANT_PROPERTY_CHANGED: "conference.participant_property_changed"
+    PARTICIPANT_PROPERTY_CHANGED: "conference.participant_property_changed",
+    /**
+     * Indicates that a message from another participant is received on
+     * data channel.
+     */
+    ENDPOINT_MESSAGE_RECEIVED:
+        "conference.endpoint_message_received"
 };
 
 module.exports = JitsiConferenceEvents;

doc/API.md

@@ -118,6 +118,8 @@ JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);
         - AVAILABLE_DEVICES_CHANGED - notifies that available participant devices changed (camera or microphone was added or removed) (parameters - id(string), devices(JS object with 2 properties - audio(boolean), video(boolean)))
         - CONNECTION_STATS - New local connection statistics are received. (parameters - stats(object))
         - AUTH_STATUS_CHANGED - notifies that authentication is enabled or disabled, or local user authenticated (logged in). (parameters - isAuthEnabled(boolean), authIdentity(string))
+        - ENDPOINT_MESSAGE_RECEIVED - notifies that a new message
+        from another participant is received on a data channel.
 
     2. connection
         - CONNECTION_FAILED - indicates that the server connection failed.
@@ -170,10 +172,10 @@ JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);
         - CHROME_EXTENSION_USER_CANCELED - an error which indicates that user canceled screen sharing window selection dialog in jidesha extension for Chrome.
         - CHROME_EXTENSION_INSTALLATION_ERROR - an error which indicates that the jidesha extension for Chrome is failed to install.
         - FIREFOX_EXTENSION_NEEDED - An error which indicates that the jidesha extension for Firefox is needed to proceed with screen sharing, and that it is not installed.
-        
+
 * ```JitsiMeetJS.errorTypes``` - constructors for Error instances that can be produced by library. Are useful for checks like ```error instanceof JitsiMeetJS.errorTypes.JitsiTrackError```. Following Errors are available:
     1. ```JitsiTrackError``` - Error that happened to a JitsiTrack.
-        
+
 * ```JitsiMeetJS.logLevels``` - object with the log levels:
     1. TRACE
     2. DEBUG
@@ -341,6 +343,13 @@ The object represents a conference. We have the following methods to control the
 
     Note: available only for moderator
 
+31. sendEndpointMessage(to, payload) - Sends message via the data channels.
+    - to - the id of the endpoint that should receive the message. If "" the message will be sent to all participants.
+    - payload - JSON object - the payload of the message.
+
+32. broadcastEndpointMessage(payload) - Sends broadcast message via the datachannels.
+    - payload - JSON object - the payload of the message.
+
 JitsiTrack
 ======
 The object represents single track - video or audio. They can be remote tracks ( from the other participants in the call) or local tracks (from the devices of the local participant).
@@ -381,7 +390,7 @@ We have the following methods for controling the tracks:
 
 JitsiTrackError
 ======
-The object represents error that happened to a JitsiTrack. Is inherited from JavaScript base ```Error``` object, 
+The object represents error that happened to a JitsiTrack. Is inherited from JavaScript base ```Error``` object,
 so ```"name"```, ```"message"``` and ```"stack"``` properties are available. For GUM-related errors,
 exposes additional ```"gum"``` property, which is an object with following properties:
  - error - original GUM error

modules/RTC/DataChannels.js

@@ -143,6 +143,10 @@ DataChannels.prototype.onDataChannel = function (event) {
                     lastNEndpoints, endpointsEnteringLastN, obj);
                 self.eventEmitter.emit(RTCEvents.LASTN_ENDPOINT_CHANGED,
                     lastNEndpoints, endpointsEnteringLastN, obj);
+            } else if("EndpointMessage" === colibriClass) {
+                self.eventEmitter.emit(
+                    RTCEvents.ENDPOINT_MESSAGE_RECEIVED, obj.from,
+                    obj.msgPayload);
             }
             else {
                 logger.debug("Data channel JSON-formatted message: ", obj);
@@ -204,34 +208,22 @@ DataChannels.prototype._onXXXEndpointChanged = function (xxx, userResource) {
     var tail = xxx.substring(1);
     var lower = head.toLowerCase() + tail;
     var upper = head.toUpperCase() + tail;
+    logger.log(
+            'sending ' + lower
+                + ' endpoint changed notification to the bridge: ',
+            userResource);
+
+    var jsonObject = {};
+
+    jsonObject.colibriClass = (upper + 'EndpointChangedEvent');
+    jsonObject[lower + "Endpoint"]
+        = (userResource ? userResource : null);
+
+    this.send(jsonObject);
 
     // Notify Videobridge about the specified endpoint change.
     logger.log(lower + ' endpoint changed: ', userResource);
-    this._some(function (dataChannel) {
-        if (dataChannel.readyState == 'open') {
-            logger.log(
-                    'sending ' + lower
-                        + ' endpoint changed notification to the bridge: ',
-                    userResource);
-
-            var jsonObject = {};
-
-            jsonObject.colibriClass = (upper + 'EndpointChangedEvent');
-            jsonObject[lower + "Endpoint"]
-                = (userResource ? userResource : null);
-            try {
-                dataChannel.send(JSON.stringify(jsonObject));
-            } catch (e) {
-                // FIXME: Maybe we should check if the conference is left
-                // before calling _onXXXEndpointChanged method.
-                // FIXME: We should check if we are disposing correctly the
-                // data channels.
-                logger.warn(e);
-            }
 
-            return true;
-        }
-    });
 };
 
 DataChannels.prototype._some = function (callback, thisArg) {
@@ -247,4 +239,31 @@ DataChannels.prototype._some = function (callback, thisArg) {
     }
 };
 
+/**
+ * Sends passed object via the first found open datachannel
+ * @param jsonObject {object} the object that will be sent
+ */
+DataChannels.prototype.send = function (jsonObject) {
+    this._some(function (dataChannel) {
+        if (dataChannel.readyState == 'open') {
+            dataChannel.send(JSON.stringify(jsonObject));
+            return true;
+        }
+    });
+}
+
+/**
+ * Sends message via the datachannels.
+ * @param to {string} the id of the endpoint that should receive the message.
+ * If "" the message will be sent to all participants.
+ * @param payload {object} the payload of the message.
+ */
+DataChannels.prototype.sendDataChannelMessage = function (to, payload) {
+    this.send({
+        colibriClass: "EndpointMessage",
+        to: to,
+        msgPayload: payload
+    });
+}
+
 module.exports = DataChannels;

modules/RTC/RTC.js

@@ -485,4 +485,16 @@ RTC.prototype.handleRemoteTrackVideoTypeChanged = function (value, from) {
     }
 }
 
+/**
+ * Sends message via the datachannels.
+ * @param to {string} the id of the endpoint that should receive the message.
+ * If "" the message will be sent to all participants.
+ * @param payload {object} the payload of the message.
+ */
+RTC.prototype.sendDataChannelMessage = function (to, payload) {
+    if(this.dataChannels) {
+        this.dataChannels.sendDataChannelMessage(to, payload);
+    }
+}
+
 module.exports = RTC;

service/RTC/RTCEvents.js

@@ -8,7 +8,13 @@ var RTCEvents = {
     TRACK_ATTACHED: "rtc.track_attached",
     AUDIO_OUTPUT_DEVICE_CHANGED: "rtc.audio_output_device_changed",
     DEVICE_LIST_CHANGED: "rtc.device_list_changed",
-    DEVICE_LIST_AVAILABLE: "rtc.device_list_available"
+    DEVICE_LIST_AVAILABLE: "rtc.device_list_available",
+    /**
+     * Indicates that a message from another participant is received on
+     * data channel.
+     */
+    ENDPOINT_MESSAGE_RECEIVED:
+        "rtc.endpoint_message_received"
 };
 
 module.exports = RTCEvents;