src/AsyncFramework/CriticalSection.h

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by Stefan Fuhrmann                                 *
   3  *   stefanfuhrmann@alice-dsl.de                                           *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #pragma once
  22
  23 namespace async
  24 {
  25
  26 /**
  27 * Just a simple critical section (i.e. recursive mutex)
  28 * implementation with minimal overhead.
  29 */
  30
  31 class CCriticalSection
  32 {
  33 private:
  34
  35     /// OS-specific critical section object
  36
  37     CRITICAL_SECTION section;
  38
  39 public:
  40
  41     /// construction
  42
  43     CCriticalSection(void);
  44
  45     /// destruction
  46
  47     ~CCriticalSection(void);
  48
  49     /// Acquire the mutex, i.e. enter the critical section
  50
  51     void Acquire();
  52
  53     /// Release the mutex, i.e. leave the critical section
  54
  55     void Release();
  56 };
  57
  58 // Mutex functionality
  59
  60 __forceinline void CCriticalSection::Acquire()
  61 {
  62     EnterCriticalSection (&section);
  63 }
  64
  65 __forceinline void CCriticalSection::Release()
  66 {
  67     LeaveCriticalSection (&section);
  68 }
  69
  70 /**
  71 * RAII lock class for \ref CCriticalSection mutexes.
  72 */
  73
  74 class CCriticalSectionLock
  75 {
  76 private:
  77
  78     CCriticalSection& section;
  79
  80     // dummy assignment operator to silence the C4512 compiler warning
  81     // not implemented assignment operator (even is dummy and private) to
  82     // get rid of cppcheck error as well as accidental use
  83     CCriticalSectionLock & operator=( const CCriticalSectionLock & ) /*{ section = ; return * this; }*/;
  84 public:
  85
  86     __forceinline CCriticalSectionLock (CCriticalSection& section)
  87         : section (section)
  88     {
  89         section.Acquire();
  90     }
  91
  92     __forceinline ~CCriticalSectionLock()
  93     {
  94         section.Release();
  95     }
  96 };
  97
  98 }