Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 14, 2025
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions Doc/library/signal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading