critsec.h

Go to the documentation of this file.

/**
 * \file critsec.h <mi32/critsec.h>
 * \brief Definition for Windows Critical section objects
 *
 * \if NODOC
 * $Id: critsec.h_v 1.5 2005/05/16 16:19:38 scowan Exp $
 *
 * $Log: critsec.h_v $
 * Revision 1.5  2005/05/16 16:19:38  scowan
 * Move lock class into dll and export.
 *
 * Revision 1.4  2004/10/07 15:35:32  mju
 * Add copy ctor and op=.
 *
 * Revision 1.3  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.2  2002/01/16 18:13:32  scowan
 * Do stupid thing for MAC.
 *
 * Revision 1.1  2001/12/06 17:46:22  scowan
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MI32_CRITSEC_H
#define  INC_MI32_CRITSEC_H

#ifndef GENERATING_DOXYGEN_OUTPUT
#if defined(WIN32)
#ifndef _WINBASE_
extern "C" {
struct _RTL_CRITICAL_SECTION;
}
#endif
#endif
#endif // GENERATING_DOXYGEN_OUTPUT

#include <mi32/stddefns.h>

#ifdef MISYSTEMDLL
   #define CLASSLIBEXPORT MI_DLLCLASSEXPORT
#else
   #define CLASSLIBEXPORT MI_DLLCLASSIMPORT
#endif

//! Critical section class for WIN32, UNIX and MAC platforms.  Currently only implemented for WIN32.
class CLASSLIBEXPORT CRITICALSECTION {
   public:

      #ifndef GENERATING_DOXYGEN_OUTPUT
      class LOCK;
      friend class LOCK;
      #endif

      //! Default constructor.
      CRITICALSECTION (
         unsigned long SpinCount = 0   //!< How many times to check and yield before allocating a system resource
         );
         
      //! Destructor.
      ~CRITICALSECTION (
         );
         
      //! Set spin count for the critical section
      unsigned long SetSpinCount (
         unsigned long SpinCount       //!< How many times to check and yield before allocating a system resource
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      #if defined(WIN32)
         _RTL_CRITICAL_SECTION* m_cs;
      #else
         void* m_cs;
      #endif
      
      CRITICALSECTION (const CRITICALSECTION& rhs);
      CRITICALSECTION& operator= (const CRITICALSECTION& rhs);

      #endif // GENERATING_DOXYGEN_OUTPUT
   };


//! Control of entering an instance of a CRITICALSECTION upon initialization and
//! released when out of scope.  Inlined for speed reasons.
class CLASSLIBEXPORT CRITICALSECTION::LOCK {
   public:
      //! Default constructor - used to implement TryEnter() paradigm.
      LOCK ();
            
      //! Constructor - Get critical section or wait until it is available
      explicit LOCK (
         CRITICALSECTION& sc,
         bool EnterSection = true         //!< Flag to allow setting of non-multithread mode
         );

      //! Destructor - Releases critical section            
      ~LOCK ();
            
      //! Check if it is possible to enter a critical section
      //! @return 'True' if entered critical section, 'false' if not
      bool TryEnter (
         CRITICALSECTION& sc
         );
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      CRITICALSECTION* m_sc;  
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

#undef   CLASSLIBEXPORT
#endif   //!< INC_MI32_CRITSEC_H

---