Add a note about signals to EventDriverCore.processEvents.

This commit is contained in:
Sönke Ludwig 2020-11-26 07:54:38 +01:00
parent 07d5ead617
commit 206d3fa34e

View file

@ -85,6 +85,12 @@ interface EventDriverCore {
in the event queue. The function will return after either the specified in the event queue. The function will return after either the specified
timeout has elapsed, or once the event queue has been fully emptied. timeout has elapsed, or once the event queue has been fully emptied.
On implementations that support it, the function will treat
interruptions by POSIX signals as if an event was received and will
cause it to return. However, note that it is generally recommended to
use `EventDriverSignals` instead of raw signal handlers in order to
avoid their pitfalls as far as possible.
Params: Params:
timeout = Maximum amount of time to wait for an event. A duration of timeout = Maximum amount of time to wait for an event. A duration of
zero will cause the function to only process pending events. A zero will cause the function to only process pending events. A