include/comphelper/sharedmutex.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_COMPHELPER_SHAREDMUTEX_HXX
  21 #define INCLUDED_COMPHELPER_SHAREDMUTEX_HXX
  22
  23 #include <comphelper/comphelperdllapi.h>
  24 #include <memory>
  25
  26 namespace osl { class Mutex; }
  27
  28 namespace comphelper
  29 {
  30
  31
  32     //= SharedMutex
  33
  34     class COMPHELPER_DLLPUBLIC SharedMutex
  35     {
  36     public:
  37         SharedMutex();
  38
  39         operator ::osl::Mutex& () { return *m_pMutexImpl; }
  40
  41     private:
  42         std::shared_ptr< ::osl::Mutex >  m_pMutexImpl;
  43     };
  44
  45
  46     //= SharedMutexBase
  47
  48     /** sometimes, it's necessary to have an initialized ::osl::Mutex to pass
  49         to some ctor call of your base class. In this case, you can't hold the
  50         SharedMutex as member, but you need to move it into another base class,
  51         which is initialized before the mutex-requiring class is.
  52     */
  53     class COMPHELPER_DLLPUBLIC SharedMutexBase
  54     {
  55     protected:
  56         SharedMutexBase()
  57         {
  58         }
  59         ~SharedMutexBase()
  60         {
  61         }
  62
  63     protected:
  64         ::osl::Mutex&   getMutex() const { return m_aMutex; }
  65         SharedMutex&    getSharedMutex() const { return m_aMutex; }
  66
  67     private:
  68         mutable SharedMutex m_aMutex;
  69     };
  70
  71
  72 } // namespace comphelper
  73
  74
  75 #endif // INCLUDED_COMPHELPER_SHAREDMUTEX_HXX
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */