[80] | 1 | // |
---|
| 2 | // SynchronizedObject.h |
---|
| 3 | // |
---|
| 4 | // $Id: //poco/1.3/Foundation/include/Poco/SynchronizedObject.h#2 $ |
---|
| 5 | // |
---|
| 6 | // Library: Foundation |
---|
| 7 | // Package: Threading |
---|
| 8 | // Module: SynchronizedObject |
---|
| 9 | // |
---|
| 10 | // Definition of the SynchronizedObject class. |
---|
| 11 | // |
---|
| 12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
| 13 | // and Contributors. |
---|
| 14 | // |
---|
| 15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
| 16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
| 17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
| 18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
| 19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
| 20 | // do so, all subject to the following: |
---|
| 21 | // |
---|
| 22 | // The copyright notices in the Software and this entire statement, including |
---|
| 23 | // the above license grant, this restriction and the following disclaimer, |
---|
| 24 | // must be included in all copies of the Software, in whole or in part, and |
---|
| 25 | // all derivative works of the Software, unless such copies or derivative |
---|
| 26 | // works are solely in the form of machine-executable object code generated by |
---|
| 27 | // a source language processor. |
---|
| 28 | // |
---|
| 29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
| 30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
| 31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
| 32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
| 33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
| 34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
| 35 | // DEALINGS IN THE SOFTWARE. |
---|
| 36 | // |
---|
| 37 | |
---|
| 38 | |
---|
| 39 | #ifndef Foundation_SynchronizedObject_INCLUDED |
---|
| 40 | #define Foundation_SynchronizedObject_INCLUDED |
---|
| 41 | |
---|
| 42 | |
---|
| 43 | #include "Poco/Foundation.h" |
---|
| 44 | #include "Poco/Mutex.h" |
---|
| 45 | #include "Poco/Event.h" |
---|
| 46 | |
---|
| 47 | |
---|
| 48 | namespace Poco { |
---|
| 49 | |
---|
| 50 | |
---|
| 51 | class Foundation_API SynchronizedObject |
---|
| 52 | /// This class aggregates a Mutex and an Event |
---|
| 53 | /// and can act as a base class for all objects |
---|
| 54 | /// requiring synchronization in a multithreaded |
---|
| 55 | /// scenario. |
---|
| 56 | { |
---|
| 57 | public: |
---|
| 58 | typedef Poco::ScopedLock<SynchronizedObject> ScopedLock; |
---|
| 59 | |
---|
| 60 | SynchronizedObject(); |
---|
| 61 | /// Creates the object. |
---|
| 62 | |
---|
| 63 | virtual ~SynchronizedObject(); |
---|
| 64 | /// Destroys the object. |
---|
| 65 | |
---|
| 66 | void lock() const; |
---|
| 67 | /// Locks the object. Blocks if the object |
---|
| 68 | /// is locked by another thread. |
---|
| 69 | |
---|
| 70 | bool tryLock() const; |
---|
| 71 | /// Tries to lock the object. Returns false immediately |
---|
| 72 | /// if the object is already locked by another thread |
---|
| 73 | /// Returns true if the object was successfully locked. |
---|
| 74 | |
---|
| 75 | void unlock() const; |
---|
| 76 | /// Unlocks the object so that it can be locked by |
---|
| 77 | /// other threads. |
---|
| 78 | |
---|
| 79 | void notify() const; |
---|
| 80 | /// Signals the object. |
---|
| 81 | /// Exactly only one thread waiting for the object |
---|
| 82 | /// can resume execution. |
---|
| 83 | |
---|
| 84 | void wait() const; |
---|
| 85 | /// Waits for the object to become signalled. |
---|
| 86 | |
---|
| 87 | void wait(long milliseconds) const; |
---|
| 88 | /// Waits for the object to become signalled. |
---|
| 89 | /// Throws a TimeoutException if the object |
---|
| 90 | /// does not become signalled within the specified |
---|
| 91 | /// time interval. |
---|
| 92 | |
---|
| 93 | bool tryWait(long milliseconds) const; |
---|
| 94 | /// Waits for the object to become signalled. |
---|
| 95 | /// Returns true if the object |
---|
| 96 | /// became signalled within the specified |
---|
| 97 | /// time interval, false otherwise. |
---|
| 98 | |
---|
| 99 | private: |
---|
| 100 | mutable Mutex _mutex; |
---|
| 101 | mutable Event _event; |
---|
| 102 | }; |
---|
| 103 | |
---|
| 104 | |
---|
| 105 | // |
---|
| 106 | // inlines |
---|
| 107 | // |
---|
| 108 | inline void SynchronizedObject::lock() const |
---|
| 109 | { |
---|
| 110 | _mutex.lock(); |
---|
| 111 | } |
---|
| 112 | |
---|
| 113 | |
---|
| 114 | inline bool SynchronizedObject::tryLock() const |
---|
| 115 | { |
---|
| 116 | return _mutex.tryLock(); |
---|
| 117 | } |
---|
| 118 | |
---|
| 119 | |
---|
| 120 | inline void SynchronizedObject::unlock() const |
---|
| 121 | { |
---|
| 122 | _mutex.unlock(); |
---|
| 123 | } |
---|
| 124 | |
---|
| 125 | |
---|
| 126 | inline void SynchronizedObject::notify() const |
---|
| 127 | { |
---|
| 128 | _event.set(); |
---|
| 129 | } |
---|
| 130 | |
---|
| 131 | |
---|
| 132 | inline void SynchronizedObject::wait() const |
---|
| 133 | { |
---|
| 134 | _event.wait(); |
---|
| 135 | } |
---|
| 136 | |
---|
| 137 | |
---|
| 138 | inline void SynchronizedObject::wait(long milliseconds) const |
---|
| 139 | { |
---|
| 140 | _event.wait(milliseconds); |
---|
| 141 | } |
---|
| 142 | |
---|
| 143 | |
---|
| 144 | inline bool SynchronizedObject::tryWait(long milliseconds) const |
---|
| 145 | { |
---|
| 146 | return _event.tryWait(milliseconds); |
---|
| 147 | } |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | } // namespace Poco |
---|
| 151 | |
---|
| 152 | |
---|
| 153 | #endif // Foundation_SynchronizedObject_INCLUDED |
---|