1f8e07b45SAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3f8e07b45SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4f8e07b45SAndrew Rist * or more contributor license agreements. See the NOTICE file 5f8e07b45SAndrew Rist * distributed with this work for additional information 6f8e07b45SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7f8e07b45SAndrew Rist * to you under the Apache License, Version 2.0 (the 8f8e07b45SAndrew Rist * "License"); you may not use this file except in compliance 9f8e07b45SAndrew Rist * with the License. You may obtain a copy of the License at 10f8e07b45SAndrew Rist * 11f8e07b45SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12f8e07b45SAndrew Rist * 13f8e07b45SAndrew Rist * Unless required by applicable law or agreed to in writing, 14f8e07b45SAndrew Rist * software distributed under the License is distributed on an 15f8e07b45SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16f8e07b45SAndrew Rist * KIND, either express or implied. See the License for the 17f8e07b45SAndrew Rist * specific language governing permissions and limitations 18f8e07b45SAndrew Rist * under the License. 19f8e07b45SAndrew Rist * 20f8e07b45SAndrew Rist *************************************************************/ 21f8e07b45SAndrew Rist 22f8e07b45SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir #ifndef __FRAMEWORK_THREADHELP_RESETABLEGUARD_HXX_ 25cdf0e10cSrcweir #define __FRAMEWORK_THREADHELP_RESETABLEGUARD_HXX_ 26cdf0e10cSrcweir 27cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 28cdf0e10cSrcweir // my own includes 29cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 30cdf0e10cSrcweir 31cdf0e10cSrcweir #include <threadhelp/inoncopyable.h> 32cdf0e10cSrcweir #include <framework/imutex.hxx> 33cdf0e10cSrcweir 34cdf0e10cSrcweir //#ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_ 35cdf0e10cSrcweir //#include <threadhelp/threadhelpbase.hxx> 36cdf0e10cSrcweir //#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 39cdf0e10cSrcweir // interface includes 40cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 41cdf0e10cSrcweir 42cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 43cdf0e10cSrcweir // other includes 44cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 45cdf0e10cSrcweir #include <sal/types.h> 46cdf0e10cSrcweir 47cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 48cdf0e10cSrcweir // namespace 49cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 50cdf0e10cSrcweir 51cdf0e10cSrcweir namespace framework{ 52cdf0e10cSrcweir 53cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 54cdf0e10cSrcweir // const 55cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 56cdf0e10cSrcweir 57cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 58cdf0e10cSrcweir // declarations 59cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 60cdf0e10cSrcweir 61cdf0e10cSrcweir /*-************************************************************************************************************//** 62cdf0e10cSrcweir @short implement a guard for implementing save thread access 63cdf0e10cSrcweir @descr These guard has an additional feature to well known one ::osl::Guard. 64cdf0e10cSrcweir You can lock() and unlock() it very often! 65cdf0e10cSrcweir A set bool flag inside protect this implementation against multiple lock() calls 66cdf0e10cSrcweir without any unlock()! So the increasing of guarded mutex couldn't be greater then 1 ... 67cdf0e10cSrcweir 68*30acf5e8Spfg @attention a) To prevent us against wrong using, the default ctor, copy ctor and the =operator are marked private! 69cdf0e10cSrcweir b) Use interface "IMutex" of set LockHelper only - because we must support an exclusiv locking. 70cdf0e10cSrcweir Interface "IRWLock" should be used by special guard implementations ... like "ReadGuard" or "WriteGuard"! 71cdf0e10cSrcweir 72cdf0e10cSrcweir @implements - 73cdf0e10cSrcweir @base INonCopyable 74cdf0e10cSrcweir 75cdf0e10cSrcweir @devstatus ready to use 76cdf0e10cSrcweir *//*-*************************************************************************************************************/ 77cdf0e10cSrcweir class ResetableGuard : private INonCopyable 78cdf0e10cSrcweir { 79cdf0e10cSrcweir //------------------------------------------------------------------------------------------------------------- 80cdf0e10cSrcweir // public methods 81cdf0e10cSrcweir //------------------------------------------------------------------------------------------------------------- 82cdf0e10cSrcweir public: 83cdf0e10cSrcweir 84cdf0e10cSrcweir /*-****************************************************************************************************//** 85cdf0e10cSrcweir @short ctors 86cdf0e10cSrcweir @descr Use these ctor methods to initialize the guard right. 8707a3d7f1SPedro Giffuni Given lock reference must be valid - otherwise crashes could occur! 88cdf0e10cSrcweir 89cdf0e10cSrcweir @seealso - 90cdf0e10cSrcweir 91cdf0e10cSrcweir @param "pLock", pointer to lock helper of user 92cdf0e10cSrcweir @param "rLock", reference to lock helper of user 93cdf0e10cSrcweir @return - 94cdf0e10cSrcweir 95cdf0e10cSrcweir @onerror - 96cdf0e10cSrcweir *//*-*****************************************************************************************************/ 97cdf0e10cSrcweir inline ResetableGuard( IMutex* pLock ) 98cdf0e10cSrcweir : m_pLock ( pLock ) 99cdf0e10cSrcweir , m_bLocked ( sal_False ) 100cdf0e10cSrcweir { 101cdf0e10cSrcweir lock(); 102cdf0e10cSrcweir } 103cdf0e10cSrcweir 104cdf0e10cSrcweir //********************************************************************************************************* 105cdf0e10cSrcweir inline ResetableGuard( IMutex& rLock ) 106cdf0e10cSrcweir : m_pLock ( &rLock ) 107cdf0e10cSrcweir , m_bLocked ( sal_False ) 108cdf0e10cSrcweir { 109cdf0e10cSrcweir lock(); 110cdf0e10cSrcweir } 111cdf0e10cSrcweir 112cdf0e10cSrcweir /*-****************************************************************************************************//** 113cdf0e10cSrcweir @short dtor 114cdf0e10cSrcweir @descr We must release set mutex if programmer forget it ... 115cdf0e10cSrcweir 116cdf0e10cSrcweir @seealso - 117cdf0e10cSrcweir 118cdf0e10cSrcweir @param - 119cdf0e10cSrcweir @return - 120cdf0e10cSrcweir 121cdf0e10cSrcweir @onerror - 122cdf0e10cSrcweir *//*-*****************************************************************************************************/ 123cdf0e10cSrcweir inline ~ResetableGuard() 124cdf0e10cSrcweir { 125cdf0e10cSrcweir unlock(); 126cdf0e10cSrcweir } 127cdf0e10cSrcweir 128cdf0e10cSrcweir /*-****************************************************************************************************//** 129cdf0e10cSrcweir @short enable/disable the lock 130cdf0e10cSrcweir @descr Use this methods to lock or unlock the mutex. 131cdf0e10cSrcweir You can do it so often you wish to do that ... 132cdf0e10cSrcweir 133cdf0e10cSrcweir @attention We use another member to prevent us against multiple acquire calls of the same guard 134cdf0e10cSrcweir without suitable release calls! 135cdf0e10cSrcweir You don't must protect access at these bool member by using an own mutex .... 136cdf0e10cSrcweir because nobody use the same guard instance from different threads! 137cdf0e10cSrcweir It will be a function-local object every time. 138cdf0e10cSrcweir 139cdf0e10cSrcweir @seealso - 140cdf0e10cSrcweir 141cdf0e10cSrcweir @param - 142cdf0e10cSrcweir @return - 143cdf0e10cSrcweir 144cdf0e10cSrcweir @onerror - 145cdf0e10cSrcweir *//*-*****************************************************************************************************/ 146cdf0e10cSrcweir inline void lock() 147cdf0e10cSrcweir { 148cdf0e10cSrcweir if( m_bLocked == sal_False ) 149cdf0e10cSrcweir { 150cdf0e10cSrcweir m_pLock->acquire(); 151cdf0e10cSrcweir m_bLocked = sal_True; 152cdf0e10cSrcweir } 153cdf0e10cSrcweir } 154cdf0e10cSrcweir 155cdf0e10cSrcweir //********************************************************************************************************* 156cdf0e10cSrcweir inline void unlock() 157cdf0e10cSrcweir { 158cdf0e10cSrcweir if( m_bLocked == sal_True ) 159cdf0e10cSrcweir { 160cdf0e10cSrcweir m_pLock->release(); 161cdf0e10cSrcweir m_bLocked = sal_False; 162cdf0e10cSrcweir } 163cdf0e10cSrcweir } 164cdf0e10cSrcweir 165cdf0e10cSrcweir //------------------------------------------------------------------------------------------------------------- 166cdf0e10cSrcweir // private methods 167cdf0e10cSrcweir //------------------------------------------------------------------------------------------------------------- 168cdf0e10cSrcweir private: 169cdf0e10cSrcweir 170cdf0e10cSrcweir /*-****************************************************************************************************//** 171cdf0e10cSrcweir @short disable using of these functions! 17207a3d7f1SPedro Giffuni @descr It's not allowed to use this methods. Different problems can occur otherwise. 173cdf0e10cSrcweir Thats why we disable it by make it private. 174cdf0e10cSrcweir 175cdf0e10cSrcweir @seealso other ctor 176cdf0e10cSrcweir 177cdf0e10cSrcweir @param - 178cdf0e10cSrcweir @return - 179cdf0e10cSrcweir 180cdf0e10cSrcweir @onerror - 181cdf0e10cSrcweir *//*-*****************************************************************************************************/ 182cdf0e10cSrcweir ResetableGuard(); 183cdf0e10cSrcweir 184cdf0e10cSrcweir //------------------------------------------------------------------------------------------------------------- 185cdf0e10cSrcweir // private member 186cdf0e10cSrcweir //------------------------------------------------------------------------------------------------------------- 187cdf0e10cSrcweir private: 188cdf0e10cSrcweir 189cdf0e10cSrcweir IMutex* m_pLock ; /// pointer to safed lock member of user 190cdf0e10cSrcweir sal_Bool m_bLocked ; /// protection against multiple lock() calls without unlock() 191cdf0e10cSrcweir 192cdf0e10cSrcweir }; // class ResetableGuard 193cdf0e10cSrcweir 194cdf0e10cSrcweir } // namespace framework 195cdf0e10cSrcweir 196cdf0e10cSrcweir #endif // #ifndef __FRAMEWORK_THREADHELP_RESETABLEGUARD_HXX_ 197