Changeset 22:9edffdf4aee4 for wokkel

Timestamp:

Jun 10, 2008, 8:12:33 PM (14 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Convert:

svn:b33ecbfc-034c-dc11-8662-000475d9059e/trunk@52

Message:

Clarify use of IQHandlerMixin, fix some doc strings.

Location:

wokkel

Files:

• pubsub.py (modified) (2 diffs)
• subprotocols.py (modified) (1 diff)

wokkel/pubsub.py

@@ -390 +390 @@
     handled as follows:
 
-    * If the exception is an instance of L{error.StanzaError}, an error
-      response iq is returned.
-    * Any other exception is reported using L{log.msg}. An error response
-      with the condition C{internal-server-error} is returned.
+     - If the exception is an instance of L{error.StanzaError}, an error
+       response iq is returned.
+     - Any other exception is reported using L{log.msg}. An error response
+       with the condition C{internal-server-error} is returned.
 
     The default implementation of said methods raises an L{Unsupported}
@@ -402 +402 @@
     @ivar pubSubFeatures: List of supported publish-subscribe features for
                           service discovery, as C{str}.
-    @type pubSubFeatures: C{list} or C{None}.
+    @type pubSubFeatures: C{list} or C{None}
     """
 

wokkel/subprotocols.py

@@ -235 +235 @@
     response of C{internal-server-error} to be sent.
 
+    A typical way to use this mixin, is to set up L{xpath} observers on the
+    C{xmlstream} to call handleRequest, for example in an overridden
+    L{XMPPHandler.connectionMade}. It is likely a good idea to only listen for
+    incoming iq get and/org iq set requests, and not for any iq, to prevent
+    hijacking incoming responses to outgoing iq requests. An example:
+
+        >>> QUERY_ROSTER = "/query[@xmlns='jabber:iq:roster']"
+        >>> class MyHandler(XMPPHandler, IQHandlerMixin):
+        ...    iqHandlers = {"/iq[@type='get']" + QUERY_ROSTER: 'onRosterGet',
+        ...                  "/iq[@type='set']" + QUERY_ROSTER: 'onRosterSet'}
+        ...    def connectionMade(self):
+        ...        self.xmlstream.addObserver(
+        ...          "/iq[@type='get' or @type='set']" + QUERY_ROSTER,
+        ...          self.handleRequest)
+        ...    def onRosterGet(self, iq):
+        ...        pass
+        ...    def onRosterSet(self, iq):
+        ...        pass
+
     @cvar iqHandlers: Mapping from XPath queries (as a string) to the method
                       name that will handle requests that match the query.