-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathstructevthread__lock__callbacks.html
200 lines (181 loc) · 11.1 KB
/
structevthread__lock__callbacks.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
<!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: evthread_lock_callbacks Struct 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">evthread_lock_callbacks Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This structure describes the interface a threading library uses for locking.
<a href="structevthread__lock__callbacks.html#details">More...</a></p>
<p><code>#include <<a class="el" href="thread_8h_source.html">thread.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a640c2b86b8e914b411848dc72a472591"><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structevthread__lock__callbacks.html#a640c2b86b8e914b411848dc72a472591">alloc</a> )(unsigned locktype)</td></tr>
<tr class="memdesc:a640c2b86b8e914b411848dc72a472591"><td class="mdescLeft"> </td><td class="mdescRight">Function to allocate and initialize new lock of type 'locktype'. <a href="structevthread__lock__callbacks.html#a640c2b86b8e914b411848dc72a472591">More...</a><br /></td></tr>
<tr class="separator:a640c2b86b8e914b411848dc72a472591"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afdab536528e27486ae7acb783ccad07a"><td class="memItemLeft" align="right" valign="top"><a id="afdab536528e27486ae7acb783ccad07a"></a>
void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structevthread__lock__callbacks.html#afdab536528e27486ae7acb783ccad07a">free</a> )(void *<a class="el" href="structevthread__lock__callbacks.html#a1eb04c0bb0cf9dba264d1b5ed7c9e025">lock</a>, unsigned locktype)</td></tr>
<tr class="memdesc:afdab536528e27486ae7acb783ccad07a"><td class="mdescLeft"> </td><td class="mdescRight">Function to release all storage held in 'lock', which was created with type 'locktype'. <br /></td></tr>
<tr class="separator:afdab536528e27486ae7acb783ccad07a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1eb04c0bb0cf9dba264d1b5ed7c9e025"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structevthread__lock__callbacks.html#a1eb04c0bb0cf9dba264d1b5ed7c9e025">lock</a> )(unsigned mode, void *lock)</td></tr>
<tr class="memdesc:a1eb04c0bb0cf9dba264d1b5ed7c9e025"><td class="mdescLeft"> </td><td class="mdescRight">Acquire an already-allocated lock at 'lock' with mode 'mode'. <a href="structevthread__lock__callbacks.html#a1eb04c0bb0cf9dba264d1b5ed7c9e025">More...</a><br /></td></tr>
<tr class="separator:a1eb04c0bb0cf9dba264d1b5ed7c9e025"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe0e286cfffd238f4891bdb431c79eb9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structevthread__lock__callbacks.html#afe0e286cfffd238f4891bdb431c79eb9">lock_api_version</a></td></tr>
<tr class="memdesc:afe0e286cfffd238f4891bdb431c79eb9"><td class="mdescLeft"> </td><td class="mdescRight">The current version of the locking API. <a href="structevthread__lock__callbacks.html#afe0e286cfffd238f4891bdb431c79eb9">More...</a><br /></td></tr>
<tr class="separator:afe0e286cfffd238f4891bdb431c79eb9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afebbd92f9fc12e5852b0c008b423f948"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="structevthread__lock__callbacks.html#afebbd92f9fc12e5852b0c008b423f948">supported_locktypes</a></td></tr>
<tr class="memdesc:afebbd92f9fc12e5852b0c008b423f948"><td class="mdescLeft"> </td><td class="mdescRight">Which kinds of locks does this version of the locking API support? A bitfield of EVTHREAD_LOCKTYPE_RECURSIVE and EVTHREAD_LOCKTYPE_READWRITE. <a href="structevthread__lock__callbacks.html#afebbd92f9fc12e5852b0c008b423f948">More...</a><br /></td></tr>
<tr class="separator:afebbd92f9fc12e5852b0c008b423f948"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae896047fcd1b4c5095d2b05a58e0a35d"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structevthread__lock__callbacks.html#ae896047fcd1b4c5095d2b05a58e0a35d">unlock</a> )(unsigned mode, void *<a class="el" href="structevthread__lock__callbacks.html#a1eb04c0bb0cf9dba264d1b5ed7c9e025">lock</a>)</td></tr>
<tr class="memdesc:ae896047fcd1b4c5095d2b05a58e0a35d"><td class="mdescLeft"> </td><td class="mdescRight">Release a lock at 'lock' using mode 'mode'. <a href="structevthread__lock__callbacks.html#ae896047fcd1b4c5095d2b05a58e0a35d">More...</a><br /></td></tr>
<tr class="separator:ae896047fcd1b4c5095d2b05a58e0a35d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This structure describes the interface a threading library uses for locking. </p>
<p>It's used to tell <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> how to use locking on this platform. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a640c2b86b8e914b411848dc72a472591"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a640c2b86b8e914b411848dc72a472591">◆ </a></span>alloc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void*(* evthread_lock_callbacks::alloc) (unsigned locktype)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to allocate and initialize new lock of type 'locktype'. </p>
<p>Returns NULL on failure. </p>
</div>
</div>
<a id="a1eb04c0bb0cf9dba264d1b5ed7c9e025"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1eb04c0bb0cf9dba264d1b5ed7c9e025">◆ </a></span>lock</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* evthread_lock_callbacks::lock) (unsigned mode, void *lock)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Acquire an already-allocated lock at 'lock' with mode 'mode'. </p>
<p>Returns 0 on success, and nonzero on failure. </p>
</div>
</div>
<a id="afe0e286cfffd238f4891bdb431c79eb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe0e286cfffd238f4891bdb431c79eb9">◆ </a></span>lock_api_version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int evthread_lock_callbacks::lock_api_version</td>
</tr>
</table>
</div><div class="memdoc">
<p>The current version of the locking API. </p>
<p>Set this to EVTHREAD_LOCK_API_VERSION </p>
</div>
</div>
<a id="afebbd92f9fc12e5852b0c008b423f948"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afebbd92f9fc12e5852b0c008b423f948">◆ </a></span>supported_locktypes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned evthread_lock_callbacks::supported_locktypes</td>
</tr>
</table>
</div><div class="memdoc">
<p>Which kinds of locks does this version of the locking API support? A bitfield of EVTHREAD_LOCKTYPE_RECURSIVE and EVTHREAD_LOCKTYPE_READWRITE. </p>
<p>(Note that RECURSIVE locks are currently mandatory, and READWRITE locks are not currently used.) </p>
</div>
</div>
<a id="ae896047fcd1b4c5095d2b05a58e0a35d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae896047fcd1b4c5095d2b05a58e0a35d">◆ </a></span>unlock</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* evthread_lock_callbacks::unlock) (unsigned mode, void *<a class="el" href="structevthread__lock__callbacks.html#a1eb04c0bb0cf9dba264d1b5ed7c9e025">lock</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Release a lock at 'lock' using mode 'mode'. </p>
<p>Returns 0 on success, and nonzero on failure. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>event2/<a class="el" href="thread_8h_source.html">thread.h</a></li>
</ul>
</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>