/
watch_8h_source.html
152 lines (150 loc) · 16.7 KB
/
watch_8h_source.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
<!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/watch.h Source File</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="headertitle">
<div class="title">watch.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="watch_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * modification, are permitted provided that the following conditions</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * are met:</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * documentation and/or other materials provided with the distribution.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * 3. The name of the author may not be used to endorse or promote products</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * derived from this software without specific prior written permission.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef EVENT2_WATCH_H_INCLUDED_</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define EVENT2_WATCH_H_INCLUDED_</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#include <event2/visibility.h></span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">struct </span><a class="code" href="structevent__base.html">event_base</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">struct </span>evwatch;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">struct </span>evwatch_prepare_cb_info;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">struct </span>evwatch_check_cb_info;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">struct </span>timeval;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="watch_8h.html#ab49b34b1552c9cc5e6a736cfc435c766"> 59</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="watch_8h.html#ab49b34b1552c9cc5e6a736cfc435c766">evwatch_prepare_cb</a>)(<span class="keyword">struct </span>evwatch *, <span class="keyword">const</span> <span class="keyword">struct </span>evwatch_prepare_cb_info *, <span class="keywordtype">void</span> *);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="watch_8h.html#a552db1e01295811adc2191580a48f3f7"> 69</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="watch_8h.html#a552db1e01295811adc2191580a48f3f7">evwatch_check_cb</a>)(<span class="keyword">struct </span>evwatch *, <span class="keyword">const</span> <span class="keyword">struct </span>evwatch_check_cb_info *, <span class="keywordtype">void</span> *);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> EVENT2_EXPORT_SYMBOL</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">struct </span>evwatch *<a class="code" href="watch_8h.html#ad446340d54b8de7125cae9d5fed9c61e">evwatch_prepare_new</a>(<span class="keyword">struct</span> <a class="code" href="structevent__base.html">event_base</a> *base, <a class="code" href="watch_8h.html#ab49b34b1552c9cc5e6a736cfc435c766">evwatch_prepare_cb</a> callback, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> EVENT2_EXPORT_SYMBOL</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">struct </span>evwatch *<a class="code" href="watch_8h.html#acfeaa9fc345062e41c7f807d6c5d511f">evwatch_check_new</a>(<span class="keyword">struct</span> <a class="code" href="structevent__base.html">event_base</a> *base, <a class="code" href="watch_8h.html#a552db1e01295811adc2191580a48f3f7">evwatch_check_cb</a> callback, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> EVENT2_EXPORT_SYMBOL</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">struct </span><a class="code" href="structevent__base.html">event_base</a> *<a class="code" href="watch_8h.html#a12f916b5846e7925939abbaca49b4521">evwatch_base</a>(<span class="keyword">struct</span> evwatch *watcher);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> EVENT2_EXPORT_SYMBOL</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keywordtype">void</span> <a class="code" href="watch_8h.html#aadf0c377890835ae40612b19f9029032">evwatch_free</a>(<span class="keyword">struct</span> evwatch *watcher);</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> EVENT2_EXPORT_SYMBOL</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="keywordtype">int</span> <a class="code" href="watch_8h.html#a5f7837d8af2b00c9ec401e00b4f33781">evwatch_prepare_get_timeout</a>(<span class="keyword">const</span> <span class="keyword">struct</span> evwatch_prepare_cb_info *info, <span class="keyword">struct</span> timeval *timeout);</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  </div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> }</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#endif </span><span class="comment">/* EVENT2_WATCH_H_INCLUDED_ */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="awatch_8h_html_a12f916b5846e7925939abbaca49b4521"><div class="ttname"><a href="watch_8h.html#a12f916b5846e7925939abbaca49b4521">evwatch_base</a></div><div class="ttdeci">EVENT2_EXPORT_SYMBOL struct event_base * evwatch_base(struct evwatch *watcher)</div><div class="ttdoc">Get the event_base that a given evwatch is registered with.</div></div>
<div class="ttc" id="awatch_8h_html_ab49b34b1552c9cc5e6a736cfc435c766"><div class="ttname"><a href="watch_8h.html#ab49b34b1552c9cc5e6a736cfc435c766">evwatch_prepare_cb</a></div><div class="ttdeci">void(* evwatch_prepare_cb)(struct evwatch *, const struct evwatch_prepare_cb_info *, void *)</div><div class="ttdoc">Prepare callback, invoked by event_base_loop immediately before polling for I/O.</div><div class="ttdef"><b>Definition:</b> watch.h:59</div></div>
<div class="ttc" id="awatch_8h_html_a552db1e01295811adc2191580a48f3f7"><div class="ttname"><a href="watch_8h.html#a552db1e01295811adc2191580a48f3f7">evwatch_check_cb</a></div><div class="ttdeci">void(* evwatch_check_cb)(struct evwatch *, const struct evwatch_check_cb_info *, void *)</div><div class="ttdoc">Check callback, invoked by event_base_loop immediately after polling for I/O and before processing an...</div><div class="ttdef"><b>Definition:</b> watch.h:69</div></div>
<div class="ttc" id="astructevent__base_html"><div class="ttname"><a href="structevent__base.html">event_base</a></div><div class="ttdoc">Structure to hold information and state for a Libevent dispatch loop.</div><div class="ttdef"><b>Definition:</b> event.h:219</div></div>
<div class="ttc" id="awatch_8h_html_a5f7837d8af2b00c9ec401e00b4f33781"><div class="ttname"><a href="watch_8h.html#a5f7837d8af2b00c9ec401e00b4f33781">evwatch_prepare_get_timeout</a></div><div class="ttdeci">EVENT2_EXPORT_SYMBOL int evwatch_prepare_get_timeout(const struct evwatch_prepare_cb_info *info, struct timeval *timeout)</div><div class="ttdoc">Get the timeout (the expected polling duration) passed to the underlying implementation's dispatch.</div></div>
<div class="ttc" id="awatch_8h_html_acfeaa9fc345062e41c7f807d6c5d511f"><div class="ttname"><a href="watch_8h.html#acfeaa9fc345062e41c7f807d6c5d511f">evwatch_check_new</a></div><div class="ttdeci">EVENT2_EXPORT_SYMBOL struct evwatch * evwatch_check_new(struct event_base *base, evwatch_check_cb callback, void *arg)</div><div class="ttdoc">Register a new "check" watcher, to be called in the event loop after polling for events and before ha...</div></div>
<div class="ttc" id="awatch_8h_html_ad446340d54b8de7125cae9d5fed9c61e"><div class="ttname"><a href="watch_8h.html#ad446340d54b8de7125cae9d5fed9c61e">evwatch_prepare_new</a></div><div class="ttdeci">EVENT2_EXPORT_SYMBOL struct evwatch * evwatch_prepare_new(struct event_base *base, evwatch_prepare_cb callback, void *arg)</div><div class="ttdoc">Register a new "prepare" watcher, to be called in the event loop prior to polling for events.</div></div>
<div class="ttc" id="awatch_8h_html_aadf0c377890835ae40612b19f9029032"><div class="ttname"><a href="watch_8h.html#aadf0c377890835ae40612b19f9029032">evwatch_free</a></div><div class="ttdeci">EVENT2_EXPORT_SYMBOL void evwatch_free(struct evwatch *watcher)</div><div class="ttdoc">Deregister and deallocate a watcher.</div></div>
<!-- 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>