Main Page   Namespace List   Class Hierarchy   Compound List   Namespace Members   Compound Members  

CountingSemaphore Class Reference

#include <CountingSemaphore.h>

Inheritance diagram for CountingSemaphore:

Lockable NonCopyable List of all members.

Public Methods

 CountingSemaphore (int initialCount=0)
virtual ~CountingSemaphore () throw ()
 Destroy the CountingSemaphore.

void wait ()
bool tryWait (unsigned long)
void post ()
virtual int count () throw ()
virtual bool tryAcquire (unsigned long timeout)
virtual void acquire ()
virtual void release ()

Detailed Description

Author:
Eric Crahen <crahen@cse.buffalo.edu>
Date:
<2002-06-02T08:12:01-0400>
Version:
2.2.1
A CountingSemaphore in the same way as a Semaphore. Its an ownerless Lockable object. It differs in that there is no upper bound on this object and it will not throw exceptions because a maximum value has been exceeded.

See also:
Semaphore
Scheduling

Threads blocked on a CountingSemaphore are resumed in FIFO order.

Error Checking

None. An attempt to increase a CountingSemaphore beyond its maximum value will not result in an InvalidOp_Exception.


Constructor & Destructor Documentation

CountingSemaphore int    initialCount = 0
 

Create a new CountingSemaphore.

Parameters:
count  - initial count
Exceptions:
Synchronization_Exception  thrown if the Semaphore could not be created


Member Function Documentation

virtual void acquire   [virtual]
 

Decrement the count, blocking that calling thread if the count becomes 0 or less than 0. The calling thread will remain blocked until the count is raised above 0 or if an exception is thrown.

Exceptions:
Interrupted_Exception  thrown when the calling thread is interupt()ed. A thread may be interrupted at any time, prematurely ending any wait.
Synchronization_Exception  thrown if there is some other error.
See also:
Lockable::acquire()

Implements Lockable.

virtual int count   throw () [virtual]
 

Get the current count of the semaphore. This value may change immediately after this function returns to the calling thread.

Returns :
int - count

void post  
 

Increment the count.

See also:
release() - provided to reflect the traditional Semaphore semantics

virtual void release   [virtual]
 

Increment the count, unblocking one thread if count is posative.

Exceptions:
Synchronization_Exception  thrown if there is some other error.
See also:
Lockable::release()

Implements Lockable.

virtual bool tryAcquire unsigned long    timeout [virtual]
 

Decrement the count, blocking that calling thread if the count becomes 0 or less than 0. The calling thread will remain blocked until the count is raised above 0, an exception is thrown or the given amount of time expires.

Parameters:
timeout  - maximum amount of time (milliseconds) this method could block
Returns :
bool true if the Semaphore was acquire()ed before the timeout expired, otherwise false
Exceptions:
Interrupted_Exception  thrown when the calling thread is interupt()ed. A thread may be interrupted at any time, prematurely ending any wait.
Synchronization_Exception  thrown if there is some other error.
See also:
Lockable::tryAcquire(unsigned long)

Implements Lockable.

bool tryWait unsigned    long
 

Decrement the count.

See also:
tryAcquire() - provided to reflect the traditional Semaphore semantics

void wait  
 

Decrement the count.

See also:
acquire() - provided to reflect the traditional Semaphore semantics


The documentation for this class was generated from the following file:
Generated on Tue Aug 27 07:43:11 2002 for ZThread by doxygen1.2.17