diff options
author | Max Kellermann <max@duempel.org> | 2013-12-31 15:13:22 +0100 |
---|---|---|
committer | Max Kellermann <max@duempel.org> | 2013-12-31 15:59:41 +0100 |
commit | e73d0df2b6c30d5b6242ef2adead59171f024452 (patch) | |
tree | 5dded7eb30bcd33138a6124efc49c5dff22baeda | |
parent | af3f483924b0b2b936f3b9e81e6bb4f215404c7e (diff) |
event/*Monitor: document as not being thread-safe
-rw-r--r-- | src/event/DeferredMonitor.hxx | 3 | ||||
-rw-r--r-- | src/event/IdleMonitor.hxx | 4 | ||||
-rw-r--r-- | src/event/SocketMonitor.hxx | 4 | ||||
-rw-r--r-- | src/event/TimeoutMonitor.hxx | 4 |
4 files changed, 15 insertions, 0 deletions
diff --git a/src/event/DeferredMonitor.hxx b/src/event/DeferredMonitor.hxx index d4c812e44..96ad5e282 100644 --- a/src/event/DeferredMonitor.hxx +++ b/src/event/DeferredMonitor.hxx @@ -38,6 +38,9 @@ class EventLoop; /** * Defer execution of an event into an #EventLoop. + * + * This class is thread-safe, however the constructor must be called + * from the thread that runs the #EventLoop */ class DeferredMonitor #ifdef USE_INTERNAL_EVENTLOOP diff --git a/src/event/IdleMonitor.hxx b/src/event/IdleMonitor.hxx index b040915e7..6f7365532 100644 --- a/src/event/IdleMonitor.hxx +++ b/src/event/IdleMonitor.hxx @@ -32,6 +32,10 @@ class EventLoop; * An event that runs when the EventLoop has become idle, before * waiting for more events. This class is not thread-safe; all * methods must be run from EventLoop's thread. + * + * This class is not thread-safe, all methods must be called from the + * thread that runs the #EventLoop, except where explicitly documented + * as thread-safe. */ class IdleMonitor { #ifdef USE_INTERNAL_EVENTLOOP diff --git a/src/event/SocketMonitor.hxx b/src/event/SocketMonitor.hxx index f6aac2bd6..768f21c57 100644 --- a/src/event/SocketMonitor.hxx +++ b/src/event/SocketMonitor.hxx @@ -50,6 +50,10 @@ class EventLoop; * you're interested in, or Cancel() to cancel your subscription. The * #EventLoop will invoke virtual method OnSocketReady() as soon as * any of the subscribed events are ready. + * + * This class is not thread-safe, all methods must be called from the + * thread that runs the #EventLoop, except where explicitly documented + * as thread-safe. */ class SocketMonitor { #ifdef USE_GLIB_EVENTLOOP diff --git a/src/event/TimeoutMonitor.hxx b/src/event/TimeoutMonitor.hxx index 568aa27ef..9f6b19bc7 100644 --- a/src/event/TimeoutMonitor.hxx +++ b/src/event/TimeoutMonitor.hxx @@ -31,6 +31,10 @@ class EventLoop; /** * This class monitors a timeout. Use Schedule() to begin the timeout * or Cancel() to cancel it. + * + * This class is not thread-safe, all methods must be called from the + * thread that runs the #EventLoop, except where explicitly documented + * as thread-safe. */ class TimeoutMonitor { #ifdef USE_INTERNAL_EVENTLOOP |