diff options
author | Martin v. Löwis <martin@v.loewis.de> | 2004-06-14 04:58:42 (GMT) |
---|---|---|
committer | Martin v. Löwis <martin@v.loewis.de> | 2004-06-14 04:58:42 (GMT) |
commit | ad21945d03bd792a6a93e1dbd2addd6b7b63dbee (patch) | |
tree | d320a05186c86bcef7ec02416739caacb1b58fe8 /Doc/lib/libasyncore.tex | |
parent | 148a63f1fc271a1abe0cd06dd3fac0bb57131b73 (diff) | |
download | cpython-ad21945d03bd792a6a93e1dbd2addd6b7b63dbee.zip cpython-ad21945d03bd792a6a93e1dbd2addd6b7b63dbee.tar.gz cpython-ad21945d03bd792a6a93e1dbd2addd6b7b63dbee.tar.bz2 |
Back out #957240.
Diffstat (limited to 'Doc/lib/libasyncore.tex')
-rw-r--r-- | Doc/lib/libasyncore.tex | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/Doc/lib/libasyncore.tex b/Doc/lib/libasyncore.tex index f466fa6..89c71781 100644 --- a/Doc/lib/libasyncore.tex +++ b/Doc/lib/libasyncore.tex @@ -44,20 +44,20 @@ channel (including any that have been added to the map during asynchronous service) is closed. \begin{funcdesc}{loop}{\optional{timeout\optional{, use_poll\optional{, - map\optional{,count}}}}} - Enter a polling loop that terminates after count passes or all open - channels have been closed. All arguments are optional. The \var(count) - parameter defaults to infinity, resulting in the loop terminating only - when all channels have been closed. 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 - \code{False}). The \var{map} parameter is a dictionary whose items are - the channels to watch. As channels are closed they are deleted from their - map. If \var{map} is omitted, a global map is used (this map is updated - by the default class \method{__init__()} -- make sure you extend, rather - than override, \method{__init__()} if you want to retain this behavior). + 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 \code{False}). The \var{map} parameter + is a dictionary whose items are the channels to watch. As channels + are closed they are deleted from their map. If \var{map} is + omitted, a global map is used (this map is updated by the default + class \method{__init__()} + -- make sure you extend, rather than override, \method{__init__()} + if you want to retain this behavior). Channels (instances of \class{asyncore.dispatcher}, \class{asynchat.async_chat} and subclasses thereof) can freely be mixed in the map. |