ReactOS 0.4.16-dev-1255-g6dd0406
threadpoolapiset.h
Go to the documentation of this file.
1
2#pragma once
3
4#ifndef _THREADPOOLAPISET_H_
5#define _THREADPOOLAPISET_H_
6
7#include <windef.h> // FIXME: use minwindef.h
8
9// HACK: we should include minwinbase.h, but we don't have that
10typedef struct _CRITICAL_SECTION *PCRITICAL_SECTION;
11
12#ifdef __cplusplus
13extern "C" {
14#endif
15
16WINBASEAPI
17_Must_inspect_result_
18PTP_POOL
19WINAPI
20CreateThreadpool(
21 _Reserved_ PVOID reserved);
22
23WINBASEAPI
24VOID
25WINAPI
26CloseThreadpool(
27 _Inout_ PTP_POOL ptpp);
28
29WINBASEAPI
30BOOL
31WINAPI
32SetThreadpoolThreadMinimum(
33 _Inout_ PTP_POOL ptpp,
34 _In_ DWORD cthrdMic);
35
36WINBASEAPI
37VOID
38WINAPI
39SetThreadpoolThreadMaximum(
40 _Inout_ PTP_POOL ptpp,
41 _In_ DWORD cthrdMost);
42
43WINBASEAPI
44BOOL
45WINAPI
46QueryThreadpoolStackInformation(
47 _In_ PTP_POOL ptpp,
48 _Out_ PTP_POOL_STACK_INFORMATION ptpsi);
49
50WINBASEAPI
51BOOL
52WINAPI
53SetThreadpoolStackInformation(
54 _Inout_ PTP_POOL ptpp,
55 _In_ PTP_POOL_STACK_INFORMATION ptpsi);
56
57WINBASEAPI
58_Must_inspect_result_
59BOOL
60WINAPI
61TrySubmitThreadpoolCallback(
62 _In_ PTP_SIMPLE_CALLBACK pfns,
63 _Inout_opt_ PVOID pv,
64 _In_opt_ PTP_CALLBACK_ENVIRON pcbe);
65
66WINBASEAPI
67BOOL
68WINAPI
69CallbackMayRunLong(
70 _Inout_ PTP_CALLBACK_INSTANCE pci);
71
72WINBASEAPI
73VOID
74WINAPI
75DisassociateCurrentThreadFromCallback(
76 _Inout_ PTP_CALLBACK_INSTANCE pci);
77
78WINBASEAPI
79VOID
80WINAPI
81FreeLibraryWhenCallbackReturns(
82 _Inout_ PTP_CALLBACK_INSTANCE pci,
83 _In_ HMODULE mod);
84
85WINBASEAPI
86VOID
87WINAPI
88LeaveCriticalSectionWhenCallbackReturns(
89 _Inout_ PTP_CALLBACK_INSTANCE pci,
90 _Inout_ PCRITICAL_SECTION pcs);
91
92WINBASEAPI
93VOID
94WINAPI
95ReleaseMutexWhenCallbackReturns(
96 _Inout_ PTP_CALLBACK_INSTANCE pci,
97 _In_ HANDLE mut);
98
99WINBASEAPI
100VOID
101WINAPI
102ReleaseSemaphoreWhenCallbackReturns(
103 _Inout_ PTP_CALLBACK_INSTANCE pci,
104 _In_ HANDLE sem,
105 _In_ DWORD crel);
106
107WINBASEAPI
108VOID
109WINAPI
110SetEventWhenCallbackReturns(
111 _Inout_ PTP_CALLBACK_INSTANCE pci,
112 _In_ HANDLE evt);
113
114WINBASEAPI
115_Must_inspect_result_
116PTP_CLEANUP_GROUP
117WINAPI
118CreateThreadpoolCleanupGroup(
119 VOID);
120
121WINBASEAPI
122VOID
123WINAPI
124CloseThreadpoolCleanupGroup(
125 _Inout_ PTP_CLEANUP_GROUP ptpcg);
126
127WINBASEAPI
128VOID
129WINAPI
130CloseThreadpoolCleanupGroupMembers(
131 _Inout_ PTP_CLEANUP_GROUP ptpcg,
132 _In_ BOOL fCancelPendingCallbacks,
133 _Inout_opt_ PVOID pvCleanupContext);
134
135typedef
136VOID
137(WINAPI *PTP_WIN32_IO_CALLBACK)(
138 _Inout_ PTP_CALLBACK_INSTANCE Instance,
139 _Inout_opt_ PVOID Context,
140 _Inout_opt_ PVOID Overlapped,
141 _In_ ULONG IoResult,
142 _In_ ULONG_PTR NumberOfBytesTransferred,
143 _Inout_ PTP_IO Io);
144
145WINBASEAPI
146_Must_inspect_result_
147PTP_IO
148WINAPI
149CreateThreadpoolIo(
150 _In_ HANDLE fl,
151 _In_ PTP_WIN32_IO_CALLBACK pfnio,
152 _Inout_opt_ PVOID pv,
153 _In_opt_ PTP_CALLBACK_ENVIRON pcbe);
154
155WINBASEAPI
156VOID
157WINAPI
158CloseThreadpoolIo(
159 _Inout_ PTP_IO pio);
160
161WINBASEAPI
162VOID
163WINAPI
164StartThreadpoolIo(
165 _Inout_ PTP_IO pio);
166
167WINBASEAPI
168VOID
169WINAPI
170CancelThreadpoolIo(
171 _Inout_ PTP_IO pio);
172
173WINBASEAPI
174VOID
175WINAPI
176WaitForThreadpoolIoCallbacks(
177 _Inout_ PTP_IO pio,
178 _In_ BOOL fCancelPendingCallbacks);
179
180WINBASEAPI
181_Must_inspect_result_
182PTP_TIMER
183WINAPI
184CreateThreadpoolTimer(
185 _In_ PTP_TIMER_CALLBACK pfnti,
186 _Inout_opt_ PVOID pv,
187 _In_opt_ PTP_CALLBACK_ENVIRON pcbe);
188
189WINBASEAPI
190VOID
191WINAPI
192CloseThreadpoolTimer(
193 _Inout_ PTP_TIMER pti);
194
195WINBASEAPI
196VOID
197WINAPI
198SetThreadpoolTimer(
199 _Inout_ PTP_TIMER pti,
200 _In_opt_ PFILETIME pftDueTime,
201 _In_ DWORD msPeriod,
202 _In_opt_ DWORD msWindowLength);
203
204WINBASEAPI
205BOOL
206WINAPI
207SetThreadpoolTimerEx(
208 _Inout_ PTP_TIMER pti,
209 _In_opt_ PFILETIME pftDueTime,
210 _In_ DWORD msPeriod,
211 _In_opt_ DWORD msWindowLength);
212
213WINBASEAPI
214BOOL
215WINAPI
216IsThreadpoolTimerSet(
217 _Inout_ PTP_TIMER pti);
218
219WINBASEAPI
220VOID
221WINAPI
222WaitForThreadpoolTimerCallbacks(
223 _Inout_ PTP_TIMER pti,
224 _In_ BOOL fCancelPendingCallbacks);
225
226WINBASEAPI
227_Must_inspect_result_
228PTP_WAIT
229WINAPI
230CreateThreadpoolWait(
231 _In_ PTP_WAIT_CALLBACK pfnwa,
232 _Inout_opt_ PVOID pv,
233 _In_opt_ PTP_CALLBACK_ENVIRON pcbe);
234
235WINBASEAPI
236VOID
237WINAPI
238CloseThreadpoolWait(
239 _Inout_ PTP_WAIT pwa);
240
241WINBASEAPI
242VOID
243WINAPI
244SetThreadpoolWait(
245 _Inout_ PTP_WAIT pwa,
246 _In_opt_ HANDLE h,
247 _In_opt_ PFILETIME pftTimeout);
248
249WINBASEAPI
250BOOL
251WINAPI
252SetThreadpoolWaitEx(
253 _Inout_ PTP_WAIT pwa,
254 _In_opt_ HANDLE h,
255 _In_opt_ PFILETIME pftTimeout,
256 _Reserved_ PVOID Reserved);
257
258WINBASEAPI
259VOID
260WINAPI
261WaitForThreadpoolWaitCallbacks(
262 _Inout_ PTP_WAIT pwa,
263 _In_ BOOL fCancelPendingCallbacks);
264
265WINBASEAPI
266_Must_inspect_result_
267PTP_WORK
268WINAPI
269CreateThreadpoolWork(
270 _In_ PTP_WORK_CALLBACK pfnwk,
271 _Inout_opt_ PVOID pv,
272 _In_opt_ PTP_CALLBACK_ENVIRON pcbe);
273
274WINBASEAPI
275VOID
276WINAPI
277CloseThreadpoolWork(
278 _Inout_ PTP_WORK pwk);
279
280WINBASEAPI
281VOID
282WINAPI
283SubmitThreadpoolWork(
284 _Inout_ PTP_WORK pwk);
285
286WINBASEAPI
287VOID
288WINAPI
289WaitForThreadpoolWorkCallbacks(
290 _Inout_ PTP_WORK pwk,
291 _In_ BOOL fCancelPendingCallbacks);
292
293#ifdef __cplusplus
294} // extern "C"
295#endif
296
297#endif // _THREADPOOLAPISET_H_
mod
std::map< E_MODULE, HMODULE > mod
Definition: LocaleTests.cpp:66
VOID
#define VOID
Definition: acefi.h:82
CreateThreadpoolCleanupGroup
PTP_CLEANUP_GROUP WINAPI DECLSPEC_HOTPATCH CreateThreadpoolCleanupGroup(void)
Definition: thread.c:1267
reserved
r reserved
Definition: btrfs.c:3006
BOOL
unsigned int BOOL
Definition: ntddk_ex.h:94
DWORD
unsigned long DWORD
Definition: ntddk_ex.h:95
h
GLfloat GLfloat GLfloat GLfloat h
Definition: glext.h:7723
WINBASEAPI
#define WINBASEAPI
Definition: green.h:8
sem
static HANDLE sem
Definition: sync.c:674
_Inout_
#define _Inout_
Definition: no_sal2.h:162
_Inout_opt_
#define _Inout_opt_
Definition: no_sal2.h:216
_Must_inspect_result_
#define _Must_inspect_result_
Definition: no_sal2.h:62
_Out_
#define _Out_
Definition: no_sal2.h:160
_In_
#define _In_
Definition: no_sal2.h:158
_In_opt_
#define _In_opt_
Definition: no_sal2.h:212
_Reserved_
#define _Reserved_
Definition: no_sal2.h:504
_CRITICAL_SECTION
Definition: winbase.h:934
_FILETIME
Definition: mapidefs.h:60
_TP_CALLBACK_ENVIRON_V3
Definition: winnt_old.h:4539
_TP_POOL_STACK_INFORMATION
Definition: winnt_old.h:4512
WaitForThreadpoolTimerCallbacks
WINBASEAPI VOID WINAPI WaitForThreadpoolTimerCallbacks(_Inout_ PTP_TIMER pti, _In_ BOOL fCancelPendingCallbacks)
PTP_WIN32_IO_CALLBACK
VOID(WINAPI * PTP_WIN32_IO_CALLBACK)(_Inout_ PTP_CALLBACK_INSTANCE Instance, _Inout_opt_ PVOID Context, _Inout_opt_ PVOID Overlapped, _In_ ULONG IoResult, _In_ ULONG_PTR NumberOfBytesTransferred, _Inout_ PTP_IO Io)
Definition: threadpoolapiset.h:137
ReleaseMutexWhenCallbackReturns
WINBASEAPI VOID WINAPI ReleaseMutexWhenCallbackReturns(_Inout_ PTP_CALLBACK_INSTANCE pci, _In_ HANDLE mut)
ReleaseSemaphoreWhenCallbackReturns
WINBASEAPI VOID WINAPI ReleaseSemaphoreWhenCallbackReturns(_Inout_ PTP_CALLBACK_INSTANCE pci, _In_ HANDLE sem, _In_ DWORD crel)
IsThreadpoolTimerSet
WINBASEAPI BOOL WINAPI IsThreadpoolTimerSet(_Inout_ PTP_TIMER pti)
CreateThreadpoolIo
WINBASEAPI _Must_inspect_result_ PTP_IO WINAPI CreateThreadpoolIo(_In_ HANDLE fl, _In_ PTP_WIN32_IO_CALLBACK pfnio, _Inout_opt_ PVOID pv, _In_opt_ PTP_CALLBACK_ENVIRON pcbe)
WaitForThreadpoolIoCallbacks
WINBASEAPI VOID WINAPI WaitForThreadpoolIoCallbacks(_Inout_ PTP_IO pio, _In_ BOOL fCancelPendingCallbacks)
SetThreadpoolTimerEx
WINBASEAPI BOOL WINAPI SetThreadpoolTimerEx(_Inout_ PTP_TIMER pti, _In_opt_ PFILETIME pftDueTime, _In_ DWORD msPeriod, _In_opt_ DWORD msWindowLength)
CloseThreadpoolWork
WINBASEAPI VOID WINAPI CloseThreadpoolWork(_Inout_ PTP_WORK pwk)
CloseThreadpoolTimer
WINBASEAPI VOID WINAPI CloseThreadpoolTimer(_Inout_ PTP_TIMER pti)
StartThreadpoolIo
WINBASEAPI VOID WINAPI StartThreadpoolIo(_Inout_ PTP_IO pio)
CreateThreadpoolWait
WINBASEAPI _Must_inspect_result_ PTP_WAIT WINAPI CreateThreadpoolWait(_In_ PTP_WAIT_CALLBACK pfnwa, _Inout_opt_ PVOID pv, _In_opt_ PTP_CALLBACK_ENVIRON pcbe)
SetThreadpoolTimer
WINBASEAPI VOID WINAPI SetThreadpoolTimer(_Inout_ PTP_TIMER pti, _In_opt_ PFILETIME pftDueTime, _In_ DWORD msPeriod, _In_opt_ DWORD msWindowLength)
CancelThreadpoolIo
WINBASEAPI VOID WINAPI CancelThreadpoolIo(_Inout_ PTP_IO pio)
WaitForThreadpoolWorkCallbacks
WINBASEAPI VOID WINAPI WaitForThreadpoolWorkCallbacks(_Inout_ PTP_WORK pwk, _In_ BOOL fCancelPendingCallbacks)
SetEventWhenCallbackReturns
WINBASEAPI VOID WINAPI SetEventWhenCallbackReturns(_Inout_ PTP_CALLBACK_INSTANCE pci, _In_ HANDLE evt)
LeaveCriticalSectionWhenCallbackReturns
WINBASEAPI VOID WINAPI LeaveCriticalSectionWhenCallbackReturns(_Inout_ PTP_CALLBACK_INSTANCE pci, _Inout_ PCRITICAL_SECTION pcs)
SubmitThreadpoolWork
WINBASEAPI VOID WINAPI SubmitThreadpoolWork(_Inout_ PTP_WORK pwk)
SetThreadpoolThreadMinimum
WINBASEAPI BOOL WINAPI SetThreadpoolThreadMinimum(_Inout_ PTP_POOL ptpp, _In_ DWORD cthrdMic)
CloseThreadpoolCleanupGroup
WINBASEAPI VOID WINAPI CloseThreadpoolCleanupGroup(_Inout_ PTP_CLEANUP_GROUP ptpcg)
SetThreadpoolWait
WINBASEAPI VOID WINAPI SetThreadpoolWait(_Inout_ PTP_WAIT pwa, _In_opt_ HANDLE h, _In_opt_ PFILETIME pftTimeout)
CreateThreadpool
WINBASEAPI _Must_inspect_result_ PTP_POOL WINAPI CreateThreadpool(_Reserved_ PVOID reserved)
SetThreadpoolStackInformation
WINBASEAPI BOOL WINAPI SetThreadpoolStackInformation(_Inout_ PTP_POOL ptpp, _In_ PTP_POOL_STACK_INFORMATION ptpsi)
CloseThreadpool
WINBASEAPI VOID WINAPI CloseThreadpool(_Inout_ PTP_POOL ptpp)
CloseThreadpoolIo
WINBASEAPI VOID WINAPI CloseThreadpoolIo(_Inout_ PTP_IO pio)
CallbackMayRunLong
WINBASEAPI BOOL WINAPI CallbackMayRunLong(_Inout_ PTP_CALLBACK_INSTANCE pci)
TrySubmitThreadpoolCallback
WINBASEAPI _Must_inspect_result_ BOOL WINAPI TrySubmitThreadpoolCallback(_In_ PTP_SIMPLE_CALLBACK pfns, _Inout_opt_ PVOID pv, _In_opt_ PTP_CALLBACK_ENVIRON pcbe)
CreateThreadpoolWork
WINBASEAPI _Must_inspect_result_ PTP_WORK WINAPI CreateThreadpoolWork(_In_ PTP_WORK_CALLBACK pfnwk, _Inout_opt_ PVOID pv, _In_opt_ PTP_CALLBACK_ENVIRON pcbe)
SetThreadpoolWaitEx
WINBASEAPI BOOL WINAPI SetThreadpoolWaitEx(_Inout_ PTP_WAIT pwa, _In_opt_ HANDLE h, _In_opt_ PFILETIME pftTimeout, _Reserved_ PVOID Reserved)
CloseThreadpoolWait
WINBASEAPI VOID WINAPI CloseThreadpoolWait(_Inout_ PTP_WAIT pwa)
CreateThreadpoolTimer
WINBASEAPI _Must_inspect_result_ PTP_TIMER WINAPI CreateThreadpoolTimer(_In_ PTP_TIMER_CALLBACK pfnti, _Inout_opt_ PVOID pv, _In_opt_ PTP_CALLBACK_ENVIRON pcbe)
DisassociateCurrentThreadFromCallback
WINBASEAPI VOID WINAPI DisassociateCurrentThreadFromCallback(_Inout_ PTP_CALLBACK_INSTANCE pci)
PCRITICAL_SECTION
struct _CRITICAL_SECTION * PCRITICAL_SECTION
Definition: threadpoolapiset.h:10
WaitForThreadpoolWaitCallbacks
WINBASEAPI VOID WINAPI WaitForThreadpoolWaitCallbacks(_Inout_ PTP_WAIT pwa, _In_ BOOL fCancelPendingCallbacks)
FreeLibraryWhenCallbackReturns
WINBASEAPI VOID WINAPI FreeLibraryWhenCallbackReturns(_Inout_ PTP_CALLBACK_INSTANCE pci, _In_ HMODULE mod)
QueryThreadpoolStackInformation
WINBASEAPI BOOL WINAPI QueryThreadpoolStackInformation(_In_ PTP_POOL ptpp, _Out_ PTP_POOL_STACK_INFORMATION ptpsi)
CloseThreadpoolCleanupGroupMembers
WINBASEAPI VOID WINAPI CloseThreadpoolCleanupGroupMembers(_Inout_ PTP_CLEANUP_GROUP ptpcg, _In_ BOOL fCancelPendingCallbacks, _Inout_opt_ PVOID pvCleanupContext)
SetThreadpoolThreadMaximum
WINBASEAPI VOID WINAPI SetThreadpoolThreadMaximum(_Inout_ PTP_POOL ptpp, _In_ DWORD cthrdMost)
ULONG_PTR
uint32_t ULONG_PTR
Definition: typedefs.h:65
ULONG
uint32_t ULONG
Definition: typedefs.h:59
Instance
_Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_WMI_INSTANCE_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_opt_ WDFWMIINSTANCE * Instance
Definition: wdfwmi.h:481
fl
_In_ FLONG fl
Definition: winddi.h:1279
Reserved
_Reserved_ PVOID Reserved
Definition: winddi.h:3974
WINAPI
#define WINAPI
Definition: msvc.h:6
PTP_WAIT
struct _TP_WAIT * PTP_WAIT
Definition: winnt_old.h:4497
PTP_WAIT_CALLBACK
VOID(NTAPI * PTP_WAIT_CALLBACK)(PTP_CALLBACK_INSTANCE, PVOID, PTP_WAIT, TP_WAIT_RESULT)
Definition: winnt_old.h:4536
PTP_CALLBACK_INSTANCE
struct _TP_CALLBACK_INSTANCE * PTP_CALLBACK_INSTANCE
Definition: winnt_old.h:4495
PTP_TIMER
struct _TP_TIMER * PTP_TIMER
Definition: winnt_old.h:4496
PTP_WORK
struct _TP_WORK * PTP_WORK
Definition: winnt_old.h:4494
PTP_WORK_CALLBACK
VOID(NTAPI * PTP_WORK_CALLBACK)(_Inout_ PTP_CALLBACK_INSTANCE Instance, _Inout_opt_ PVOID Context, _Inout_ PTP_WORK Work)
Definition: winnt_old.h:4518
PTP_IO
struct _TP_IO * PTP_IO
Definition: winnt_old.h:4498
PTP_SIMPLE_CALLBACK
VOID(NTAPI * PTP_SIMPLE_CALLBACK)(_Inout_ PTP_CALLBACK_INSTANCE Instance, _Inout_opt_ PVOID Context)
Definition: winnt_old.h:4526
PTP_POOL
struct _TP_POOL * PTP_POOL
Definition: winnt_old.h:4493
PTP_CLEANUP_GROUP
struct _TP_CLEANUP_GROUP * PTP_CLEANUP_GROUP
Definition: winnt_old.h:4523
PTP_TIMER_CALLBACK
VOID(NTAPI * PTP_TIMER_CALLBACK)(PTP_CALLBACK_INSTANCE, PVOID, PTP_TIMER)
Definition: winnt_old.h:4535