include/comphelper/guarding.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_GUARDING_HXX
  21 #define INCLUDED_COMPHELPER_GUARDING_HXX
  22
  23 namespace osl { class Mutex; }
  24
  25
  26 namespace comphelper
  27 {
  28
  29
  30 // = class MutexRelease -
  31
  32
  33 /** opposite of OGuard :)
  34     (a mutex is released within the constructor and acquired within the destructor)
  35     use only when you're sure the mutex is acquired !
  36 */
  37 template <class MUTEX>
  38 class ORelease
  39 {
  40     MUTEX&  m_rMutex;
  41
  42 public:
  43     ORelease(MUTEX& _rMutex) : m_rMutex(_rMutex) { _rMutex.release(); }
  44     ~ORelease() { m_rMutex.acquire(); }
  45 };
  46
  47 typedef ORelease< ::osl::Mutex >    MutexRelease;
  48
  49
  50 }   // namespace comphelper
  51
  52
  53 #endif // INCLUDED_COMPHELPER_GUARDING_HXX
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */