From 206d3fa34e932efdcde846cab48fdc6a361b3a2a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6nke=20Ludwig?= Date: Thu, 26 Nov 2020 07:54:38 +0100 Subject: [PATCH] Add a note about signals to EventDriverCore.processEvents. --- source/eventcore/driver.d | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/eventcore/driver.d b/source/eventcore/driver.d index 89da18c..00f1916 100644 --- a/source/eventcore/driver.d +++ b/source/eventcore/driver.d @@ -85,6 +85,12 @@ interface EventDriverCore { in the event queue. The function will return after either the specified 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: timeout = Maximum amount of time to wait for an event. A duration of zero will cause the function to only process pending events. A