1 | // |
---|
2 | // ScopedLock.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/Foundation/include/Poco/ScopedLock.h#2 $ |
---|
5 | // |
---|
6 | // Library: Foundation |
---|
7 | // Package: Threading |
---|
8 | // Module: Mutex |
---|
9 | // |
---|
10 | // Definition of the ScopedLock template 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_ScopedLock_INCLUDED |
---|
40 | #define Foundation_ScopedLock_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/Foundation.h" |
---|
44 | |
---|
45 | |
---|
46 | namespace Poco { |
---|
47 | |
---|
48 | |
---|
49 | template <class M> |
---|
50 | class ScopedLock |
---|
51 | /// A class that simplifies thread synchronization |
---|
52 | /// with a mutex. |
---|
53 | /// The constructor accepts a Mutex and locks it. |
---|
54 | /// The destructor unlocks the mutex. |
---|
55 | { |
---|
56 | public: |
---|
57 | ScopedLock(M& mutex): _mutex(mutex) |
---|
58 | { |
---|
59 | _mutex.lock(); |
---|
60 | } |
---|
61 | |
---|
62 | ~ScopedLock() |
---|
63 | { |
---|
64 | _mutex.unlock(); |
---|
65 | } |
---|
66 | |
---|
67 | private: |
---|
68 | M& _mutex; |
---|
69 | |
---|
70 | ScopedLock(); |
---|
71 | ScopedLock(const ScopedLock&); |
---|
72 | ScopedLock& operator = (const ScopedLock&); |
---|
73 | }; |
---|
74 | |
---|
75 | |
---|
76 | template <class M> |
---|
77 | class ScopedLockWithUnlock |
---|
78 | /// A class that simplifies thread synchronization |
---|
79 | /// with a mutex. |
---|
80 | /// The constructor accepts a Mutex and locks it. |
---|
81 | /// The destructor unlocks the mutex. |
---|
82 | /// The unlock() member function allows for manual |
---|
83 | /// unlocking of the mutex. |
---|
84 | { |
---|
85 | public: |
---|
86 | ScopedLockWithUnlock(M& mutex): _pMutex(&mutex) |
---|
87 | { |
---|
88 | _pMutex->lock(); |
---|
89 | } |
---|
90 | |
---|
91 | ~ScopedLockWithUnlock() |
---|
92 | { |
---|
93 | unlock(); |
---|
94 | } |
---|
95 | |
---|
96 | void unlock() |
---|
97 | { |
---|
98 | if (_pMutex) |
---|
99 | { |
---|
100 | _pMutex->unlock(); |
---|
101 | _pMutex = 0; |
---|
102 | } |
---|
103 | } |
---|
104 | |
---|
105 | private: |
---|
106 | M* _pMutex; |
---|
107 | |
---|
108 | ScopedLockWithUnlock(); |
---|
109 | ScopedLockWithUnlock(const ScopedLockWithUnlock&); |
---|
110 | ScopedLockWithUnlock& operator = (const ScopedLockWithUnlock&); |
---|
111 | }; |
---|
112 | |
---|
113 | |
---|
114 | } // namespace Poco |
---|
115 | |
---|
116 | |
---|
117 | #endif // Foundation_ScopedLock_INCLUDED |
---|