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_IGUARD_H_
      21             : #define __FRAMEWORK_THREADHELP_IGUARD_H_
      22             : 
      23             : #include <sal/types.h>
      24             : 
      25             : namespace framework{
      26             : 
      27             : /*-************************************************************************************************************//**
      28             :     @descr          interface for guarding a lock
      29             : *//*-*************************************************************************************************************/
      30           2 : class SAL_NO_VTABLE IGuard
      31             : {
      32             :     //-------------------------------------------------------------------------------------------------------------
      33             :     //  public methods
      34             :     //-------------------------------------------------------------------------------------------------------------
      35             :     public:
      36             : 
      37             :         /** clears the lock. If the guard does not currently hold the lock, nothing happens.
      38             :         */
      39             :         virtual void clear() = 0;
      40             : 
      41             :         /** attempts to re-establishes the lock, blocking until the attempt is successful.
      42             :         */
      43             :         virtual void reset() = 0;
      44             : 
      45             :     protected:
      46           2 :         ~IGuard() {}
      47             : 
      48             : };      //  class IGuard
      49             : 
      50             : }       //  namespace framework
      51             : 
      52             : #endif  //  #ifndef __FRAMEWORK_THREADHELP_IGUARD_H_
      53             : 
      54             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */