extl/win/synch/semaphore.h

   1 /* ///////////////////////////////////////////////////////////////////////
   2  * File:                semaphore.h
   3  *
   4  * Created:             08.03.23
   5  * Updated:             08.05.05
   6  *
   7  * Brief: semaphore object class
   8  *
   9  * [<Home>]
  10  * Copyright (c) 2008-2020, Waruqi All rights reserved.
  11  * //////////////////////////////////////////////////////////////////// */
  12 #ifndef EXTL_WIN_SYNCH_SEMAPHORE_H
  13 #define EXTL_WIN_SYNCH_SEMAPHORE_H
  14
  15 /*!\file semaphore.h
  16  * \brief semaphore object class
  17  */
  18 #ifndef __cplusplus
  19 #       error semaphore.h need be supported by c++.
  20 #endif
  21
  22 /* ///////////////////////////////////////////////////////////////////////
  23  * Includes
  24  */
  25 #include "../win.h"
  26 #include "../../utility/uncopyable.h"
  27
  28 #if defined(EXTL_EXCEPTION_SUPPORT) && \
  29                 defined(EXTL_EXCEPTION_ENABLE)
  30 #       include "../error/win_synch_error.h"
  31 #endif
  32
  33 /* ///////////////////////////////////////////////////////////////////////
  34  * ::extl::platform::win namespace
  35  */
  36 EXTL_WIN_BEGIN_WHOLE_NAMESPACE
  37
  38 /*!\brief semaphore class
  39  * \ingroup extl_group_synch
  40  */
  41 class semaphore : private uncopyable<semaphore>
  42 {
  43         /// \name Types
  44         /// @{
  45         public:
  46                 typedef semaphore                       class_type;
  47                 typedef HANDLE                          handle_type;
  48                 typedef HANDLE                          synch_object_type;
  49                 typedef LONG                            size_type;
  50         /// @}
  51
  52         private:
  53                 /// The semaphore object
  54                 synch_object_type                                       m_semaphore_obj;
  55
  56         /// \name Constructors
  57         /// @{
  58         public:
  59                 semaphore()
  60                         : m_semaphore_obj(NULL)
  61                 {}
  62                 explicit_k semaphore(size_type nInitialCount, size_type nMaxCount,
  63                                                         LPSECURITY_ATTRIBUTES psa = NULL)
  64                 : m_semaphore_obj(create_semaphore_(psa, nInitialCount, nMaxCount, NULL))
  65                 {
  66                 }
  67                 explicit_k semaphore(e_tchar_t const* szName, size_type nInitialCount,
  68                                                                 size_type nMaxCount, LPSECURITY_ATTRIBUTES psa = NULL)
  69                 : m_semaphore_obj(create_semaphore_(psa, nInitialCount, nMaxCount, szName))
  70                 {
  71                 }
  72         public:
  73                 virtual ~semaphore() EXTL_THROW_0()
  74                 {
  75                         if(NULL != m_semaphore_obj)
  76                         {
  77                                 ::CloseHandle(m_semaphore_obj);
  78                                 m_semaphore_obj = NULL;
  79                         }
  80                 }
  81         /// @}
  82
  83         public:
  84                 /// Release the semaphore object
  85                 e_bool_t release(size_type n, size_type* lpPrevCount = NULL)
  86                 {
  87                         EXTL_ASSERT(NULL != m_semaphore_obj);
  88
  89                         if(!::ReleaseSemaphore(m_semaphore_obj, n, lpPrevCount))
  90                         {
  91                                 EXTL_THROW_E(win_synch_error("ReleaseMutex operation failed"));
  92                                 return e_false_v;
  93                         }
  94                         else return e_true_v;
  95                 }
  96
  97         public:
  98                 /// Returns object handle
  99                 operator handle_type() const
 100                 {
 101                         return m_semaphore_obj;
 102                 }
 103                 /// Returns object handle
 104                 handle_type get_handle() const
 105                 {
 106                         return m_semaphore_obj;
 107                 }
 108
 109                 /// Create semaphore object
 110                 void create(size_type nInitialCount, size_type nMaxCount,
 111                                                         LPSECURITY_ATTRIBUTES psa = NULL)
 112                 {
 113                         m_semaphore_obj = create_semaphore_(psa, nInitialCount, nMaxCount, NULL);
 114                 }
 115                 /// Create semaphore object
 116                 void create(e_tchar_t const* szName, size_type nInitialCount,
 117                                                                 size_type nMaxCount, LPSECURITY_ATTRIBUTES psa = NULL)
 118                 {
 119                         m_semaphore_obj = create_semaphore_(psa, nInitialCount, nMaxCount, szName);
 120                 }
 121
 122         private:
 123                 synch_object_type create_semaphore_(LPSECURITY_ATTRIBUTES psa, size_type nInitialCount, size_type nMaxCount, e_tchar_t const* pszName)
 124                 {
 125                         synch_object_type semaphore_obj = ::CreateSemaphore(psa, nInitialCount, nMaxCount, pszName);
 126                         EXTL_ASSERT_THROW(semaphore_obj != NULL, win_synch_error("Failed to create kernel semaphore object"));
 127                         return semaphore_obj;
 128                 }
 129 };
 130
 131 /* ///////////////////////////////////////////////////////////////////////
 132  * ::extl::platform::win namespace
 133  */
 134 EXTL_WIN_END_WHOLE_NAMESPACE
 135
 136 /* //////////////////////////////////////////////////////////////////// */
 137 #endif /* EXTL_WIN_SYNCH_SEMAPHORE_H */
 138 /* //////////////////////////////////////////////////////////////////// */