mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
Update include/ comments to Doxygen formatting (see issue #3384)
See related guidelines in the issue.
This commit is contained in:
@ -41,25 +41,25 @@
|
||||
#include "include/cef_base.h"
|
||||
|
||||
///
|
||||
// WaitableEvent is a thread synchronization tool that allows one thread to wait
|
||||
// for another thread to finish some work. This is equivalent to using a
|
||||
// Lock+ConditionVariable to protect a simple boolean value. However, using
|
||||
// WaitableEvent in conjunction with a Lock to wait for a more complex state
|
||||
// change (e.g., for an item to be added to a queue) is not recommended. In that
|
||||
// case consider using a ConditionVariable instead of a WaitableEvent. It is
|
||||
// safe to create and/or signal a WaitableEvent from any thread. Blocking on a
|
||||
// WaitableEvent by calling the *Wait() methods is not allowed on the browser
|
||||
// process UI or IO threads.
|
||||
/// WaitableEvent is a thread synchronization tool that allows one thread to
|
||||
/// wait for another thread to finish some work. This is equivalent to using a
|
||||
/// Lock+ConditionVariable to protect a simple boolean value. However, using
|
||||
/// WaitableEvent in conjunction with a Lock to wait for a more complex state
|
||||
/// change (e.g., for an item to be added to a queue) is not recommended. In
|
||||
/// that case consider using a ConditionVariable instead of a WaitableEvent. It
|
||||
/// is safe to create and/or signal a WaitableEvent from any thread. Blocking on
|
||||
/// a WaitableEvent by calling the *Wait() methods is not allowed on the browser
|
||||
/// process UI or IO threads.
|
||||
///
|
||||
/*--cef(source=library)--*/
|
||||
class CefWaitableEvent : public CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Create a new waitable event. If |automatic_reset| is true then the event
|
||||
// state is automatically reset to un-signaled after a single waiting thread
|
||||
// has been released; otherwise, the state remains signaled until Reset() is
|
||||
// called manually. If |initially_signaled| is true then the event will start
|
||||
// in the signaled state.
|
||||
/// Create a new waitable event. If |automatic_reset| is true then the event
|
||||
/// state is automatically reset to un-signaled after a single waiting thread
|
||||
/// has been released; otherwise, the state remains signaled until Reset() is
|
||||
/// called manually. If |initially_signaled| is true then the event will start
|
||||
/// in the signaled state.
|
||||
///
|
||||
/*--cef()--*/
|
||||
static CefRefPtr<CefWaitableEvent> CreateWaitableEvent(
|
||||
@ -67,40 +67,40 @@ class CefWaitableEvent : public CefBaseRefCounted {
|
||||
bool initially_signaled);
|
||||
|
||||
///
|
||||
// Put the event in the un-signaled state.
|
||||
/// Put the event in the un-signaled state.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void Reset() = 0;
|
||||
|
||||
///
|
||||
// Put the event in the signaled state. This causes any thread blocked on Wait
|
||||
// to be woken up.
|
||||
/// Put the event in the signaled state. This causes any thread blocked on
|
||||
/// Wait to be woken up.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void Signal() = 0;
|
||||
|
||||
///
|
||||
// Returns true if the event is in the signaled state, else false. If the
|
||||
// event was created with |automatic_reset| set to true then calling this
|
||||
// method will also cause a reset.
|
||||
/// Returns true if the event is in the signaled state, else false. If the
|
||||
/// event was created with |automatic_reset| set to true then calling this
|
||||
/// method will also cause a reset.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool IsSignaled() = 0;
|
||||
|
||||
///
|
||||
// Wait indefinitely for the event to be signaled. This method will not return
|
||||
// until after the call to Signal() has completed. This method cannot be
|
||||
// called on the browser process UI or IO threads.
|
||||
/// Wait indefinitely for the event to be signaled. This method will not
|
||||
/// return until after the call to Signal() has completed. This method cannot
|
||||
/// be called on the browser process UI or IO threads.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void Wait() = 0;
|
||||
|
||||
///
|
||||
// Wait up to |max_ms| milliseconds for the event to be signaled. Returns true
|
||||
// if the event was signaled. A return value of false does not necessarily
|
||||
// mean that |max_ms| was exceeded. This method will not return until after
|
||||
// the call to Signal() has completed. This method cannot be called on the
|
||||
// browser process UI or IO threads.
|
||||
/// Wait up to |max_ms| milliseconds for the event to be signaled. Returns
|
||||
/// true if the event was signaled. A return value of false does not
|
||||
/// necessarily mean that |max_ms| was exceeded. This method will not return
|
||||
/// until after the call to Signal() has completed. This method cannot be
|
||||
/// called on the browser process UI or IO threads.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool TimedWait(int64 max_ms) = 0;
|
||||
|
Reference in New Issue
Block a user