plugins/common/mutex.h

   1 /*
   2 Copyright (C) 2012 Intel Corporation
   3
   4 This library is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU Lesser General Public
   6 License as published by the Free Software Foundation; either
   7 version 2.1 of the License, or (at your option) any later version.
   8
   9 This library is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 Lesser General Public License for more details.
  13
  14 You should have received a copy of the GNU Lesser General Public
  15 License along with this library; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  17 */
  18
  19 #ifndef _CUTIL_MUTEX_H_
  20 #define _CUTIL_MUTEX_H_
  21
  22 #include <pthread.h>
  23
  24 /**
  25  * @defgroup libamb-plugins-common amb-plugins-common static library.
  26  * \brief Project common C++ utilities.
  27  *
  28  * Contains Logger, Thread and Mutex, SerialPort and other utility classes.
  29  *
  30  * @{
  31  */
  32
  33 /**
  34  * \brief Project common C++ utilities namespace
  35  * @namespace CUtil
  36  */
  37
  38 namespace CUtil {
  39
  40 /**
  41 * \brief Encapsulation of the recursive posix mutex.
  42 *
  43 * @class Mutex
  44 */
  45
  46 class Mutex
  47 {
  48         /**
  49         * Encapsulated posix mutex object
  50         * @property mutexID
  51         * @private
  52         */
  53         pthread_mutex_t mutexID;
  54
  55 public:
  56
  57         Mutex();
  58         ~Mutex();
  59
  60         /**
  61         * Locks mutex object
  62         * @fn lock
  63         * @public
  64         */
  65         void lock();
  66         /**
  67         * Unlocks mutex object
  68         * @fn unlock
  69         * @public
  70         */
  71         void unlock();
  72 };
  73
  74 }
  75
  76 #endif
  77
  78 /** @} */