Branch data Line data Source code
1 : : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : : /*************************************************************************
3 : : *
4 : : * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 : : *
6 : : * Copyright 2000, 2010 Oracle and/or its affiliates.
7 : : *
8 : : * OpenOffice.org - a multi-platform office productivity suite
9 : : *
10 : : * This file is part of OpenOffice.org.
11 : : *
12 : : * OpenOffice.org is free software: you can redistribute it and/or modify
13 : : * it under the terms of the GNU Lesser General Public License version 3
14 : : * only, as published by the Free Software Foundation.
15 : : *
16 : : * OpenOffice.org is distributed in the hope that it will be useful,
17 : : * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 : : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 : : * GNU Lesser General Public License version 3 for more details
20 : : * (a copy is included in the LICENSE file that accompanied this code).
21 : : *
22 : : * You should have received a copy of the GNU Lesser General Public License
23 : : * version 3 along with OpenOffice.org. If not, see
24 : : * <http://www.openoffice.org/license.html>
25 : : * for a copy of the LGPLv3 License.
26 : : *
27 : : ************************************************************************/
28 : :
29 : : #ifndef __FRAMEWORK_THREADHELP_IRWLOCK_H_
30 : : #define __FRAMEWORK_THREADHELP_IRWLOCK_H_
31 : :
32 : : namespace framework{
33 : :
34 : : /*-************************************************************************************************************//**
35 : : @descr A guard (specialy a write guard) support different internal working states.
36 : : His lock can set for reading or writing/reading! Or he was unlocked by user ...
37 : : *//*-*************************************************************************************************************/
38 : : enum ELockMode
39 : : {
40 : : E_NOLOCK ,
41 : : E_READLOCK ,
42 : : E_WRITELOCK
43 : : };
44 : :
45 : : /*-************************************************************************************************************//**
46 : : @descr We implement two guards for using an rw-lock. But if you wish to implement
47 : : different rw-locks to you will have problems by using with same guard implementation!
48 : : Thats why we define this "pure virtual base class" ...
49 : : All rw-locks must support this base interface for working and all guard must use this one too!
50 : : *//*-*************************************************************************************************************/
51 : 154769 : class IRWLock
52 : : {
53 : : //-------------------------------------------------------------------------------------------------------------
54 : : // public methods
55 : : //-------------------------------------------------------------------------------------------------------------
56 : : public:
57 : :
58 : : /*-****************************************************************************************************//**
59 : : @descr These functions must be supported by a derived class!
60 : : acquireReadAccess() -try to register thread as reader
61 : : releaseReadAccess() -unregister thread as reader
62 : : acquireWriteAccess() -try to register thread as writer
63 : : releaseWriteAccess() -unregister thread as writer
64 : : downgradeWriteAccess() -make writer to reader
65 : : *//*-*****************************************************************************************************/
66 : : virtual void acquireReadAccess () =0;
67 : : virtual void releaseReadAccess () =0;
68 : : virtual void acquireWriteAccess () =0;
69 : : virtual void releaseWriteAccess () =0;
70 : : virtual void downgradeWriteAccess () =0;
71 : :
72 : : protected:
73 : 147765 : ~IRWLock() {}
74 : : }; // class IRWLock
75 : :
76 : : } // namespace framework
77 : :
78 : : #endif // #ifndef __FRAMEWORK_THREADHELP_IRWLOCK_H_
79 : :
80 : : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
