framework/inc/helper/shareablemutex.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_INC_HELPER_SHAREABLEMUTEX_HXX
  21 #define INCLUDED_FRAMEWORK_INC_HELPER_SHAREABLEMUTEX_HXX
  22
  23 #include <osl/interlck.h>
  24 #include <osl/mutex.hxx>
  25 #include <fwidllapi.h>
  26
  27 namespace framework
  28 {
  29
  30 /**
  31  * This acts like a rtl::Reference<osl::Mutex>
  32  */
  33 class FWI_DLLPUBLIC ShareableMutex
  34 {
  35     public:
  36         ShareableMutex();
  37         ShareableMutex( const ShareableMutex& rShareableMutex );
  38         const ShareableMutex& operator=( const ShareableMutex& rShareableMutex );
  39
  40         ~ShareableMutex() { m_pMutexRef->release(); }
  41
  42         /** acquire the shared mutex */
  43         void acquire();
  44         /** release the shared mutex */
  45         void release();
  46
  47     private:
  48         /* ShareableMutex::MutexRef will destroy itself when the last ShareableMutex pointing to it is destroyed */
  49         struct MutexRef
  50         {
  51             MutexRef() : m_refCount(0) {}
  52             void acquire()
  53             {
  54                 osl_atomic_increment( &m_refCount );
  55             }
  56
  57             void release()
  58             {
  59                 if ( osl_atomic_decrement( &m_refCount ) == 0 )
  60                     delete this;
  61             }
  62
  63             oslInterlockedCount m_refCount;
  64             osl::Mutex          m_oslMutex;
  65         };
  66
  67         MutexRef* m_pMutexRef;
  68 };
  69
  70 class ShareGuard
  71 {
  72     public:
  73         ShareGuard( ShareableMutex& rShareMutex ) :
  74             m_rShareMutex( rShareMutex )
  75         {
  76             m_rShareMutex.acquire();
  77         }
  78
  79         ~ShareGuard()
  80         {
  81             m_rShareMutex.release();
  82         }
  83
  84     private:
  85         ShareGuard& operator=( const ShareGuard& ) SAL_DELETED_FUNCTION;
  86
  87         ShareableMutex& m_rShareMutex;
  88 };
  89
  90 }
  91
  92 #endif // INCLUDED_FRAMEWORK_INC_HELPER_SHAREABLEMUTEX_HXX
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */