extl/win/synch/mutex_lock.h

   1 /* ///////////////////////////////////////////////////////////////////////
   2  * File:                mutex_lock.h
   3  *
   4  * Created:             08.03.21
   5  * Updated:             08.05.05
   6  *
   7  * Brief: mutex_lock class
   8  *
   9  * [<Home>]
  10  * Copyright (c) 2008-2020, Waruqi All rights reserved.
  11  * //////////////////////////////////////////////////////////////////// */
  12 #ifndef EXTL_WIN_SYNCH_MUTEX_LOCK_H
  13 #define EXTL_WIN_SYNCH_MUTEX_LOCK_H
  14
  15 /*!\file mutex_lock.h
  16  * \brief mutex_lock class
  17  */
  18 #ifndef __cplusplus
  19 #       error mutex_lock.h need be supported by c++.
  20 #endif
  21
  22 /* ///////////////////////////////////////////////////////////////////////
  23  * Includes
  24  */
  25 #include "../win.h"
  26 #include "../../synch/lock_base.h"
  27 #include "mutex.h"
  28
  29 /* ///////////////////////////////////////////////////////////////////////
  30  * ::extl::platform::win namespace
  31  */
  32 EXTL_WIN_BEGIN_WHOLE_NAMESPACE
  33
  34 /*!\brief mutex_lock class
  35  * \ingroup extl_group_synch
  36  */
  37 class mutex_lock
  38         : public lock_base< mutex_lock >
  39 {
  40         public:
  41                 typedef lock_base< mutex_lock >                 base_type;
  42                 typedef mutex_lock                                              class_type;
  43                 typedef base_type::size_type                    size_type;
  44
  45         private:
  46                 mutex                                                                   m_mutex_obj;
  47
  48         public:
  49                 mutex_lock()
  50                 :       base_type(), m_mutex_obj(e_false_v)
  51
  52                 {
  53                         EXTL_ASSERT(is_valid());
  54                 }
  55
  56                 ~mutex_lock()
  57                 {
  58                         if(base_type::is_locked())
  59                         {
  60                                 base_type::unlock();
  61                         }
  62                 }
  63
  64         public:
  65                 void do_lock()
  66                 {
  67                         EXTL_ASSERT(is_valid());
  68
  69                         /* Waits the mutex object */
  70                         ::WaitForSingleObject(m_mutex_obj, INFINITE);
  71
  72                 }
  73                 e_bool_t do_trylock()
  74                 {
  75                         EXTL_ASSERT(is_valid());
  76                         /* Try waiting the mutex object for 100 milliseconds */
  77                         return (WAIT_TIMEOUT != ::WaitForSingleObject(m_mutex_obj, 100));
  78                 }
  79                 void do_unlock()
  80                 {
  81                         EXTL_ASSERT(is_valid());
  82                         /* Release the mutex object */
  83                         m_mutex_obj.release();
  84                 }
  85         private:
  86                 e_bool_t is_valid()
  87                 {
  88                         return ((m_mutex_obj != NULL) && (m_mutex_obj != INVALID_HANDLE_VALUE));
  89                 }
  90 };
  91
  92 /* ///////////////////////////////////////////////////////////////////////
  93  * Unit-testing
  94  */
  95 #ifdef EXTL_SYNCH_LOCK_TEST_ENABLE
  96 #       include "unit_test/mutex_lock_test.h"
  97 #endif
  98 /* ///////////////////////////////////////////////////////////////////////
  99  * ::extl::platform::win namespace
 100  */
 101 EXTL_WIN_END_WHOLE_NAMESPACE
 102
 103 /* //////////////////////////////////////////////////////////////////// */
 104 #endif /* EXTL_WIN_SYNCH_MUTEX_LOCK_H */
 105 /* //////////////////////////////////////////////////////////////////// */