1*f8e07b45SAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3*f8e07b45SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*f8e07b45SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*f8e07b45SAndrew Rist * distributed with this work for additional information 6*f8e07b45SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*f8e07b45SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*f8e07b45SAndrew Rist * "License"); you may not use this file except in compliance 9*f8e07b45SAndrew Rist * with the License. You may obtain a copy of the License at 10*f8e07b45SAndrew Rist * 11*f8e07b45SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*f8e07b45SAndrew Rist * 13*f8e07b45SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*f8e07b45SAndrew Rist * software distributed under the License is distributed on an 15*f8e07b45SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*f8e07b45SAndrew Rist * KIND, either express or implied. See the License for the 17*f8e07b45SAndrew Rist * specific language governing permissions and limitations 18*f8e07b45SAndrew Rist * under the License. 19*f8e07b45SAndrew Rist * 20*f8e07b45SAndrew Rist *************************************************************/ 21*f8e07b45SAndrew Rist 22*f8e07b45SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir #ifndef __FRAMEWORK_THREADHELP_READGUARD_HXX_ 25cdf0e10cSrcweir #define __FRAMEWORK_THREADHELP_READGUARD_HXX_ 26cdf0e10cSrcweir 27cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 28cdf0e10cSrcweir // my own includes 29cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 30cdf0e10cSrcweir 31cdf0e10cSrcweir #include <threadhelp/inoncopyable.h> 32cdf0e10cSrcweir #include <threadhelp/irwlock.h> 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 to set read locks 63cdf0e10cSrcweir @descr This guard should be used to set a lock for reading object internal member. 64cdf0e10cSrcweir Nobody can control it but don't use member after successfuly locking for writing! 65cdf0e10cSrcweir We never need a own mutex to safe our internal member access - because 66cdf0e10cSrcweir a guard is used as function-local member only. There exist no multithreaded access to it realy ... 67cdf0e10cSrcweir 68cdf0e10cSrcweir @attention a) To prevent us against wrong using, the default ctor, copy ctor and the =operator are maked private! 69cdf0e10cSrcweir b) Use interface "IRWLock" of set LockHelper only - because we must support a finer granularity of locking. 70cdf0e10cSrcweir Interface "IMutex" should be used by easier guard implementations ... like "ResetableGuard"! 71cdf0e10cSrcweir 72cdf0e10cSrcweir @implements - 73cdf0e10cSrcweir @base INonCopyable 74cdf0e10cSrcweir 75cdf0e10cSrcweir @devstatus ready to use 76cdf0e10cSrcweir *//*-*************************************************************************************************************/ 77cdf0e10cSrcweir class ReadGuard : private INonCopyable 78cdf0e10cSrcweir { 79cdf0e10cSrcweir //------------------------------------------------------------------------------------------------------------- 80cdf0e10cSrcweir // public methods 81cdf0e10cSrcweir //------------------------------------------------------------------------------------------------------------- 82cdf0e10cSrcweir public: 83cdf0e10cSrcweir 84cdf0e10cSrcweir /*-****************************************************************************************************//** 85cdf0e10cSrcweir @short ctor 86cdf0e10cSrcweir @descr These ctors initialize the guard with a reference to used lock member of object to protect. 87cdf0e10cSrcweir Null isn't allowed as value! 88cdf0e10cSrcweir 89cdf0e10cSrcweir @seealso - 90cdf0e10cSrcweir 91cdf0e10cSrcweir @param "pLock" ,reference to used lock member of object to protect 92cdf0e10cSrcweir @param "rLock" ,reference to used lock member of object to protect 93cdf0e10cSrcweir @return - 94cdf0e10cSrcweir 95cdf0e10cSrcweir @onerror - 96cdf0e10cSrcweir *//*-*****************************************************************************************************/ ReadGuard(IRWLock * pLock)97cdf0e10cSrcweir inline ReadGuard( IRWLock* pLock ) 98cdf0e10cSrcweir : m_pLock ( pLock ) 99cdf0e10cSrcweir , m_bLocked ( sal_False ) 100cdf0e10cSrcweir { 101cdf0e10cSrcweir lock(); 102cdf0e10cSrcweir } 103cdf0e10cSrcweir 104cdf0e10cSrcweir //********************************************************************************************************* ReadGuard(IRWLock & rLock)105cdf0e10cSrcweir inline ReadGuard( IRWLock& rLock ) 106cdf0e10cSrcweir : m_pLock ( &rLock ) 107cdf0e10cSrcweir , m_bLocked ( sal_False ) 108cdf0e10cSrcweir { 109cdf0e10cSrcweir lock(); 110cdf0e10cSrcweir } 111cdf0e10cSrcweir 112cdf0e10cSrcweir /*-****************************************************************************************************//** 113cdf0e10cSrcweir @short dtor 114cdf0e10cSrcweir @descr We unlock the used lock member automaticly if user forget it. 115cdf0e10cSrcweir 116cdf0e10cSrcweir @seealso - 117cdf0e10cSrcweir 118cdf0e10cSrcweir @param - 119cdf0e10cSrcweir @return - 120cdf0e10cSrcweir 121cdf0e10cSrcweir @onerror - 122cdf0e10cSrcweir *//*-*****************************************************************************************************/ ~ReadGuard()123cdf0e10cSrcweir inline ~ReadGuard() 124cdf0e10cSrcweir { 125cdf0e10cSrcweir unlock(); 126cdf0e10cSrcweir } 127cdf0e10cSrcweir 128cdf0e10cSrcweir /*-****************************************************************************************************//** 129cdf0e10cSrcweir @short set read lock 130cdf0e10cSrcweir @descr Call this method to set the read lock. The call will block till all current threads are synchronized! 131cdf0e10cSrcweir 132cdf0e10cSrcweir @seealso method unlock() 133cdf0e10cSrcweir 134cdf0e10cSrcweir @param - 135cdf0e10cSrcweir @return - 136cdf0e10cSrcweir 137cdf0e10cSrcweir @onerror - 138cdf0e10cSrcweir *//*-*****************************************************************************************************/ lock()139cdf0e10cSrcweir inline void lock() 140cdf0e10cSrcweir { 141cdf0e10cSrcweir if( m_bLocked == sal_False ) 142cdf0e10cSrcweir { 143cdf0e10cSrcweir m_pLock->acquireReadAccess(); 144cdf0e10cSrcweir m_bLocked = sal_True; 145cdf0e10cSrcweir } 146cdf0e10cSrcweir } 147cdf0e10cSrcweir 148cdf0e10cSrcweir /*-****************************************************************************************************//** 149cdf0e10cSrcweir @short unset read lock 150cdf0e10cSrcweir @descr Call this method to unlock the rw-lock temp.! 151cdf0e10cSrcweir Normaly we do it at dtor automaticly for you ... 152cdf0e10cSrcweir 153cdf0e10cSrcweir @seealso method lock() 154cdf0e10cSrcweir 155cdf0e10cSrcweir @param - 156cdf0e10cSrcweir @return - 157cdf0e10cSrcweir 158cdf0e10cSrcweir @onerror - 159cdf0e10cSrcweir *//*-*****************************************************************************************************/ unlock()160cdf0e10cSrcweir inline void unlock() 161cdf0e10cSrcweir { 162cdf0e10cSrcweir if( m_bLocked == sal_True ) 163cdf0e10cSrcweir { 164cdf0e10cSrcweir m_pLock->releaseReadAccess(); 165cdf0e10cSrcweir m_bLocked = sal_False; 166cdf0e10cSrcweir } 167cdf0e10cSrcweir } 168cdf0e10cSrcweir 169cdf0e10cSrcweir //------------------------------------------------------------------------------------------------------------- 170cdf0e10cSrcweir // private methods 171cdf0e10cSrcweir //------------------------------------------------------------------------------------------------------------- 172cdf0e10cSrcweir private: 173cdf0e10cSrcweir 174cdf0e10cSrcweir /*-****************************************************************************************************//** 175cdf0e10cSrcweir @short disable using of these functions! 176cdf0e10cSrcweir @descr It's not allowed to use this methods. Different problem can occure otherwise. 177cdf0e10cSrcweir Thats why we disable it by make it private. 178cdf0e10cSrcweir 179cdf0e10cSrcweir @seealso other ctor 180cdf0e10cSrcweir 181cdf0e10cSrcweir @param - 182cdf0e10cSrcweir @return - 183cdf0e10cSrcweir 184cdf0e10cSrcweir @onerror - 185cdf0e10cSrcweir *//*-*****************************************************************************************************/ 186cdf0e10cSrcweir ReadGuard(); 187cdf0e10cSrcweir 188cdf0e10cSrcweir //------------------------------------------------------------------------------------------------------------- 189cdf0e10cSrcweir // private member 190cdf0e10cSrcweir //------------------------------------------------------------------------------------------------------------- 191cdf0e10cSrcweir private: 192cdf0e10cSrcweir 193cdf0e10cSrcweir IRWLock* m_pLock ; /// reference to lock-member of protected object 194cdf0e10cSrcweir sal_Bool m_bLocked ; /// protection against multiple lock calls without unlock! 195cdf0e10cSrcweir 196cdf0e10cSrcweir }; // class ReadGuard 197cdf0e10cSrcweir 198cdf0e10cSrcweir } // namespace framework 199cdf0e10cSrcweir 200cdf0e10cSrcweir #endif // #ifndef __FRAMEWORK_THREADHELP_READGUARD_HXX_ 201