ReactOS 0.4.16-dev-1946-g52006dd
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 <minwindef.h>
8#include <minwinbase.h>
9
10#ifdef __cplusplus
11extern "C" {
12#endif
13
14WINBASEAPI
15_Must_inspect_result_
16PTP_POOL
17WINAPI
18CreateThreadpool(
19 _Reserved_ PVOID reserved);
20
21WINBASEAPI
22VOID
23WINAPI
24CloseThreadpool(
25 _Inout_ PTP_POOL ptpp);
26
27WINBASEAPI
28BOOL
29WINAPI
30SetThreadpoolThreadMinimum(
31 _Inout_ PTP_POOL ptpp,
32 _In_ DWORD cthrdMic);
33
34WINBASEAPI
35VOID
36WINAPI
37SetThreadpoolThreadMaximum(
38 _Inout_ PTP_POOL ptpp,
39 _In_ DWORD cthrdMost);
40
41WINBASEAPI
42BOOL
43WINAPI
44QueryThreadpoolStackInformation(
45 _In_ PTP_POOL ptpp,
46 _Out_ PTP_POOL_STACK_INFORMATION ptpsi);
47
48WINBASEAPI
49BOOL
50WINAPI
51SetThreadpoolStackInformation(
52 _Inout_ PTP_POOL ptpp,
53 _In_ PTP_POOL_STACK_INFORMATION ptpsi);
54
55WINBASEAPI
56_Must_inspect_result_
57BOOL
58WINAPI
59TrySubmitThreadpoolCallback(
60 _In_ PTP_SIMPLE_CALLBACK pfns,
61 _Inout_opt_ PVOID pv,
62 _In_opt_ PTP_CALLBACK_ENVIRON pcbe);
63
64WINBASEAPI
65BOOL
66WINAPI
67CallbackMayRunLong(
68 _Inout_ PTP_CALLBACK_INSTANCE pci);
69
70WINBASEAPI
71VOID
72WINAPI
73DisassociateCurrentThreadFromCallback(
74 _Inout_ PTP_CALLBACK_INSTANCE pci);
75
76WINBASEAPI
77VOID
78WINAPI
79FreeLibraryWhenCallbackReturns(
80 _Inout_ PTP_CALLBACK_INSTANCE pci,
81 _In_ HMODULE mod);
82
83WINBASEAPI
84VOID
85WINAPI
86LeaveCriticalSectionWhenCallbackReturns(
87 _Inout_ PTP_CALLBACK_INSTANCE pci,
88 _Inout_ PCRITICAL_SECTION pcs);
89
90WINBASEAPI
91VOID
92WINAPI
93ReleaseMutexWhenCallbackReturns(
94 _Inout_ PTP_CALLBACK_INSTANCE pci,
95 _In_ HANDLE mut);
96
97WINBASEAPI
98VOID
99WINAPI
100ReleaseSemaphoreWhenCallbackReturns(
101 _Inout_ PTP_CALLBACK_INSTANCE pci,
102 _In_ HANDLE sem,
103 _In_ DWORD crel);
104
105WINBASEAPI
106VOID
107WINAPI
108SetEventWhenCallbackReturns(
109 _Inout_ PTP_CALLBACK_INSTANCE pci,
110 _In_ HANDLE evt);
111
112WINBASEAPI
113_Must_inspect_result_
114PTP_CLEANUP_GROUP
115WINAPI
116CreateThreadpoolCleanupGroup(
117 VOID);
118
119WINBASEAPI
120VOID
121WINAPI
122CloseThreadpoolCleanupGroup(
123 _Inout_ PTP_CLEANUP_GROUP ptpcg);
124
125WINBASEAPI
126VOID
127WINAPI
128CloseThreadpoolCleanupGroupMembers(
129 _Inout_ PTP_CLEANUP_GROUP ptpcg,
130 _In_ BOOL fCancelPendingCallbacks,
131 _Inout_opt_ PVOID pvCleanupContext);
132
133typedef
134VOID
135(WINAPI *PTP_WIN32_IO_CALLBACK)(
136 _Inout_ PTP_CALLBACK_INSTANCE Instance,
137 _Inout_opt_ PVOID Context,
138 _Inout_opt_ PVOID Overlapped,
139 _In_ ULONG IoResult,
140 _In_ ULONG_PTR NumberOfBytesTransferred,
141 _Inout_ PTP_IO Io);
142
143WINBASEAPI
144_Must_inspect_result_
145PTP_IO
146WINAPI
147CreateThreadpoolIo(
148 _In_ HANDLE fl,
149 _In_ PTP_WIN32_IO_CALLBACK pfnio,
150 _Inout_opt_ PVOID pv,
151 _In_opt_ PTP_CALLBACK_ENVIRON pcbe);
152
153WINBASEAPI
154VOID
155WINAPI
156CloseThreadpoolIo(
157 _Inout_ PTP_IO pio);
158
159WINBASEAPI
160VOID
161WINAPI
162StartThreadpoolIo(
163 _Inout_ PTP_IO pio);
164
165WINBASEAPI
166VOID
167WINAPI
168CancelThreadpoolIo(
169 _Inout_ PTP_IO pio);
170
171WINBASEAPI
172VOID
173WINAPI
174WaitForThreadpoolIoCallbacks(
175 _Inout_ PTP_IO pio,
176 _In_ BOOL fCancelPendingCallbacks);
177
178WINBASEAPI
179_Must_inspect_result_
180PTP_TIMER
181WINAPI
182CreateThreadpoolTimer(
183 _In_ PTP_TIMER_CALLBACK pfnti,
184 _Inout_opt_ PVOID pv,
185 _In_opt_ PTP_CALLBACK_ENVIRON pcbe);
186
187WINBASEAPI
188VOID
189WINAPI
190CloseThreadpoolTimer(
191 _Inout_ PTP_TIMER pti);
192
193WINBASEAPI
194VOID
195WINAPI
196SetThreadpoolTimer(
197 _Inout_ PTP_TIMER pti,
198 _In_opt_ PFILETIME pftDueTime,
199 _In_ DWORD msPeriod,
200 _In_opt_ DWORD msWindowLength);
201
202WINBASEAPI
203BOOL
204WINAPI
205SetThreadpoolTimerEx(
206 _Inout_ PTP_TIMER pti,
207 _In_opt_ PFILETIME pftDueTime,
208 _In_ DWORD msPeriod,
209 _In_opt_ DWORD msWindowLength);
210
211WINBASEAPI
212BOOL
213WINAPI
214IsThreadpoolTimerSet(
215 _Inout_ PTP_TIMER pti);
216
217WINBASEAPI
218VOID
219WINAPI
220WaitForThreadpoolTimerCallbacks(
221 _Inout_ PTP_TIMER pti,
222 _In_ BOOL fCancelPendingCallbacks);
223
224WINBASEAPI
225_Must_inspect_result_
226PTP_WAIT
227WINAPI
228CreateThreadpoolWait(
229 _In_ PTP_WAIT_CALLBACK pfnwa,
230 _Inout_opt_ PVOID pv,
231 _In_opt_ PTP_CALLBACK_ENVIRON pcbe);
232
233WINBASEAPI
234VOID
235WINAPI
236CloseThreadpoolWait(
237 _Inout_ PTP_WAIT pwa);
238
239WINBASEAPI
240VOID
241WINAPI
242SetThreadpoolWait(
243 _Inout_ PTP_WAIT pwa,
244 _In_opt_ HANDLE h,
245 _In_opt_ PFILETIME pftTimeout);
246
247WINBASEAPI
248BOOL
249WINAPI
250SetThreadpoolWaitEx(
251 _Inout_ PTP_WAIT pwa,
252 _In_opt_ HANDLE h,
253 _In_opt_ PFILETIME pftTimeout,
254 _Reserved_ PVOID Reserved);
255
256WINBASEAPI
257VOID
258WINAPI
259WaitForThreadpoolWaitCallbacks(
260 _Inout_ PTP_WAIT pwa,
261 _In_ BOOL fCancelPendingCallbacks);
262
263WINBASEAPI
264_Must_inspect_result_
265PTP_WORK
266WINAPI
267CreateThreadpoolWork(
268 _In_ PTP_WORK_CALLBACK pfnwk,
269 _Inout_opt_ PVOID pv,
270 _In_opt_ PTP_CALLBACK_ENVIRON pcbe);
271
272WINBASEAPI
273VOID
274WINAPI
275CloseThreadpoolWork(
276 _Inout_ PTP_WORK pwk);
277
278WINBASEAPI
279VOID
280WINAPI
281SubmitThreadpoolWork(
282 _Inout_ PTP_WORK pwk);
283
284WINBASEAPI
285VOID
286WINAPI
287WaitForThreadpoolWorkCallbacks(
288 _Inout_ PTP_WORK pwk,
289 _In_ BOOL fCancelPendingCallbacks);
290
291#ifdef __cplusplus
292} // extern "C"
293#endif
294
295#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
_FILETIME
Definition: mapidefs.h:60
_RTL_CRITICAL_SECTION
Definition: rtltypes.h:1449
_TP_CALLBACK_ENVIRON_V3
Definition: winnt_old.h:4687
_TP_POOL_STACK_INFORMATION
Definition: winnt_old.h:4660
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:135
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)
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:4645
PTP_WAIT_CALLBACK
VOID(NTAPI * PTP_WAIT_CALLBACK)(PTP_CALLBACK_INSTANCE, PVOID, PTP_WAIT, TP_WAIT_RESULT)
Definition: winnt_old.h:4684
PTP_CALLBACK_INSTANCE
struct _TP_CALLBACK_INSTANCE * PTP_CALLBACK_INSTANCE
Definition: winnt_old.h:4643
PTP_TIMER
struct _TP_TIMER * PTP_TIMER
Definition: winnt_old.h:4644
PTP_WORK
struct _TP_WORK * PTP_WORK
Definition: winnt_old.h:4642
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:4666
PTP_IO
struct _TP_IO * PTP_IO
Definition: winnt_old.h:4646
PTP_SIMPLE_CALLBACK
VOID(NTAPI * PTP_SIMPLE_CALLBACK)(_Inout_ PTP_CALLBACK_INSTANCE Instance, _Inout_opt_ PVOID Context)
Definition: winnt_old.h:4674
PTP_POOL
struct _TP_POOL * PTP_POOL
Definition: winnt_old.h:4641
PTP_CLEANUP_GROUP
struct _TP_CLEANUP_GROUP * PTP_CLEANUP_GROUP
Definition: winnt_old.h:4671
PTP_TIMER_CALLBACK
VOID(NTAPI * PTP_TIMER_CALLBACK)(PTP_CALLBACK_INSTANCE, PVOID, PTP_TIMER)
Definition: winnt_old.h:4683