summaryrefslogtreecommitdiffstats
path: root/Doc/library/select.rst
diff options
context:
space:
mode:
authorSandro Tosi <sandro.tosi@gmail.com>2012-01-14 15:42:02 (GMT)
committerSandro Tosi <sandro.tosi@gmail.com>2012-01-14 15:42:02 (GMT)
commit98ed08f24e4b7b7a5d82fb1e07ad5a0319291c2b (patch)
treeea97c15200ee6221998e0ea6eb1ca5f1b3faccd7 /Doc/library/select.rst
parentbbd41d0874c49f756b3a7bcdcbf1e5ac61137377 (diff)
downloadcpython-98ed08f24e4b7b7a5d82fb1e07ad5a0319291c2b.zip
cpython-98ed08f24e4b7b7a5d82fb1e07ad5a0319291c2b.tar.gz
cpython-98ed08f24e4b7b7a5d82fb1e07ad5a0319291c2b.tar.bz2
update to new C roles and directives
Diffstat (limited to 'Doc/library/select.rst')
-rw-r--r--Doc/library/select.rst24
1 files changed, 12 insertions, 12 deletions
diff --git a/Doc/library/select.rst b/Doc/library/select.rst
index 2e08b74..d131cb9 100644
--- a/Doc/library/select.rst
+++ b/Doc/library/select.rst
@@ -6,9 +6,9 @@
:synopsis: Wait for I/O completion on multiple streams.
-This module provides access to the :cfunc:`select` and :cfunc:`poll` functions
-available in most operating systems, :cfunc:`epoll` available on Linux 2.5+ and
-:cfunc:`kqueue` available on most BSD.
+This module provides access to the :c:func:`select` and :c:func:`poll` functions
+available in most operating systems, :c:func:`epoll` available on Linux 2.5+ and
+:c:func:`kqueue` available on most BSD.
Note that on Windows, it only works for sockets; on other operating systems,
it also works for other file types (in particular, on Unix, it works on pipes).
It cannot be used on regular files to determine whether a file has grown since
@@ -20,8 +20,8 @@ The module defines the following:
.. exception:: error
The exception raised when an error occurs. The accompanying value is a pair
- containing the numeric error code from :cdata:`errno` and the corresponding
- string, as would be printed by the C function :cfunc:`perror`.
+ containing the numeric error code from :c:data:`errno` and the corresponding
+ string, as would be printed by the C function :c:func:`perror`.
.. function:: epoll([sizehint=-1])
@@ -60,7 +60,7 @@ The module defines the following:
.. function:: select(rlist, wlist, xlist[, timeout])
- This is a straightforward interface to the Unix :cfunc:`select` system call.
+ This is a straightforward interface to the Unix :c:func:`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:
@@ -96,7 +96,7 @@ 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
+ the underlying :c:func:`select` function is provided by the WinSock
library, and does not handle file descriptors that don't originate from
WinSock.
@@ -195,13 +195,13 @@ Edge and Level Trigger Polling (epoll) Objects
Polling Objects
---------------
-The :cfunc:`poll` system call, supported on most Unix systems, provides better
+The :c:func:`poll` system call, supported on most Unix systems, provides better
scalability for network servers that service many, many clients at the same
-time. :cfunc:`poll` scales better because the system call only requires listing
-the file descriptors of interest, while :cfunc:`select` builds a bitmap, turns
+time. :c:func:`poll` scales better because the system call only requires listing
+the file descriptors of interest, while :c:func:`select` builds a bitmap, turns
on bits for the fds of interest, and then afterward the whole bitmap has to be
-linearly scanned again. :cfunc:`select` is O(highest file descriptor), while
-:cfunc:`poll` is O(number of file descriptors).
+linearly scanned again. :c:func:`select` is O(highest file descriptor), while
+:c:func:`poll` is O(number of file descriptors).
.. method:: poll.register(fd[, eventmask])