Mutex.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2014  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_Mutex_hxx
#define __ccxx_Mutex_hxx

#include <commonc++/Common.h++>
#include <commonc++/Lock.h++>

#ifdef CCXX_OS_POSIX
#include <pthread.h>
#endif

namespace ccxx {

class COMMONCPP_API Mutex : public Lock
{
  friend class ConditionVar;

 public:

  Mutex(bool recursive = false);

  ~Mutex();

  void lock();

  bool tryLock(timespan_ms_t timeout = 0);

  void unlock();

  inline bool isRecursive() const
  { return(_recursive); }

  static bool supportsTimedLocks();

 protected:

#ifdef CCXX_OS_WINDOWS
  HANDLE _mutex;
#else
  pthread_mutex_t _mutex;
#endif

 private:

  bool _recursive;

  CCXX_COPY_DECLS(Mutex);
};

} // namespace ccxx

#endif // __ccxx_Mutex_hxx