framework/inc/threadhelp/igate.h

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