• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2010 Vicente J. Botet Escriba
3  * Copyright 2015, 2017 Andrey Semashev
4  *
5  * Distributed under the Boost Software License, Version 1.0.
6  * See http://www.boost.org/LICENSE_1_0.txt
7  */
8 
9 #ifndef BOOST_WINAPI_EVENT_HPP_INCLUDED_
10 #define BOOST_WINAPI_EVENT_HPP_INCLUDED_
11 
12 #include <boost/winapi/basic_types.hpp>
13 #include <boost/winapi/detail/header.hpp>
14 
15 #ifdef BOOST_HAS_PRAGMA_ONCE
16 #pragma once
17 #endif
18 
19 #if !defined( BOOST_USE_WINDOWS_H ) && BOOST_WINAPI_PARTITION_APP_SYSTEM
20 extern "C" {
21 #if !defined( BOOST_NO_ANSI_APIS )
22 BOOST_WINAPI_IMPORT boost::winapi::HANDLE_ BOOST_WINAPI_WINAPI_CC
23 CreateEventA(
24     ::_SECURITY_ATTRIBUTES* lpEventAttributes,
25     boost::winapi::BOOL_ bManualReset,
26     boost::winapi::BOOL_ bInitialState,
27     boost::winapi::LPCSTR_ lpName);
28 #endif
29 
30 BOOST_WINAPI_IMPORT_EXCEPT_WM boost::winapi::HANDLE_ BOOST_WINAPI_WINAPI_CC
31 CreateEventW(
32     ::_SECURITY_ATTRIBUTES* lpEventAttributes,
33     boost::winapi::BOOL_ bManualReset,
34     boost::winapi::BOOL_ bInitialState,
35     boost::winapi::LPCWSTR_ lpName);
36 } // extern "C"
37 #endif // !defined( BOOST_USE_WINDOWS_H ) && BOOST_WINAPI_PARTITION_APP_SYSTEM
38 
39 #if !defined( BOOST_USE_WINDOWS_H )
40 extern "C" {
41 #if !defined( BOOST_NO_ANSI_APIS )
42 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
43 BOOST_WINAPI_IMPORT boost::winapi::HANDLE_ BOOST_WINAPI_WINAPI_CC
44 CreateEventExA(
45     ::_SECURITY_ATTRIBUTES *lpEventAttributes,
46     boost::winapi::LPCSTR_ lpName,
47     boost::winapi::DWORD_ dwFlags,
48     boost::winapi::DWORD_ dwDesiredAccess);
49 #endif
50 
51 BOOST_WINAPI_IMPORT boost::winapi::HANDLE_ BOOST_WINAPI_WINAPI_CC
52 OpenEventA(
53     boost::winapi::DWORD_ dwDesiredAccess,
54     boost::winapi::BOOL_ bInheritHandle,
55     boost::winapi::LPCSTR_ lpName);
56 #endif // !defined( BOOST_NO_ANSI_APIS )
57 
58 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
59 BOOST_WINAPI_IMPORT boost::winapi::HANDLE_ BOOST_WINAPI_WINAPI_CC
60 CreateEventExW(
61     ::_SECURITY_ATTRIBUTES *lpEventAttributes,
62     boost::winapi::LPCWSTR_ lpName,
63     boost::winapi::DWORD_ dwFlags,
64     boost::winapi::DWORD_ dwDesiredAccess);
65 #endif
66 
67 BOOST_WINAPI_IMPORT_EXCEPT_WM boost::winapi::HANDLE_ BOOST_WINAPI_WINAPI_CC
68 OpenEventW(
69     boost::winapi::DWORD_ dwDesiredAccess,
70     boost::winapi::BOOL_ bInheritHandle,
71     boost::winapi::LPCWSTR_ lpName);
72 
73 // Windows CE define SetEvent/ResetEvent as inline functions in kfuncs.h
74 #if !defined( UNDER_CE )
75 BOOST_WINAPI_IMPORT boost::winapi::BOOL_ BOOST_WINAPI_WINAPI_CC
76 SetEvent(boost::winapi::HANDLE_ hEvent);
77 
78 BOOST_WINAPI_IMPORT boost::winapi::BOOL_ BOOST_WINAPI_WINAPI_CC
79 ResetEvent(boost::winapi::HANDLE_ hEvent);
80 #endif
81 } // extern "C"
82 #endif
83 
84 namespace boost {
85 namespace winapi {
86 
87 #if !defined( BOOST_NO_ANSI_APIS )
88 using ::OpenEventA;
89 #endif
90 using ::OpenEventW;
91 using ::SetEvent;
92 using ::ResetEvent;
93 
94 #if defined( BOOST_USE_WINDOWS_H )
95 
96 BOOST_CONSTEXPR_OR_CONST DWORD_ EVENT_ALL_ACCESS_ = EVENT_ALL_ACCESS;
97 BOOST_CONSTEXPR_OR_CONST DWORD_ EVENT_MODIFY_STATE_ = EVENT_MODIFY_STATE;
98 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
99 BOOST_CONSTEXPR_OR_CONST DWORD_ CREATE_EVENT_INITIAL_SET_ = CREATE_EVENT_INITIAL_SET;
100 BOOST_CONSTEXPR_OR_CONST DWORD_ CREATE_EVENT_MANUAL_RESET_ = CREATE_EVENT_MANUAL_RESET;
101 #endif
102 
103 #else // defined( BOOST_USE_WINDOWS_H )
104 
105 BOOST_CONSTEXPR_OR_CONST DWORD_ EVENT_ALL_ACCESS_ = 0x001F0003;
106 BOOST_CONSTEXPR_OR_CONST DWORD_ EVENT_MODIFY_STATE_ = 0x00000002;
107 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
108 BOOST_CONSTEXPR_OR_CONST DWORD_ CREATE_EVENT_INITIAL_SET_ = 0x00000002;
109 BOOST_CONSTEXPR_OR_CONST DWORD_ CREATE_EVENT_MANUAL_RESET_ = 0x00000001;
110 #endif
111 
112 #endif // defined( BOOST_USE_WINDOWS_H )
113 
114 // Undocumented and not present in Windows SDK. Enables NtQueryEvent.
115 // http://undocumented.ntinternals.net/index.html?page=UserMode%2FUndocumented%20Functions%2FNT%20Objects%2FEvent%2FNtQueryEvent.html
116 BOOST_CONSTEXPR_OR_CONST DWORD_ EVENT_QUERY_STATE_ = 0x00000001;
117 
118 BOOST_CONSTEXPR_OR_CONST DWORD_ event_all_access = EVENT_ALL_ACCESS_;
119 BOOST_CONSTEXPR_OR_CONST DWORD_ event_modify_state = EVENT_MODIFY_STATE_;
120 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
121 BOOST_CONSTEXPR_OR_CONST DWORD_ create_event_initial_set = CREATE_EVENT_INITIAL_SET_;
122 BOOST_CONSTEXPR_OR_CONST DWORD_ create_event_manual_reset = CREATE_EVENT_MANUAL_RESET_;
123 #endif
124 
125 #if !defined( BOOST_NO_ANSI_APIS )
CreateEventA(SECURITY_ATTRIBUTES_ * lpEventAttributes,BOOL_ bManualReset,BOOL_ bInitialState,LPCSTR_ lpName)126 BOOST_FORCEINLINE HANDLE_ CreateEventA(SECURITY_ATTRIBUTES_* lpEventAttributes, BOOL_ bManualReset, BOOL_ bInitialState, LPCSTR_ lpName)
127 {
128 #if !BOOST_WINAPI_PARTITION_APP_SYSTEM && BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
129     const DWORD_ flags = (bManualReset ? create_event_manual_reset : 0u) | (bInitialState ? create_event_initial_set : 0u);
130     return ::CreateEventExA(reinterpret_cast< ::_SECURITY_ATTRIBUTES* >(lpEventAttributes), lpName, flags, event_all_access);
131 #else
132     return ::CreateEventA(reinterpret_cast< ::_SECURITY_ATTRIBUTES* >(lpEventAttributes), bManualReset, bInitialState, lpName);
133 #endif
134 }
135 
136 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
CreateEventExA(SECURITY_ATTRIBUTES_ * lpEventAttributes,LPCSTR_ lpName,DWORD_ dwFlags,DWORD_ dwDesiredAccess)137 BOOST_FORCEINLINE HANDLE_ CreateEventExA(SECURITY_ATTRIBUTES_* lpEventAttributes, LPCSTR_ lpName, DWORD_ dwFlags, DWORD_ dwDesiredAccess)
138 {
139     return ::CreateEventExA(reinterpret_cast< ::_SECURITY_ATTRIBUTES* >(lpEventAttributes), lpName, dwFlags, dwDesiredAccess);
140 }
141 #endif
142 #endif
143 
CreateEventW(SECURITY_ATTRIBUTES_ * lpEventAttributes,BOOL_ bManualReset,BOOL_ bInitialState,LPCWSTR_ lpName)144 BOOST_FORCEINLINE HANDLE_ CreateEventW(SECURITY_ATTRIBUTES_* lpEventAttributes, BOOL_ bManualReset, BOOL_ bInitialState, LPCWSTR_ lpName)
145 {
146 #if !BOOST_WINAPI_PARTITION_APP_SYSTEM && BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
147     const DWORD_ flags = (bManualReset ? create_event_manual_reset : 0u) | (bInitialState ? create_event_initial_set : 0u);
148     return ::CreateEventExW(reinterpret_cast< ::_SECURITY_ATTRIBUTES* >(lpEventAttributes), lpName, flags, event_all_access);
149 #else
150     return ::CreateEventW(reinterpret_cast< ::_SECURITY_ATTRIBUTES* >(lpEventAttributes), bManualReset, bInitialState, lpName);
151 #endif
152 }
153 
154 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
CreateEventExW(SECURITY_ATTRIBUTES_ * lpEventAttributes,LPCWSTR_ lpName,DWORD_ dwFlags,DWORD_ dwDesiredAccess)155 BOOST_FORCEINLINE HANDLE_ CreateEventExW(SECURITY_ATTRIBUTES_* lpEventAttributes, LPCWSTR_ lpName, DWORD_ dwFlags, DWORD_ dwDesiredAccess)
156 {
157     return ::CreateEventExW(reinterpret_cast< ::_SECURITY_ATTRIBUTES* >(lpEventAttributes), lpName, dwFlags, dwDesiredAccess);
158 }
159 #endif
160 
161 #if !defined( BOOST_NO_ANSI_APIS )
create_event(SECURITY_ATTRIBUTES_ * lpEventAttributes,BOOL_ bManualReset,BOOL_ bInitialState,LPCSTR_ lpName)162 BOOST_FORCEINLINE HANDLE_ create_event(SECURITY_ATTRIBUTES_* lpEventAttributes, BOOL_ bManualReset, BOOL_ bInitialState, LPCSTR_ lpName)
163 {
164     return winapi::CreateEventA(lpEventAttributes, bManualReset, bInitialState, lpName);
165 }
166 
open_event(DWORD_ dwDesiredAccess,BOOL_ bInheritHandle,LPCSTR_ lpName)167 BOOST_FORCEINLINE HANDLE_ open_event(DWORD_ dwDesiredAccess, BOOL_ bInheritHandle, LPCSTR_ lpName)
168 {
169     return ::OpenEventA(dwDesiredAccess, bInheritHandle, lpName);
170 }
171 #endif
172 
create_event(SECURITY_ATTRIBUTES_ * lpEventAttributes,BOOL_ bManualReset,BOOL_ bInitialState,LPCWSTR_ lpName)173 BOOST_FORCEINLINE HANDLE_ create_event(SECURITY_ATTRIBUTES_* lpEventAttributes, BOOL_ bManualReset, BOOL_ bInitialState, LPCWSTR_ lpName)
174 {
175     return winapi::CreateEventW(lpEventAttributes, bManualReset, bInitialState, lpName);
176 }
177 
open_event(DWORD_ dwDesiredAccess,BOOL_ bInheritHandle,LPCWSTR_ lpName)178 BOOST_FORCEINLINE HANDLE_ open_event(DWORD_ dwDesiredAccess, BOOL_ bInheritHandle, LPCWSTR_ lpName)
179 {
180     return ::OpenEventW(dwDesiredAccess, bInheritHandle, lpName);
181 }
182 
create_anonymous_event(SECURITY_ATTRIBUTES_ * lpEventAttributes,BOOL_ bManualReset,BOOL_ bInitialState)183 BOOST_FORCEINLINE HANDLE_ create_anonymous_event(SECURITY_ATTRIBUTES_* lpEventAttributes, BOOL_ bManualReset, BOOL_ bInitialState)
184 {
185     return winapi::CreateEventW(lpEventAttributes, bManualReset, bInitialState, 0);
186 }
187 
188 }
189 }
190 
191 #include <boost/winapi/detail/footer.hpp>
192 
193 #endif // BOOST_WINAPI_EVENT_HPP_INCLUDED_
194