diff options
| author | William A. Kennington III <wak@google.com> | 2018-09-26 14:25:22 -0700 |
|---|---|---|
| committer | William A. Kennington III <wak@google.com> | 2018-09-26 14:26:55 -0700 |
| commit | c07ddb5ad6179eda358b3bb5362609b65eafd108 (patch) | |
| tree | 5acca6d7fb3d0b539af260a333de8c4e72a5657a | |
| parent | ba04ffb5a94fd47d8acc57c7a6be4d31624d2c23 (diff) | |
| download | sdeventplus-c07ddb5ad6179eda358b3bb5362609b65eafd108.tar.gz sdeventplus-c07ddb5ad6179eda358b3bb5362609b65eafd108.zip | |
source/signal: Clarify signal bocking during construction
Blocking signals is a potentially unexpected requirement of the user
prior to constructing a signal source. Clarify this requirement base on
guidance from the sd_event_add_signal(3) docs.
Change-Id: I34335f1882acbf54a3219324e4e23e803a763365
Signed-off-by: William A. Kennington III <wak@google.com>
| -rw-r--r-- | src/sdeventplus/source/signal.hpp | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/sdeventplus/source/signal.hpp b/src/sdeventplus/source/signal.hpp index 50bafa6..d5d9b5a 100644 --- a/src/sdeventplus/source/signal.hpp +++ b/src/sdeventplus/source/signal.hpp @@ -23,7 +23,8 @@ class Signal : public Base /** @brief Creates a new signal event source on the provided event loop * This type of source defaults to Enabled::On, executing the - * callback for each signal observed. + * callback for each signal observed. You are required to block + * the signal in all threads prior to creating this source. * * @param[in] event - The event to attach the handler * @param[in] sig - Signum to watch, see signal(7) |
