py/tripe.py.in: Sort out the `SelIOWatcher.iterate' commentary.
authorMark Wooding <mdw@distorted.org.uk>
Sun, 19 May 2013 18:36:52 +0000 (19:36 +0100)
committerMark Wooding <mdw@distorted.org.uk>
Sun, 19 May 2013 18:36:52 +0000 (19:36 +0100)
It's not strictly true that `SelIOWatcher.iterate' isn't used by
`TripeCommandDispatcher', because the latter's `mainloop' method calls
it; but that's not something you need to care about unless you're also
using the service implementation framework.

py/tripe.py.in

index ac616ae..ae88ba3 100644 (file)
@@ -330,8 +330,10 @@ class SelIOWatcher (object):
     Wait for something interesting to happen, and issue events.
 
     That is, basically, do one iteration of a main select loop, processing
-    all of the events, and then return.  This isn't needed for
-    `TripeCommandDispatcher', but `runservices' wants it.
+    all of the events, and then return.  This is used in the method
+    `TripeCommandDispatcher.mainloop', but that's mostly for the benefit of
+    `runservices'; if your I/O watcher has a different main loop, you can
+    drive it yourself.
     """
     M.select()