utl::ConditionVar Class Reference
Condition variable. More...
#include <ConditionVar.h>
Inheritance diagram for utl::ConditionVar:
Public Member Functions | |
| void | broadcast () |
| Wake up all waiting threads. More... | |
| void | signal () |
| Wake up a single waiting thread. More... | |
| void | wait () |
| Atomically unlock the mutex and wait for the predicate to be satisfied. | |
| void | lockMutex () |
| Lock the associated Mutex. More... | |
| void | unlockMutex () |
| Unlock the associated Mutex. More... | |
 Public Member Functions inherited from utl::Object | |
| void | clear () |
| Revert to initial state. More... | |
| virtual int | compare (const Object &rhs) const |
| Compare with another object. More... | |
| virtual void | copy (const Object &rhs) |
| Copy another instance. More... | |
| virtual void | vclone (const Object &rhs) |
| Make an exact copy of another instance. More... | |
| virtual void | steal (Object &rhs) |
| "Steal" the internal representation from another instance. More... | |
| virtual void | dump (Stream &os, uint_t level=uint_t_max) const |
| Dump a human-readable representation of self to the given output stream. More... | |
| void | dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const |
| Front-end for dump() that prints the object's class name. More... | |
| virtual const Object & | getKey () const |
| Get the key for this object. More... | |
| bool | hasKey () const |
| Determine whether or not the object has a key. More... | |
| virtual const Object & | getProxiedObject () const |
| Get the proxied object (= self if none). More... | |
| virtual Object & | getProxiedObject () |
| Get the proxied object (= self if none). More... | |
| virtual size_t | hash (size_t size) const |
| Get the hash code for the object. More... | |
| bool | _isA (const RunTimeClass *runTimeClass) const |
| Determine whether self's class is a descendent of the given class. More... | |
| virtual String | toString () const |
| Return a string representation of self. More... | |
| operator String () const | |
| Conversion to String. More... | |
| size_t | allocatedSize () const |
| Get the total allocated size of this object. More... | |
| virtual size_t | innerAllocatedSize () const |
| Get the "inner" allocated size. More... | |
| virtual void | addOwnedIt (const class FwdIt *it) const |
| Notify self that it owns the given iterator. More... | |
| virtual void | removeOwnedIt (const class FwdIt *it) const |
| Notify self that the given owned iterator has been destroyed. More... | |
| bool | operator< (const Object &rhs) const |
| Less-than operator. More... | |
| bool | operator<= (const Object &rhs) const |
| Less-than-or-equal-to operator. More... | |
| bool | operator> (const Object &rhs) const |
| Greater-than operator. More... | |
| bool | operator>= (const Object &rhs) const |
| Greater-than-or-equal-to operator. More... | |
| bool | operator== (const Object &rhs) const |
| Equal-to operator. More... | |
| bool | operator!= (const Object &rhs) const |
| Unequal-to operator. More... | |
| void | serializeIn (Stream &is, uint_t mode=ser_default) |
| Serialize from an input stream. More... | |
| void | serializeOut (Stream &os, uint_t mode=ser_default) const |
| Serialize to an output stream. More... | |
| virtual void | serialize (Stream &stream, uint_t io, uint_t mode=ser_default) |
| Serialize to or from a stream. More... | |
| void | serializeOutBoxed (Stream &os, uint_t mode=ser_default) const |
| Serialize a boxed object to an output stream. More... | |
| Public Member Functions inherited from utl::NamedObjectMI | |
| NamedObjectMI () | |
| Constructor. | |
| NamedObjectMI (const String &name) | |
| Constructor. More... | |
| void | clear () |
| Clear the name. More... | |
| const String & | getName () const |
| Get the name. More... | |
| const String * | getNamePtr () const |
| Get the address of the name. More... | |
| void | setName (const String &name) |
| Set the name. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from utl::Object | |
| static Object * | serializeInNullable (Stream &is, uint_t mode=ser_default) |
| Serialize a nullptr-able object from an input stream. More... | |
| static void | serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default) |
| Serialize a nullptr-able object to an output stream. More... | |
| static void | serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default) |
| Serialize a nullptr-able object to or from a stream. More... | |
| static Object * | serializeInBoxed (Stream &is, uint_t mode=ser_default) |
| Serialize a boxed object from an input stream. More... | |
| static void | serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default) |
| Serialize a boxed object to or from a stream. More... | |
Detailed Description
Condition variable.
ConditionVar is a synchronization device that allows a thread to block until a predicate is satisfied. It has an associated Mutex which is used to prevent the race condition where one thread calls wait() while another thread simultaneously calls broadcast() or signal(). If all threads always acquire the mutex before signaling the condition, this guarantees that the condition cannot be signaled (and thus ignored) between the time a thread locks the mutex and the time it waits on the condition variable.
Definition at line 30 of file ConditionVar.h.
Member Function Documentation
◆ broadcast()
| void utl::ConditionVar::broadcast | ( | ) |
Wake up all waiting threads.
◆ signal()
| void utl::ConditionVar::signal | ( | ) |
Wake up a single waiting thread.
◆ lockMutex()
| void utl::ConditionVar::lockMutex | ( | ) |
Lock the associated Mutex.
◆ unlockMutex()
| void utl::ConditionVar::unlockMutex | ( | ) |
Unlock the associated Mutex.
The documentation for this class was generated from the following file:
