include/framework/imutex.hxx

   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 INCLUDED_FRAMEWORK_IMUTEX_HXX
  21 #define INCLUDED_FRAMEWORK_IMUTEX_HXX
  22
  23 #include <sal/types.h>
  24
  25 namespace framework{
  26
  27 /*-************************************************************************************************************
  28     @descr          We need this interface to support using of different mutex implementations in a generic way.
  29 *//*-*************************************************************************************************************/
  30 class SAL_NO_VTABLE IMutex
  31 {
  32
  33     //  public methods
  34
  35     public:
  36
  37         /*-****************************************************************************************************
  38             @descr      These functions must be supported by a derived class!
  39                             acquire()     -try to register thread
  40                             release()     -unregister thread
  41         *//*-*****************************************************************************************************/
  42         virtual void acquire() = 0;
  43         virtual void release() = 0;
  44
  45     protected:
  46         ~IMutex() {}
  47 };      //  class IMutex
  48
  49 }       //  namespace framework
  50
  51 #endif // INCLUDED_FRAMEWORK_IMUTEX_HXX
  52
  53 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */