Branch data     Line data    Source code

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