Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

# ACE_Condition Class Template Reference

ACE_Condition variable wrapper, which allows threads to block until shared data changes state. More...

`#include <Synch_T.h>`

Inheritance diagram for ACE_Condition:

[legend]
Collaboration diagram for ACE_Condition:

[legend]
List of all members.

## Public Methods
| ACE_Condition (MUTEX &m, int type=USYNC_THREAD, const ACE_TCHAR *name=0, void *arg=0)
| Initialize the condition variable. More...
| ~ACE_Condition (void)
| Implicitly destroy the condition variable. More...
int | wait (const ACE_Time_Value *abstime)
| Block on condition, or until absolute time-of-day has passed. More...
int | wait (void)
| Block on condition. More...
int | wait (MUTEX &mutex, const ACE_Time_Value *abstime=0)
| Block on condition or until absolute time-of-day has passed. More...
int | signal (void)
| Signal one waiting thread. More...
int | broadcast (void)
| Signal *all* waiting threads. More...
int | remove (void)
| Explicitly destroy the condition variable. More...
MUTEX & | mutex (void)
| Returns a reference to the underlying mutex_;. More...
void | dump (void) const
| Dump the state of an object. More...
## Protected Attributes
ACE_cond_t | cond_
| Condition variable. More...
MUTEX & | mutex_
| Reference to mutex lock. More...
## Private Methods
void | operator= (const ACE_Condition< MUTEX > &)
| ACE_Condition (const ACE_Condition< MUTEX > &)

## Detailed Description

### template<class MUTEX>
class ACE_Condition< MUTEX >

ACE_Condition variable wrapper, which allows threads to block until shared data changes state.

A condition variable enables threads to atomically block and test the condition under the protection of a mutual exclu- sion lock (mutex) until the condition is satisfied. That is, the mutex must have been held by the thread before calling wait or signal on the condition. If the condition is false, a thread blocks on a condition variable and atomically releases the mutex that is waiting for the condition to change. If another thread changes the condition, it may wake up waiting threads by signaling the associated condition variable. The waiting threads, upon awakening, reacquire the mutex and re-evaluate the condition. Note, you can only parameterize <ACE_Condition> with ACE_Thread_Mutex, ACE_Recursive_Thread_Mutex, or ACE_Null_Mutex.

## Constructor & Destructor Documentation

template<class MUTEX>
ACE_Condition< MUTEX >::ACE_Condition | ( | MUTEX & | m,
|  | int | type = USYNC_THREAD,
|  | const ACE_TCHAR * | name = 0,
|  | void * | arg = 0
| ) |

| Initialize the condition variable.

template<class MUTEX>
ACE_Condition< MUTEX >::~ACE_Condition | ( | void |  | ) |

| Implicitly destroy the condition variable.

template<class MUTEX>
ACE_Condition< MUTEX >::ACE_Condition | ( | const ACE_Condition< MUTEX > & |  | ) | `[private]`

## Member Function Documentation

template<class MUTEX>
ACE_INLINE int ACE_Condition< MUTEX >::broadcast | ( | void |  | ) |

| Signal *all* waiting threads.

template<class MUTEX>
void ACE_Condition< MUTEX >::dump | ( | void |  | ) | const

| Dump the state of an object. Reimplemented in ACE_Thread_Condition.

template<class MUTEX>
ACE_INLINE MUTEX & ACE_Condition< MUTEX >::mutex | ( | void |  | ) |

| Returns a reference to the underlying mutex_;.

template<class MUTEX>
void ACE_Condition< MUTEX >::operator= | ( | const ACE_Condition< MUTEX > & |  | ) | `[private]`

template<class MUTEX>
ACE_INLINE int ACE_Condition< MUTEX >::remove | ( | void |  | ) |

| Explicitly destroy the condition variable.

template<class MUTEX>
ACE_INLINE int ACE_Condition< MUTEX >::signal | ( | void |  | ) |

| Signal one waiting thread.

template<class MUTEX>
int ACE_Condition< MUTEX >::wait | ( | MUTEX & | mutex,
|  | const ACE_Time_Value * | abstime = 0
| ) |

| Block on condition or until absolute time-of-day has passed. If abstime == 0 use "blocking" wait() semantics on the <mutex> passed as a parameter (this is useful if you need to store the <Condition> in shared memory). Else, if <abstime> != 0 and the call times out before the condition is signaled <wait> returns -1 and sets errno to ETIME.

template<class MUTEX>
int ACE_Condition< MUTEX >::wait | ( | void |  | ) |

| Block on condition.

template<class MUTEX>
int ACE_Condition< MUTEX >::wait | ( | const ACE_Time_Value * | abstime | ) |

| Block on condition, or until absolute time-of-day has passed. If abstime == 0 use "blocking" <wait> semantics. Else, if <abstime> != 0 and the call times out before the condition is signaled <wait> returns -1 and sets errno to ETIME.

## Member Data Documentation

template<class MUTEX>
ACE_cond_t ACE_Condition::cond_`[protected]`

| Condition variable.

template<class MUTEX>
MUTEX& ACE_Condition::mutex_`[protected]`

| Reference to mutex lock.

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

- Synch_T.h
- Synch_T.cpp
- Synch_T.i