framework/inc/threadhelp/imutex.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: imutex.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_IMUTEX_H_
  32 #define __FRAMEWORK_THREADHELP_IMUTEX_H_
  33
  34 //_________________________________________________________________________________________________________________
  35 //      includes
  36 //_________________________________________________________________________________________________________________
  37
  38 //_________________________________________________________________________________________________________________
  39 //      namespace
  40 //_________________________________________________________________________________________________________________
  41
  42 namespace framework{
  43
  44 //_________________________________________________________________________________________________________________
  45 //      declarations
  46 //_________________________________________________________________________________________________________________
  47
  48 /*-************************************************************************************************************//**
  49     @descr          We need this interface to support using of different mutex implementations in a generic way.
  50 *//*-*************************************************************************************************************/
  51 class IMutex
  52 {
  53     //-------------------------------------------------------------------------------------------------------------
  54     //  public methods
  55     //-------------------------------------------------------------------------------------------------------------
  56     public:
  57
  58         /*-****************************************************************************************************//**
  59             @descr              These functions must be supported by a derived class!
  60                             acquire()     -try to register thread
  61                             release()     -unregister thread
  62         *//*-*****************************************************************************************************/
  63         virtual void acquire() = 0;
  64         virtual void release() = 0;
  65
  66 };      //  class IMutex
  67
  68 }               //      namespace framework
  69
  70 #endif  //  #ifndef __FRAMEWORK_THREADHELP_IMUTEX_H_