traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

- clean up some extra punctuation hidden in indexing markup 

- fix a typo and one markup nit
- normalize whitespace
This commit is contained in:
Fred Drake 2003-04-29 13:56:40 +00:00
parent 83c19ee06b
commit c95628e3f2
1 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
Doc/lib/libselect.tex
View File

@ -23,10 +23,10 @@ corresponding string, as would be printed by the \C{} function
\end{excdesc} \end{excdesc}
\begin{funcdesc}{poll}{} \begin{funcdesc}{poll}{}
(Not supported by all operating systems.) Returns a polling object, (Not supported by all operating systems.) Returns a polling object,
which supports registering and unregistering file descriptors, and which supports registering and unregistering file descriptors, and
then polling them for I/O events; then polling them for I/O events;
see section~\ref{poll-objects} below for the methods supported by see section~\ref{poll-objects} below for the methods supported by
polling objects. polling objects.
\end{funcdesc} \end{funcdesc}
@ -49,12 +49,12 @@ subsets of the first three arguments. When the time-out is reached
without a file descriptor becoming ready, three empty lists are without a file descriptor becoming ready, three empty lists are
returned. returned.
Amongst the acceptable object types in the lists are Python file Among the acceptable object types in the lists are Python file
objects (e.g. \code{sys.stdin}, or objects returned by objects (e.g. \code{sys.stdin}, or objects returned by
\function{open()} or \function{os.popen()}), socket objects \function{open()} or \function{os.popen()}), socket objects
returned by \function{socket.socket()},% returned by \function{socket.socket()}.%
\withsubitem{(in module socket)}{\ttindex{socket()}} \withsubitem{(in module socket)}{\ttindex{socket()}}
\withsubitem{(in module os)}{\ttindex{popen()}}. \withsubitem{(in module os)}{\ttindex{popen()}}
You may also define a \dfn{wrapper} class yourself, as long as it has You may also define a \dfn{wrapper} class yourself, as long as it has
an appropriate \method{fileno()} method (that really returns a file an appropriate \method{fileno()} method (that really returns a file
descriptor, not just a random integer). descriptor, not just a random integer).
@ -102,8 +102,7 @@ used will check for all 3 types of events.
Registering a file descriptor that's already registered is not an Registering a file descriptor that's already registered is not an
error, and has the same effect as registering the descriptor exactly error, and has the same effect as registering the descriptor exactly
once. once.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{unregister}{fd} \begin{methoddesc}{unregister}{fd}
@ -119,17 +118,15 @@ causes a \exception{KeyError} exception to be raised.
Polls the set of registered file descriptors, and returns a Polls the set of registered file descriptors, and returns a
possibly-empty list containing \code{(\var{fd}, \var{event})} 2-tuples possibly-empty list containing \code{(\var{fd}, \var{event})} 2-tuples
for the descriptors that have events or errors to report. for the descriptors that have events or errors to report.
\var{fd} is the file descriptor, and \var{event} is a bitmask \var{fd} is the file descriptor, and \var{event} is a bitmask
with bits set for the reported events for that descriptor with bits set for the reported events for that descriptor
--- \constant{POLLIN} for waiting input, --- \constant{POLLIN} for waiting input,
\constant{POLLOUT} to indicate that the descriptor can be written to, and \constant{POLLOUT} to indicate that the descriptor can be written to, and
so forth. so forth.
An empty list indicates that the call timed out and no file An empty list indicates that the call timed out and no file
descriptors had any events to report. descriptors had any events to report.
If \var{timeout} is given, it specifies the length of time in If \var{timeout} is given, it specifies the length of time in
milliseconds which the system will wait for events before returning. milliseconds which the system will wait for events before returning.
If \var{timeout} is omitted, negative, or \code{None}, the call will If \var{timeout} is omitted, negative, or \constant{None}, the call will
block until there is an event for this poll object. block until there is an event for this poll object.
\end{methoddesc} \end{methoddesc}