xref: /AOO41X/main/sal/inc/systools/win32/SyncObjects.hxx (revision 565d668c30d8a6cacc881c774c5068be5401257d)
1*565d668cSAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*565d668cSAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*565d668cSAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*565d668cSAndrew Rist  * distributed with this work for additional information
6*565d668cSAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*565d668cSAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*565d668cSAndrew Rist  * "License"); you may not use this file except in compliance
9*565d668cSAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11*565d668cSAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13*565d668cSAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*565d668cSAndrew Rist  * software distributed under the License is distributed on an
15*565d668cSAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*565d668cSAndrew Rist  * KIND, either express or implied.  See the License for the
17*565d668cSAndrew Rist  * specific language governing permissions and limitations
18*565d668cSAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20*565d668cSAndrew Rist  *************************************************************/
21*565d668cSAndrew Rist 
22*565d668cSAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir 
25cdf0e10cSrcweir #ifndef _SYNCOBJECTS_HXX_
26cdf0e10cSrcweir #define _SYNCOBJECTS_HXX_
27cdf0e10cSrcweir 
28cdf0e10cSrcweir //------------------------------------------------------------------------
29cdf0e10cSrcweir // includes
30cdf0e10cSrcweir //------------------------------------------------------------------------
31cdf0e10cSrcweir 
32cdf0e10cSrcweir #include <windows.h>
33cdf0e10cSrcweir 
34cdf0e10cSrcweir //------------------------------------------------------------------------
35cdf0e10cSrcweir // a simple helper template for automatic locking/unlocking
36cdf0e10cSrcweir //------------------------------------------------------------------------
37cdf0e10cSrcweir 
38cdf0e10cSrcweir template< class LOCK >
39cdf0e10cSrcweir class CLockGuard
40cdf0e10cSrcweir {
41cdf0e10cSrcweir public:
CLockGuard(LOCK * aLock)42cdf0e10cSrcweir 	CLockGuard( LOCK* aLock ) :
43cdf0e10cSrcweir 		m_pLock( aLock )
44cdf0e10cSrcweir 	{
45cdf0e10cSrcweir 		m_pLock->Lock( );
46cdf0e10cSrcweir 	}
47cdf0e10cSrcweir 
~CLockGuard()48cdf0e10cSrcweir 	~CLockGuard( )
49cdf0e10cSrcweir 	{
50cdf0e10cSrcweir 		m_pLock->Unlock( );
51cdf0e10cSrcweir 	}
52cdf0e10cSrcweir 
53cdf0e10cSrcweir private:
54cdf0e10cSrcweir 	LOCK* m_pLock;
55cdf0e10cSrcweir };
56cdf0e10cSrcweir 
57cdf0e10cSrcweir //------------------------------------------------------------------------
58cdf0e10cSrcweir // a interface base class for different locking sub classes
59cdf0e10cSrcweir //------------------------------------------------------------------------
60cdf0e10cSrcweir 
61cdf0e10cSrcweir class CSyncObject
62cdf0e10cSrcweir {
63cdf0e10cSrcweir public:
64cdf0e10cSrcweir 	virtual ~CSyncObject( ) = 0;
65cdf0e10cSrcweir 
66cdf0e10cSrcweir 	virtual int Lock( )     = 0;
67cdf0e10cSrcweir 	virtual int Unlock( )   = 0;
68cdf0e10cSrcweir };
69cdf0e10cSrcweir 
70cdf0e10cSrcweir //------------------------------------------------------------------------
71cdf0e10cSrcweir // if no synchronization is necessary this class will be used
72cdf0e10cSrcweir // declaring the functions as inline safes runtime overhead
73cdf0e10cSrcweir //------------------------------------------------------------------------
74cdf0e10cSrcweir 
75cdf0e10cSrcweir class CNullLock
76cdf0e10cSrcweir {
77cdf0e10cSrcweir public:
~CNullLock()78cdf0e10cSrcweir 	inline virtual ~CNullLock ( ) {};
Lock()79cdf0e10cSrcweir 	inline virtual int Lock( )    {};
Unlock()80cdf0e10cSrcweir 	inline virtual int Unlock()   {};
81cdf0e10cSrcweir };
82cdf0e10cSrcweir 
83cdf0e10cSrcweir //------------------------------------------------------------------------
84cdf0e10cSrcweir // a minimal wrapper for a win32 critical section
85cdf0e10cSrcweir //------------------------------------------------------------------------
86cdf0e10cSrcweir 
87cdf0e10cSrcweir class CCriticalSection : public CSyncObject
88cdf0e10cSrcweir {
89cdf0e10cSrcweir public:
90cdf0e10cSrcweir 	CCriticalSection( );
91cdf0e10cSrcweir 	virtual ~CCriticalSection( );
92cdf0e10cSrcweir 
93cdf0e10cSrcweir 	// both functions return always 0
94cdf0e10cSrcweir 	// because the win32 critsec functions
95cdf0e10cSrcweir 	// don't return any return code
96cdf0e10cSrcweir 	virtual int Lock( );
97cdf0e10cSrcweir 	virtual int Unlock( );
98cdf0e10cSrcweir 
99cdf0e10cSrcweir private:
100cdf0e10cSrcweir 	CRITICAL_SECTION m_critSec;
101cdf0e10cSrcweir };
102cdf0e10cSrcweir 
103cdf0e10cSrcweir 
104cdf0e10cSrcweir typedef CLockGuard< CSyncObject > SyncObjLockGuard_t;
105cdf0e10cSrcweir 
106cdf0e10cSrcweir #endif
107