src/external/3rd/library/soePlatform/CSAssist/utils/Base/solaris/Mutex.h

   1 ////////////////////////////////////////
   2 //  Mutex.h
   3 //
   4 //  Purpose:
   5 //          1. Declair the CMutex class that encapsulates the functionality of a
   6 //          mutually-exclusive device.
   7 //
   8 //  Revisions:
   9 //          07/10/2001  Created
  10 //
  11
  12 #ifndef BASE_SOLARIS_MUTEX_H
  13 #define BASE_SOLARIS_MUTEX_H
  14
  15 #if !defined(_REENTRANT)
  16 #   pragma message( "Excluding Base::CMutex - requires multi-threaded compile. (_REENTRANT)" )
  17 #else
  18
  19
  20 #include "Platform.h"
  21
  22 namespace Base
  23 {
  24
  25     ////////////////////////////////////////
  26     //  Class:
  27     //      CMutex
  28     //
  29     //  Purpose:
  30     //      Encapsulates the functionality of a mutually-exclusive device.
  31     //      This class is valuable for protecting against race conditions
  32     //      within threaded applications.  The CMutex class can be used to
  33     //      only allow a single thread to run within a specified code
  34     //      segment at a time.
  35     //
  36     //  Public Methods:
  37     //      Lock() : Locks the mutex.  If the mutex is already locked, the
  38     //          operating system will block the calling thread until another
  39     //          thread has unlocked the mutex.
  40     //      Unlock() : Unlocks the mutex.
  41     //
  42     class CMutex
  43         {
  44             public:
  45             CMutex();
  46             ~CMutex();
  47
  48             void Lock();
  49                     void Unlock();
  50             private:
  51                     pthread_mutex_t mMutex;
  52             bool            mInitialized;
  53         };
  54
  55     inline void CMutex::Lock(void)
  56     {
  57             if (mInitialized)
  58             pthread_mutex_lock(&mMutex);
  59     }
  60
  61     inline void CMutex::Unlock(void)
  62     {
  63         if (mInitialized)
  64             pthread_mutex_unlock(&mMutex);
  65     }
  66
  67 }
  68
  69 #endif  //  #if defined(_MT)
  70
  71 #endif  // BASE_SOLARIS_MUTEX_H