SignalEvent Class Reference

#include </home/jenkins/root/workspace/OSVR-Core-Docs/plugins/videobasedtracker/DirectShowCameraLib/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 ()
bool	wait (DWORD milliseconds)
	SignalEvent (SignalEvent const &)=delete
SignalEvent &	operator= (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

Definition at line 45 of file SignalEvent.h.

Member Function Documentation

bool SignalEvent::wait ( )

inline

Wait for the event, infinitely. Returns true if we were, in fact, signalled (should always be true)

Definition at line 64 of file SignalEvent.h.

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)

Definition at line 69 of file SignalEvent.h.

---

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

• plugins/videobasedtracker/DirectShowCameraLib/SignalEvent.h