summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libsocket.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-04-04 17:48:30 (GMT)
committerFred Drake <fdrake@acm.org>2000-04-04 17:48:30 (GMT)
commit7d68690d8d8a3207c9432b38df58d2ebdd54d9da (patch)
tree6166f6506eaf97989a07c2db12fbdf37c91f6eb1 /Doc/lib/libsocket.tex
parentb49dc75f514cc5d81489fe4c9d90097245c2ac77 (diff)
downloadcpython-7d68690d8d8a3207c9432b38df58d2ebdd54d9da.zip
cpython-7d68690d8d8a3207c9432b38df58d2ebdd54d9da.tar.gz
cpython-7d68690d8d8a3207c9432b38df58d2ebdd54d9da.tar.bz2
Added notes about the eventual disappearance of two-parameter bind(),
connect(), and connect_ex(). I didn't make these deprecation notices since it was never a documented feature.
Diffstat (limited to 'Doc/lib/libsocket.tex')
-rw-r--r--Doc/lib/libsocket.tex15
1 files changed, 13 insertions, 2 deletions
diff --git a/Doc/lib/libsocket.tex b/Doc/lib/libsocket.tex
index bcbb76f..c845615 100644
--- a/Doc/lib/libsocket.tex
+++ b/Doc/lib/libsocket.tex
@@ -247,7 +247,11 @@ to the socket on the other end of the connection.
\begin{methoddesc}[socket]{bind}{address}
Bind the socket to \var{address}. The socket must not already be bound.
-(The format of \var{address} depends on the address family --- see above.)
+(The format of \var{address} depends on the address family --- see
+above.) \strong{Note:} This method has historically accepted a pair
+of parameters for \constant{AF_INET} addresses instead of only a
+tuple. This was never intentional and will no longer be available in
+Python 1.7.
\end{methoddesc}
\begin{methoddesc}[socket]{close}{}
@@ -259,7 +263,10 @@ Sockets are automatically closed when they are garbage-collected.
\begin{methoddesc}[socket]{connect}{address}
Connect to a remote socket at \var{address}.
(The format of \var{address} depends on the address family --- see
-above.)
+above.) \strong{Note:} This method has historically accepted a pair
+of parameters for \constant{AF_INET} addresses instead of only a
+tuple. This was never intentional and will no longer be available in
+Python 1.7.
\end{methoddesc}
\begin{methoddesc}[socket]{connect_ex}{address}
@@ -269,6 +276,10 @@ instead of raising an exception for errors returned by the C-level
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.
+\strong{Note:} This method has historically accepted a pair of
+parameters for \constant{AF_INET} addresses instead of only a tuple.
+This was never intentional and will no longer be available in Python
+1.7.
\end{methoddesc}
\begin{methoddesc}[socket]{fileno}{}