mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

gh-131803: Clarify that you must register signal handlers for set_wakeup_fd (#131859)

Browse source
This commit is contained in:
Jeremy Fleischman 2025-04-14 09:46:11 -07:00 • committed by GitHub
parent 8768df2fe9
commit 939476bbbb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Doc/library/signal.rst
View file

@ -510,10 +510,12 @@ The :mod:`signal` module defines the following functions:
.. function:: set_wakeup_fd(fd, *, warn_on_full_buffer=True)
Set the wakeup file descriptor to *fd*. When a signal is received, the
signal number is written as a single byte into the fd. This can be used by
a library to wakeup a poll or select call, allowing the signal to be fully
processed.
Set the wakeup file descriptor to *fd*. When a signal your program has
registered a signal handler for is received, the signal number is written as
a single byte into the fd. If you haven't registered a signal handler for
the signals you care about, then nothing will be written to the wakeup fd.
This can be used by a library to wakeup a poll or select call, allowing the
signal to be fully processed.
The old wakeup fd is returned (or -1 if file descriptor wakeup was not
enabled). If *fd* is -1, file descriptor wakeup is disabled.