summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
Diffstat (limited to 'Doc')
-rw-r--r--Doc/lib/libasyncore.tex14
1 files changed, 14 insertions, 0 deletions
diff --git a/Doc/lib/libasyncore.tex b/Doc/lib/libasyncore.tex
index 0004365..8f8be98 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: