[Python-checkins] CVS: python/dist/src/Doc/lib libsocket.tex,1.58,1.58.6.1
Fred L. Drake
fdrake@users.sourceforge.net
Thu, 27 Dec 2001 20:42:12 -0800
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv6305/lib
Modified Files:
Tag: release22-maint
libsocket.tex
Log Message:
Add note that fromfd() is Unix-specific.
This fixes SF bug #495896.
Fix up various markup consistency & style guide conformance nits.
Index: libsocket.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libsocket.tex,v
retrieving revision 1.58
retrieving revision 1.58.6.1
diff -C2 -d -r1.58 -r1.58.6.1
*** libsocket.tex 2001/12/05 05:25:59 1.58
--- libsocket.tex 2001/12/28 04:42:10 1.58.6.1
***************
*** 91,110 ****
\begin{excdesc}{herror}
This exception is raised for address-related errors, i.e. for
! functions that use \var{h_errno} in C API, including
! \function{gethostbyname_ex} and \function{gethostbyaddr}.
The accompanying value is a pair \code{(\var{h_errno}, \var{string})}
representing an error returned by a library call. \var{string}
represents the description of \var{h_errno}, as returned by
! \cfunction{hstrerror} C API.
\end{excdesc}
\begin{excdesc}{gaierror}
This exception is raised for address-related errors, for
! \function{getaddrinfo} and \function{getnameinfo}.
The accompanying value is a pair \code{(\var{error}, \var{string})}
representing an error returned by a library call.
\var{string} represents the description of \var{error}, as returned
! by \cfunction{gai_strerror} C API.
\end{excdesc}
--- 91,110 ----
\begin{excdesc}{herror}
This exception is raised for address-related errors, i.e. for
! functions that use \var{h_errno} in the C API, including
! \function{gethostbyname_ex()} and \function{gethostbyaddr()}.
The accompanying value is a pair \code{(\var{h_errno}, \var{string})}
representing an error returned by a library call. \var{string}
represents the description of \var{h_errno}, as returned by
! the \cfunction{hstrerror()} C function.
\end{excdesc}
\begin{excdesc}{gaierror}
This exception is raised for address-related errors, for
! \function{getaddrinfo()} and \function{getnameinfo()}.
The accompanying value is a pair \code{(\var{error}, \var{string})}
representing an error returned by a library call.
\var{string} represents the description of \var{error}, as returned
! by the \cfunction{gai_strerror()} C function.
\end{excdesc}
***************
*** 141,144 ****
--- 141,145 ----
\dataline{AI_*}
\dataline{NI_*}
+ \dataline{TCP_*}
Many constants of these forms, documented in the \UNIX{} documentation on
sockets and/or the IP protocol, are also defined in the socket module.
***************
*** 190,194 ****
\begin{funcdesc}{gethostbyname}{hostname}
Translate a host name to IPv4 address format. The IPv4 address is
! returned as a string, e.g., \code{'100.50.200.5'}. If the host name
is an IPv4 address itself it is returned unchanged. See
\function{gethostbyname_ex()} for a more complete interface.
--- 191,195 ----
\begin{funcdesc}{gethostbyname}{hostname}
Translate a host name to IPv4 address format. The IPv4 address is
! returned as a string, such as \code{'100.50.200.5'}. If the host name
is an IPv4 address itself it is returned unchanged. See
\function{gethostbyname_ex()} for a more complete interface.
***************
*** 244,248 ****
\begin{funcdesc}{getprotobyname}{protocolname}
! Translate an Internet protocol name (e.g.\ \code{'icmp'}) to a constant
suitable for passing as the (optional) third argument to the
\function{socket()} function. This is usually only needed for sockets
--- 245,249 ----
\begin{funcdesc}{getprotobyname}{protocolname}
! Translate an Internet protocol name (for example, \code{'icmp'}) to a constant
suitable for passing as the (optional) third argument to the
\function{socket()} function. This is usually only needed for sockets
***************
*** 283,288 ****
descriptor is invalid. This function is rarely needed, but can be
used to get or set socket options on a socket passed to a program as
! standard input or output (e.g.\ a server started by the \UNIX{} inet
daemon).
\end{funcdesc}
--- 284,290 ----
descriptor is invalid. This function is rarely needed, but can be
used to get or set socket options on a socket passed to a program as
! standard input or output (such as a server started by the \UNIX{} inet
daemon).
+ Availability: \UNIX.
\end{funcdesc}
***************
*** 312,317 ****
\begin{funcdesc}{inet_aton}{ip_string}
! Convert an IPv4 address from dotted-quad string format
! (e.g.\ '123.45.67.89') to 32-bit packed binary format, as a string four
characters in length.
--- 314,319 ----
\begin{funcdesc}{inet_aton}{ip_string}
! Convert an IPv4 address from dotted-quad string format (for example,
! '123.45.67.89') to 32-bit packed binary format, as a string four
characters in length.
***************
*** 325,330 ****
\cfunction{inet_aton()}.
! \function{inet_aton} does not support IPv6, and
! \function{getnameinfo()} should be used instead for IPv4/v6 dual stack support.
\end{funcdesc}
--- 327,333 ----
\cfunction{inet_aton()}.
! \function{inet_aton()} does not support IPv6, and
! \function{getnameinfo()} should be used instead for IPv4/v6 dual stack
! support.
\end{funcdesc}
***************
*** 332,336 ****
Convert a 32-bit packed IPv4 address (a string four characters in
length) to its standard dotted-quad string representation
! (e.g. '123.45.67.89').
Useful when conversing with a program that uses the standard C library
--- 335,339 ----
Convert a 32-bit packed IPv4 address (a string four characters in
length) to its standard dotted-quad string representation
! (for example, '123.45.67.89').
Useful when conversing with a program that uses the standard C library
***************
*** 341,346 ****
length, \exception{socket.error} will be raised.
! \function{inet_ntoa} does not support IPv6, and
! \function{getnameinfo()} should be used instead for IPv4/v6 dual stack support.
\end{funcdesc}
--- 344,350 ----
length, \exception{socket.error} will be raised.
! \function{inet_ntoa()} does not support IPv6, and
! \function{getnameinfo()} should be used instead for IPv4/v6 dual stack
! support.
\end{funcdesc}
***************
*** 401,405 ****
can still raise exceptions). The error indicator is \code{0} if the
operation succeeded, otherwise the value of the \cdata{errno}
! variable. This is useful, e.g., for asynchronous connects.
\note{This method has historically accepted a pair of
parameters for \constant{AF_INET} addresses instead of only a tuple.
--- 405,409 ----
can still raise exceptions). The error indicator is \code{0} if the
operation succeeded, otherwise the value of the \cdata{errno}
! variable. This is useful to support, for example, asynchronous connects.
\note{This method has historically accepted a pair of
parameters for \constant{AF_INET} addresses instead of only a tuple.