Changeset 169:bb939a909750 for wokkel/component.py

Timestamp:

Feb 25, 2012, 8:27:56 PM (8 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Let wokkel.component.Component reconnect if first attempt fails.

Author: ralphm.
Fixes #75.

File:

• wokkel/component.py (modified) (5 diffs)

wokkel/component.py

@@ -5 +5 @@
 
 """
-XMPP External Component utilities
+XMPP External Component utilities.
 """
 
@@ -21 +21 @@
 
 class Component(StreamManager, service.Service):
+    """
+    XMPP External Component service.
+
+    This service is a XMPP stream manager that connects as an External
+    Component to an XMPP server, as described in
+    U{XEP-0114<http://xmpp.org/extensions/xep-0114.html>}.
+    """
     def __init__(self, host, port, jid, password):
         self.host = host
@@ -29 +36 @@
         StreamManager.__init__(self, factory)
 
+
     def _authd(self, xs):
+        """
+        Called when stream initialization has completed.
+
+        This replaces the C{send} method of the C{XmlStream} instance
+        that represents the current connection so that outgoing stanzas
+        always have a from attribute set to the JID of the component.
+        """
         old_send = xs.send
 
@@ -41 +56 @@
         StreamManager._authd(self, xs)
 
+
     def initializationFailed(self, reason):
         """
@@ -51 +67 @@
         reason.raiseException()
 
+
     def startService(self):
+        """
+        Start the service and connect to the server.
+        """
         service.Service.startService(self)
 
+        self._connection = self._getConnection()
+
+
+    def stopService(self):
+        """
+        Stop the service, close the connection and prevent reconnects.
+        """
+        service.Service.stopService(self)
+
         self.factory.stopTrying()
-        self._connection = self._getConnection()
-
-    def stopService(self):
-        service.Service.stopService(self)
-
         self._connection.disconnect()
 
+
     def _getConnection(self):
+        """
+        Create a connector that connects to the server.
+        """
         return reactor.connectTCP(self.host, self.port, self.factory)