blob: f96672188da30c01421b77d63469ab04f35d09bf (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: writeguard.hxx,v $
* $Revision: 1.7 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __FRAMEWORK_THREADHELP_WRITEGUARD_HXX_
#define __FRAMEWORK_THREADHELP_WRITEGUARD_HXX_
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
#include <threadhelp/inoncopyable.h>
#include <threadhelp/irwlock.h>
//#ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
//#include <threadhelp/threadhelpbase.hxx>
//#endif
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
//_________________________________________________________________________________________________________________
// const
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// declarations
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short implement a guard to set write locks
@descr This guard should be used to set a lock for reading AND writing object internal member.
We never need a own mutex to safe our internal member access - because
a guard is used as function-local member only. There exist no multithreaded access to it realy ...
@attention a) To prevent us against wrong using, the default ctor, copy ctor and the =operator are maked private!
b) Use interface "IRWLock" of set LockHelper only - because we must support a finer granularity of locking.
Interface "IMutex" should be used by easier guard implementations ... like "ResetableGuard"!
@implements -
@base INonCopyable
@devstatus ready to use
*//*-*************************************************************************************************************/
class WriteGuard : private INonCopyable
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
/*-****************************************************************************************************//**
@short ctor
@descr These ctors initialize the guard with a reference to used lock member of object to protect.
Null isn't allowed as value!
@seealso -
@param "pLock" ,reference to used lock member of object to protect
@param "rLock" ,reference to used lock member of object to protect
@return -
@onerror -
*//*-*****************************************************************************************************/
inline WriteGuard( IRWLock* pLock )
: m_pLock ( pLock )
, m_eMode ( E_NOLOCK )
{
lock();
}
//*********************************************************************************************************
inline WriteGuard( IRWLock& rLock )
: m_pLock ( &rLock )
, m_eMode ( E_NOLOCK )
{
lock();
}
/*-****************************************************************************************************//**
@short dtor
@descr We unlock the used lock member automaticly if user forget it.
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
inline ~WriteGuard()
{
unlock();
}
/*-****************************************************************************************************//**
@short set write lock
@descr Call this method to set the write lock. The call will block till all current threads are synchronized!
@seealso method unlock()
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
inline void lock()
{
switch( m_eMode )
{
case E_NOLOCK : {
// Acquire write access and set return state.
// Mode is set later if it was successful!
m_pLock->acquireWriteAccess();
m_eMode = E_WRITELOCK;
}
break;
case E_READLOCK : {
// User has downgrade to read access before!
// We must release it before we can set a new write access!
m_pLock->releaseReadAccess();
m_pLock->acquireWriteAccess();
m_eMode = E_WRITELOCK;
}
break;
default: break; // nothing to do
}
}
/*-****************************************************************************************************//**
@short unset write lock
@descr Call this method to unlock the rw-lock temp.!
Normaly we do it at dtor automaticly for you ...
@seealso method lock()
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
inline void unlock()
{
switch( m_eMode )
{
case E_READLOCK : {
// User has downgraded to a read lock before!
// => There isn't realy a write lock ...
m_pLock->releaseReadAccess();
m_eMode = E_NOLOCK;
}
break;
case E_WRITELOCK : {
m_pLock->releaseWriteAccess();
m_eMode = E_NOLOCK;
}
break;
default: break; // nothing to do
}
}
/*-****************************************************************************************************//**
@short downgrade write access to read access without new blocking!
@descr If this write lock is set you can change it to a "read lock".
An "upgrade" is the same like new calling "lock()"!
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
inline void downgrade()
{
if( m_eMode == E_WRITELOCK )
{
m_pLock->downgradeWriteAccess();
m_eMode = E_READLOCK;
}
}
/*-****************************************************************************************************//**
@short return internal states
@descr For user they dont know what they are doing ...
@seealso -
@param -
@return Current set lock mode.
@onerror No error should occure.
*//*-*****************************************************************************************************/
inline ELockMode getMode() const
{
return m_eMode;
}
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private:
/*-****************************************************************************************************//**
@short disable using of these functions!
@descr It's not allowed to use this methods. Different problem can occure otherwise.
Thats why we disable it by make it private.
@seealso other ctor
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
WriteGuard();
//-------------------------------------------------------------------------------------------------------------
// private member
//-------------------------------------------------------------------------------------------------------------
private:
IRWLock* m_pLock ; /// reference to lock-member of protected object
ELockMode m_eMode ; /// protection against multiple lock calls without unlock and difference between supported lock modi
}; // class WriteGuard
} // namespace framework
#endif // #ifndef __FRAMEWORK_THREADHELP_WRITEGUARD_HXX_
|
