PWaitAndSignal Class Reference

#include <psync.h>

List of all members.

Public Member Functions

 PWaitAndSignal (const PSync &sem, BOOL wait=TRUE)
 ~PWaitAndSignal ()

Protected Attributes

PSyncsync


Detailed Description

This class waits for the semaphore on construction and automatically signals the semaphore on destruction. Any descendent of PSemaphore may be used.

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


Constructor & Destructor Documentation

PWaitAndSignal::PWaitAndSignal ( const PSync sem,
BOOL  wait = TRUE 
) [inline]

Create the semaphore wait instance. This will wait on the specified semaphore using the Wait()# function before returning.

Parameters:
sem  Semaphore descendent to wait/signal.
wait  Wait for semaphore before returning.

PWaitAndSignal::~PWaitAndSignal (  )  [inline]

Signal the semaphore. This will execute the Signal() function on the semaphore that was used in the construction of this instance.


Member Data Documentation

PSync& PWaitAndSignal::sync [protected]


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