blob: f961f2c2a40ea1574a7f384be40e7e9a808a61f0 (
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
|
/* -*- 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 INCLUDED_FRAMEWORK_INC_THREADHELP_LOCKHELPER_HXX
#define INCLUDED_FRAMEWORK_INC_THREADHELP_LOCKHELPER_HXX
#include <threadhelp/inoncopyable.h>
#include <framework/imutex.hxx>
#include <threadhelp/irwlock.h>
#include <threadhelp/fairrwlock.hxx>
#include <comphelper/solarmutex.hxx>
#include <fwidllapi.h>
namespace framework{
/*-************************************************************************************************************
@short helper to set right lock in right situation
@descr This helper support different types of locking:
a) no locks - transparent for user!
This could be useful for simluation or single threaded environments!
b) own mutex
An object use his own osl-mutex to be threadsafe. Useful for easy and exclusiv locking.
c) solar mutex
An object use our solar mutex and will be a part of a greater safed "threadsafe code block".
Could be useful for simulation and testing of higher modules!
d) fair rw-lock
An object use an implementation of a fair rw-lock. This increase granularity of t hreadsafe mechanism
and should be used for high performance threadsafe code!
@attention We support two interfaces - "IMutex" and "IRWLock". Don't mix using of it!
A guard implementation should use one interface only!
@implements IMutex
@implements IRWLock
@base INonCopyable
IMutex
IRWLock
@devstatus draft
*//*-*************************************************************************************************************/
class FWI_DLLPUBLIC LockHelper : public IMutex
, public IRWLock
, private INonCopyable
{
// public methods
public:
// ctor/dtor
LockHelper( comphelper::SolarMutex* pSolarMutex = NULL );
virtual ~LockHelper( );
// interface ::framework::IMutex
virtual void acquire();
virtual void release();
// interface ::framework::IRWLock
virtual void acquireReadAccess ();
virtual void releaseReadAccess ();
virtual void acquireWriteAccess ();
virtual void releaseWriteAccess ();
virtual void downgradeWriteAccess();
// something else
static LockHelper& getGlobalLock();
//TODO: this presumable should return the SolarMutex, though it
// actually returns some independent mutex
::osl::Mutex& getShareableOslMutex( );
// private member
// Make some member mutable for using in const functions!
private:
mutable comphelper::SolarMutex* m_pSolarMutex ;
mutable ::osl::Mutex* m_pShareableOslMutex ;
mutable sal_Bool m_bDummySolarMutex ;
};
} // namespace framework
#endif // INCLUDED_FRAMEWORK_INC_THREADHELP_LOCKHELPER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
