Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Fix some markup errors and adjust wording slightly.

This commit is contained in:
Fred Drake 2002-06-06 21:57:48 +00:00
parent be946bfea7
commit 6c6d662760
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Doc/lib/libsocket.tex
View File

@ -515,27 +515,27 @@ block until they can proceed.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[socket]{settimeout}{value} \begin{methoddesc}[socket]{settimeout}{value}
Set a timeout on blocking socket operations. Value can be any numeric value Set a timeout on blocking socket operations. Value can be any numeric
or \var{None}. Socket operations will raise an \exception{error} exception value or \code{None}. Socket operations will raise an
if the timeout period \var{value} has elapsed before the operation has \exception{error} exception if the timeout period \var{value} has
completed. Setting a timeout of \var{None} disables timeouts on socket elapsed before the operation has completed. Setting a timeout of
operations. \code{None} disables timeouts on socket operations.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[socket]{gettimeout}{} \begin{methoddesc}[socket]{gettimeout}{}
Returns the timeout in floating seconds associated with socket operations. Returns the timeout in floating seconds associated with socket
A timeout of None indicates that timeouts on socket operations are operations. A timeout of \code{None} indicates that timeouts on
disabled. socket operations are disabled.
\end{methoddesc} \end{methoddesc}
Some notes on the interaction between socket blocking and timeouts: Some notes on the interaction between socket blocking and timeouts:
socket blocking mode takes precendence over timeouts. If a socket socket blocking mode takes precendence over timeouts. If a socket if
if set to non-blocking mode, then timeouts set on sockets are never set to non-blocking mode, then timeouts set on sockets are not used.
don't mean anything. The timeout value associated with the socket The timeout value associated with the socket can still be set using
can still be set via settimeout and its value retrieved via gettimeout, \method{settimeout()} and its value retrieved using
but the timeout is never enforced (i.e, an exception will never be \method{gettimeout()}, but the timeout is never enforced (an exception
thrown). Otherwise, if the socket is in blocking mode, setting the will never be thrown). Otherwise, if the socket is in blocking mode,
timeout will raise an exception as expected. setting the timeout will raise an exception as expected.
\begin{methoddesc}[socket]{setsockopt}{level, optname, value} \begin{methoddesc}[socket]{setsockopt}{level, optname, value}
Set the value of the given socket option (see the \UNIX{} manual page Set the value of the given socket option (see the \UNIX{} manual page