MutexLocker.h.svn-base
上传用户:market2
上传日期:2018-11-18
资源大小:18786k
文件大小:2k
源码类别:

外挂编程

开发平台:

Windows_Unix

  1. /*
  2.  *  OpenKore C++ Standard Library
  3.  *  Copyright (C) 2006  VCL
  4.  *
  5.  *  This library is free software; you can redistribute it and/or
  6.  *  modify it under the terms of the GNU Lesser General Public
  7.  *  License as published by the Free Software Foundation; either
  8.  *  version 2.1 of the License, or (at your option) any later version.
  9.  *
  10.  *  This library is distributed in the hope that it will be useful,
  11.  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13.  *  Lesser General Public License for more details.
  14.  *
  15.  *  You should have received a copy of the GNU Lesser General Public
  16.  *  License along with this library; if not, write to the Free Software
  17.  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  18.  *  MA  02110-1301  USA
  19.  */
  20. #ifndef _OSL_MUTEX_LOCKER_H_
  21. #define _OSL_MUTEX_LOCKER_H_
  22. #include "Mutex.h"
  23. namespace OSL {
  24. /**
  25.  * Automatic locking and unlocking a mutex.
  26.  *
  27.  * This class locks a mutex immediately, and unlocks it when
  28.  * it is deleted. This can be used to easy and exception-safe
  29.  * mutex locking.
  30.  *
  31.  * For example, consider the following:
  32.  * @code
  33.  * void foo()
  34.  * {
  35.  *     mutex->lock();
  36.  *     do_something();
  37.  *     mutex->unlock();
  38.  * }
  39.  * @endcode
  40.  * Suppose <tt>do_something()</tt> throws an exception. The mutex
  41.  * will never be unlocked. You can fix that with try..catch but that
  42.  * will result in more (unnecessary) code.
  43.  *
  44.  * By using MutexLocker, things will be greatly simplified:
  45.  * @code
  46.  * void foo()
  47.  * {
  48.  *     MutexLocker lock(mutex);
  49.  *     do_something();
  50.  * }
  51.  * @endcode
  52.  * MutexLocker immediately acquires a lock on the mutex. Whenever
  53.  * <tt>foo()</tt> exits, the MutexLocker is automatically deleted, and
  54.  * thus the mutex is automatically unlocked, even in the event of an
  55.  * unhandled exception.
  56.  *
  57.  * @class MutexLocker OSL/Threading/MutexLocker.h
  58.  * @ingroup Threading
  59.  */
  60. class MutexLocker {
  61. private:
  62. Mutex *mutex;
  63. public:
  64. /**
  65.  * Create a new MutexLocker object from the specified mutex.
  66.  */
  67. MutexLocker(Mutex &mutex);
  68. /**
  69.  * Create a new MutexLocker object from the specified mutex.
  70.  *
  71.  * @pre mutex != NULL
  72.  */
  73. MutexLocker(Mutex *mutex);
  74. ~MutexLocker();
  75. };
  76. }
  77. #endif /* _OSL_MUTEX_LOCKER_H_ */