Changeset 656

Timestamp:

05/09/08 16:14:30 (7 months ago)

Author:

sylvain

Message:

more doc

Files:

• oss/headstock/headstock/example/simplechat/simplechat.py (modified) (2 diffs)

oss/headstock/headstock/example/simplechat/simplechat.py

@@ -1 +1 @@
-# -*- coding: utf-8 -*-
+"""
+This module is a simple XMPP chat client demonstrating the use of headstock.
+Many Kamaelia components are created to manage different XMPP kind of stanzas.
+
+* RosterHandler:
+  * querying the server for the roster list
+  * if supported by server, asking for the last activity of each contact
+
+* DummyMessageHandler:
+  * sending a message typed into the console window
+  * printing to the console any received messages
+
+* DiscoHandler: 
+  * querying for the supported features by the server
+  * dispatching the result of the previous query to components interested in that event
+
+* ActivityHandler:
+  * dispatching to the RosterHandler the fact the server supports the feature
+
+
+The actual XMPP client is the Client component that sets up the different
+dispatchers and handlers involved by liking each inbox to the expected outbox and
+vcie versa.
+
+"""
-from Axon.Component import component
-from Kamaelia.Chassis.Graphline import Graphline
@@ -328 +353 @@
-
-    def setup(self):
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        Backplane("CONSOLE").activate()
-        Backplane("JID").activate()
+        # Used to inform components that the session is now active
-        Backplane("BOUND").activate()
+        # Used to inform components of the supported features
-        Backplane("DISCO_FEAT").activate()
-
-        sub = SubscribeTo("JID")
-        sub.activate()
-        self.link((sub, 'outbox'), (self, 'jid'))
-
+
+
+
+
+
+
+
+
-        Pipeline(ConsoleReader(), PublishTo('CONSOLE')).activate()
-
-
+
+
-        ClientStream.Outboxes["%s.query" % XMPP_LAST_NS] = "Activity"
-        ClientStream.Outboxes["%s.query" % XMPP_DISCO_INFO_NS] = "Discovery"
+
-        self.client = ClientStream(self.jid, self.passwordLookup, use_tls=self.usetls)
-        
-        self.graph = Graphline(client = self,
-                               console = SubscribeTo('CONSOLE'),
-PublishTo("LOGGER"
+Logger(path=None, stdout=True
-                               tcp = TCPClient(self.server, self.port),
-                               xmlparser = XMLIncrParser(),