UCommon
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
ucommon::Semaphore Class Reference

A portable counting semaphore class. More...

#include <thread.h>

Inheritance diagram for ucommon::Semaphore:
Inheritance graph
[legend]
Collaboration diagram for ucommon::Semaphore:
Collaboration graph
[legend]

Public Member Functions

unsigned getCount (void)
 Get active semaphore limit.
unsigned getUsed (void)
 Get current semaphore usage.
void operator++ (void)
 Convenience operator to wait on a counting semaphore.
void operator-- (void)
 Convenience operator to release a counting semaphore.
void release (void)
 Release the semaphore after waiting for it.
 Semaphore (unsigned count=0)
 Construct a semaphore with an initial count of threads to permit.
void set (unsigned count)
 Alter semaphore limit at runtime.
bool wait (timeout_t timeout)
 Wait until the semphore usage count is less than the thread limit.
void wait (void)
 Wait until the semphore usage count is less than the thread limit.

Static Public Member Functions

static void release (Semaphore &sync)
 Convenience class to release a semaphore.
static void wait (Semaphore &sync)
 Convenience class to wait on a semaphore.
static bool wait (Semaphore &sync, timeout_t timeout)
 Convenience class to wait on a semaphore.

Protected Member Functions

void Shlock (void)
 Protocol interface to share lock the object.
void Unlock (void)
 Protocol interface to release a lock.

Protected Attributes

unsigned count
unsigned used
unsigned waits

Detailed Description

A portable counting semaphore class.

A semaphore will allow threads to pass through it until the count is reached, and blocks further threads. Unlike pthread semaphore, our semaphore class supports it's count limit to be altered during runtime and the use of timed waits. This class also implements the shared_lock protocol.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 1023 of file thread.h.


Member Function Documentation

unsigned ucommon::Semaphore::getCount ( void  )

Get active semaphore limit.

Returns:
count of maximum threads to pass.
unsigned ucommon::Semaphore::getUsed ( void  )

Get current semaphore usage.

Returns:
number of active threads.
static void ucommon::Semaphore::release ( Semaphore sync) [inline, static]

Convenience class to release a semaphore.

Parameters:
syncobject to release.

Definition at line 1107 of file thread.h.

Here is the call graph for this function:

void ucommon::Semaphore::set ( unsigned  count)

Alter semaphore limit at runtime.

Parameters:
countof threads to allow.
static void ucommon::Semaphore::wait ( Semaphore sync) [inline, static]

Convenience class to wait on a semaphore.

Parameters:
syncobject to wait on.

Definition at line 1091 of file thread.h.

Here is the call graph for this function:

static bool ucommon::Semaphore::wait ( Semaphore sync,
timeout_t  timeout 
) [inline, static]

Convenience class to wait on a semaphore.

Parameters:
syncobject to wait on.
timeoutin milliseconds.
Returns:
if success, false if timeout.

Definition at line 1100 of file thread.h.

Here is the call graph for this function:

bool ucommon::Semaphore::wait ( timeout_t  timeout)

Wait until the semphore usage count is less than the thread limit.

Increase used count for our thread when unblocked, or return without changing if timed out.

Parameters:
timeoutto wait in millseconds.
Returns:
true if success, false if timeout.

Reimplemented from ucommon::Conditional.

void ucommon::Semaphore::wait ( void  )

Wait until the semphore usage count is less than the thread limit.

Increase used count for our thread when unblocked.

Reimplemented from ucommon::Conditional.


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