summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libsocket.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-06-06 21:57:48 (GMT)
committerFred Drake <fdrake@acm.org>2002-06-06 21:57:48 (GMT)
commit6c6d6627608c1a49529df38db27d0258dd5f423a (patch)
tree5cf60c7d5e3ff8aa7e4a2aea53f2e9b1bd1cb277 /Doc/lib/libsocket.tex
parentbe946bfea7acfeeb0a8bbb01faca117230df17d5 (diff)
downloadcpython-6c6d6627608c1a49529df38db27d0258dd5f423a.zip
cpython-6c6d6627608c1a49529df38db27d0258dd5f423a.tar.gz
cpython-6c6d6627608c1a49529df38db27d0258dd5f423a.tar.bz2
Fix some markup errors and adjust wording slightly.
Diffstat (limited to 'Doc/lib/libsocket.tex')
-rw-r--r--Doc/lib/libsocket.tex30
1 files changed, 15 insertions, 15 deletions
diff --git a/Doc/lib/libsocket.tex b/Doc/lib/libsocket.tex
index 0fe8940..aace6fd 100644
--- a/Doc/lib/libsocket.tex
+++ b/Doc/lib/libsocket.tex
@@ -515,27 +515,27 @@ block until they can proceed.
\end{methoddesc}
\begin{methoddesc}[socket]{settimeout}{value}
-Set a timeout on blocking socket operations. Value can be any numeric value
-or \var{None}. Socket operations will raise an \exception{error} exception
-if the timeout period \var{value} has elapsed before the operation has
-completed. Setting a timeout of \var{None} disables timeouts on socket
-operations.
+Set a timeout on blocking socket operations. Value can be any numeric
+value or \code{None}. Socket operations will raise an
+\exception{error} exception if the timeout period \var{value} has
+elapsed before the operation has completed. Setting a timeout of
+\code{None} disables timeouts on socket operations.
\end{methoddesc}
\begin{methoddesc}[socket]{gettimeout}{}
-Returns the timeout in floating seconds associated with socket operations.
-A timeout of None indicates that timeouts on socket operations are
-disabled.
+Returns the timeout in floating seconds associated with socket
+operations. A timeout of \code{None} indicates that timeouts on
+socket operations are disabled.
\end{methoddesc}
Some notes on the interaction between socket blocking and timeouts:
-socket blocking mode takes precendence over timeouts. If a socket
-if set to non-blocking mode, then timeouts set on sockets are never
-don't mean anything. The timeout value associated with the socket
-can still be set via settimeout and its value retrieved via gettimeout,
-but the timeout is never enforced (i.e, an exception will never be
-thrown). Otherwise, if the socket is in blocking mode, setting the
-timeout will raise an exception as expected.
+socket blocking mode takes precendence over timeouts. If a socket if
+set to non-blocking mode, then timeouts set on sockets are not used.
+The timeout value associated with the socket can still be set using
+\method{settimeout()} and its value retrieved using
+\method{gettimeout()}, but the timeout is never enforced (an exception
+will never be thrown). Otherwise, if the socket is in blocking mode,
+setting the timeout will raise an exception as expected.
\begin{methoddesc}[socket]{setsockopt}{level, optname, value}
Set the value of the given socket option (see the \UNIX{} manual page