Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefWaitableEvent

CefBaseRefCounted
   |
   +--CefWaitableEvent

   in cef_waitable_event.h

class CefWaitableEvent
extends CefBaseRefCounted

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.


Method Summary
 static CefRefPtr< CefWaitableEvent > CreateWaitableEvent( bool automatic_reset, bool initially_signaled )
          Create a new waitable event.
 virtual bool IsSignaled()= 0
          Returns true if the event is in the signaled state, else false.
 virtual void Reset()= 0
          Put the event in the un-signaled state.
 virtual void Signal()= 0
          Put the event in the signaled state.
 virtual bool TimedWait( int64 max_ms )= 0
          Wait up to |max_ms| milliseconds for the event to be signaled.
 virtual void Wait()= 0
          Wait indefinitely for the event to be signaled.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

CreateWaitableEvent

public static CefRefPtr< CefWaitableEvent > CreateWaitableEvent( bool automatic_reset, bool initially_signaled );
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.

IsSignaled

public virtual bool IsSignaled()= 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.

Reset

public virtual void Reset()= 0;
Put the event in the un-signaled state.

Signal

public virtual void Signal()= 0;
Put the event in the signaled state. This causes any thread blocked on Wait to be woken up.

TimedWait

public virtual bool TimedWait( int64 max_ms )= 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

public virtual void Wait()= 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.

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt