xmpp.chapril.org-conversejs/src/strophe.ping.js
thierrytiti fb589398ad XEP-0199: XMPP Ping
Use modified StropheJS ping plugin (AMD support)
Add Ping functionality
Add Pong handler

Fix to issue #144:
2015-05-27 18:14:58 +02:00

101 lines
2.7 KiB
JavaScript

/*
* Based on Ping Strophejs plugins (https://github.com/metajack/strophejs-plugins/tree/master/ping)
* This plugin is distributed under the terms of the MIT licence.
* Please see the LICENCE file for details.
*
* Copyright (c) Markus Kohlhase, 2010
* Refactored by Pavel Lang, 2011
*/
/**
* File: strophe.ping.js
* A Strophe plugin for XMPP Ping ( http://xmpp.org/extensions/xep-0199.html )
*/
/*
* AMD Support added by Thierry
*
*/
(function (root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define([
"strophe"
], function (Strophe) {
factory(
Strophe.Strophe,
Strophe.$build,
Strophe.$iq ,
Strophe.$msg,
Strophe.$pres
);
return Strophe;
});
} else {
// Browser globals
factory(
root.Strophe,
root.$build,
root.$iq ,
root.$msg,
root.$pres
);
}
}(this, function (Strophe, $build, $iq, $msg, $pres) {
Strophe.addConnectionPlugin('ping', {
_c: null,
// called by the Strophe.Connection constructor
init: function(conn)
{
this._c = conn;
Strophe.addNamespace('PING', "urn:xmpp:ping");
},
/**
* Function: ping
*
* Parameters:
* (String) to - The JID you want to ping
* (Function) success - Callback function on success
* (Function) error - Callback function on error
* (Integer) timeout - Timeout in milliseconds
*/
ping: function(jid, success, error, timeout)
{
var id = this._c.getUniqueId('ping');
var iq = $iq({type: 'get', to: jid, id: id}).c(
'ping', {xmlns: Strophe.NS.PING});
this._c.sendIQ(iq, success, error, timeout);
},
/**
* Function: pong
*
* Parameters:
* (Object) ping - The ping stanza from the server.
*/
pong: function(ping)
{
var from = ping.getAttribute('from');
var id = ping.getAttribute('id');
var iq = $iq({type: 'result', to: from,id: id});
this._c.sendIQ(iq);
},
/**
* Function: addPingHandler
*
* Parameters:
* (Function) handler - Ping handler
*
* Returns:
* A reference to the handler that can be used to remove it.
*/
addPingHandler: function(handler)
{
return this._c.addHandler(handler, Strophe.NS.PING, "iq", "get");
}
});
}));