xref: /aoo41x/main/framework/inc/threadhelp/igate.h (revision 228b4580)
1*228b4580SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*228b4580SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*228b4580SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*228b4580SAndrew Rist  * distributed with this work for additional information
6*228b4580SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*228b4580SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*228b4580SAndrew Rist  * "License"); you may not use this file except in compliance
9*228b4580SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*228b4580SAndrew Rist  *
11*228b4580SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*228b4580SAndrew Rist  *
13*228b4580SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*228b4580SAndrew Rist  * software distributed under the License is distributed on an
15*228b4580SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*228b4580SAndrew Rist  * KIND, either express or implied.  See the License for the
17*228b4580SAndrew Rist  * specific language governing permissions and limitations
18*228b4580SAndrew Rist  * under the License.
19*228b4580SAndrew Rist  *
20*228b4580SAndrew Rist  *************************************************************/
21*228b4580SAndrew Rist 
22*228b4580SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef __FRAMEWORK_THREADHELP_IGATE_H_
25cdf0e10cSrcweir #define __FRAMEWORK_THREADHELP_IGATE_H_
26cdf0e10cSrcweir 
27cdf0e10cSrcweir //_________________________________________________________________________________________________________________
28cdf0e10cSrcweir //	includes
29cdf0e10cSrcweir //_________________________________________________________________________________________________________________
30cdf0e10cSrcweir 
31cdf0e10cSrcweir #include <osl/time.h>
32cdf0e10cSrcweir 
33cdf0e10cSrcweir //_________________________________________________________________________________________________________________
34cdf0e10cSrcweir //	namespace
35cdf0e10cSrcweir //_________________________________________________________________________________________________________________
36cdf0e10cSrcweir 
37cdf0e10cSrcweir namespace framework{
38cdf0e10cSrcweir 
39cdf0e10cSrcweir //_________________________________________________________________________________________________________________
40cdf0e10cSrcweir //	declarations
41cdf0e10cSrcweir //_________________________________________________________________________________________________________________
42cdf0e10cSrcweir 
43cdf0e10cSrcweir /*-************************************************************************************************************//**
44cdf0e10cSrcweir     @descr          We need this interface to support using of different gate implementations in a generic way.
45cdf0e10cSrcweir *//*-*************************************************************************************************************/
46cdf0e10cSrcweir class IGate
47cdf0e10cSrcweir {
48cdf0e10cSrcweir 	//-------------------------------------------------------------------------------------------------------------
49cdf0e10cSrcweir 	//	public methods
50cdf0e10cSrcweir 	//-------------------------------------------------------------------------------------------------------------
51cdf0e10cSrcweir 	public:
52cdf0e10cSrcweir 
53cdf0e10cSrcweir 		/*-****************************************************************************************************//**
54cdf0e10cSrcweir 			@descr		These functions must be supported by a derived class!
55cdf0e10cSrcweir                             open()      -open access for all waiting threads
56cdf0e10cSrcweir                             close()     -close access for all further coming threads
57cdf0e10cSrcweir                             openGap()   -open access for current waiting threads only
58cdf0e10cSrcweir                             wait()      -must be called to pass the gate
59cdf0e10cSrcweir 		*//*-*****************************************************************************************************/
60cdf0e10cSrcweir         virtual void     open    (                                   ) = 0;
61cdf0e10cSrcweir         virtual void     close   (                                   ) = 0;
62cdf0e10cSrcweir         virtual void     openGap (                                   ) = 0;
63cdf0e10cSrcweir         virtual sal_Bool wait    ( const TimeValue* pTimeOut = NULL  ) = 0;
64cdf0e10cSrcweir 
65cdf0e10cSrcweir };      //  class IGate
66cdf0e10cSrcweir 
67cdf0e10cSrcweir }		//	namespace framework
68cdf0e10cSrcweir 
69cdf0e10cSrcweir #endif  //  #ifndef __FRAMEWORK_THREADHELP_IGATE_H_
70