/* global $, $iq, Strophe */ var logger = require("jitsi-meet-logger").getLogger(__filename); var GlobalOnErrorHandler = require("../util/GlobalOnErrorHandler"); var XMPPEvents = require("../../service/xmpp/XMPPEvents"); /** * Ping every 10 sec */ var PING_INTERVAL = 10000; /** * Ping timeout error after 15 sec of waiting. */ var PING_TIMEOUT = 15000; /** * Will close the connection after 3 consecutive ping errors. */ var PING_THRESHOLD = 3; /** * XEP-0199 ping plugin. * * Registers "urn:xmpp:ping" namespace under Strophe.NS.PING. */ module.exports = function (XMPP, eventEmitter) { Strophe.addConnectionPlugin('ping', { connection: null, failedPings: 0, /** * Initializes the plugin. Method called by Strophe. * @param connection Strophe connection instance. */ init: function (connection) { this.connection = connection; Strophe.addNamespace('PING', "urn:xmpp:ping"); }, /** * Sends "ping" to given jid * @param jid the JID to which ping request will be sent. * @param success callback called on success. * @param error callback called on error. * @param timeout ms how long are we going to wait for the response. On * timeout error callback is called with undefined error * argument. */ ping: function (jid, success, error, timeout) { var iq = $iq({type: 'get', to: jid}); iq.c('ping', {xmlns: Strophe.NS.PING}); this.connection.sendIQ(iq, success, error, timeout); }, /** * Checks if given jid has XEP-0199 ping support. * @param jid the JID to be checked for ping support. * @param callback function with boolean argument which will be * true if XEP-0199 ping is supported by given jid */ hasPingSupport: function (jid, callback) { var disco = this.connection.disco; // XXX The following disco.info was observed to throw a "TypeError: // Cannot read property 'info' of undefined" during porting to React // Native. Since disco is checked in multiple places (e.g. // strophe.jingle.js, strophe.rayo.js), check it here as well. if (disco) { disco.info( jid, null, function (result) { var ping = $(result).find('>>feature[var="urn:xmpp:ping"]'); callback(ping.length > 0); }, function (error) { var errmsg = "Ping feature discovery error"; GlobalOnErrorHandler.callErrorHandler(new Error( errmsg + ": " + error)); logger.error(errmsg, error); callback(false); } ); } else { // FIXME Should callback be invoked here? Maybe with false as an // argument? } }, /** * Starts to send ping in given interval to specified remote JID. * This plugin supports only one such task and stopInterval * must be called before starting a new one. * @param remoteJid remote JID to which ping requests will be sent to. * @param interval task interval in ms. */ startInterval: function (remoteJid, interval) { if (this.intervalId) { var errmsg = "Ping task scheduled already"; GlobalOnErrorHandler.callErrorHandler(new Error(errmsg)); logger.error(errmsg); return; } if (!interval) interval = PING_INTERVAL; var self = this; this.intervalId = window.setInterval(function () { self.ping(remoteJid, function (result) { // Ping OK self.failedPings = 0; }, function (error) { self.failedPings += 1; var errmsg = "Ping " + (error ? "error" : "timeout"); GlobalOnErrorHandler.callErrorHandler(new Error(errmsg)); logger.error(errmsg, error); if (self.failedPings >= PING_THRESHOLD) { self.connection.disconnect(); } }, PING_TIMEOUT); }, interval); logger.info("XMPP pings will be sent every " + interval + " ms"); }, /** * Stops current "ping" interval task. */ stopInterval: function () { if (this.intervalId) { window.clearInterval(this.intervalId); this.intervalId = null; this.failedPings = 0; logger.info("Ping interval cleared"); } } }); };