Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef __FRAMEWORK_THREADHELP_IGATE_H_
      21             : #define __FRAMEWORK_THREADHELP_IGATE_H_
      22             : 
      23             : #include <osl/time.h>
      24             : 
      25             : namespace framework{
      26             : 
      27             : /*-************************************************************************************************************//**
      28             :     @descr          We need this interface to support using of different gate implementations in a generic way.
      29             : *//*-*************************************************************************************************************/
      30         520 : class IGate
      31             : {
      32             :     //-------------------------------------------------------------------------------------------------------------
      33             :     //  public methods
      34             :     //-------------------------------------------------------------------------------------------------------------
      35             :     public:
      36             : 
      37             :         /*-****************************************************************************************************//**
      38             :             @descr      These functions must be supported by a derived class!
      39             :                             open()      -open access for all waiting threads
      40             :                             close()     -close access for all further coming threads
      41             :                             openGap()   -open access for current waiting threads only
      42             :                             wait()      -must be called to pass the gate
      43             :         *//*-*****************************************************************************************************/
      44             :         virtual void     open    (                                   ) = 0;
      45             :         virtual void     close   (                                   ) = 0;
      46             :         virtual void     openGap (                                   ) = 0;
      47             :         virtual sal_Bool wait    ( const TimeValue* pTimeOut = NULL  ) = 0;
      48             : 
      49             :     protected:
      50         154 :         ~IGate() {}
      51             : };      //  class IGate
      52             : 
      53             : }       //  namespace framework
      54             : 
      55             : #endif  //  #ifndef __FRAMEWORK_THREADHELP_IGATE_H_
      56             : 
      57             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */