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
|
/*************************************************************************
*
* $RCSfile: resetableguard.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: as $ $Date: 2001-06-11 10:24:36 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __FRAMEWORK_THREADHELP_RESETABLEGUARD_HXX_
#define __FRAMEWORK_THREADHELP_RESETABLEGUARD_HXX_
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
#ifndef __FRAMEWORK_THREADHELP_INONCOPYABLE_H_
#include <threadhelp/inoncopyable.h>
#endif
#ifndef __FRAMEWORK_THREADHELP_IMUTEX_H_
#include <threadhelp/imutex.h>
#endif
//#ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
//#include <threadhelp/threadhelpbase.hxx>
//#endif
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
#ifndef _SAL_TYPES_H_
#include <sal/types.h>
#endif
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
//_________________________________________________________________________________________________________________
// const
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// declarations
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short implement a guard for implementing save thread access
@descr These guard has an additional feature to well known one ::osl::Guard.
You can lock() and unlock() it very often!
A set bool flag inside protect this implementation against multiple lock() calls
without any unlock()! So the increasing of guarded mutex couldn't be greater then 1 ...
@attention a) To prevent us against wrong using, the default ctor, copy ctor and the =operator are maked private!
b) Use interface "IMutex" of set LockHelper only - because we must support an exclusiv locking.
Interface "IRWLock" should be used by special guard implementations ... like "ReadGuard" or "WriteGuard"!
@implements -
@base INonCopyable
@devstatus ready to use
*//*-*************************************************************************************************************/
class ResetableGuard : private INonCopyable
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
/*-****************************************************************************************************//**
@short ctors
@descr Use these ctor methods to initialize the guard right.
Given lock reference must be valid - otherwise crashes could occure!
@seealso -
@param "pLock", pointer to lock helper of user
@param "rLock", reference to lock helper of user
@return -
@onerror -
*//*-*****************************************************************************************************/
inline ResetableGuard( IMutex* pLock )
: m_pLock ( pLock )
, m_bLocked ( sal_False )
{
lock();
}
//*********************************************************************************************************
inline ResetableGuard( IMutex& rLock )
: m_pLock ( &rLock )
, m_bLocked ( sal_False )
{
lock();
}
/*-****************************************************************************************************//**
@short dtor
@descr We must release set mutex if programmer forget it ...
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
inline ~ResetableGuard()
{
unlock();
}
/*-****************************************************************************************************//**
@short enable/disable the lock
@descr Use this methods to lock or unlock the mutex.
You can do it so often you wish to do that ...
@attention We use another member to prevent us against multiple acquire calls of the same guard
without suitable release calls!
You don't must protect access at these bool member by using an own mutex ....
because nobody use the same guard instance from different threads!
It will be a function-local object every time.
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
inline void lock()
{
if( m_bLocked == sal_False )
{
m_pLock->acquire();
m_bLocked = sal_True;
}
}
//*********************************************************************************************************
inline void unlock()
{
if( m_bLocked == sal_True )
{
m_pLock->release();
m_bLocked = sal_False;
}
}
//-------------------------------------------------------------------------------------------------------------
// 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 -
*//*-*****************************************************************************************************/
ResetableGuard();
//-------------------------------------------------------------------------------------------------------------
// private member
//-------------------------------------------------------------------------------------------------------------
private:
IMutex* m_pLock ; /// pointer to safed lock member of user
sal_Bool m_bLocked ; /// protection against multiple lock() calls without unlock()
}; // class ResetableGuard
} // namespace framework
#endif // #ifndef __FRAMEWORK_THREADHELP_RESETABLEGUARD_HXX_
|
