Fawkes API  Fawkes Development Version
mutex.h
00001 
00002 /***************************************************************************
00003  *  mutex.h - Mutex
00004  *
00005  *  Generated: Thu Sep 14 16:58:49 2006
00006  *  Copyright  2006  Tim Niemueller [www.niemueller.de]
00007  *
00008  ****************************************************************************/
00009 
00010 /*  This program is free software; you can redistribute it and/or modify
00011  *  it under the terms of the GNU General Public License as published by
00012  *  the Free Software Foundation; either version 2 of the License, or
00013  *  (at your option) any later version. A runtime exception applies to
00014  *  this software (see LICENSE.GPL_WRE file mentioned below for details).
00015  *
00016  *  This program is distributed in the hope that it will be useful,
00017  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  *  GNU Library General Public License for more details.
00020  *
00021  *  Read the full text in the LICENSE.GPL_WRE file in the doc directory.
00022  */
00023 
00024 #ifndef __CORE_THREADING_MUTEX_H_
00025 #define __CORE_THREADING_MUTEX_H_
00026 
00027 namespace fawkes {
00028 
00029 class MutexData;
00030 class WaitCondition;
00031 
00032 class Mutex
00033 {
00034   friend class WaitCondition;
00035 
00036  public:
00037   /** Mutex type. */
00038   typedef enum {
00039     NORMAL,     ///< This type of mutex does not detect deadlock.
00040     RECURSIVE   ///< A thread attempting to relock this mutex without
00041                 ///< first unlocking it shall succeed in locking the mutex.
00042   } Type;
00043 
00044   Mutex(Type type = NORMAL);
00045   ~Mutex();
00046 
00047   void lock();
00048   bool try_lock();
00049   void unlock();
00050 
00051   void stopby();
00052 
00053  private:
00054   MutexData *mutex_data;
00055 };
00056 
00057 
00058 } // end namespace fawkes
00059 
00060 #endif