summaryrefslogtreecommitdiffstats
path: root/Doc/library/select.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-08-12 08:18:18 (GMT)
committerGeorg Brandl <georg@python.org>2008-08-12 08:18:18 (GMT)
commit734e2680627e3e946284856e82076abf4faf6641 (patch)
tree7c771cf2f2c66759e8403c28fadc1ececb3a5779 /Doc/library/select.rst
parenteaf8f7a4c04e62c1515fb464cd40a046da026dc9 (diff)
downloadcpython-734e2680627e3e946284856e82076abf4faf6641.zip
cpython-734e2680627e3e946284856e82076abf4faf6641.tar.gz
cpython-734e2680627e3e946284856e82076abf4faf6641.tar.bz2
Merged revisions 65437,65469,65476,65480,65502,65528,65539,65543,65558,65561-65562,65565,65591,65601,65608,65610,65639 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r65437 | georg.brandl | 2008-08-03 22:28:55 +0000 (Sun, 03 Aug 2008) | 2 lines Note the removal of several committers. ........ r65469 | gregory.p.smith | 2008-08-04 01:03:50 +0000 (Mon, 04 Aug 2008) | 3 lines issue1606: Add warnings to the subprocess documentation about common pitfalls of using pipes that cause deadlocks. ........ r65476 | georg.brandl | 2008-08-04 06:29:36 +0000 (Mon, 04 Aug 2008) | 2 lines Fix markup. ........ r65480 | georg.brandl | 2008-08-04 07:31:50 +0000 (Mon, 04 Aug 2008) | 3 lines Clarify the meaning of the select() parameters and sync names with docstring. ........ r65502 | gregory.p.smith | 2008-08-04 18:34:07 +0000 (Mon, 04 Aug 2008) | 2 lines more cleanup ups of the recently added warnings in the subprocess docs. ........ r65528 | brett.cannon | 2008-08-04 21:52:25 +0000 (Mon, 04 Aug 2008) | 4 lines Add a note about all the modules/packages changed to silence -3 warnings. More changes are needed once some decisions are made, but this is the work up to this point. ........ r65539 | andrew.kuchling | 2008-08-05 01:38:08 +0000 (Tue, 05 Aug 2008) | 6 lines #3367 from Kristjan Valur Jonsson: If a PyTokenizer_FromString() is called with an empty string, the tokenizer's line_start member never gets initialized. Later, it is compared with the token pointer 'a' in parsetok.c:193 and that behavior can result in undefined behavior. ........ r65543 | andrew.kuchling | 2008-08-05 02:05:23 +0000 (Tue, 05 Aug 2008) | 1 line #3367: revert rev. 65539: this change causes test_parser to fail ........ r65558 | georg.brandl | 2008-08-06 17:20:41 +0000 (Wed, 06 Aug 2008) | 2 lines Fix longstringitem definition. #3505. ........ r65561 | mark.dickinson | 2008-08-06 20:12:30 +0000 (Wed, 06 Aug 2008) | 2 lines Docstring typo ........ r65562 | mark.dickinson | 2008-08-06 21:36:57 +0000 (Wed, 06 Aug 2008) | 2 lines Remove duplicate import ........ r65565 | andrew.kuchling | 2008-08-07 01:47:34 +0000 (Thu, 07 Aug 2008) | 1 line Add some items ........ r65591 | georg.brandl | 2008-08-08 06:42:20 +0000 (Fri, 08 Aug 2008) | 2 lines #3519: callee is an expression too. ........ r65601 | georg.brandl | 2008-08-08 15:34:34 +0000 (Fri, 08 Aug 2008) | 2 lines Remove mention of backquotes in the tutorial. ........ r65608 | guido.van.rossum | 2008-08-09 14:55:34 +0000 (Sat, 09 Aug 2008) | 2 lines Add news item about _sre.compile() re-bytecode validator. ........ r65610 | antoine.pitrou | 2008-08-09 17:27:23 +0000 (Sat, 09 Aug 2008) | 3 lines move NEWS entry to the appropriate section (oops!) ........ r65639 | georg.brandl | 2008-08-11 10:27:31 +0000 (Mon, 11 Aug 2008) | 2 lines #3540: fix exception name. ........
Diffstat (limited to 'Doc/library/select.rst')
-rw-r--r--Doc/library/select.rst30
1 files changed, 18 insertions, 12 deletions
diff --git a/Doc/library/select.rst b/Doc/library/select.rst
index f64d6dd..bf33c92 100644
--- a/Doc/library/select.rst
+++ b/Doc/library/select.rst
@@ -52,19 +52,24 @@ The module defines the following:
:ref:`kevent-objects` below for the methods supported by kqueue objects.
-.. function:: select(iwtd, owtd, ewtd[, timeout])
+.. function:: select(rlist, wlist, xlist[, timeout])
This is a straightforward interface to the Unix :cfunc:`select` system call.
The first three arguments are sequences of 'waitable objects': either
integers representing file descriptors or objects with a parameterless method
- named :meth:`fileno` returning such an integer. The three sequences of
- waitable objects are for input, output and 'exceptional conditions',
- respectively. Empty sequences are allowed, but acceptance of three empty
- sequences is platform-dependent. (It is known to work on Unix but not on
- Windows.) The optional *timeout* argument specifies a time-out as a floating
- point number in seconds. When the *timeout* argument is omitted the function
- blocks until at least one file descriptor is ready. A time-out value of zero
- specifies a poll and never blocks.
+ named :meth:`fileno` returning such an integer:
+
+ * *rlist*: wait until ready for reading
+ * *wlist*: wait until ready for writing
+ * *xlist*: wait for an "exceptional condition" (see the manual page for what
+ your system considers such a condition)
+
+ Empty sequences are allowed, but acceptance of three empty sequences is
+ platform-dependent. (It is known to work on Unix but not on Windows.) The
+ optional *timeout* argument specifies a time-out as a floating point number
+ in seconds. When the *timeout* argument is omitted the function blocks until
+ at least one file descriptor is ready. A time-out value of zero specifies a
+ poll and never blocks.
The return value is a triple of lists of objects that are ready: subsets of the
first three arguments. When the time-out is reached without a file descriptor
@@ -84,9 +89,10 @@ The module defines the following:
.. index:: single: WinSock
- File objects on Windows are not acceptable, but sockets are. On Windows, the
- underlying :cfunc:`select` function is provided by the WinSock library, and does
- not handle file descriptors that don't originate from WinSock.
+ File objects on Windows are not acceptable, but sockets are. On Windows,
+ the underlying :cfunc:`select` function is provided by the WinSock
+ library, and does not handle file descriptors that don't originate from
+ WinSock.
.. _epoll-objects: