annotate Doc/lib/libselect.tex @ 25838:8540887bcec6 2.2

Backport of 2.183: Fix memory leak in add_subclass() found by NealN with valgrind.
author Guido van Rossum <guido@python.org>
date Fri, 18 Oct 2002 13:42:21 +0000
parents bc02c3b09626
children ea7772732da1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8918
acfffe14628e New section header style.
Fred Drake <fdrake@acm.org>
parents: 8716
diff changeset
1 \section{\module{select} ---
10251
d83935d14084 Shorten a few section titles.
Fred Drake <fdrake@acm.org>
parents: 9150
diff changeset
2 Waiting for I/O completion}
d83935d14084 Shorten a few section titles.
Fred Drake <fdrake@acm.org>
parents: 9150
diff changeset
3
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
4 \declaremodule{builtin}{select}
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
5 \modulesynopsis{Wait for I/O completion on multiple streams.}
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
6
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
7
14176
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
8 This module provides access to the \cfunction{select()}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
9 and \cfunction{poll()} functions
9150
4af87ced9f3a Add warning that on Windows it only works on sockets.
Guido van Rossum <guido@python.org>
parents: 8918
diff changeset
10 available in most operating systems. Note that on Windows, it only
4af87ced9f3a Add warning that on Windows it only works on sockets.
Guido van Rossum <guido@python.org>
parents: 8918
diff changeset
11 works for sockets; on other operating systems, it also works for other
21062
bc02c3b09626 Clean up some markup cruft. A number of the macros that take no
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
12 file types (in particular, on \UNIX, it works on pipes). It cannot
12223
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10656
diff changeset
13 be used on regular files to determine whether a file has grown since
9150
4af87ced9f3a Add warning that on Windows it only works on sockets.
Guido van Rossum <guido@python.org>
parents: 8918
diff changeset
14 it was last read.
4af87ced9f3a Add warning that on Windows it only works on sockets.
Guido van Rossum <guido@python.org>
parents: 8918
diff changeset
15
4af87ced9f3a Add warning that on Windows it only works on sockets.
Guido van Rossum <guido@python.org>
parents: 8918
diff changeset
16 The module defines the following:
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
17
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 \begin{excdesc}{error}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
19 The exception raised when an error occurs. The accompanying value is
7789
88c53921bf88 Markup nits, index entries.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
20 a pair containing the numeric error code from \cdata{errno} and the
88c53921bf88 Markup nits, index entries.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
21 corresponding string, as would be printed by the \C{} function
88c53921bf88 Markup nits, index entries.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
22 \cfunction{perror()}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 \end{excdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
24
14176
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
25 \begin{funcdesc}{poll}{}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
26 (Not supported by all operating systems.) Returns a polling object,
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
27 which supports registering and unregistering file descriptors, and
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
28 then polling them for I/O events;
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
29 see section~\ref{poll-objects} below for the methods supported by
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
30 polling objects.
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
31 \end{funcdesc}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
32
7712
0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
33 \begin{funcdesc}{select}{iwtd, owtd, ewtd\optional{, timeout}}
7789
88c53921bf88 Markup nits, index entries.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
34 This is a straightforward interface to the \UNIX{} \cfunction{select()}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
35 system call. The first three arguments are lists of `waitable
15500
d137b94f3ddf select.select(): Add note that though this function accepts empty lists,
Fred Drake <fdrake@acm.org>
parents: 14176
diff changeset
36 objects': either integers representing file descriptors or
7789
88c53921bf88 Markup nits, index entries.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
37 objects with a parameterless method named \method{fileno()} returning
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
38 such an integer. The three lists of waitable objects are for input,
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
39 output and `exceptional conditions', respectively. Empty lists are
15500
d137b94f3ddf select.select(): Add note that though this function accepts empty lists,
Fred Drake <fdrake@acm.org>
parents: 14176
diff changeset
40 allowed, but acceptance of three empty lists is platform-dependent.
d137b94f3ddf select.select(): Add note that though this function accepts empty lists,
Fred Drake <fdrake@acm.org>
parents: 14176
diff changeset
41 (It is known to work on \UNIX{} but not on Windows.) The optional
d137b94f3ddf select.select(): Add note that though this function accepts empty lists,
Fred Drake <fdrake@acm.org>
parents: 14176
diff changeset
42 \var{timeout} argument specifies a time-out as a floating point number
d137b94f3ddf select.select(): Add note that though this function accepts empty lists,
Fred Drake <fdrake@acm.org>
parents: 14176
diff changeset
43 in seconds. When the \var{timeout} argument is omitted the function
d137b94f3ddf select.select(): Add note that though this function accepts empty lists,
Fred Drake <fdrake@acm.org>
parents: 14176
diff changeset
44 blocks until at least one file descriptor is ready. A time-out value
d137b94f3ddf select.select(): Add note that though this function accepts empty lists,
Fred Drake <fdrake@acm.org>
parents: 14176
diff changeset
45 of zero specifies a poll and never blocks.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
46
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
47 The return value is a triple of lists of objects that are ready:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
48 subsets of the first three arguments. When the time-out is reached
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
49 without a file descriptor becoming ready, three empty lists are
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
50 returned.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
51
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
52 Amongst the acceptable object types in the lists are Python file
7789
88c53921bf88 Markup nits, index entries.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
53 objects (e.g. \code{sys.stdin}, or objects returned by
88c53921bf88 Markup nits, index entries.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
54 \function{open()} or \function{os.popen()}), socket objects
88c53921bf88 Markup nits, index entries.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
55 returned by \function{socket.socket()},%
88c53921bf88 Markup nits, index entries.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
56 \withsubitem{(in module socket)}{\ttindex{socket()}}
15500
d137b94f3ddf select.select(): Add note that though this function accepts empty lists,
Fred Drake <fdrake@acm.org>
parents: 14176
diff changeset
57 \withsubitem{(in module os)}{\ttindex{popen()}}.
d137b94f3ddf select.select(): Add note that though this function accepts empty lists,
Fred Drake <fdrake@acm.org>
parents: 14176
diff changeset
58 You may also define a \dfn{wrapper} class yourself, as long as it has
d137b94f3ddf select.select(): Add note that though this function accepts empty lists,
Fred Drake <fdrake@acm.org>
parents: 14176
diff changeset
59 an appropriate \method{fileno()} method (that really returns a file
d137b94f3ddf select.select(): Add note that though this function accepts empty lists,
Fred Drake <fdrake@acm.org>
parents: 14176
diff changeset
60 descriptor, not just a random integer).
20580
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 18479
diff changeset
61 \note{File objects on Windows are not acceptable, but sockets
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 18479
diff changeset
62 are.\index{WinSock} On Windows, the underlying \cfunction{select()}
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 18479
diff changeset
63 function is provided by the WinSock library, and does not handle file
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 18479
diff changeset
64 desciptors that don't originate from WinSock.}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
65 \end{funcdesc}
14176
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
66
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
67 \subsection{Polling Objects
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
68 \label{poll-objects}}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
69
21062
bc02c3b09626 Clean up some markup cruft. A number of the macros that take no
Fred Drake <fdrake@acm.org>
parents: 20580
diff changeset
70 The \cfunction{poll()} system call, supported on most \UNIX{} systems,
14176
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
71 provides better scalability for network servers that service many,
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
72 many clients at the same time.
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
73 \cfunction{poll()} scales better because the system call only
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
74 requires listing the file descriptors of interest, while \cfunction{select()}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
75 builds a bitmap, turns on bits for the fds of interest, and then
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
76 afterward the whole bitmap has to be linearly scanned again.
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
77 \cfunction{select()} is O(highest file descriptor), while
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
78 \cfunction{poll()} is O(number of file descriptors).
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
79
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
80 \begin{methoddesc}{register}{fd\optional{, eventmask}}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
81 Register a file descriptor with the polling object. Future calls to
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
82 the \method{poll()} method will then check whether the file descriptor
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
83 has any pending I/O events. \var{fd} can be either an integer, or an
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
84 object with a \method{fileno()} method that returns an integer. File
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
85 objects implement
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
86 \method{fileno()}, so they can also be used as the argument.
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
87
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
88 \var{eventmask} is an optional bitmask describing the type of events you
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
89 want to check for, and can be a combination of the constants
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
90 \constant{POLLIN}, \constant{POLLPRI}, and \constant{POLLOUT},
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
91 described in the table below. If not specified, the default value
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
92 used will check for all 3 types of events.
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
93
18479
dfb77422c607 Added information about the timeout parameter to the poll() method for
Fred Drake <fdrake@acm.org>
parents: 15500
diff changeset
94 \begin{tableii}{l|l}{constant}{Constant}{Meaning}
14176
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
95 \lineii{POLLIN}{There is data to read}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
96 \lineii{POLLPRI}{There is urgent data to read}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
97 \lineii{POLLOUT}{Ready for output: writing will not block}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
98 \lineii{POLLERR}{Error condition of some sort}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
99 \lineii{POLLHUP}{Hung up}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
100 \lineii{POLLNVAL}{Invalid request: descriptor not open}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
101 \end{tableii}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
102
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
103 Registering a file descriptor that's already registered is not an
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
104 error, and has the same effect as registering the descriptor exactly
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
105 once.
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
106
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
107 \end{methoddesc}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
108
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
109 \begin{methoddesc}{unregister}{fd}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
110 Remove a file descriptor being tracked by a polling object. Just like
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
111 the \method{register()} method, \var{fd} can be an integer or an
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
112 object with a \method{fileno()} method that returns an integer.
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
113
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
114 Attempting to remove a file descriptor that was never registered
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
115 causes a \exception{KeyError} exception to be raised.
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
116 \end{methoddesc}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
117
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
118 \begin{methoddesc}{poll}{\optional{timeout}}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
119 Polls the set of registered file descriptors, and returns a
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
120 possibly-empty list containing \code{(\var{fd}, \var{event})} 2-tuples
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
121 for the descriptors that have events or errors to report.
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
122 \var{fd} is the file descriptor, and \var{event} is a bitmask
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
123 with bits set for the reported events for that descriptor
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
124 --- \constant{POLLIN} for waiting input,
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
125 \constant{POLLOUT} to indicate that the descriptor can be written to, and
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
126 so forth.
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
127 An empty list indicates that the call timed out and no file
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
128 descriptors had any events to report.
18479
dfb77422c607 Added information about the timeout parameter to the poll() method for
Fred Drake <fdrake@acm.org>
parents: 15500
diff changeset
129 If \var{timeout} is given, it specifies the length of time in
dfb77422c607 Added information about the timeout parameter to the poll() method for
Fred Drake <fdrake@acm.org>
parents: 15500
diff changeset
130 milliseconds which the system will wait for events before returning.
dfb77422c607 Added information about the timeout parameter to the poll() method for
Fred Drake <fdrake@acm.org>
parents: 15500
diff changeset
131 If \var{timeout} is omitted, negative, or \code{None}, the call will
dfb77422c607 Added information about the timeout parameter to the poll() method for
Fred Drake <fdrake@acm.org>
parents: 15500
diff changeset
132 block until there is an event for this poll object.
14176
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
133 \end{methoddesc}
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
134
acc72858eb72 Documentation for poll() interface (SF patch #100852)
Andrew M. Kuchling <amk@amk.ca>
parents: 12223
diff changeset
135