extl/win/synch/event.h

   1 /* ///////////////////////////////////////////////////////////////////////
   2  * File:                event.h
   3  *
   4  * Created:             08.03.20
   5  * Updated:             08.05.05
   6  *
   7  * Brief: event object class
   8  *
   9  * [<Home>]
  10  * Copyright (c) 2008-2020, Waruqi All rights reserved.
  11  * //////////////////////////////////////////////////////////////////// */
  12 #ifndef EXTL_WIN_SYNCH_EVENT_H
  13 #define EXTL_WIN_SYNCH_EVENT_H
  14
  15 /*!\file event.h
  16  * \brief event object class
  17  */
  18 #ifndef __cplusplus
  19 #       error event.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 event class
  39  * \ingroup extl_group_synch
  40  */
  41 class event : private uncopyable<event>
  42 {
  43         /// \name Types
  44         /// @{
  45         public:
  46                 typedef event                           class_type;
  47                 typedef HANDLE                          handle_type;
  48                 typedef HANDLE                          synch_object_type;
  49         /// @}
  50
  51         private:
  52                 /// The event object
  53                 synch_object_type                       m_event_obj;
  54
  55         /// \name Constructors
  56         /// @{
  57         public:
  58                 event()
  59                         : m_event_obj(NULL)
  60                 {
  61                 }
  62                 explicit_k event(e_bool_t bManualreset, e_bool_t bInitialState,
  63                                                         LPSECURITY_ATTRIBUTES psa = NULL)
  64                 : m_event_obj(create_event_(psa, bManualreset, bInitialState, NULL))
  65                 {
  66                 }
  67                 explicit_k event(e_tchar_t const* szName, e_bool_t bManualreset,
  68                                                         e_bool_t bInitialState, LPSECURITY_ATTRIBUTES psa = NULL)
  69                 : m_event_obj(create_event_(psa, bManualreset, bInitialState, szName))
  70                 {
  71                 }
  72                 virtual ~event() EXTL_THROW_0()
  73                 {
  74                         if(NULL != m_event_obj)
  75                         {
  76                                 ::CloseHandle(m_event_obj);
  77                                 m_event_obj = NULL;
  78                         }
  79                 }
  80         /// @}
  81         public:
  82                 /// Sets the event
  83                 e_bool_t set_event()
  84                 {
  85                         EXTL_ASSERT(NULL != m_event_obj);
  86
  87                         if(!::SetEvent(m_event_obj))
  88                         {
  89                                 EXTL_THROW_E(win_synch_error("SetEvent operation failed"));
  90                                 return e_false_v;
  91                         }
  92                         else return e_true_v;
  93                 }
  94
  95                 /// Resets the event
  96                 e_bool_t reset_event()
  97                 {
  98                         EXTL_ASSERT(NULL != m_event_obj);
  99
 100                         if(!::ResetEvent(m_event_obj))
 101                         {
 102                                 EXTL_THROW_E(win_synch_error("reset_event operation failed"));
 103                                 return e_false_v;
 104                         }
 105                         else return e_true_v;
 106                 }
 107                 /// Pulses the event
 108                 e_bool_t pulse_event()
 109                 {
 110                         EXTL_ASSERT(NULL != m_event_obj);
 111
 112                         if(!::PulseEvent(m_event_obj))
 113                         {
 114                                 EXTL_THROW_E(win_synch_error("PulseEvent operation failed"));
 115                                 return e_false_v;
 116                         }
 117                         else return e_true_v;
 118                 }
 119         public:
 120                 /// Returns object handle
 121                 operator handle_type() const
 122                 {
 123                         return m_event_obj;
 124                 }
 125                 /// Returns object handle
 126                 handle_type get_handle() const
 127                 {
 128                         return m_event_obj;
 129                 }
 130
 131                 /// Create event
 132                 void create(e_bool_t bManualreset, e_bool_t bInitialState,
 133                                                         LPSECURITY_ATTRIBUTES psa = NULL)
 134                 {
 135                         m_event_obj = create_event_(psa, bManualreset, bInitialState, NULL);
 136                 }
 137
 138                 /// Create event
 139                 void create(e_tchar_t const* szName, e_bool_t bManualreset,
 140                                                         e_bool_t bInitialState, LPSECURITY_ATTRIBUTES psa = NULL)
 141                 {
 142                         m_event_obj = create_event_(psa, bManualreset, bInitialState, szName);
 143                 }
 144
 145
 146         private:
 147                 synch_object_type create_event_(LPSECURITY_ATTRIBUTES psa, e_bool_t bManualreset, e_bool_t bInitialState, e_tchar_t const* pszName)
 148                 {
 149                         synch_object_type event_obj = ::CreateEvent(psa, bManualreset, bInitialState, pszName);
 150                         EXTL_ASSERT_THROW(event_obj != NULL, win_synch_error("Failed to create kernel event object"));
 151                         return event_obj;
 152                 }
 153 };
 154
 155 /* ///////////////////////////////////////////////////////////////////////
 156  * ::extl::platform::win namespace
 157  */
 158 EXTL_WIN_END_WHOLE_NAMESPACE
 159
 160 /* //////////////////////////////////////////////////////////////////// */
 161 #endif /* EXTL_WIN_SYNCH_EVENT_H */
 162 /* //////////////////////////////////////////////////////////////////// */