1 /************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28 #ifndef __FRAMEWORK_THREADHELP_IGATE_H_ 29 #define __FRAMEWORK_THREADHELP_IGATE_H_ 30 31 //_________________________________________________________________________________________________________________ 32 // includes 33 //_________________________________________________________________________________________________________________ 34 35 #include <osl/time.h> 36 37 //_________________________________________________________________________________________________________________ 38 // namespace 39 //_________________________________________________________________________________________________________________ 40 41 namespace framework{ 42 43 //_________________________________________________________________________________________________________________ 44 // declarations 45 //_________________________________________________________________________________________________________________ 46 47 /*-************************************************************************************************************//** 48 @descr We need this interface to support using of different gate implementations in a generic way. 49 *//*-*************************************************************************************************************/ 50 class IGate 51 { 52 //------------------------------------------------------------------------------------------------------------- 53 // public methods 54 //------------------------------------------------------------------------------------------------------------- 55 public: 56 57 /*-****************************************************************************************************//** 58 @descr These functions must be supported by a derived class! 59 open() -open access for all waiting threads 60 close() -close access for all further coming threads 61 openGap() -open access for current waiting threads only 62 wait() -must be called to pass the gate 63 *//*-*****************************************************************************************************/ 64 virtual void open ( ) = 0; 65 virtual void close ( ) = 0; 66 virtual void openGap ( ) = 0; 67 virtual sal_Bool wait ( const TimeValue* pTimeOut = NULL ) = 0; 68 69 }; // class IGate 70 71 } // namespace framework 72 73 #endif // #ifndef __FRAMEWORK_THREADHELP_IGATE_H_ 74