summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-07-11 18:49:00 (GMT)
committerFred Drake <fdrake@acm.org>2001-07-11 18:49:00 (GMT)
commit90e651863a55f091c4c488bc0c3ec9da991ec534 (patch)
tree99fa8150945ed4f244de3ae5cac7fae22a03a3d1
parent44589dda83bb90ad4a9e9f6fc714a71888153d01 (diff)
downloadcpython-90e651863a55f091c4c488bc0c3ec9da991ec534.zip
cpython-90e651863a55f091c4c488bc0c3ec9da991ec534.tar.gz
cpython-90e651863a55f091c4c488bc0c3ec9da991ec534.tar.bz2
Added information about the timeout parameter to the poll() method for
polling objects. This closes SF bug #439823. Fixed a minor markup bug.
-rw-r--r--Doc/lib/libselect.tex6
1 files changed, 5 insertions, 1 deletions
diff --git a/Doc/lib/libselect.tex b/Doc/lib/libselect.tex
index b79f5c2..9113460 100644
--- a/Doc/lib/libselect.tex
+++ b/Doc/lib/libselect.tex
@@ -91,7 +91,7 @@ want to check for, and can be a combination of the constants
described in the table below. If not specified, the default value
used will check for all 3 types of events.
-\begin{tableii}{l|l}{code}{Constant}{Meaning}
+\begin{tableii}{l|l}{constant}{Constant}{Meaning}
\lineii{POLLIN}{There is data to read}
\lineii{POLLPRI}{There is urgent data to read}
\lineii{POLLOUT}{Ready for output: writing will not block}
@@ -126,6 +126,10 @@ with bits set for the reported events for that descriptor
so forth.
An empty list indicates that the call timed out and no file
descriptors had any events to report.
+If \var{timeout} is given, it specifies the length of time in
+milliseconds which the system will wait for events before returning.
+If \var{timeout} is omitted, negative, or \code{None}, the call will
+block until there is an event for this poll object.
\end{methoddesc}