Mutex.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLUtils/src/ICLUtils/Mutex.h                          **
** Module : ICLUtils                                               **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/Uncopyable.h>
#include <pthread.h>

namespace icl{
  namespace utils{

    class Lockable;

    class Mutex : public Uncopyable{
      public:

      enum MutexType {
      //#ifndef ICL_SYSTEM_WINDOWS
        mutexTypeNormal = PTHREAD_MUTEX_NORMAL,
        mutexTypeRecursive = PTHREAD_MUTEX_RECURSIVE
      //#else

      //#endif
      } type;


      Mutex(MutexType type = mutexTypeNormal):type(type){
          //#ifndef ICL_SYSTEM_WINDOWS
        pthread_mutexattr_init(&a);
        pthread_mutexattr_settype(&a, type);
        pthread_mutex_init(&m,&a);
          //#else

          //#endif
      }
      ~Mutex(){
          //#ifndef ICL_SYSTEM_WINDOWS
          pthread_mutex_destroy(&m);
          //#else

          //#endif
      }
      void lock(){
          //#ifndef ICL_SYSTEM_WINDOWS
        pthread_mutex_lock(&m);
          //#else

          //#endif
      }

      int trylock(){
        //#ifndef ICL_SYSTEM_WINDOWS
        return pthread_mutex_trylock(&m);
        //#else

        //#endif
      }

      void unlock(){
          //#ifndef ICL_SYSTEM_WINDOWS
        pthread_mutex_unlock(&m);
          //#else

          //#endif
      }

      class Locker : public Uncopyable{
        public:
        Locker(Mutex *m);

        Locker(Mutex &m);

        ICLUtils_API Locker(const Lockable *l);

        ICLUtils_API Locker(const Lockable &l);

        ~Locker();
        private:
        Mutex *m;
      };
      private:
      pthread_mutex_t m;
      pthread_mutexattr_t a;
    };


    inline Mutex::Locker::Locker(Mutex *m):m(m){
      m->lock();
    }
    inline Mutex::Locker::Locker(Mutex &m):m(&m){
      m.lock();
    }
    inline Mutex::Locker::~Locker(){
      m->unlock();
    }
  } // namespace utils
}