event/*Monitor: document as not being thread-safe
This commit is contained in:
parent
af3f483924
commit
e73d0df2b6
@ -38,6 +38,9 @@ class EventLoop;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Defer execution of an event into an #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
|
class DeferredMonitor
|
||||||
#ifdef USE_INTERNAL_EVENTLOOP
|
#ifdef USE_INTERNAL_EVENTLOOP
|
||||||
|
@ -32,6 +32,10 @@ class EventLoop;
|
|||||||
* An event that runs when the EventLoop has become idle, before
|
* An event that runs when the EventLoop has become idle, before
|
||||||
* waiting for more events. This class is not thread-safe; all
|
* waiting for more events. This class is not thread-safe; all
|
||||||
* methods must be run from EventLoop's thread.
|
* 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 {
|
class IdleMonitor {
|
||||||
#ifdef USE_INTERNAL_EVENTLOOP
|
#ifdef USE_INTERNAL_EVENTLOOP
|
||||||
|
@ -50,6 +50,10 @@ class EventLoop;
|
|||||||
* you're interested in, or Cancel() to cancel your subscription. The
|
* you're interested in, or Cancel() to cancel your subscription. The
|
||||||
* #EventLoop will invoke virtual method OnSocketReady() as soon as
|
* #EventLoop will invoke virtual method OnSocketReady() as soon as
|
||||||
* any of the subscribed events are ready.
|
* 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 {
|
class SocketMonitor {
|
||||||
#ifdef USE_GLIB_EVENTLOOP
|
#ifdef USE_GLIB_EVENTLOOP
|
||||||
|
@ -31,6 +31,10 @@ class EventLoop;
|
|||||||
/**
|
/**
|
||||||
* This class monitors a timeout. Use Schedule() to begin the timeout
|
* This class monitors a timeout. Use Schedule() to begin the timeout
|
||||||
* or Cancel() to cancel it.
|
* 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 {
|
class TimeoutMonitor {
|
||||||
#ifdef USE_INTERNAL_EVENTLOOP
|
#ifdef USE_INTERNAL_EVENTLOOP
|
||||||
|
Loading…
Reference in New Issue
Block a user