xmltooling/Lockable.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 Lockable.h\r
  19  * \r
  20  * Locking abstraction \r
  21  */\r
  22 \r
  23 #ifndef __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      * Abstract mixin interface for interfaces that support locking\r
  32      */\r
  33     struct XMLTOOL_API Lockable\r
  34     {\r
  35         virtual ~Lockable() {}\r
  36         \r
  37         /**\r
  38          * Lock the associated object for exclusive access.\r
  39          * \r
  40          * @return a pointer to the object being locked\r
  41          */\r
  42         virtual Lockable* 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          * Optionally locks an object and stores it for later release.\r
  59          * \r
  60          * @param lockee    pointer to an object to hold, and optionally lock\r
  61          * @param lock      true iff object is not yet locked\r
  62          */\r
  63         Locker(Lockable* lockee=NULL, bool lock=true) {\r
  64             if (lockee && lock)\r
  65                 m_lockee=lockee->lock();\r
  66             else\r
  67                 m_lockee=lockee;\r
  68         }\r
  69 \r
  70         /**\r
  71          * Optionally locks an object and stores it for later release.\r
  72          * If an object is already held, it is unlocked and detached.\r
  73          * \r
  74          * @param lockee    pointer to an object to hold, and optionally lock\r
  75          * @param lock      true iff object is not yet locked\r
  76          */\r
  77         void assign(Lockable* lockee=NULL, bool lock=true) {\r
  78             if (m_lockee)\r
  79                 m_lockee->unlock();\r
  80             m_lockee=NULL;\r
  81             if (lockee && lock)\r
  82                 m_lockee=lockee->lock();\r
  83             else\r
  84                 m_lockee=lockee;\r
  85         }\r
  86         \r
  87         /**\r
  88          * Destructor releases lock on held pointer, if any.\r
  89          */\r
  90         ~Locker() {\r
  91             if (m_lockee)\r
  92                 m_lockee->unlock();\r
  93          }\r
  94         \r
  95     private:\r
  96         Lockable* m_lockee;\r
  97     };\r
  98 \r
  99 };\r
 100 \r
 101 #endif /* __xmltooling_lockable_h__ */\r