languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-10-06 15:29:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Add os.splice flags argument (#109847)

Browse source 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Blaise Pabon <blaise@gmail.com>
This commit is contained in:
Amin Alaee 2024-07-03 10:10:57 +02:00 committed by GitHub
parent 4232976b02
commit 9d3c9b822c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
Doc/library/os.rst
View file

@ -1724,10 +1724,27 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
Added support for pipes on Windows.
.. function:: splice(src, dst, count, offset_src=None, offset_dst=None)
.. function:: splice(src, dst, count, offset_src=None, offset_dst=None, flags=0)
Transfer *count* bytes from file descriptor *src*, starting from offset
*offset_src*, to file descriptor *dst*, starting from offset *offset_dst*.
The splicing behaviour can be modified by specifying a *flags* value.
Any of the following variables may used, combined using bitwise OR
(the ``|`` operator):
* If :const:`SPLICE_F_MOVE` is specified,
the kernel is asked to move pages instead of copying,
but pages may still be copied if the kernel cannot move the pages from the pipe.
* If :const:`SPLICE_F_NONBLOCK` is specified,
the kernel is asked to not block on I/O.
This makes the splice pipe operations nonblocking,
but splice may nevertheless block because the spliced file descriptors may block.
* If :const:`SPLICE_F_MORE` is specified,
it hints to the kernel that more data will be coming in a subsequent splice.
At least one of the file descriptors must refer to a pipe. If *offset_src*
is ``None``, then *src* is read from the current position; respectively for
*offset_dst*. The offset associated to the file descriptor that refers to a
@ -1746,6 +1763,8 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
make sense to block because there are no writers connected to the write end
of the pipe.
.. seealso:: The :manpage:`splice(2)` man page.
.. availability:: Linux >= 2.6.17 with glibc >= 2.5
.. versionadded:: 3.10