summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNathan Fritz <nathan@andyet.net>2011-02-10 13:45:35 -0800
committerNathan Fritz <nathan@andyet.net>2011-02-10 13:45:35 -0800
commit3463bf46c65f091f42643bc3f777ac05620192b6 (patch)
tree27ca9a4fd54d1d8c2e1fe2868c34a397064ebdb4
parent13a01beb07329e3d87cdd53d167edd137b310668 (diff)
downloadslixmpp-3463bf46c65f091f42643bc3f777ac05620192b6.tar.gz
slixmpp-3463bf46c65f091f42643bc3f777ac05620192b6.tar.bz2
slixmpp-3463bf46c65f091f42643bc3f777ac05620192b6.tar.xz
slixmpp-3463bf46c65f091f42643bc3f777ac05620192b6.zip
added option to return false on ping error, added ping example
-rwxr-xr-xexamples/ping.py134
-rw-r--r--sleekxmpp/plugins/xep_0199.py4
2 files changed, 136 insertions, 2 deletions
diff --git a/examples/ping.py b/examples/ping.py
new file mode 100755
index 00000000..a476e1d8
--- /dev/null
+++ b/examples/ping.py
@@ -0,0 +1,134 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+ 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 sys
+import logging
+import time
+from optparse import OptionParser
+
+import sleekxmpp
+
+# Python versions before 3.0 do not use UTF-8 encoding
+# by default. To ensure that Unicode is handled properly
+# throughout SleekXMPP, we will set the default encoding
+# ourselves to UTF-8.
+if sys.version_info < (3, 0):
+ reload(sys)
+ sys.setdefaultencoding('utf8')
+
+
+class PingTest(sleekxmpp.ClientXMPP):
+
+ """
+ A simple SleekXMPP bot that will echo messages it
+ receives, along with a short thank you message.
+ """
+
+ def __init__(self, jid, password, pingjid):
+ sleekxmpp.ClientXMPP.__init__(self, jid, password)
+ if pingjid is None:
+ pingjid = self.jid
+ self.pingjid = pingjid
+
+ # The session_start event will be triggered when
+ # the bot establishes its connection with the server
+ # and the XML streams are ready for use. We want to
+ # listen for this event so that we we can intialize
+ # our roster.
+ self.add_event_handler("session_start", self.start)
+
+ def start(self, event):
+ """
+ Process the session_start event.
+
+ Typical actions for the session_start event are
+ requesting the roster and broadcasting an intial
+ presence stanza.
+
+ Arguments:
+ event -- An empty dictionary. The session_start
+ event does not provide any additional
+ data.
+ """
+ self.sendPresence()
+ result = self.plugin['xep_0199'].sendPing(self.pingjid, timeout=10, errorfalse=True)
+ logging.info("Pinging...")
+ if result is False:
+ logging.info("Couldn't ping.")
+ self.disconnect()
+ sys.exit(1)
+ else:
+ logging.info("Success!")
+ self.disconnect()
+
+
+if __name__ == '__main__':
+ # Setup the command line arguments.
+ optp = OptionParser()
+
+ # Output verbosity options.
+ optp.add_option('-q', '--quiet', help='set logging to ERROR',
+ action='store_const', dest='loglevel',
+ const=logging.ERROR, default=logging.INFO)
+ optp.add_option('-d', '--debug', help='set logging to DEBUG',
+ action='store_const', dest='loglevel',
+ const=logging.DEBUG, default=logging.INFO)
+ optp.add_option('-v', '--verbose', help='set logging to COMM',
+ action='store_const', dest='loglevel',
+ const=5, default=logging.INFO)
+ optp.add_option('-t', '--pingto', help='set jid to ping',
+ action='store', type='string', dest='pingjid', default=None)
+
+ # JID and password options.
+ optp.add_option("-j", "--jid", dest="jid",
+ help="JID to use")
+ optp.add_option("-p", "--password", dest="password",
+ help="password to use")
+
+ opts, args = optp.parse_args()
+
+ # Setup logging.
+ logging.basicConfig(level=opts.loglevel,
+ format='%(levelname)-8s %(message)s')
+
+ if None in [opts.jid, opts.password]:
+ optp.print_help()
+ sys.exit(1)
+
+ # Setup the PingTest and register plugins. Note that while plugins may
+ # have interdependencies, the order in which you register them does
+ # not matter.
+ xmpp = PingTest(opts.jid, opts.password, opts.pingjid)
+ xmpp.registerPlugin('xep_0030') # Service Discovery
+ xmpp.registerPlugin('xep_0004') # Data Forms
+ xmpp.registerPlugin('xep_0060') # PubSub
+ xmpp.registerPlugin('xep_0199') # XMPP Ping
+
+ # If you are working with an OpenFire server, you may need
+ # to adjust the SSL version used:
+ # xmpp.ssl_version = ssl.PROTOCOL_SSLv3
+
+ # If you want to verify the SSL certificates offered by a server:
+ # xmpp.ca_certs = "path/to/ca/cert"
+
+ # Connect to the XMPP server and start processing XMPP stanzas.
+ if xmpp.connect():
+ # If you do not have the pydns library installed, you will need
+ # to manually specify the name of the server if it does not match
+ # the one in the JID. For example, to use Google Talk you would
+ # need to use:
+ #
+ # if xmpp.connect(('talk.google.com', 5222)):
+ # ...
+ xmpp.process(threaded=False)
+ print("Done")
+ else:
+ print("Unable to connect.")
diff --git a/sleekxmpp/plugins/xep_0199.py b/sleekxmpp/plugins/xep_0199.py
index 16e79e26..e7ec5c46 100644
--- a/sleekxmpp/plugins/xep_0199.py
+++ b/sleekxmpp/plugins/xep_0199.py
@@ -42,7 +42,7 @@ class xep_0199(base.base_plugin):
iq.attrib['to'] = xml.get('from', self.xmpp.boundjid.domain)
self.xmpp.send(iq)
- def sendPing(self, jid, timeout = 30):
+ def sendPing(self, jid, timeout = 30, errorfalse=False):
""" sendPing(jid, timeout)
Sends a ping to the specified jid, returning the time (in seconds)
to receive a reply, or None if no reply is received in timeout seconds.
@@ -57,7 +57,7 @@ class xep_0199(base.base_plugin):
#pingresult = self.xmpp.send(iq, self.xmpp.makeIq(id), timeout)
pingresult = iq.send()
endTime = time.clock()
- if pingresult == False:
+ if pingresult == False or (errorfalse and pingresult['type'] == 'error'):
#self.xmpp.disconnect(reconnect=True)
return False
return endTime - startTime