ScopedMutexLock.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_THREAD_SCOPED_MUTEX_LOCK_H_INCLUDED
#define ICL_CORE_THREAD_SCOPED_MUTEX_LOCK_H_INCLUDED

#include <icl_core/BaseTypes.h>
#include <icl_core/Noncopyable.h>
#include "icl_core_thread/ImportExport.h"

#ifdef _IC_BUILDER_DEPRECATED_STYLE_
# include "icl_core/Deprecate.h"
#endif

namespace icl_core {
namespace thread {

class Mutex;

class ICL_CORE_THREAD_IMPORT_EXPORT ScopedMutexLock : protected virtual icl_core::Noncopyable
{
public:
  explicit ScopedMutexLock(Mutex& mutex, bool force = true);
  ~ScopedMutexLock();

  bool isLocked() const { return m_is_locked; }

  operator bool () const { return isLocked(); }

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE bool IsLocked() const ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

private:
  Mutex& m_mutex;
  bool m_is_locked;
};

}
}

#endif