OSVR-Core
Public Member Functions | List of all members
SignalEvent Class Reference

Handy little low-level sync primitive An automatic reset event restores to "un-signalled" after releasing one thread, while a manual reset event must be manually reset. More...

#include <SignalEvent.h>

Public Member Functions

 SignalEvent (bool manual=false)
 Constructor.
 
 ~SignalEvent ()
 Destructor.
 
void set ()
 Set or signal the event.
 
void clear ()
 Un-signal the event (not usually necessary for auto=reset events)
 
bool wait ()
 Wait for the event, infinitely. More...
 
bool wait (DWORD milliseconds)
 Wait for the event, with a timeout. More...
 
 SignalEvent (SignalEvent const &)=delete
 
SignalEventoperator= (SignalEvent const &)=delete
 

Detailed Description

Handy little low-level sync primitive An automatic reset event restores to "un-signalled" after releasing one thread, while a manual reset event must be manually reset.

inspired by https://msdn.microsoft.com/en-us/magazine/jj721588.aspx

Member Function Documentation

§ wait() [1/2]

bool SignalEvent::wait ( )
inline

Wait for the event, infinitely.

Returns true if we were, in fact, signalled (should always be true)

§ wait() [2/2]

bool SignalEvent::wait ( DWORD  milliseconds)
inline

Wait for the event, with a timeout.

Returns true if we were, in fact, signalled (false if we hit our timeout)


The documentation for this class was generated from the following file: