xmltooling/ILockable.h

   1 /*\r
   2  *  Copyright 2001-2006 Internet2\r
   3  * \r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 /**\r
  18  * @file ILockable.h\r
  19  * \r
  20  * Locking abstraction \r
  21  */\r
  22 \r
  23 #if !defined(__xmltooling_lockable_h__)\r
  24 #define __xmltooling_lockable_h__\r
  25 \r
  26 #include <xmltooling/base.h>\r
  27 \r
  28 namespace xmltooling {\r
  29 \r
  30     /**\r
  31      * Singleton object that manages library startup/shutdown.configuration.\r
  32      */\r
  33     struct XMLTOOL_API ILockable\r
  34     {\r
  35         virtual ~ILockable() {}\r
  36         \r
  37         /**\r
  38          * Lock the associated object for exclusive access.\r
  39          * \r
  40          * @return a reference to the object being locked\r
  41          */\r
  42         virtual ILockable& lock()=0;\r
  43 \r
  44         /**\r
  45          * Unlock the associated object from exclusive access.\r
  46          */\r
  47         virtual void unlock()=0;\r
  48     };\r
  49 \r
  50     /**\r
  51      * RAII wrapper for lockable objects to ensure lock release\r
  52      */\r
  53     class XMLTOOL_API Locker\r
  54     {\r
  55     MAKE_NONCOPYABLE(Locker);\r
  56     public:\r
  57         /**\r
  58          * Locks an object and stores it for later release.\r
  59          * \r
  60          * @param lockee    Pointer to an object to lock and hold\r
  61          */\r
  62         Locker(ILockable* lockee) : m_lockee(lockee->lock()) {}\r
  63         \r
  64         /**\r
  65          * Locks an object and stores it for later release.\r
  66          * \r
  67          * @param lockee    Reference to an object to lock and hold\r
  68          */\r
  69         Locker(ILockable& lockee) : m_lockee(lockee.lock()) {}\r
  70 \r
  71         /**\r
  72          * Releases lock on held pointer, if any.\r
  73          */\r
  74         ~Locker() {m_lockee.unlock();}\r
  75     private:\r
  76         ILockable& m_lockee;\r
  77     };\r
  78 \r
  79 };\r
  80 \r
  81 #endif /* __xmltooling_lockable_h__ */\r