CATCritSec.h

Go to the documentation of this file.

/// \file    CATCritSec.h
/// \brief Defines the interface to critical sections for thread synchronization.
/// \ingroup CAT
///
/// Copyright (c) 2008 by Michael Ellison.
/// See COPYING.txt for the \ref gaslicense License (MIT License).
///
// $Author: mikeellison $
// $Date: 2008-01-26 03:19:45 -0600 (Sat, 26 Jan 2008) $
// $Revision:   $
// $NoKeywords: $

#ifndef _CATCritSec_H_
#define _CATCritSec_H_

#include "CATInternal.h"

/// \class CATCritSec
/// \brief Defines the interface to critical sections for thread synchronization.
/// \ingroup CAT
/// 
/// CATCritSec provides a per-thread synchronization object.  While one thread
/// owns a critical section, another may not receive it and will have to wait until
/// it is released.  A single thread, however, will not be forced to wait
/// if it tries to acquire the critical section twice before releasing it - just make
/// sure to call Release() for each Wait().
class CATCritSec
{
   public:
      CATCritSec();
      virtual ~CATCritSec();

      /// Wait until the critical section is available.
      ///
      /// \sa Release()
      void Wait();

      /// Release() releases an acquired critical section.
      ///
      /// \sa Wait()
      void Release();

   private:
      CATCritSec& operator=(const CATCritSec&)
      {
         CATASSERT(false,"Copying critical sections is not supported.");
         return *this;
      }

      // Platform specific critical section handles
      CRITICAL_SECTION fCritSec;
};


#endif // _CATCritSec_H_

---