dep/include/zthread/ClassLockable.h

   1 /*
   2  * Copyright (c) 2005, Eric Crahen
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is furnished
   9  * to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in all
  12  * copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  18  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  19  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20  *
  21  */
  22
  23 #ifndef __ZTCLASSLOCKABLE_H__
  24 #define __ZTCLASSLOCKABLE_H__
  25
  26 #include "zthread/CountedPtr.h"
  27 #include "zthread/Mutex.h"
  28
  29 namespace ZThread {
  30
  31   /**
  32    * @class ClassLockable
  33    *
  34    * @author Eric Crahen <http://www.code-foo.com>
  35    * @date <2003-07-16T23:37:38-0400>
  36    * @version 2.3.0
  37    *
  38    *
  39    */
  40   template <typename ClassType, class LockType = Mutex>
  41     class ClassLockable : public Lockable {
  42
  43     static CountedPtr<LockType> _instance;
  44     CountedPtr<LockType> _lock;
  45
  46     public:
  47
  48     //! Create a ClassLockable
  49     ClassLockable()
  50       : _lock(_instance) {}
  51
  52     //! acquire() the ClassLockable
  53     virtual void acquire() {
  54       _lock->acquire();
  55     }
  56
  57     //! tryAcquire() the ClassLockable
  58     virtual bool tryAcquire(unsigned long timeout) {
  59       return _lock->tryAcquire(timeout);
  60     }
  61
  62     //! release() the ClassLockable
  63     virtual void release() {
  64       _lock->release();
  65     }
  66
  67   };
  68
  69   template <typename ClassType, class LockType>
  70     CountedPtr<LockType> ClassLockable<ClassType, LockType>::_instance(new LockType);
  71
  72 } // namespace ZThread
  73
  74 #endif // __ZTCLASSLOCKABLE_H__