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