blob: eaa1d5ac33b272eb18b326a2d06badcda636ce06 (
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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __FRAMEWORK_THREADHELP_READGUARD_HXX_
#define __FRAMEWORK_THREADHELP_READGUARD_HXX_
#include <threadhelp/inoncopyable.h>
#include <threadhelp/irwlock.h>
#include <sal/types.h>
namespace framework{
/*-************************************************************************************************************//**
@short implement a guard to set read locks
@descr This guard should be used to set a lock for reading object internal member.
Nobody can control it but don't use member after successfully locking for writing!
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 ReadGuard : 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 ReadGuard( IRWLock* pLock )
: m_pLock ( pLock )
, m_bLocked ( sal_False )
{
lock();
}
//*********************************************************************************************************
inline ReadGuard( IRWLock& rLock )
: m_pLock ( &rLock )
, m_bLocked ( sal_False )
{
lock();
}
/*-****************************************************************************************************//**
@short dtor
@descr We unlock the used lock member automaticly if user forget it.
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
inline ~ReadGuard()
{
unlock();
}
/*-****************************************************************************************************//**
@short set read lock
@descr Call this method to set the read lock. The call will block till all current threads are synchronized!
@seealso method unlock()
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
inline void lock()
{
if( m_bLocked == sal_False )
{
m_pLock->acquireReadAccess();
m_bLocked = sal_True;
}
}
/*-****************************************************************************************************//**
@short unset read 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()
{
if( m_bLocked == sal_True )
{
m_pLock->releaseReadAccess();
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 occur otherwise.
Thats why we disable it by make it private.
@seealso other ctor
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
ReadGuard();
//-------------------------------------------------------------------------------------------------------------
// private member
//-------------------------------------------------------------------------------------------------------------
private:
IRWLock* m_pLock ; /// reference to lock-member of protected object
sal_Bool m_bLocked ; /// protection against multiple lock calls without unlock!
}; // class ReadGuard
} // namespace framework
#endif // #ifndef __FRAMEWORK_THREADHELP_READGUARD_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
