summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2010-08-09 20:39:54 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2010-08-09 20:39:54 (GMT)
commit6e451df800af66eefe68ea15938bd65029af06c5 (patch)
tree3a94bf3c48a965f464f1f112d384076103a4676a /Doc/library
parent30e86a47676d2175901af29445aec5bd7967ef76 (diff)
downloadcpython-6e451df800af66eefe68ea15938bd65029af06c5.zip
cpython-6e451df800af66eefe68ea15938bd65029af06c5.tar.gz
cpython-6e451df800af66eefe68ea15938bd65029af06c5.tar.bz2
Followup to r83869 and issue #8524: rename socket.forget() to socket.detach()
and make it return the file descriptor.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/socket.rst17
1 files changed, 9 insertions, 8 deletions
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 2b43266..f340920 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -538,6 +538,15 @@ correspond to Unix system calls applicable to sockets.
connects.
+.. method:: socket.detach()
+
+ Put the socket object into closed state without actually closing the
+ underlying file descriptor. The file descriptor is returned, and can
+ be reused for other purposes.
+
+ .. versionadded:: 3.2
+
+
.. method:: socket.fileno()
Return the socket's file descriptor (a small integer). This is useful with
@@ -548,14 +557,6 @@ correspond to Unix system calls applicable to sockets.
this limitation.
-.. method:: socket.forget()
-
- Put the socket object into closed state without actually closing the
- underlying file descriptor. This allows the latter to be reused.
-
- .. versionadded:: 3.2
-
-
.. method:: socket.getpeername()
Return the remote address to which the socket is connected. This is useful to