libUTL++
utl::Semaphore Class Reference

Counter for resources shared between threads. More...

#include <Semaphore.h>

Inheritance diagram for utl::Semaphore:

Public Member Functions

 Semaphore (uint_t count)
 Constructor. More...
 
bool trydown ()
 Try to decrement the count (without blocking). More...
 
void down ()
 Block until count is non-zero and decrement count. More...
 
void up ()
 Increment the count. More...
 
void tryP ()
 Alias for trydown(). More...
 
void P ()
 Alias for down(). More...
 
void V ()
 Alias for up(). 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 ObjectgetKey () const
 Get the key for this object. More...
 
bool hasKey () const
 Determine whether or not the object has a key. More...
 
virtual const ObjectgetProxiedObject () const
 Get the proxied object (= self if none). More...
 
virtual ObjectgetProxiedObject ()
 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 StringgetName () const
 Get the name. More...
 
const StringgetNamePtr () 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 ObjectserializeInNullable (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 ObjectserializeInBoxed (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

Counter for resources shared between threads.

Author
Adam McKee

Definition at line 23 of file Semaphore.h.

Constructor & Destructor Documentation

◆ Semaphore()

utl::Semaphore::Semaphore ( uint_t  count)
inline

Constructor.

Parameters
countinitial counter value

Definition at line 33 of file Semaphore.h.

References utl::init().

Member Function Documentation

◆ trydown()

bool utl::Semaphore::trydown ( )

Try to decrement the count (without blocking).

Returns
true if count decremented, false otherwise

◆ down()

void utl::Semaphore::down ( )

Block until count is non-zero and decrement count.

◆ up()

void utl::Semaphore::up ( )

Increment the count.

◆ tryP()

void utl::Semaphore::tryP ( )
inline

Alias for trydown().

Definition at line 52 of file Semaphore.h.

◆ P()

void utl::Semaphore::P ( )
inline

Alias for down().

Definition at line 59 of file Semaphore.h.

◆ V()

void utl::Semaphore::V ( )
inline

Alias for up().

Definition at line 66 of file Semaphore.h.

References utl::count(), utl::deInit(), and utl::init().


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