Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-28724: Doc: Move socket.send_fds and socket.recv_fds docs to right section (GH-22608)

This commit is contained in:
Saiyang Gou 2021-04-21 21:08:46 -07:00 committed by GitHub
parent 37b173c523
commit 660592f67c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
Doc/library/socket.rst
View File

@ -1143,6 +1143,32 @@ The :mod:`socket` module also offers various network-related services:
"Interface name" is a name as documented in :func:`if_nameindex`.
.. function:: send_fds(sock, buffers, fds[, flags[, address]])
Send the list of file descriptors *fds* over an :const:`AF_UNIX` socket *sock*.
The *fds* parameter is a sequence of file descriptors.
Consult :meth:`sendmsg` for the documentation of these parameters.
.. availability:: Unix supporting :meth:`~socket.sendmsg` and :const:`SCM_RIGHTS` mechanism.
.. versionadded:: 3.9
.. function:: recv_fds(sock, bufsize, maxfds[, flags])
Receive up to *maxfds* file descriptors from an :const:`AF_UNIX` socket *sock*.
Return ``(msg, list(fds), flags, addr)``.
Consult :meth:`recvmsg` for the documentation of these parameters.
.. availability:: Unix supporting :meth:`~socket.recvmsg` and :const:`SCM_RIGHTS` mechanism.
.. versionadded:: 3.9
.. note::
Any truncated integers at the end of the list of file descriptors.
.. _socket-objects:
Socket Objects
@ -1637,29 +1663,6 @@ to sockets.
.. versionadded:: 3.6
.. method:: socket.send_fds(sock, buffers, fds[, flags[, address]])
Send the list of file descriptors *fds* over an :const:`AF_UNIX` socket.
The *fds* parameter is a sequence of file descriptors.
Consult :meth:`sendmsg` for the documentation of these parameters.
.. availability:: Unix supporting :meth:`~socket.sendmsg` and :const:`SCM_RIGHTS` mechanism.
.. versionadded:: 3.9
.. method:: socket.recv_fds(sock, bufsize, maxfds[, flags])
Receive up to *maxfds* file descriptors. Return ``(msg, list(fds), flags, addr)``. Consult
:meth:`recvmsg` for the documentation of these parameters.
.. availability:: Unix supporting :meth:`~socket.recvmsg` and :const:`SCM_RIGHTS` mechanism.
.. versionadded:: 3.9
.. note::
Any truncated integers at the end of the list of file descriptors.
.. method:: socket.sendfile(file, offset=0, count=None)
Send a file until EOF is reached by using high-performance

2
Doc/whatsnew/3.9.rst
View File

@ -658,7 +658,7 @@ The socket module now supports the :data:`~socket.CAN_J1939` protocol on
platforms that support it. (Contributed by Karl Ding in :issue:`40291`.)
The socket module now has the :func:`socket.send_fds` and
:func:`socket.recv.fds` methods. (Contributed by Joannah Nanjekye, Shinya
:func:`socket.recv_fds` functions. (Contributed by Joannah Nanjekye, Shinya
Okano and Victor Stinner in :issue:`28724`.)