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 __ZTREADWRITELOCK_H__ 24 #define __ZTREADWRITELOCK_H__ 25 26 #include "zthread/Lockable.h" 27 #include "zthread/NonCopyable.h" 28 29 namespace ZThread { 30 31 /** 32 * @class ReadWriteLock 33 * 34 * @author Eric Crahen <http://www.code-foo.com> 35 * @date <2003-07-16T10:17:31-0400> 36 * @version 2.2.7 37 * 38 * A ReadWriteLock provides a set of coordinated Lockable objects that can be used to 39 * guard an object; One for read-only access, and another for read-write access. 40 * 41 * @see BiasedReadWriteLock 42 * @see FairReadWriteLock 43 */ 44 class ReadWriteLock : public NonCopyable { 45 public: 46 47 /** 48 * Create a ReadWriteLock 49 * 50 * @exception Initialization_Exception thrown if resources could not be 51 * allocated for this object. 52 */ ReadWriteLock()53 ReadWriteLock() {} 54 55 //! Destroy this ReadWriteLock ~ReadWriteLock()56 virtual ~ReadWriteLock() {} 57 58 /** 59 * Get a reference to the read-only Lockable. 60 * 61 * @return <em>Lockable&</em> reference to a Lockable that provides read-only 62 * access. 63 */ 64 virtual Lockable& getReadLock() = 0; 65 66 /** 67 * Get a reference to the read-write Lockable. 68 * 69 * @return <em>Lockable&</em> reference to a Lockable that provides read-write 70 * access. 71 */ 72 virtual Lockable& getWriteLock() = 0; 73 74 75 }; /* ReadWriteLock */ 76 77 78 }; // __ZTREADWRITELOCK_H__ 79 80 #endif 81