Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 6c6d662

Browse files
committed
Fix some markup errors and adjust wording slightly.
1 parent be946bf commit 6c6d662

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

Doc/lib/libsocket.tex

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -515,27 +515,27 @@ \subsection{Socket Objects \label{socket-objects}}
515515
\end{methoddesc}
516516

517517
\begin{methoddesc}[socket]{settimeout}{value}
518-
Set a timeout on blocking socket operations. Value can be any numeric value
519-
or \var{None}. Socket operations will raise an \exception{error} exception
520-
if the timeout period \var{value} has elapsed before the operation has
521-
completed. Setting a timeout of \var{None} disables timeouts on socket
522-
operations.
518+
Set a timeout on blocking socket operations. Value can be any numeric
519+
value or \code{None}. Socket operations will raise an
520+
\exception{error} exception if the timeout period \var{value} has
521+
elapsed before the operation has completed. Setting a timeout of
522+
\code{None} disables timeouts on socket operations.
523523
\end{methoddesc}
524524

525525
\begin{methoddesc}[socket]{gettimeout}{}
526-
Returns the timeout in floating seconds associated with socket operations.
527-
A timeout of None indicates that timeouts on socket operations are
528-
disabled.
526+
Returns the timeout in floating seconds associated with socket
527+
operations. A timeout of \code{None} indicates that timeouts on
528+
socket operations are disabled.
529529
\end{methoddesc}
530530

531531
Some notes on the interaction between socket blocking and timeouts:
532-
socket blocking mode takes precendence over timeouts. If a socket
533-
if set to non-blocking mode, then timeouts set on sockets are never
534-
don't mean anything. The timeout value associated with the socket
535-
can still be set via settimeout and its value retrieved via gettimeout,
536-
but the timeout is never enforced (i.e, an exception will never be
537-
thrown). Otherwise, if the socket is in blocking mode, setting the
538-
timeout will raise an exception as expected.
532+
socket blocking mode takes precendence over timeouts. If a socket if
533+
set to non-blocking mode, then timeouts set on sockets are not used.
534+
The timeout value associated with the socket can still be set using
535+
\method{settimeout()} and its value retrieved using
536+
\method{gettimeout()}, but the timeout is never enforced (an exception
537+
will never be thrown). Otherwise, if the socket is in blocking mode,
538+
setting the timeout will raise an exception as expected.
539539

540540
\begin{methoddesc}[socket]{setsockopt}{level, optname, value}
541541
Set the value of the given socket option (see the \UNIX{} manual page

0 commit comments

Comments
 (0)