From 5ab77c745270d7d5c016c1dc7ef2a82533a4b16e Mon Sep 17 00:00:00 2001 From: Florent Le Coz Date: Thu, 17 Jul 2014 14:19:04 +0200 Subject: Rename to slixmpp --- sleekxmpp/plugins/xep_0199/ping.py | 186 ------------------------------------- 1 file changed, 186 deletions(-) delete mode 100644 sleekxmpp/plugins/xep_0199/ping.py (limited to 'sleekxmpp/plugins/xep_0199/ping.py') diff --git a/sleekxmpp/plugins/xep_0199/ping.py b/sleekxmpp/plugins/xep_0199/ping.py deleted file mode 100644 index 836ff4ae..00000000 --- a/sleekxmpp/plugins/xep_0199/ping.py +++ /dev/null @@ -1,186 +0,0 @@ -""" - SleekXMPP: The Sleek XMPP Library - Copyright (C) 2010 Nathanael C. Fritz - This file is part of SleekXMPP. - - See the file LICENSE for copying permission. -""" - -import time -import logging - -from sleekxmpp.jid import JID -from sleekxmpp.stanza import Iq -from sleekxmpp.exceptions import IqError, IqTimeout -from sleekxmpp.xmlstream import register_stanza_plugin -from sleekxmpp.xmlstream.matcher import StanzaPath -from sleekxmpp.xmlstream.handler import Callback -from sleekxmpp.plugins import BasePlugin -from sleekxmpp.plugins.xep_0199 import stanza, Ping - - -log = logging.getLogger(__name__) - - -class XEP_0199(BasePlugin): - - """ - XEP-0199: XMPP Ping - - Given that XMPP is based on TCP connections, it is possible for the - underlying connection to be terminated without the application's - awareness. Ping stanzas provide an alternative to whitespace based - keepalive methods for detecting lost connections. - - Also see . - - Attributes: - keepalive -- If True, periodically send ping requests - to the server. If a ping is not answered, - the connection will be reset. - interval -- Time in seconds between keepalive pings. - Defaults to 300 seconds. - timeout -- Time in seconds to wait for a ping response. - Defaults to 30 seconds. - Methods: - send_ping -- Send a ping to a given JID, returning the - round trip time. - """ - - name = 'xep_0199' - description = 'XEP-0199: XMPP Ping' - dependencies = set(['xep_0030']) - stanza = stanza - default_config = { - 'keepalive': False, - 'interval': 300, - 'timeout': 30 - } - - def plugin_init(self): - """ - Start the XEP-0199 plugin. - """ - - register_stanza_plugin(Iq, Ping) - - self.xmpp.register_handler( - Callback('Ping', - StanzaPath('iq@type=get/ping'), - self._handle_ping)) - - if self.keepalive: - self.xmpp.add_event_handler('session_start', - self.enable_keepalive, - threaded=True) - self.xmpp.add_event_handler('session_end', - self.disable_keepalive) - - def plugin_end(self): - self.xmpp['xep_0030'].del_feature(feature=Ping.namespace) - self.xmpp.remove_handler('Ping') - if self.keepalive: - self.xmpp.del_event_handler('session_start', - self.enable_keepalive) - self.xmpp.del_event_handler('session_end', - self.disable_keepalive) - - def session_bind(self, jid): - self.xmpp['xep_0030'].add_feature(Ping.namespace) - - def enable_keepalive(self, interval=None, timeout=None): - if interval: - self.interval = interval - if timeout: - self.timeout = timeout - - self.keepalive = True - self.xmpp.schedule('Ping keepalive', - self.interval, - self._keepalive, - repeat=True) - - def disable_keepalive(self, event=None): - self.xmpp.scheduler.remove('Ping keepalive') - - def _keepalive(self, event=None): - log.debug("Keepalive ping...") - try: - rtt = self.ping(self.xmpp.boundjid.host, timeout=self.timeout) - except IqTimeout: - log.debug("Did not recieve ping back in time." + \ - "Requesting Reconnect.") - self.xmpp.reconnect() - else: - log.debug('Keepalive RTT: %s' % rtt) - - def _handle_ping(self, iq): - """Automatically reply to ping requests.""" - log.debug("Pinged by %s", iq['from']) - iq.reply().send() - - def send_ping(self, jid, ifrom=None, block=True, timeout=None, callback=None): - """Send a ping request. - - Arguments: - jid -- The JID that will receive the ping. - ifrom -- Specifiy the sender JID. - block -- Indicate if execution should block until - a pong response is received. Defaults - to True. - timeout -- Time in seconds to wait for a response. - Defaults to self.timeout. - callback -- Optional handler to execute when a pong - is received. Useful in conjunction with - the option block=False. - """ - if not timeout: - timeout = self.timeout - - iq = self.xmpp.Iq() - iq['type'] = 'get' - iq['to'] = jid - iq['from'] = ifrom - iq.enable('ping') - - return iq.send(block=block, timeout=timeout, callback=callback) - - def ping(self, jid=None, ifrom=None, timeout=None): - """Send a ping request and calculate RTT. - - Arguments: - jid -- The JID that will receive the ping. - ifrom -- Specifiy the sender JID. - timeout -- Time in seconds to wait for a response. - Defaults to self.timeout. - """ - own_host = False - if not jid: - if self.xmpp.is_component: - jid = self.xmpp.server - else: - jid = self.xmpp.boundjid.host - jid = JID(jid) - if jid == self.xmpp.boundjid.host or \ - self.xmpp.is_component and jid == self.xmpp.server: - own_host = True - - if not timeout: - timeout = self.timeout - - start = time.time() - - log.debug('Pinging %s' % jid) - try: - self.send_ping(jid, ifrom=ifrom, timeout=timeout) - except IqError as e: - if own_host: - rtt = time.time() - start - log.debug('Pinged %s, RTT: %s', jid, rtt) - return rtt - else: - raise e - else: - rtt = time.time() - start - log.debug('Pinged %s, RTT: %s', jid, rtt) - return rtt -- cgit v1.2.3