From: Fred Drake <fdrake@acm.org>
Date: Wed, 5 Dec 2001 21:37:50 +0000 (+0000)
Subject: asyncore.loop() description contributed by Skip Montanaro.
X-Git-Tag: v2.2.1c1~535
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d761662b66133a6be86798235b206a0097446bbf;p=python

asyncore.loop() description contributed by Skip Montanaro.
This closes SF bug #489513.
---

diff --git a/Doc/lib/libasyncore.tex b/Doc/lib/libasyncore.tex
index 0004365e86..8f8be9888a 100644
--- a/Doc/lib/libasyncore.tex
+++ b/Doc/lib/libasyncore.tex
@@ -56,6 +56,20 @@ network servers and clients a snap.
   \end{tableii}
 \end{classdesc}
 
+\begin{funcdesc}{loop}{\optional{timeout\optional{, use_poll\optional{,
+                       map}}}}
+  Enter a polling loop that only terminates after all open channels
+  have been closed.  All arguments are optional.  The \var{timeout}
+  argument sets the timeout parameter for the appropriate
+  \function{select()} or \function{poll()} call, measured in seconds;
+  the default is 30 seconds.  The \var{use_poll} parameter, if true,
+  indicates that \function{poll()} should be used in preference to
+  \function{select()} (the default is false).  The \var{map} parameter
+  is a dictionary that gives a list of channels to watch.  As channels
+  are closed they are deleted from their map.  If \var{map} is
+  omitted, a global map is used.
+\end{funcdesc}
+
 This set of user-level events is larger than the basics.  The 
 full set of methods that can be overridden in your subclass are: