Skip to content

Commit 87a392d

Browse files
bpo-28724: Doc: Move socket.send_fds and socket.recv_fds docs to right section (GH-22608)
(cherry picked from commit 660592f) Co-authored-by: Saiyang Gou <[email protected]>
1 parent d8576b1 commit 87a392d

File tree

2 files changed

+27
-24
lines changed

2 files changed

+27
-24
lines changed

Doc/library/socket.rst

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1139,6 +1139,32 @@ The :mod:`socket` module also offers various network-related services:
11391139
"Interface name" is a name as documented in :func:`if_nameindex`.
11401140

11411141

1142+
.. function:: send_fds(sock, buffers, fds[, flags[, address]])
1143+
1144+
Send the list of file descriptors *fds* over an :const:`AF_UNIX` socket *sock*.
1145+
The *fds* parameter is a sequence of file descriptors.
1146+
Consult :meth:`sendmsg` for the documentation of these parameters.
1147+
1148+
.. availability:: Unix supporting :meth:`~socket.sendmsg` and :const:`SCM_RIGHTS` mechanism.
1149+
1150+
.. versionadded:: 3.9
1151+
1152+
1153+
.. function:: recv_fds(sock, bufsize, maxfds[, flags])
1154+
1155+
Receive up to *maxfds* file descriptors from an :const:`AF_UNIX` socket *sock*.
1156+
Return ``(msg, list(fds), flags, addr)``.
1157+
Consult :meth:`recvmsg` for the documentation of these parameters.
1158+
1159+
.. availability:: Unix supporting :meth:`~socket.recvmsg` and :const:`SCM_RIGHTS` mechanism.
1160+
1161+
.. versionadded:: 3.9
1162+
1163+
.. note::
1164+
1165+
Any truncated integers at the end of the list of file descriptors.
1166+
1167+
11421168
.. _socket-objects:
11431169

11441170
Socket Objects
@@ -1633,29 +1659,6 @@ to sockets.
16331659

16341660
.. versionadded:: 3.6
16351661

1636-
.. method:: socket.send_fds(sock, buffers, fds[, flags[, address]])
1637-
1638-
Send the list of file descriptors *fds* over an :const:`AF_UNIX` socket.
1639-
The *fds* parameter is a sequence of file descriptors.
1640-
Consult :meth:`sendmsg` for the documentation of these parameters.
1641-
1642-
.. availability:: Unix supporting :meth:`~socket.sendmsg` and :const:`SCM_RIGHTS` mechanism.
1643-
1644-
.. versionadded:: 3.9
1645-
1646-
.. method:: socket.recv_fds(sock, bufsize, maxfds[, flags])
1647-
1648-
Receive up to *maxfds* file descriptors. Return ``(msg, list(fds), flags, addr)``. Consult
1649-
:meth:`recvmsg` for the documentation of these parameters.
1650-
1651-
.. availability:: Unix supporting :meth:`~socket.recvmsg` and :const:`SCM_RIGHTS` mechanism.
1652-
1653-
.. versionadded:: 3.9
1654-
1655-
.. note::
1656-
1657-
Any truncated integers at the end of the list of file descriptors.
1658-
16591662
.. method:: socket.sendfile(file, offset=0, count=None)
16601663

16611664
Send a file until EOF is reached by using high-performance

Doc/whatsnew/3.9.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -658,7 +658,7 @@ The socket module now supports the :data:`~socket.CAN_J1939` protocol on
658658
platforms that support it. (Contributed by Karl Ding in :issue:`40291`.)
659659

660660
The socket module now has the :func:`socket.send_fds` and
661-
:func:`socket.recv.fds` methods. (Contributed by Joannah Nanjekye, Shinya
661+
:func:`socket.recv_fds` functions. (Contributed by Joannah Nanjekye, Shinya
662662
Okano and Victor Stinner in :issue:`28724`.)
663663

664664

0 commit comments

Comments
 (0)