PReadWaitAndSignal Class Reference

#include <syncthrd.h>

List of all members.

Public Member Functions

 PReadWaitAndSignal (const PReadWriteMutex &rw, BOOL start=TRUE)
 ~PReadWaitAndSignal ()

Protected Attributes

PReadWriteMutexmutex


Detailed Description

This class starts a read operation for the PReadWriteMutex on construction and automatically ends the read operation on destruction.

This is very usefull for constructs such as: {verbatim} void func() { PReadWaitAndSignal mutexWait(myMutex); if (condition) return; do_something(); if (other_condition) return; do_something_else(); } {verbatim}


Constructor & Destructor Documentation

PReadWaitAndSignal::PReadWaitAndSignal ( const PReadWriteMutex rw,
BOOL  start = TRUE 
)

Create the PReadWaitAndSignal wait instance. This will wait on the specified PReadWriteMutex using the StartRead()# function before returning.

Parameters:
rw  PReadWriteMutex descendent to wait/signal.
start  Start read operation on PReadWriteMutex before returning.

PReadWaitAndSignal::~PReadWaitAndSignal (  ) 

End read operation on the PReadWriteMutex. This will execute the EndRead() function on the PReadWriteMutex that was used in the construction of this instance.


Member Data Documentation

PReadWriteMutex& PReadWaitAndSignal::mutex [protected]


The documentation for this class was generated from the following file:
Generated on Fri Mar 7 06:25:06 2008 for PTLib by  doxygen 1.5.1