-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy paththread_8h.html
384 lines (354 loc) · 28 KB
/
thread_8h.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libevent: event2/thread.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libevent
 <span id="projectnumber">2.2.1</span>
</div>
<div id="projectbrief">Event notification library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_db160b4728e6067cf5f9cc14ec42c79d.html">event2</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">thread.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Functions for multi-threaded applications using Libevent.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <event2/visibility.h></code><br />
<code>#include <event2/event-config.h></code><br />
</div>
<p><a href="thread_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structevthread__condition__callbacks.html">evthread_condition_callbacks</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This structure describes the interface a threading library uses for condition variables. <a href="structevthread__condition__callbacks.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structevthread__lock__callbacks.html">evthread_lock_callbacks</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This structure describes the interface a threading library uses for locking. <a href="structevthread__lock__callbacks.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a83fecb8503fdb40ca4e57bac66608721"><td class="memItemLeft" align="right" valign="top"><a id="a83fecb8503fdb40ca4e57bac66608721"></a>
#define </td><td class="memItemRight" valign="bottom"><b>EVTHREAD_CONDITION_API_VERSION</b>   1</td></tr>
<tr class="separator:a83fecb8503fdb40ca4e57bac66608721"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a911771b77b303b553612bef600573448"><td class="memItemLeft" align="right" valign="top"><a id="a911771b77b303b553612bef600573448"></a>
#define </td><td class="memItemRight" valign="bottom"><b>EVTHREAD_LOCK_API_VERSION</b>   1</td></tr>
<tr class="separator:a911771b77b303b553612bef600573448"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e512480e7848b2a6812883a389c612d"><td class="memItemLeft" align="right" valign="top"><a id="a1e512480e7848b2a6812883a389c612d"></a>
#define </td><td class="memItemRight" valign="bottom"><b>EVTHREAD_PTHREAD_PRIO_INHERIT</b>   0x01</td></tr>
<tr class="separator:a1e512480e7848b2a6812883a389c612d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8906b609d6c2bb4af5c7653c4f0f355d"><td class="memItemLeft" align="right" valign="top"><a id="a8906b609d6c2bb4af5c7653c4f0f355d"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a8906b609d6c2bb4af5c7653c4f0f355d">EVTHREAD_USE_PTHREADS_IMPLEMENTED</a>   1</td></tr>
<tr class="memdesc:a8906b609d6c2bb4af5c7653c4f0f355d"><td class="mdescLeft"> </td><td class="mdescRight">Defined if Libevent was built with support for <a class="el" href="thread_8h.html#acc0cc708c566c14f4659331ec12f8a5b" title="Sets up Libevent for use with Pthreads locking and thread ID functions.">evthread_use_pthreads()</a> <br /></td></tr>
<tr class="separator:a8906b609d6c2bb4af5c7653c4f0f355d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05306512f3074b45be6eba702440f1f1"><td class="memItemLeft" align="right" valign="top"><a id="a05306512f3074b45be6eba702440f1f1"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a05306512f3074b45be6eba702440f1f1">EVTHREAD_USE_WINDOWS_THREADS_IMPLEMENTED</a>   1</td></tr>
<tr class="memdesc:a05306512f3074b45be6eba702440f1f1"><td class="mdescLeft"> </td><td class="mdescRight">Defined if Libevent was built with support for <a class="el" href="thread_8h.html#a1b0fe36dcb033da2c679d39ce8a190e2" title="Sets up Libevent for use with Windows builtin locking and thread ID functions.">evthread_use_windows_threads()</a> <br /></td></tr>
<tr class="separator:a05306512f3074b45be6eba702440f1f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Flags passed to lock functions</div></td></tr>
<tr class="memitem:a8c7a3fb4b1f521b4a262e5043f3fa14c"><td class="memItemLeft" align="right" valign="top"><a id="a8c7a3fb4b1f521b4a262e5043f3fa14c"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a8c7a3fb4b1f521b4a262e5043f3fa14c">EVTHREAD_READ</a>   0x08</td></tr>
<tr class="memdesc:a8c7a3fb4b1f521b4a262e5043f3fa14c"><td class="mdescLeft"> </td><td class="mdescRight">A flag passed to a locking callback when the lock was allocated as a read-write lock, and we want to acquire or release the lock for reading. <br /></td></tr>
<tr class="separator:a8c7a3fb4b1f521b4a262e5043f3fa14c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a746e63692bf5bd5b4ee5d929df1592e2"><td class="memItemLeft" align="right" valign="top"><a id="a746e63692bf5bd5b4ee5d929df1592e2"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a746e63692bf5bd5b4ee5d929df1592e2">EVTHREAD_TRY</a>   0x10</td></tr>
<tr class="memdesc:a746e63692bf5bd5b4ee5d929df1592e2"><td class="mdescLeft"> </td><td class="mdescRight">A flag passed to a locking callback when we don't want to block waiting for the lock; if we can't get the lock immediately, we will instead return nonzero from the locking callback. <br /></td></tr>
<tr class="separator:a746e63692bf5bd5b4ee5d929df1592e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9fb1861f3b09a03c5986561dd00db0d"><td class="memItemLeft" align="right" valign="top"><a id="aa9fb1861f3b09a03c5986561dd00db0d"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#aa9fb1861f3b09a03c5986561dd00db0d">EVTHREAD_WRITE</a>   0x04</td></tr>
<tr class="memdesc:aa9fb1861f3b09a03c5986561dd00db0d"><td class="mdescLeft"> </td><td class="mdescRight">A flag passed to a locking callback when the lock was allocated as a read-write lock, and we want to acquire or release the lock for writing. <br /></td></tr>
<tr class="separator:aa9fb1861f3b09a03c5986561dd00db0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Types of locks</div></td></tr>
<tr class="memitem:aefbfdb33065b9e3a50e69c7c02cf2f42"><td class="memItemLeft" align="right" valign="top"><a id="aefbfdb33065b9e3a50e69c7c02cf2f42"></a>
#define </td><td class="memItemRight" valign="bottom"><b>EVTHREAD_LOCKTYPE_READWRITE</b>   2</td></tr>
<tr class="separator:aefbfdb33065b9e3a50e69c7c02cf2f42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8fbf4020f11c3b98459fd8d4d427513c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a8fbf4020f11c3b98459fd8d4d427513c">EVTHREAD_LOCKTYPE_RECURSIVE</a>   1</td></tr>
<tr class="memdesc:a8fbf4020f11c3b98459fd8d4d427513c"><td class="mdescLeft"> </td><td class="mdescRight">A recursive lock is one that can be acquired multiple times at once by the same thread. <a href="thread_8h.html#a8fbf4020f11c3b98459fd8d4d427513c">More...</a><br /></td></tr>
<tr class="separator:a8fbf4020f11c3b98459fd8d4d427513c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4b9ec0970d762320451fafc8f7cb2087"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a4b9ec0970d762320451fafc8f7cb2087">evthread_enable_lock_debugging</a> (void)</td></tr>
<tr class="memdesc:a4b9ec0970d762320451fafc8f7cb2087"><td class="mdescLeft"> </td><td class="mdescRight">Enable debugging wrappers around the current lock callbacks. <a href="thread_8h.html#a4b9ec0970d762320451fafc8f7cb2087">More...</a><br /></td></tr>
<tr class="separator:a4b9ec0970d762320451fafc8f7cb2087"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7981c25b2a1cd4ee29b0133d4d24cf4b"><td class="memItemLeft" align="right" valign="top"><a id="a7981c25b2a1cd4ee29b0133d4d24cf4b"></a>
EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><b>evthread_enable_lock_debuging</b> (void)</td></tr>
<tr class="separator:a7981c25b2a1cd4ee29b0133d4d24cf4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac0c39231d48295aff378fd9f65b2569a"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#ac0c39231d48295aff378fd9f65b2569a">evthread_make_base_notifiable</a> (struct <a class="el" href="structevent__base.html">event_base</a> *base)</td></tr>
<tr class="memdesc:ac0c39231d48295aff378fd9f65b2569a"><td class="mdescLeft"> </td><td class="mdescRight">Make sure it's safe to tell an event base to wake up from another thread or a signal handler. <a href="thread_8h.html#ac0c39231d48295aff378fd9f65b2569a">More...</a><br /></td></tr>
<tr class="separator:ac0c39231d48295aff378fd9f65b2569a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15c0f69030cfec09cc34bf8afd151bac"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a15c0f69030cfec09cc34bf8afd151bac">evthread_set_condition_callbacks</a> (const struct <a class="el" href="structevthread__condition__callbacks.html">evthread_condition_callbacks</a> *)</td></tr>
<tr class="memdesc:a15c0f69030cfec09cc34bf8afd151bac"><td class="mdescLeft"> </td><td class="mdescRight">Sets a group of functions that Libevent should use for condition variables. <a href="thread_8h.html#a15c0f69030cfec09cc34bf8afd151bac">More...</a><br /></td></tr>
<tr class="separator:a15c0f69030cfec09cc34bf8afd151bac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79ec78eb62ee5082a33cfb0c14df9772"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a79ec78eb62ee5082a33cfb0c14df9772">evthread_set_id_callback</a> (unsigned long(*id_fn)(void))</td></tr>
<tr class="memdesc:a79ec78eb62ee5082a33cfb0c14df9772"><td class="mdescLeft"> </td><td class="mdescRight">Sets the function for determining the thread id. <a href="thread_8h.html#a79ec78eb62ee5082a33cfb0c14df9772">More...</a><br /></td></tr>
<tr class="separator:a79ec78eb62ee5082a33cfb0c14df9772"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5fa5c777ca30576db8355a9140c533b"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#ae5fa5c777ca30576db8355a9140c533b">evthread_set_lock_callbacks</a> (const struct <a class="el" href="structevthread__lock__callbacks.html">evthread_lock_callbacks</a> *)</td></tr>
<tr class="memdesc:ae5fa5c777ca30576db8355a9140c533b"><td class="mdescLeft"> </td><td class="mdescRight">Sets a group of functions that Libevent should use for locking. <a href="thread_8h.html#ae5fa5c777ca30576db8355a9140c533b">More...</a><br /></td></tr>
<tr class="separator:ae5fa5c777ca30576db8355a9140c533b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc0cc708c566c14f4659331ec12f8a5b"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#acc0cc708c566c14f4659331ec12f8a5b">evthread_use_pthreads</a> (void)</td></tr>
<tr class="memdesc:acc0cc708c566c14f4659331ec12f8a5b"><td class="mdescLeft"> </td><td class="mdescRight">Sets up Libevent for use with Pthreads locking and thread ID functions. <a href="thread_8h.html#acc0cc708c566c14f4659331ec12f8a5b">More...</a><br /></td></tr>
<tr class="separator:acc0cc708c566c14f4659331ec12f8a5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2cef140279d8452e69dc73cc15ca697c"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a2cef140279d8452e69dc73cc15ca697c">evthread_use_pthreads_with_flags</a> (int flags)</td></tr>
<tr class="memdesc:a2cef140279d8452e69dc73cc15ca697c"><td class="mdescLeft"> </td><td class="mdescRight">Sets up Libevent for use with Pthreads locking and thread ID functions. <a href="thread_8h.html#a2cef140279d8452e69dc73cc15ca697c">More...</a><br /></td></tr>
<tr class="separator:a2cef140279d8452e69dc73cc15ca697c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b0fe36dcb033da2c679d39ce8a190e2"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a1b0fe36dcb033da2c679d39ce8a190e2">evthread_use_windows_threads</a> (void)</td></tr>
<tr class="memdesc:a1b0fe36dcb033da2c679d39ce8a190e2"><td class="mdescLeft"> </td><td class="mdescRight">Sets up Libevent for use with Windows builtin locking and thread ID functions. <a href="thread_8h.html#a1b0fe36dcb033da2c679d39ce8a190e2">More...</a><br /></td></tr>
<tr class="separator:a1b0fe36dcb033da2c679d39ce8a190e2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Functions for multi-threaded applications using Libevent. </p>
<p>When using a multi-threaded application in which multiple threads add and delete events from a single event base, Libevent needs to lock its data structures.</p>
<p>Like the memory-management function hooks, all of the threading functions <em>must</em> be set up before an <a class="el" href="structevent__base.html" title="Structure to hold information and state for a Libevent dispatch loop.">event_base</a> is created if you want the base to use them.</p>
<p>Most programs will either be using Windows threads or Posix threads. You can configure Libevent to use one of these <a class="el" href="thread_8h.html#a1b0fe36dcb033da2c679d39ce8a190e2" title="Sets up Libevent for use with Windows builtin locking and thread ID functions.">evthread_use_windows_threads()</a> or <a class="el" href="thread_8h.html#acc0cc708c566c14f4659331ec12f8a5b" title="Sets up Libevent for use with Pthreads locking and thread ID functions.">evthread_use_pthreads()</a> respectively. If you're using another threading library, you'll need to configure threading functions manually using <a class="el" href="thread_8h.html#ae5fa5c777ca30576db8355a9140c533b" title="Sets a group of functions that Libevent should use for locking.">evthread_set_lock_callbacks()</a> and <a class="el" href="thread_8h.html#a15c0f69030cfec09cc34bf8afd151bac" title="Sets a group of functions that Libevent should use for condition variables.">evthread_set_condition_callbacks()</a>. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a8fbf4020f11c3b98459fd8d4d427513c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fbf4020f11c3b98459fd8d4d427513c">◆ </a></span>EVTHREAD_LOCKTYPE_RECURSIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define EVTHREAD_LOCKTYPE_RECURSIVE   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>A recursive lock is one that can be acquired multiple times at once by the same thread. </p>
<p>No other process can allocate the lock until the thread that has been holding it has unlocked it as many times as it locked it. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a4b9ec0970d762320451fafc8f7cb2087"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b9ec0970d762320451fafc8f7cb2087">◆ </a></span>evthread_enable_lock_debugging()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL void evthread_enable_lock_debugging </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable debugging wrappers around the current lock callbacks. </p>
<p>If Libevent makes one of several common locking errors, exit with an assertion failure.</p>
<p>If you're going to call this function, you must do so before any locks are allocated. </p>
</div>
</div>
<a id="ac0c39231d48295aff378fd9f65b2569a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0c39231d48295aff378fd9f65b2569a">◆ </a></span>evthread_make_base_notifiable()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL int evthread_make_base_notifiable </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structevent__base.html">event_base</a> * </td>
<td class="paramname"><em>base</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make sure it's safe to tell an event base to wake up from another thread or a signal handler. </p>
<p>You shouldn't need to call this by hand; configuring the base with thread support should be necessary and sufficient.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on failure. </dd></dl>
</div>
</div>
<a id="a15c0f69030cfec09cc34bf8afd151bac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15c0f69030cfec09cc34bf8afd151bac">◆ </a></span>evthread_set_condition_callbacks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL int evthread_set_condition_callbacks </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structevthread__condition__callbacks.html">evthread_condition_callbacks</a> * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a group of functions that Libevent should use for condition variables. </p>
<p>For full information on the required callback API, see the documentation for the individual members of <a class="el" href="structevthread__condition__callbacks.html" title="This structure describes the interface a threading library uses for condition variables.">evthread_condition_callbacks</a>.</p>
<p>Note that if you're using Windows or the Pthreads threading library, you probably shouldn't call this function; instead, use <a class="el" href="thread_8h.html#a1b0fe36dcb033da2c679d39ce8a190e2" title="Sets up Libevent for use with Windows builtin locking and thread ID functions.">evthread_use_windows_threads()</a> or <a class="el" href="thread_8h.html#acc0cc708c566c14f4659331ec12f8a5b" title="Sets up Libevent for use with Pthreads locking and thread ID functions.">evthread_use_pthreads()</a> if you can. </p>
</div>
</div>
<a id="a79ec78eb62ee5082a33cfb0c14df9772"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79ec78eb62ee5082a33cfb0c14df9772">◆ </a></span>evthread_set_id_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL void evthread_set_id_callback </td>
<td>(</td>
<td class="paramtype">unsigned long(*)(void) </td>
<td class="paramname"><em>id_fn</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the function for determining the thread id. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id_fn</td><td>the identify function Libevent should invoke to determine the identity of a thread. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae5fa5c777ca30576db8355a9140c533b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5fa5c777ca30576db8355a9140c533b">◆ </a></span>evthread_set_lock_callbacks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL int evthread_set_lock_callbacks </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structevthread__lock__callbacks.html">evthread_lock_callbacks</a> * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a group of functions that Libevent should use for locking. </p>
<p>For full information on the required callback API, see the documentation for the individual members of <a class="el" href="structevthread__lock__callbacks.html" title="This structure describes the interface a threading library uses for locking.">evthread_lock_callbacks</a>.</p>
<p>Note that if you're using Windows or the Pthreads threading library, you probably shouldn't call this function; instead, use <a class="el" href="thread_8h.html#a1b0fe36dcb033da2c679d39ce8a190e2" title="Sets up Libevent for use with Windows builtin locking and thread ID functions.">evthread_use_windows_threads()</a> or evthread_use_posix_threads() if you can. </p>
</div>
</div>
<a id="acc0cc708c566c14f4659331ec12f8a5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc0cc708c566c14f4659331ec12f8a5b">◆ </a></span>evthread_use_pthreads()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL int evthread_use_pthreads </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up Libevent for use with Pthreads locking and thread ID functions. </p>
<p>Unavailable if Libevent is not build for use with pthreads. Requires libraries to link against Libevent_pthreads as well as Libevent.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on failure. </dd></dl>
</div>
</div>
<a id="a2cef140279d8452e69dc73cc15ca697c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cef140279d8452e69dc73cc15ca697c">◆ </a></span>evthread_use_pthreads_with_flags()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL int evthread_use_pthreads_with_flags </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up Libevent for use with Pthreads locking and thread ID functions. </p>
<p>Use <a class="el" href="thread_8h.html#a2cef140279d8452e69dc73cc15ca697c" title="Sets up Libevent for use with Pthreads locking and thread ID functions.">evthread_use_pthreads_with_flags()</a> to use Pthreads locking, taking the specified flags under consideration.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>the flags to apply when setting up Pthreads locking. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>EVTHREAD_PTHREAD_* </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on failure. </dd></dl>
</div>
</div>
<a id="a1b0fe36dcb033da2c679d39ce8a190e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b0fe36dcb033da2c679d39ce8a190e2">◆ </a></span>evthread_use_windows_threads()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL int evthread_use_windows_threads </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up Libevent for use with Windows builtin locking and thread ID functions. </p>
<p>Unavailable if Libevent is not built for Windows.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on failure. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>