Main Page   Class Hierarchy   Compound List   Compound Members  

ArCondition Class Reference

Threading condition wrapper class. More...

#include <ArCondition.h>

List of all members.

Public Types

enum  typedef {
  STATUS_FAILED = 1, STATUS_FAILED_DESTROY, STATUS_FAILED_INIT, STATUS_WAIT_TIMEDOUT,
  STATUS_WAIT_INTR, STATUS_MUTEX_FAILED_INIT, STATUS_MUTEX_FAILED
}

Public Methods

 ArCondition ()
 Constructor.

virtual ~ArCondition ()
 Desctructor.

int signal ()
 Signal the thread waiting.

int broadcast ()
 Broadcast a signal to all threads waiting.

int wait ()
 Wait for a signal.

int timedWait (unsigned int msecs)
 Wait for a signal for a period of time in milliseconds.

std::string getError (int messageNumber)
 Translate error into string.


Detailed Description

Threading condition wrapper class.


Member Enumeration Documentation

enum ArCondition::typedef
 

Enumeration values:
STATUS_FAILED  General failure.
STATUS_FAILED_DESTROY  Another thread is waiting on this condition so it can not be destroyed.
STATUS_FAILED_INIT  Failed to initialize thread. Requested action is imposesible.
STATUS_WAIT_TIMEDOUT  The timedwait timed out before signaling.
STATUS_WAIT_INTR  The wait was interupted by a signal.
STATUS_MUTEX_FAILED_INIT  The underlying mutex failed to init.
STATUS_MUTEX_FAILED  The underlying mutex failed in some fashion.


The documentation for this class was generated from the following files:
Generated on Tue Nov 12 17:43:51 2002 for Aria by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001