PTLib  Version 2.10.4
PTimedMutex Class Reference

This class defines a thread mutual exclusion object. More...

#include <mutex.h>

Inheritance diagram for PTimedMutex:
PSync PObject

List of all members.

Public Member Functions

 PTimedMutex ()
 PTimedMutex (const PTimedMutex &mutex)
PINLINE bool Try ()
 Try to enter the critical section for exlusive access.

Detailed Description

This class defines a thread mutual exclusion object.

A mutex is where a piece of code or data cannot be accessed by more than one thread at a time. To prevent this the PMutex is used in the following manner:


      PMutex mutex;
      ...
      mutex.Wait();
      ... critical section - only one thread at a time here.
      mutex.Signal();
      ...

The first thread will pass through the Wait() function, a second thread will block on that function until the first calls the Signal() function, releasing the second thread.


Constructor & Destructor Documentation


Member Function Documentation

PINLINE bool PTimedMutex::Try ( ) [inline]

Try to enter the critical section for exlusive access.

Does not wait.

Returns:
true if cirical section entered, leave/Signal must be called.

References PSync::Wait().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines