summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
Diffstat (limited to 'examples')
-rwxr-xr-xexamples/ping.py137
-rw-r--r--examples/rpc_async.py44
-rw-r--r--examples/rpc_client_side.py53
-rw-r--r--examples/rpc_server_side.py52
4 files changed, 286 insertions, 0 deletions
diff --git a/examples/ping.py b/examples/ping.py
new file mode 100755
index 00000000..70066e3c
--- /dev/null
+++ b/examples/ping.py
@@ -0,0 +1,137 @@
+#!/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 send a ping request
+ to a given JID.
+ """
+
+ 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['xep_0199'].send_ping(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! RTT: %s" % str(result))
+ 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.register_plugin('xep_0030') # Service Discovery
+ xmpp.register_plugin('xep_0004') # Data Forms
+ xmpp.register_plugin('xep_0060') # PubSub
+ xmpp.register_plugin('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/examples/rpc_async.py b/examples/rpc_async.py
new file mode 100644
index 00000000..0b6d1936
--- /dev/null
+++ b/examples/rpc_async.py
@@ -0,0 +1,44 @@
+"""
+ SleekXMPP: The Sleek XMPP Library
+ Copyright (C) 2011 Dann Martens
+ This file is part of SleekXMPP.
+
+ See the file LICENSE for copying permission.
+"""
+
+from sleekxmpp.plugins.xep_0009.remote import Endpoint, remote, Remote, \
+ ANY_ALL, Future
+import time
+
+class Boomerang(Endpoint):
+
+ def FQN(self):
+ return 'boomerang'
+
+ @remote
+ def throw(self):
+ print "Duck!"
+
+
+
+def main():
+
+ session = Remote.new_session('kangaroo@xmpp.org/rpc', '*****')
+
+ session.new_handler(ANY_ALL, Boomerang)
+
+ boomerang = session.new_proxy('kangaroo@xmpp.org/rpc', Boomerang)
+
+ callback = Future()
+
+ boomerang.async(callback).throw()
+
+ time.sleep(10)
+
+ session.close()
+
+
+
+if __name__ == '__main__':
+ main()
+ \ No newline at end of file
diff --git a/examples/rpc_client_side.py b/examples/rpc_client_side.py
new file mode 100644
index 00000000..ca1084f0
--- /dev/null
+++ b/examples/rpc_client_side.py
@@ -0,0 +1,53 @@
+"""
+ SleekXMPP: The Sleek XMPP Library
+ Copyright (C) 2011 Dann Martens
+ This file is part of SleekXMPP.
+
+ See the file LICENSE for copying permission.
+"""
+
+from sleekxmpp.plugins.xep_0009.remote import Endpoint, remote, Remote, \
+ ANY_ALL
+import threading
+import time
+
+class Thermostat(Endpoint):
+
+ def FQN(self):
+ return 'thermostat'
+
+ def __init(self, initial_temperature):
+ self._temperature = initial_temperature
+ self._event = threading.Event()
+
+ @remote
+ def set_temperature(self, temperature):
+ return NotImplemented
+
+ @remote
+ def get_temperature(self):
+ return NotImplemented
+
+ @remote(False)
+ def release(self):
+ return NotImplemented
+
+
+
+def main():
+
+ session = Remote.new_session('operator@xmpp.org/rpc', '*****')
+
+ thermostat = session.new_proxy('thermostat@xmpp.org/rpc', Thermostat)
+
+ print("Current temperature is %s" % thermostat.get_temperature())
+
+ thermostat.set_temperature(20)
+
+ time.sleep(10)
+
+ session.close()
+
+if __name__ == '__main__':
+ main()
+ \ No newline at end of file
diff --git a/examples/rpc_server_side.py b/examples/rpc_server_side.py
new file mode 100644
index 00000000..0af8af43
--- /dev/null
+++ b/examples/rpc_server_side.py
@@ -0,0 +1,52 @@
+"""
+ SleekXMPP: The Sleek XMPP Library
+ Copyright (C) 2011 Dann Martens
+ This file is part of SleekXMPP.
+
+ See the file LICENSE for copying permission.
+"""
+
+from sleekxmpp.plugins.xep_0009.remote import Endpoint, remote, Remote, \
+ ANY_ALL
+import threading
+
+class Thermostat(Endpoint):
+
+ def FQN(self):
+ return 'thermostat'
+
+ def __init(self, initial_temperature):
+ self._temperature = initial_temperature
+ self._event = threading.Event()
+
+ @remote
+ def set_temperature(self, temperature):
+ print("Setting temperature to %s" % temperature)
+ self._temperature = temperature
+
+ @remote
+ def get_temperature(self):
+ return self._temperature
+
+ @remote(False)
+ def release(self):
+ self._event.set()
+
+ def wait_for_release(self):
+ self._event.wait()
+
+
+
+def main():
+
+ session = Remote.new_session('sleek@xmpp.org/rpc', '*****')
+
+ thermostat = session.new_handler(ANY_ALL, Thermostat, 18)
+
+ thermostat.wait_for_release()
+
+ session.close()
+
+if __name__ == '__main__':
+ main()
+ \ No newline at end of file