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