Support for Client to Server pings

wokkel/ping.py

@@ -30,18 +30,21 @@ class PingClientProtocol(XMPPHandler):
     This handler implements the protocol for sending out XMPP Ping requests.
     """
 
-    def ping(self, entity, sender=None):
+    def ping(self, entity=None, sender=None, timeout=None):
         """
         Send out a ping request and wait for a response.
 
-        @param entity: Entity to be pinged.
+        @param entity: Entity to be pinged. L{None} to ping the server.
         @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @return: A deferred that fires upon receiving a response.
         @rtype: L{Deferred<twisted.internet.defer.Deferred>}
 
         @param sender: Optional sender address.
         @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
+
+        @param entity: timeout in seconds for the ping to be responded before errback is called.
+        @type entity: L{int}
         """
         def cb(response):
             return None
@@ -60,7 +63,13 @@ def eb(failure):
         if sender is not None:
             request['from'] = sender.full()
 
-        d = request.send(entity.full())
+        if timeout is not None:
+            request.timeout = timeout
+
+        if entity is None:
+            d = request.send()
+        else:
+            d = request.send(entity.full())
         d.addCallbacks(cb, eb)
         return d
 

wokkel/test/test_ping.py

@@ -51,6 +51,26 @@ def cb(result):
 
         return d
 
+    def test_pingToServer(self):
+        """
+                Pinging a service should fire a deferred with None
+                """
+
+        def cb(result):
+            self.assertIdentical(None, result)
+
+        d = self.protocol.ping()
+        d.addCallback(cb)
+
+        iq = self.stub.output[-1]
+        self.assertIsNone(iq.getAttribute(u'to'))
+        self.assertEqual(u'get', iq.getAttribute(u'type'))
+        self.assertEqual('urn:xmpp:ping', iq.ping.uri)
+
+        response = toResponse(iq, u'result')
+        self.stub.send(response)
+
+        return d
 
     def test_pingWithSender(self):
         """