MPMA::BlockingObject Class Reference

An object that can be used to block a thread until another thread signals it to resume. More...

#include <Locks.h>

List of all members.

Public Member Functions

void Clear ()

Marks the object as cleared, so nothing is blocking on it.

void Set ()

Marks the object as set, so BlockUntilClear will block on it.

bool WaitUntilClear (bool setOnReturn=false, uint timeToWait=0xffffffff)

Blocks and waits for as long as the object is set (or if time is non-max, then until that many milliseconds pass). Returns false only on timeout. If setOnReturn is true, the object will be Set() when the function returns. Only 1 thread should block on this, though any number may set or clear it.

Detailed Description

An object that can be used to block a thread until another thread signals it to resume.

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

base/Locks.h
base/linux/Locks.cpp
base/win32/LocksWin32.cpp


Public Member Functions
void	Clear ()
	Marks the object as cleared, so nothing is blocking on it.
void	Set ()
	Marks the object as set, so BlockUntilClear will block on it.
bool	WaitUntilClear (bool setOnReturn=false, uint timeToWait=0xffffffff)
	Blocks and waits for as long as the object is set (or if time is non-max, then until that many milliseconds pass). Returns false only on timeout. If setOnReturn is true, the object will be Set() when the function returns. Only 1 thread should block on this, though any number may set or clear it.