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