ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.html
(Generate patch)

Comparing libev/ev.html (file contents):
Revision 1.1 by root, Mon Nov 12 07:58:13 2007 UTC vs.
Revision 1.28 by root, Sun Nov 18 03:43:24 2007 UTC

… …
4<head> 4<head>
5 <title>libev</title> 5 <title>libev</title>
6 <meta name="description" content="Pod documentation for libev" /> 6 <meta name="description" content="Pod documentation for libev" />
7 <meta name="inputfile" content="&lt;standard input&gt;" /> 7 <meta name="inputfile" content="&lt;standard input&gt;" />
8 <meta name="outputfile" content="&lt;standard output&gt;" /> 8 <meta name="outputfile" content="&lt;standard output&gt;" />
9 <meta name="created" content="Mon Nov 12 08:58:02 2007" /> 9 <meta name="created" content="Sun Nov 18 04:43:20 2007" />
10 <meta name="generator" content="Pod::Xhtml 1.57" /> 10 <meta name="generator" content="Pod::Xhtml 1.57" />
11<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> 11<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
12<body> 12<body>
13<div class="pod"> 13<div class="pod">
14<!-- INDEX START --> 14<!-- INDEX START -->
… …
17<ul><li><a href="#NAME">NAME</a></li> 17<ul><li><a href="#NAME">NAME</a></li>
18<li><a href="#SYNOPSIS">SYNOPSIS</a></li> 18<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
19<li><a href="#DESCRIPTION">DESCRIPTION</a></li> 19<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
20<li><a href="#FEATURES">FEATURES</a></li> 20<li><a href="#FEATURES">FEATURES</a></li>
21<li><a href="#CONVENTIONS">CONVENTIONS</a></li> 21<li><a href="#CONVENTIONS">CONVENTIONS</a></li>
22<li><a href="#TIME_REPRESENTATION">TIME REPRESENTATION</a></li>
22<li><a href="#TIME_AND_OTHER_GLOBAL_FUNCTIONS">TIME AND OTHER GLOBAL FUNCTIONS</a></li> 23<li><a href="#GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</a></li>
23<li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li> 24<li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li>
24<li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a> 25<li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a>
25<ul><li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li> 26<ul><li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li>
26</ul> 27</ul>
27</li> 28</li>
28<li><a href="#WATCHER_TYPES">WATCHER TYPES</a> 29<li><a href="#WATCHER_TYPES">WATCHER TYPES</a>
29<ul><li><a href="#struct_ev_io_is_my_file_descriptor_r">struct ev_io - is my file descriptor readable or writable</a></li> 30<ul><li><a href="#code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</a></li>
30<li><a href="#struct_ev_timer_relative_and_optiona">struct ev_timer - relative and optionally recurring timeouts</a></li> 31<li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</a></li>
31<li><a href="#ev_periodic">ev_periodic</a></li> 32<li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</a></li>
32<li><a href="#ev_signal_signal_me_when_a_signal_ge">ev_signal - signal me when a signal gets signalled</a></li> 33<li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</a></li>
33<li><a href="#ev_child_wait_for_pid_status_changes">ev_child - wait for pid status changes</a></li> 34<li><a href="#code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</a></li>
34<li><a href="#ev_idle_when_you_ve_got_nothing_bett">ev_idle - when you've got nothing better to do</a></li> 35<li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</a></li>
35<li><a href="#prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</a></li> 36<li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</a></li>
36</ul> 37</ul>
37</li> 38</li>
38<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> 39<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li>
40<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li>
41<li><a href="#C_SUPPORT">C++ SUPPORT</a></li>
39<li><a href="#AUTHOR">AUTHOR</a> 42<li><a href="#AUTHOR">AUTHOR</a>
40</li> 43</li>
41</ul><hr /> 44</ul><hr />
42<!-- INDEX END --> 45<!-- INDEX END -->
43 46
… …
55</div> 58</div>
56<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p> 59<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
57<div id="DESCRIPTION_CONTENT"> 60<div id="DESCRIPTION_CONTENT">
58<p>Libev is an event loop: you register interest in certain events (such as a 61<p>Libev is an event loop: you register interest in certain events (such as a
59file descriptor being readable or a timeout occuring), and it will manage 62file descriptor being readable or a timeout occuring), and it will manage
60these event sources and provide your program events.</p> 63these event sources and provide your program with events.</p>
61<p>To do this, it must take more or less complete control over your process 64<p>To do this, it must take more or less complete control over your process
62(or thread) by executing the <i>event loop</i> handler, and will then 65(or thread) by executing the <i>event loop</i> handler, and will then
63communicate events via a callback mechanism.</p> 66communicate events via a callback mechanism.</p>
64<p>You register interest in certain events by registering so-called <i>event 67<p>You register interest in certain events by registering so-called <i>event
65watchers</i>, which are relatively small C structures you initialise with the 68watchers</i>, which are relatively small C structures you initialise with the
… …
71<div id="FEATURES_CONTENT"> 74<div id="FEATURES_CONTENT">
72<p>Libev supports select, poll, the linux-specific epoll and the bsd-specific 75<p>Libev supports select, poll, the linux-specific epoll and the bsd-specific
73kqueue mechanisms for file descriptor events, relative timers, absolute 76kqueue mechanisms for file descriptor events, relative timers, absolute
74timers with customised rescheduling, signal events, process status change 77timers with customised rescheduling, signal events, process status change
75events (related to SIGCHLD), and event watchers dealing with the event 78events (related to SIGCHLD), and event watchers dealing with the event
76loop mechanism itself (idle, prepare and check watchers).</p> 79loop mechanism itself (idle, prepare and check watchers). It also is quite
80fast (see this <a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing
81it to libevent for example).</p>
77 82
78</div> 83</div>
79<h1 id="CONVENTIONS">CONVENTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 84<h1 id="CONVENTIONS">CONVENTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
80<div id="CONVENTIONS_CONTENT"> 85<div id="CONVENTIONS_CONTENT">
81<p>Libev is very configurable. In this manual the default configuration 86<p>Libev is very configurable. In this manual the default configuration
82will be described, which supports multiple event loops. For more info 87will be described, which supports multiple event loops. For more info
83about various configuraiton options please have a look at the file 88about various configuration options please have a look at the file
84<cite>README.embed</cite> in the libev distribution. If libev was configured without 89<cite>README.embed</cite> in the libev distribution. If libev was configured without
85support for multiple event loops, then all functions taking an initial 90support for multiple event loops, then all functions taking an initial
86argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>) 91argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>)
87will not have this argument.</p> 92will not have this argument.</p>
88 93
89</div> 94</div>
90<h1 id="TIME_AND_OTHER_GLOBAL_FUNCTIONS">TIME AND OTHER GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 95<h1 id="TIME_REPRESENTATION">TIME REPRESENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p>
91<div id="TIME_AND_OTHER_GLOBAL_FUNCTIONS_CONT"> 96<div id="TIME_REPRESENTATION_CONTENT">
92<p>Libev represents time as a single floating point number. This type is 97<p>Libev represents time as a single floating point number, representing the
98(fractional) number of seconds since the (POSIX) epoch (somewhere near
99the beginning of 1970, details are complicated, don't ask). This type is
93called <code>ev_tstamp</code>, which is what you should use too. It usually aliases 100called <code>ev_tstamp</code>, which is what you should use too. It usually aliases
94to the double type in C.</p> 101to the double type in C.</p>
102
103</div>
104<h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
105<div id="GLOBAL_FUNCTIONS_CONTENT">
106<p>These functions can be called anytime, even before initialising the
107library in any way.</p>
95<dl> 108<dl>
96 <dt>ev_tstamp ev_time ()</dt> 109 <dt>ev_tstamp ev_time ()</dt>
97 <dd> 110 <dd>
98 <p>Returns the current time as libev would use it.</p> 111 <p>Returns the current time as libev would use it. Please note that the
112<code>ev_now</code> function is usually faster and also often returns the timestamp
113you actually want to know.</p>
99 </dd> 114 </dd>
100 <dt>int ev_version_major ()</dt> 115 <dt>int ev_version_major ()</dt>
101 <dt>int ev_version_minor ()</dt> 116 <dt>int ev_version_minor ()</dt>
102 <dd> 117 <dd>
103 <p>You can find out the major and minor version numbers of the library 118 <p>You can find out the major and minor version numbers of the library
104you linked against by calling the functions <code>ev_version_major</code> and 119you linked against by calling the functions <code>ev_version_major</code> and
105<code>ev_version_minor</code>. If you want, you can compare against the global 120<code>ev_version_minor</code>. If you want, you can compare against the global
106symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the 121symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the
107version of the library your program was compiled against.</p> 122version of the library your program was compiled against.</p>
108 <p>Usually, its a good idea to terminate if the major versions mismatch, 123 <p>Usually, it's a good idea to terminate if the major versions mismatch,
109as this indicates an incompatible change. Minor versions are usually 124as this indicates an incompatible change. Minor versions are usually
110compatible to older versions, so a larger minor version alone is usually 125compatible to older versions, so a larger minor version alone is usually
111not a problem.</p> 126not a problem.</p>
112 </dd> 127 </dd>
113 <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> 128 <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt>
114 <dd> 129 <dd>
115 <p>Sets the allocation function to use (the prototype is similar to the 130 <p>Sets the allocation function to use (the prototype is similar to the
116realloc function). It is used to allocate and free memory (no surprises 131realloc C function, the semantics are identical). It is used to allocate
117here). If it returns zero when memory needs to be allocated, the library 132and free memory (no surprises here). If it returns zero when memory
118might abort or take some potentially destructive action. The default is 133needs to be allocated, the library might abort or take some potentially
119your system realloc function.</p> 134destructive action. The default is your system realloc function.</p>
120 <p>You could override this function in high-availability programs to, say, 135 <p>You could override this function in high-availability programs to, say,
121free some memory if it cannot allocate memory, to use a special allocator, 136free some memory if it cannot allocate memory, to use a special allocator,
122or even to sleep a while and retry until some memory is available.</p> 137or even to sleep a while and retry until some memory is available.</p>
123 </dd> 138 </dd>
124 <dt>ev_set_syserr_cb (void (*cb)(const char *msg));</dt> 139 <dt>ev_set_syserr_cb (void (*cb)(const char *msg));</dt>
125 <dd> 140 <dd>
126 <p>Set the callback function to call on a retryable syscall error (such 141 <p>Set the callback function to call on a retryable syscall error (such
127as failed select, poll, epoll_wait). The message is a printable string 142as failed select, poll, epoll_wait). The message is a printable string
128indicating the system call or subsystem causing the problem. If this 143indicating the system call or subsystem causing the problem. If this
129callback is set, then libev will expect it to remedy the sitution, no 144callback is set, then libev will expect it to remedy the sitution, no
130matter what, when it returns. That is, libev will geenrally retry the 145matter what, when it returns. That is, libev will generally retry the
131requested operation, or, if the condition doesn't go away, do bad stuff 146requested operation, or, if the condition doesn't go away, do bad stuff
132(such as abort).</p> 147(such as abort).</p>
133 </dd> 148 </dd>
134</dl> 149</dl>
135 150
… …
138<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2"> 153<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2">
139<p>An event loop is described by a <code>struct ev_loop *</code>. The library knows two 154<p>An event loop is described by a <code>struct ev_loop *</code>. The library knows two
140types of such loops, the <i>default</i> loop, which supports signals and child 155types of such loops, the <i>default</i> loop, which supports signals and child
141events, and dynamically created loops which do not.</p> 156events, and dynamically created loops which do not.</p>
142<p>If you use threads, a common model is to run the default event loop 157<p>If you use threads, a common model is to run the default event loop
143in your main thread (or in a separate thrad) and for each thread you 158in your main thread (or in a separate thread) and for each thread you
144create, you also create another event loop. Libev itself does no lockign 159create, you also create another event loop. Libev itself does no locking
145whatsoever, so if you mix calls to different event loops, make sure you 160whatsoever, so if you mix calls to the same event loop in different
146lock (this is usually a bad idea, though, even if done right).</p> 161threads, make sure you lock (this is usually a bad idea, though, even if
162done correctly, because it's hideous and inefficient).</p>
147<dl> 163<dl>
148 <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt> 164 <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt>
149 <dd> 165 <dd>
150 <p>This will initialise the default event loop if it hasn't been initialised 166 <p>This will initialise the default event loop if it hasn't been initialised
151yet and return it. If the default loop could not be initialised, returns 167yet and return it. If the default loop could not be initialised, returns
152false. If it already was initialised it simply returns it (and ignores the 168false. If it already was initialised it simply returns it (and ignores the
153flags).</p> 169flags).</p>
154 <p>If you don't know what event loop to use, use the one returned from this 170 <p>If you don't know what event loop to use, use the one returned from this
155function.</p> 171function.</p>
156 <p>The flags argument can be used to specify special behaviour or specific 172 <p>The flags argument can be used to specify special behaviour or specific
157backends to use, and is usually specified as 0 (or EVFLAG_AUTO)</p> 173backends to use, and is usually specified as 0 (or EVFLAG_AUTO).</p>
158 <p>It supports the following flags:</p> 174 <p>It supports the following flags:</p>
159 <p> 175 <p>
160 <dl> 176 <dl>
161 <dt>EVFLAG_AUTO</dt> 177 <dt><code>EVFLAG_AUTO</code></dt>
162 <dd> 178 <dd>
163 <p>The default flags value. Use this if you have no clue (its the right 179 <p>The default flags value. Use this if you have no clue (it's the right
164thing, believe me).</p> 180thing, believe me).</p>
165 </dd> 181 </dd>
166 <dt>EVFLAG_NOENV</dt> 182 <dt><code>EVFLAG_NOENV</code></dt>
167 <dd> 183 <dd>
168 <p>If this flag bit is ored into the flag value then libev will <i>not</i> look 184 <p>If this flag bit is ored into the flag value (or the program runs setuid
169at the environment variable <code>LIBEV_FLAGS</code>. Otherwise (the default), this 185or setgid) then libev will <i>not</i> look at the environment variable
170environment variable will override the flags completely. This is useful 186<code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will
187override the flags completely if it is found in the environment. This is
171to try out specific backends to tets their performance, or to work around 188useful to try out specific backends to test their performance, or to work
172bugs.</p> 189around bugs.</p>
173 </dd> 190 </dd>
174 <dt>EVMETHOD_SELECT portable select backend</dt> 191 <dt><code>EVMETHOD_SELECT</code> (portable select backend)</dt>
175 <dt>EVMETHOD_POLL poll backend (everywhere except windows)</dt> 192 <dt><code>EVMETHOD_POLL</code> (poll backend, available everywhere except on windows)</dt>
176 <dt>EVMETHOD_EPOLL linux only</dt> 193 <dt><code>EVMETHOD_EPOLL</code> (linux only)</dt>
177 <dt>EVMETHOD_KQUEUE some bsds only</dt> 194 <dt><code>EVMETHOD_KQUEUE</code> (some bsds only)</dt>
178 <dt>EVMETHOD_DEVPOLL solaris 8 only</dt> 195 <dt><code>EVMETHOD_DEVPOLL</code> (solaris 8 only)</dt>
179 <dt>EVMETHOD_PORT solaris 10 only</dt> 196 <dt><code>EVMETHOD_PORT</code> (solaris 10 only)</dt>
180 <dd> 197 <dd>
181 <p>If one or more of these are ored into the flags value, then only these 198 <p>If one or more of these are ored into the flags value, then only these
182backends will be tried (in the reverse order as given here). If one are 199backends will be tried (in the reverse order as given here). If one are
183specified, any backend will do.</p> 200specified, any backend will do.</p>
184 </dd> 201 </dd>
… …
194 </dd> 211 </dd>
195 <dt>ev_default_destroy ()</dt> 212 <dt>ev_default_destroy ()</dt>
196 <dd> 213 <dd>
197 <p>Destroys the default loop again (frees all memory and kernel state 214 <p>Destroys the default loop again (frees all memory and kernel state
198etc.). This stops all registered event watchers (by not touching them in 215etc.). This stops all registered event watchers (by not touching them in
199any way whatsoever, although you cnanot rely on this :).</p> 216any way whatsoever, although you cannot rely on this :).</p>
200 </dd> 217 </dd>
201 <dt>ev_loop_destroy (loop)</dt> 218 <dt>ev_loop_destroy (loop)</dt>
202 <dd> 219 <dd>
203 <p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an 220 <p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an
204earlier call to <code>ev_loop_new</code>.</p> 221earlier call to <code>ev_loop_new</code>.</p>
… …
210after forking, in either the parent or child process (or both, but that 227after forking, in either the parent or child process (or both, but that
211again makes little sense).</p> 228again makes little sense).</p>
212 <p>You <i>must</i> call this function after forking if and only if you want to 229 <p>You <i>must</i> call this function after forking if and only if you want to
213use the event library in both processes. If you just fork+exec, you don't 230use the event library in both processes. If you just fork+exec, you don't
214have to call it.</p> 231have to call it.</p>
215 <p>The function itself is quite fast and its usually not a problem to call 232 <p>The function itself is quite fast and it's usually not a problem to call
216it just in case after a fork. To make this easy, the function will fit in 233it just in case after a fork. To make this easy, the function will fit in
217quite nicely into a call to <code>pthread_atfork</code>:</p> 234quite nicely into a call to <code>pthread_atfork</code>:</p>
218<pre> pthread_atfork (0, 0, ev_default_fork); 235<pre> pthread_atfork (0, 0, ev_default_fork);
219 236
220</pre> 237</pre>
… …
228 <dt>unsigned int ev_method (loop)</dt> 245 <dt>unsigned int ev_method (loop)</dt>
229 <dd> 246 <dd>
230 <p>Returns one of the <code>EVMETHOD_*</code> flags indicating the event backend in 247 <p>Returns one of the <code>EVMETHOD_*</code> flags indicating the event backend in
231use.</p> 248use.</p>
232 </dd> 249 </dd>
233 <dt>ev_tstamp = ev_now (loop)</dt> 250 <dt>ev_tstamp ev_now (loop)</dt>
234 <dd> 251 <dd>
235 <p>Returns the current &quot;event loop time&quot;, which is the time the event loop 252 <p>Returns the current &quot;event loop time&quot;, which is the time the event loop
236got events and started processing them. This timestamp does not change 253got events and started processing them. This timestamp does not change
237as long as callbacks are being processed, and this is also the base time 254as long as callbacks are being processed, and this is also the base time
238used for relative timers. You can treat it as the timestamp of the event 255used for relative timers. You can treat it as the timestamp of the event
… …
245events.</p> 262events.</p>
246 <p>If the flags argument is specified as 0, it will not return until either 263 <p>If the flags argument is specified as 0, it will not return until either
247no event watchers are active anymore or <code>ev_unloop</code> was called.</p> 264no event watchers are active anymore or <code>ev_unloop</code> was called.</p>
248 <p>A flags value of <code>EVLOOP_NONBLOCK</code> will look for new events, will handle 265 <p>A flags value of <code>EVLOOP_NONBLOCK</code> will look for new events, will handle
249those events and any outstanding ones, but will not block your process in 266those events and any outstanding ones, but will not block your process in
250case there are no events.</p> 267case there are no events and will return after one iteration of the loop.</p>
251 <p>A flags value of <code>EVLOOP_ONESHOT</code> will look for new events (waiting if 268 <p>A flags value of <code>EVLOOP_ONESHOT</code> will look for new events (waiting if
252neccessary) and will handle those and any outstanding ones. It will block 269neccessary) and will handle those and any outstanding ones. It will block
253your process until at least one new event arrives.</p> 270your process until at least one new event arrives, and will return after
271one iteration of the loop.</p>
254 <p>This flags value could be used to implement alternative looping 272 <p>This flags value could be used to implement alternative looping
255constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and 273constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and
256more generic mechanism.</p> 274more generic mechanism.</p>
275 <p>Here are the gory details of what ev_loop does:</p>
276<pre> 1. If there are no active watchers (reference count is zero), return.
277 2. Queue and immediately call all prepare watchers.
278 3. If we have been forked, recreate the kernel state.
279 4. Update the kernel state with all outstanding changes.
280 5. Update the &quot;event loop time&quot;.
281 6. Calculate for how long to block.
282 7. Block the process, waiting for events.
283 8. Update the &quot;event loop time&quot; and do time jump handling.
284 9. Queue all outstanding timers.
285 10. Queue all outstanding periodics.
286 11. If no events are pending now, queue all idle watchers.
287 12. Queue all check watchers.
288 13. Call all queued watchers in reverse order (i.e. check watchers first).
289 14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
290 was used, return, otherwise continue with step #1.
291
292</pre>
257 </dd> 293 </dd>
258 <dt>ev_unloop (loop, how)</dt> 294 <dt>ev_unloop (loop, how)</dt>
259 <dd> 295 <dd>
260 <p>Can be used to make a call to <code>ev_loop</code> return early. The <code>how</code> argument 296 <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it
297has processed all outstanding events). The <code>how</code> argument must be either
261must be either <code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> 298<code>EVUNLOOP_ONE</code>, which will make the innermost <code>ev_loop</code> call return, or
262call return, or <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> 299<code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p>
263calls return.</p>
264 </dd> 300 </dd>
265 <dt>ev_ref (loop)</dt> 301 <dt>ev_ref (loop)</dt>
266 <dt>ev_unref (loop)</dt> 302 <dt>ev_unref (loop)</dt>
267 <dd> 303 <dd>
268 <p>Ref/unref can be used to add or remove a refcount on the event loop: Every 304 <p>Ref/unref can be used to add or remove a reference count on the event
269watcher keeps one reference. If you have a long-runing watcher you never 305loop: Every watcher keeps one reference, and as long as the reference
270unregister that should not keep ev_loop from running, ev_unref() after 306count is nonzero, <code>ev_loop</code> will not return on its own. If you have
271starting, and ev_ref() before stopping it. Libev itself uses this for 307a watcher you never unregister that should not keep <code>ev_loop</code> from
272example for its internal signal pipe: It is not visible to you as a user 308returning, ev_unref() after starting, and ev_ref() before stopping it. For
273and should not keep <code>ev_loop</code> from exiting if the work is done. It is 309example, libev itself uses this for its internal signal pipe: It is not
274also an excellent way to do this for generic recurring timers or from 310visible to the libev user and should not keep <code>ev_loop</code> from exiting if
275within third-party libraries. Just remember to unref after start and ref 311no event watchers registered by it are active. It is also an excellent
276before stop.</p> 312way to do this for generic recurring timers or from within third-party
313libraries. Just remember to <i>unref after start</i> and <i>ref before stop</i>.</p>
277 </dd> 314 </dd>
278</dl> 315</dl>
279 316
280</div> 317</div>
281<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> 318<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p>
282<div id="ANATOMY_OF_A_WATCHER_CONTENT"> 319<div id="ANATOMY_OF_A_WATCHER_CONTENT">
283<p>A watcher is a structure that you create and register to record your 320<p>A watcher is a structure that you create and register to record your
284interest in some event. For instance, if you want to wait for STDIN to 321interest in some event. For instance, if you want to wait for STDIN to
285become readable, you would create an ev_io watcher for that:</p> 322become readable, you would create an <code>ev_io</code> watcher for that:</p>
286<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 323<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
287 { 324 {
288 ev_io_stop (w); 325 ev_io_stop (w);
289 ev_unloop (loop, EVUNLOOP_ALL); 326 ev_unloop (loop, EVUNLOOP_ALL);
290 } 327 }
… …
314*)</code>), and you can stop watching for events at any time by calling the 351*)</code>), and you can stop watching for events at any time by calling the
315corresponding stop function (<code>ev_&lt;type&gt;_stop (loop, watcher *)</code>.</p> 352corresponding stop function (<code>ev_&lt;type&gt;_stop (loop, watcher *)</code>.</p>
316<p>As long as your watcher is active (has been started but not stopped) you 353<p>As long as your watcher is active (has been started but not stopped) you
317must not touch the values stored in it. Most specifically you must never 354must not touch the values stored in it. Most specifically you must never
318reinitialise it or call its set method.</p> 355reinitialise it or call its set method.</p>
319<p>You cna check wether an event is active by calling the <code>ev_is_active 356<p>You can check whether an event is active by calling the <code>ev_is_active
320(watcher *)</code> macro. To see wether an event is outstanding (but the 357(watcher *)</code> macro. To see whether an event is outstanding (but the
321callback for it has not been called yet) you cna use the <code>ev_is_pending 358callback for it has not been called yet) you can use the <code>ev_is_pending
322(watcher *)</code> macro.</p> 359(watcher *)</code> macro.</p>
323<p>Each and every callback receives the event loop pointer as first, the 360<p>Each and every callback receives the event loop pointer as first, the
324registered watcher structure as second, and a bitset of received events as 361registered watcher structure as second, and a bitset of received events as
325third argument.</p> 362third argument.</p>
326<p>The rceeived events usually include a single bit per event type received 363<p>The received events usually include a single bit per event type received
327(you can receive multiple events at the same time). The possible bit masks 364(you can receive multiple events at the same time). The possible bit masks
328are:</p> 365are:</p>
329<dl> 366<dl>
330 <dt>EV_READ</dt> 367 <dt><code>EV_READ</code></dt>
331 <dt>EV_WRITE</dt> 368 <dt><code>EV_WRITE</code></dt>
332 <dd> 369 <dd>
333 <p>The file descriptor in the ev_io watcher has become readable and/or 370 <p>The file descriptor in the <code>ev_io</code> watcher has become readable and/or
334writable.</p> 371writable.</p>
335 </dd> 372 </dd>
336 <dt>EV_TIMEOUT</dt> 373 <dt><code>EV_TIMEOUT</code></dt>
337 <dd>
338 <p>The ev_timer watcher has timed out.</p>
339 </dd> 374 <dd>
340 <dt>EV_PERIODIC</dt> 375 <p>The <code>ev_timer</code> watcher has timed out.</p>
341 <dd> 376 </dd>
342 <p>The ev_periodic watcher has timed out.</p> 377 <dt><code>EV_PERIODIC</code></dt>
343 </dd> 378 <dd>
344 <dt>EV_SIGNAL</dt> 379 <p>The <code>ev_periodic</code> watcher has timed out.</p>
345 <dd> 380 </dd>
381 <dt><code>EV_SIGNAL</code></dt>
382 <dd>
346 <p>The signal specified in the ev_signal watcher has been received by a thread.</p> 383 <p>The signal specified in the <code>ev_signal</code> watcher has been received by a thread.</p>
347 </dd>
348 <dt>EV_CHILD</dt>
349 <dd> 384 </dd>
385 <dt><code>EV_CHILD</code></dt>
386 <dd>
350 <p>The pid specified in the ev_child watcher has received a status change.</p> 387 <p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p>
351 </dd>
352 <dt>EV_IDLE</dt>
353 <dd> 388 </dd>
389 <dt><code>EV_IDLE</code></dt>
390 <dd>
354 <p>The ev_idle watcher has determined that you have nothing better to do.</p> 391 <p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p>
355 </dd>
356 <dt>EV_PREPARE</dt>
357 <dt>EV_CHECK</dt>
358 <dd> 392 </dd>
393 <dt><code>EV_PREPARE</code></dt>
394 <dt><code>EV_CHECK</code></dt>
395 <dd>
359 <p>All ev_prepare watchers are invoked just <i>before</i> <code>ev_loop</code> starts 396 <p>All <code>ev_prepare</code> watchers are invoked just <i>before</i> <code>ev_loop</code> starts
360to gather new events, and all ev_check watchers are invoked just after 397to gather new events, and all <code>ev_check</code> watchers are invoked just after
361<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any 398<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any
362received events. Callbacks of both watcher types can start and stop as 399received events. Callbacks of both watcher types can start and stop as
363many watchers as they want, and all of them will be taken into account 400many watchers as they want, and all of them will be taken into account
364(for example, a ev_prepare watcher might start an idle watcher to keep 401(for example, a <code>ev_prepare</code> watcher might start an idle watcher to keep
365<code>ev_loop</code> from blocking).</p> 402<code>ev_loop</code> from blocking).</p>
366 </dd> 403 </dd>
367 <dt>EV_ERROR</dt> 404 <dt><code>EV_ERROR</code></dt>
368 <dd> 405 <dd>
369 <p>An unspecified error has occured, the watcher has been stopped. This might 406 <p>An unspecified error has occured, the watcher has been stopped. This might
370happen because the watcher could not be properly started because libev 407happen because the watcher could not be properly started because libev
371ran out of memory, a file descriptor was found to be closed or any other 408ran out of memory, a file descriptor was found to be closed or any other
372problem. You best act on it by reporting the problem and somehow coping 409problem. You best act on it by reporting the problem and somehow coping
… …
381 418
382</div> 419</div>
383<h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2> 420<h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2>
384<div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2"> 421<div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2">
385<p>Each watcher has, by default, a member <code>void *data</code> that you can change 422<p>Each watcher has, by default, a member <code>void *data</code> that you can change
386and read at any time, libev will completely ignore it. This cna be used 423and read at any time, libev will completely ignore it. This can be used
387to associate arbitrary data with your watcher. If you need more data and 424to associate arbitrary data with your watcher. If you need more data and
388don't want to allocate memory and store a pointer to it in that data 425don't want to allocate memory and store a pointer to it in that data
389member, you can also &quot;subclass&quot; the watcher type and provide your own 426member, you can also &quot;subclass&quot; the watcher type and provide your own
390data:</p> 427data:</p>
391<pre> struct my_io 428<pre> struct my_io
… …
418<div id="WATCHER_TYPES_CONTENT"> 455<div id="WATCHER_TYPES_CONTENT">
419<p>This section describes each watcher in detail, but will not repeat 456<p>This section describes each watcher in detail, but will not repeat
420information given in the last section.</p> 457information given in the last section.</p>
421 458
422</div> 459</div>
423<h2 id="struct_ev_io_is_my_file_descriptor_r">struct ev_io - is my file descriptor readable or writable</h2> 460<h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</h2>
424<div id="struct_ev_io_is_my_file_descriptor_r-2"> 461<div id="code_ev_io_code_is_this_file_descrip-2">
425<p>I/O watchers check wether a file descriptor is readable or writable 462<p>I/O watchers check whether a file descriptor is readable or writable
426in each iteration of the event loop (This behaviour is called 463in each iteration of the event loop (This behaviour is called
427level-triggering because you keep receiving events as long as the 464level-triggering because you keep receiving events as long as the
428condition persists. Remember you cna stop the watcher if you don't want to 465condition persists. Remember you can stop the watcher if you don't want to
429act on the event and neither want to receive future events).</p> 466act on the event and neither want to receive future events).</p>
467<p>In general you can register as many read and/or write event watchers per
468fd as you want (as long as you don't confuse yourself). Setting all file
469descriptors to non-blocking mode is also usually a good idea (but not
470required if you know what you are doing).</p>
471<p>You have to be careful with dup'ed file descriptors, though. Some backends
472(the linux epoll backend is a notable example) cannot handle dup'ed file
473descriptors correctly if you register interest in two or more fds pointing
474to the same underlying file/socket etc. description (that is, they share
475the same underlying &quot;file open&quot;).</p>
476<p>If you must do this, then force the use of a known-to-be-good backend
477(at the time of this writing, this includes only EVMETHOD_SELECT and
478EVMETHOD_POLL).</p>
430<dl> 479<dl>
431 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> 480 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>
432 <dt>ev_io_set (ev_io *, int fd, int events)</dt> 481 <dt>ev_io_set (ev_io *, int fd, int events)</dt>
433 <dd> 482 <dd>
434 <p>Configures an ev_io watcher. The fd is the file descriptor to rceeive 483 <p>Configures an <code>ev_io</code> watcher. The fd is the file descriptor to rceeive
435events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ | 484events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ |
436EV_WRITE</code> to receive the given events.</p> 485EV_WRITE</code> to receive the given events.</p>
437 </dd> 486 </dd>
438</dl> 487</dl>
439 488
440</div> 489</div>
441<h2 id="struct_ev_timer_relative_and_optiona">struct ev_timer - relative and optionally recurring timeouts</h2> 490<h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2>
442<div id="struct_ev_timer_relative_and_optiona-2"> 491<div id="code_ev_timer_code_relative_and_opti-2">
443<p>Timer watchers are simple relative timers that generate an event after a 492<p>Timer watchers are simple relative timers that generate an event after a
444given time, and optionally repeating in regular intervals after that.</p> 493given time, and optionally repeating in regular intervals after that.</p>
445<p>The timers are based on real time, that is, if you register an event that 494<p>The timers are based on real time, that is, if you register an event that
446times out after an hour and youreset your system clock to last years 495times out after an hour and you reset your system clock to last years
447time, it will still time out after (roughly) and hour. &quot;Roughly&quot; because 496time, it will still time out after (roughly) and hour. &quot;Roughly&quot; because
448detecting time jumps is hard, and soem inaccuracies are unavoidable (the 497detecting time jumps is hard, and some inaccuracies are unavoidable (the
449monotonic clock option helps a lot here).</p> 498monotonic clock option helps a lot here).</p>
499<p>The relative timeouts are calculated relative to the <code>ev_now ()</code>
500time. This is usually the right thing as this timestamp refers to the time
501of the event triggering whatever timeout you are modifying/starting. If
502you suspect event processing to be delayed and you <i>need</i> to base the timeout
503on the current time, use something like this to adjust for this:</p>
504<pre> ev_timer_set (&amp;timer, after + ev_now () - ev_time (), 0.);
505
506</pre>
507<p>The callback is guarenteed to be invoked only when its timeout has passed,
508but if multiple timers become ready during the same loop iteration then
509order of execution is undefined.</p>
450<dl> 510<dl>
451 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> 511 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt>
452 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> 512 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt>
453 <dd> 513 <dd>
454 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is 514 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is
… …
456timer will automatically be configured to trigger again <code>repeat</code> seconds 516timer will automatically be configured to trigger again <code>repeat</code> seconds
457later, again, and again, until stopped manually.</p> 517later, again, and again, until stopped manually.</p>
458 <p>The timer itself will do a best-effort at avoiding drift, that is, if you 518 <p>The timer itself will do a best-effort at avoiding drift, that is, if you
459configure a timer to trigger every 10 seconds, then it will trigger at 519configure a timer to trigger every 10 seconds, then it will trigger at
460exactly 10 second intervals. If, however, your program cannot keep up with 520exactly 10 second intervals. If, however, your program cannot keep up with
461the timer (ecause it takes longer than those 10 seconds to do stuff) the 521the timer (because it takes longer than those 10 seconds to do stuff) the
462timer will not fire more than once per event loop iteration.</p> 522timer will not fire more than once per event loop iteration.</p>
463 </dd> 523 </dd>
464 <dt>ev_timer_again (loop)</dt> 524 <dt>ev_timer_again (loop)</dt>
465 <dd> 525 <dd>
466 <p>This will act as if the timer timed out and restart it again if it is 526 <p>This will act as if the timer timed out and restart it again if it is
… …
470value), or reset the running timer to the repeat value.</p> 530value), or reset the running timer to the repeat value.</p>
471 <p>This sounds a bit complicated, but here is a useful and typical 531 <p>This sounds a bit complicated, but here is a useful and typical
472example: Imagine you have a tcp connection and you want a so-called idle 532example: Imagine you have a tcp connection and you want a so-called idle
473timeout, that is, you want to be called when there have been, say, 60 533timeout, that is, you want to be called when there have been, say, 60
474seconds of inactivity on the socket. The easiest way to do this is to 534seconds of inactivity on the socket. The easiest way to do this is to
475configure an ev_timer with after=repeat=60 and calling ev_timer_again each 535configure an <code>ev_timer</code> with after=repeat=60 and calling ev_timer_again each
476time you successfully read or write some data. If you go into an idle 536time you successfully read or write some data. If you go into an idle
477state where you do not expect data to travel on the socket, you can stop 537state where you do not expect data to travel on the socket, you can stop
478the timer, and again will automatically restart it if need be.</p> 538the timer, and again will automatically restart it if need be.</p>
479 </dd> 539 </dd>
480</dl> 540</dl>
481 541
482</div> 542</div>
483<h2 id="ev_periodic">ev_periodic</h2> 543<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</h2>
484<div id="ev_periodic_CONTENT"> 544<div id="code_ev_periodic_code_to_cron_or_not-2">
485<p>Periodic watchers are also timers of a kind, but they are very versatile 545<p>Periodic watchers are also timers of a kind, but they are very versatile
486(and unfortunately a bit complex).</p> 546(and unfortunately a bit complex).</p>
487<p>Unlike ev_timer's, they are not based on real time (or relative time) 547<p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time)
488but on wallclock time (absolute time). You can tell a periodic watcher 548but on wallclock time (absolute time). You can tell a periodic watcher
489to trigger &quot;at&quot; some specific point in time. For example, if you tell a 549to trigger &quot;at&quot; some specific point in time. For example, if you tell a
490periodic watcher to trigger in 10 seconds (by specifiying e.g. c&lt;ev_now () 550periodic watcher to trigger in 10 seconds (by specifiying e.g. c&lt;ev_now ()
491+ 10.&gt;) and then reset your system clock to the last year, then it will 551+ 10.&gt;) and then reset your system clock to the last year, then it will
492take a year to trigger the event (unlike an ev_timer, which would trigger 552take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger
493roughly 10 seconds later and of course not if you reset your system time 553roughly 10 seconds later and of course not if you reset your system time
494again).</p> 554again).</p>
495<p>They can also be used to implement vastly more complex timers, such as 555<p>They can also be used to implement vastly more complex timers, such as
496triggering an event on eahc midnight, local time.</p> 556triggering an event on eahc midnight, local time.</p>
557<p>As with timers, the callback is guarenteed to be invoked only when the
558time (<code>at</code>) has been passed, but if multiple periodic timers become ready
559during the same loop iteration then order of execution is undefined.</p>
497<dl> 560<dl>
498 <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> 561 <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt>
499 <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt> 562 <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt>
500 <dd> 563 <dd>
501 <p>Lots of arguments, lets sort it out... There are basically three modes of 564 <p>Lots of arguments, lets sort it out... There are basically three modes of
502operation, and we will explain them from simplest to complex:</p> 565operation, and we will explain them from simplest to complex:</p>
503
504
505
506
507 <p> 566 <p>
508 <dl> 567 <dl>
509 <dt>* absolute timer (interval = reschedule_cb = 0)</dt> 568 <dt>* absolute timer (interval = reschedule_cb = 0)</dt>
510 <dd> 569 <dd>
511 <p>In this configuration the watcher triggers an event at the wallclock time 570 <p>In this configuration the watcher triggers an event at the wallclock time
… …
523<pre> ev_periodic_set (&amp;periodic, 0., 3600., 0); 582<pre> ev_periodic_set (&amp;periodic, 0., 3600., 0);
524 583
525</pre> 584</pre>
526 <p>This doesn't mean there will always be 3600 seconds in between triggers, 585 <p>This doesn't mean there will always be 3600 seconds in between triggers,
527but only that the the callback will be called when the system time shows a 586but only that the the callback will be called when the system time shows a
528full hour (UTC), or more correct, when the system time is evenly divisible 587full hour (UTC), or more correctly, when the system time is evenly divisible
529by 3600.</p> 588by 3600.</p>
530 <p>Another way to think about it (for the mathematically inclined) is that 589 <p>Another way to think about it (for the mathematically inclined) is that
531ev_periodic will try to run the callback in this mode at the next possible 590<code>ev_periodic</code> will try to run the callback in this mode at the next possible
532time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p> 591time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p>
533 </dd> 592 </dd>
534 <dt>* manual reschedule mode (reschedule_cb = callback)</dt> 593 <dt>* manual reschedule mode (reschedule_cb = callback)</dt>
535 <dd> 594 <dd>
536 <p>In this mode the values for <code>interval</code> and <code>at</code> are both being 595 <p>In this mode the values for <code>interval</code> and <code>at</code> are both being
537ignored. Instead, each time the periodic watcher gets scheduled, the 596ignored. Instead, each time the periodic watcher gets scheduled, the
538reschedule callback will be called with the watcher as first, and the 597reschedule callback will be called with the watcher as first, and the
539current time as second argument.</p> 598current time as second argument.</p>
540 <p>NOTE: <i>This callback MUST NOT stop or destroy the periodic or any other 599 <p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher,
541periodic watcher, ever, or make any event loop modificstions</i>. If you need 600ever, or make any event loop modifications</i>. If you need to stop it,
542to stop it, return 1e30 (or so, fudge fudge) and stop it afterwards.</p> 601return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by
602starting a prepare watcher).</p>
543 <p>Its prototype is c&lt;ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 603 <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
544ev_tstamp now)&gt;, e.g.:</p> 604ev_tstamp now)</code>, e.g.:</p>
545<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 605<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
546 { 606 {
547 return now + 60.; 607 return now + 60.;
548 } 608 }
549 609
550</pre> 610</pre>
551 <p>It must return the next time to trigger, based on the passed time value 611 <p>It must return the next time to trigger, based on the passed time value
552(that is, the lowest time value larger than to the second argument). It 612(that is, the lowest time value larger than to the second argument). It
553will usually be called just before the callback will be triggered, but 613will usually be called just before the callback will be triggered, but
554might be called at other times, too.</p> 614might be called at other times, too.</p>
615 <p>NOTE: <i>This callback must always return a time that is later than the
616passed <code>now</code> value</i>. Not even <code>now</code> itself will do, it <i>must</i> be larger.</p>
555 <p>This can be used to create very complex timers, such as a timer that 617 <p>This can be used to create very complex timers, such as a timer that
556triggers on each midnight, local time. To do this, you would calculate the 618triggers on each midnight, local time. To do this, you would calculate the
557next midnight after <code>now</code> and return the timestamp value for this. How you do this 619next midnight after <code>now</code> and return the timestamp value for this. How
558is, again, up to you (but it is not trivial).</p> 620you do this is, again, up to you (but it is not trivial, which is the main
621reason I omitted it as an example).</p>
559 </dd> 622 </dd>
560 </dl> 623 </dl>
561 </p> 624 </p>
562 </dd> 625 </dd>
563 <dt>ev_periodic_again (loop, ev_periodic *)</dt> 626 <dt>ev_periodic_again (loop, ev_periodic *)</dt>
… …
568program when the crontabs have changed).</p> 631program when the crontabs have changed).</p>
569 </dd> 632 </dd>
570</dl> 633</dl>
571 634
572</div> 635</div>
573<h2 id="ev_signal_signal_me_when_a_signal_ge">ev_signal - signal me when a signal gets signalled</h2> 636<h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</h2>
574<div id="ev_signal_signal_me_when_a_signal_ge-2"> 637<div id="code_ev_signal_code_signal_me_when_a-2">
575<p>Signal watchers will trigger an event when the process receives a specific 638<p>Signal watchers will trigger an event when the process receives a specific
576signal one or more times. Even though signals are very asynchronous, libev 639signal one or more times. Even though signals are very asynchronous, libev
577will try its best to deliver signals synchronously, i.e. as part of the 640will try it's best to deliver signals synchronously, i.e. as part of the
578normal event processing, like any other event.</p> 641normal event processing, like any other event.</p>
579<p>You cna configure as many watchers as you like per signal. Only when the 642<p>You can configure as many watchers as you like per signal. Only when the
580first watcher gets started will libev actually register a signal watcher 643first watcher gets started will libev actually register a signal watcher
581with the kernel (thus it coexists with your own signal handlers as long 644with the kernel (thus it coexists with your own signal handlers as long
582as you don't register any with libev). Similarly, when the last signal 645as you don't register any with libev). Similarly, when the last signal
583watcher for a signal is stopped libev will reset the signal handler to 646watcher for a signal is stopped libev will reset the signal handler to
584SIG_DFL (regardless of what it was set to before).</p> 647SIG_DFL (regardless of what it was set to before).</p>
… …
590of the <code>SIGxxx</code> constants).</p> 653of the <code>SIGxxx</code> constants).</p>
591 </dd> 654 </dd>
592</dl> 655</dl>
593 656
594</div> 657</div>
595<h2 id="ev_child_wait_for_pid_status_changes">ev_child - wait for pid status changes</h2> 658<h2 id="code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</h2>
596<div id="ev_child_wait_for_pid_status_changes-2"> 659<div id="code_ev_child_code_wait_for_pid_stat-2">
597<p>Child watchers trigger when your process receives a SIGCHLD in response to 660<p>Child watchers trigger when your process receives a SIGCHLD in response to
598some child status changes (most typically when a child of yours dies).</p> 661some child status changes (most typically when a child of yours dies).</p>
599<dl> 662<dl>
600 <dt>ev_child_init (ev_child *, callback, int pid)</dt> 663 <dt>ev_child_init (ev_child *, callback, int pid)</dt>
601 <dt>ev_child_set (ev_child *, int pid)</dt> 664 <dt>ev_child_set (ev_child *, int pid)</dt>
602 <dd> 665 <dd>
603 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or 666 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or
604<i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look 667<i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look
605at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see 668at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see
606the status word (use the macros from <code>sys/wait.h</code>). The <code>rpid</code> member 669the status word (use the macros from <code>sys/wait.h</code> and see your systems
670<code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the
607contains the pid of the process causing the status change.</p> 671process causing the status change.</p>
608 </dd> 672 </dd>
609</dl> 673</dl>
610 674
611</div> 675</div>
612<h2 id="ev_idle_when_you_ve_got_nothing_bett">ev_idle - when you've got nothing better to do</h2> 676<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</h2>
613<div id="ev_idle_when_you_ve_got_nothing_bett-2"> 677<div id="code_ev_idle_code_when_you_ve_got_no-2">
614<p>Idle watchers trigger events when there are no other I/O or timer (or 678<p>Idle watchers trigger events when there are no other events are pending
615periodic) events pending. That is, as long as your process is busy 679(prepare, check and other idle watchers do not count). That is, as long
616handling sockets or timeouts it will not be called. But when your process 680as your process is busy handling sockets or timeouts (or even signals,
617is idle all idle watchers are being called again and again - until 681imagine) it will not be triggered. But when your process is idle all idle
682watchers are being called again and again, once per event loop iteration -
618stopped, that is, or your process receives more events.</p> 683until stopped, that is, or your process receives more events and becomes
684busy.</p>
619<p>The most noteworthy effect is that as long as any idle watchers are 685<p>The most noteworthy effect is that as long as any idle watchers are
620active, the process will not block when waiting for new events.</p> 686active, the process will not block when waiting for new events.</p>
621<p>Apart from keeping your process non-blocking (which is a useful 687<p>Apart from keeping your process non-blocking (which is a useful
622effect on its own sometimes), idle watchers are a good place to do 688effect on its own sometimes), idle watchers are a good place to do
623&quot;pseudo-background processing&quot;, or delay processing stuff to after the 689&quot;pseudo-background processing&quot;, or delay processing stuff to after the
… …
630believe me.</p> 696believe me.</p>
631 </dd> 697 </dd>
632</dl> 698</dl>
633 699
634</div> 700</div>
635<h2 id="prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</h2> 701<h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2>
636<div id="prepare_and_check_your_hooks_into_th-2"> 702<div id="code_ev_prepare_code_and_code_ev_che-2">
637<p>Prepare and check watchers usually (but not always) are used in 703<p>Prepare and check watchers are usually (but not always) used in tandem:
638tandom. Prepare watchers get invoked before the process blocks and check 704prepare watchers get invoked before the process blocks and check watchers
639watchers afterwards.</p> 705afterwards.</p>
640<p>Their main purpose is to integrate other event mechanisms into libev. This 706<p>Their main purpose is to integrate other event mechanisms into libev. This
641could be used, for example, to track variable changes, implement your own 707could be used, for example, to track variable changes, implement your own
642watchers, integrate net-snmp or a coroutine library and lots more.</p> 708watchers, integrate net-snmp or a coroutine library and lots more.</p>
643<p>This is done by examining in each prepare call which file descriptors need 709<p>This is done by examining in each prepare call which file descriptors need
644to be watched by the other library, registering ev_io watchers for them 710to be watched by the other library, registering <code>ev_io</code> watchers for
645and starting an ev_timer watcher for any timeouts (many libraries provide 711them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries
646just this functionality). Then, in the check watcher you check for any 712provide just this functionality). Then, in the check watcher you check for
647events that occured (by making your callbacks set soem flags for example) 713any events that occured (by checking the pending status of all watchers
648and call back into the library.</p> 714and stopping them) and call back into the library. The I/O and timer
715callbacks will never actually be called (but must be valid nevertheless,
716because you never know, you know?).</p>
649<p>As another example, the perl Coro module uses these hooks to integrate 717<p>As another example, the Perl Coro module uses these hooks to integrate
650coroutines into libev programs, by yielding to other active coroutines 718coroutines into libev programs, by yielding to other active coroutines
651during each prepare and only letting the process block if no coroutines 719during each prepare and only letting the process block if no coroutines
652are ready to run.</p> 720are ready to run (it's actually more complicated: it only runs coroutines
721with priority higher than or equal to the event loop and one coroutine
722of lower priority, but only once, using idle watchers to keep the event
723loop from blocking if lower-priority coroutines are active, thus mapping
724low-priority coroutines to idle/background tasks).</p>
653<dl> 725<dl>
654 <dt>ev_prepare_init (ev_prepare *, callback)</dt> 726 <dt>ev_prepare_init (ev_prepare *, callback)</dt>
655 <dt>ev_check_init (ev_check *, callback)</dt> 727 <dt>ev_check_init (ev_check *, callback)</dt>
656 <dd> 728 <dd>
657 <p>Initialises and configures the prepare or check watcher - they have no 729 <p>Initialises and configures the prepare or check watcher - they have no
658parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> 730parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code>
659macros, but using them is utterly, utterly pointless.</p> 731macros, but using them is utterly, utterly and completely pointless.</p>
660 </dd> 732 </dd>
661</dl> 733</dl>
662 734
663</div> 735</div>
664<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 736<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
665<div id="OTHER_FUNCTIONS_CONTENT"> 737<div id="OTHER_FUNCTIONS_CONTENT">
666<p>There are some other fucntions of possible interest. Described. Here. Now.</p> 738<p>There are some other functions of possible interest. Described. Here. Now.</p>
667<dl> 739<dl>
668 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> 740 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt>
669 <dd> 741 <dd>
670 <p>This function combines a simple timer and an I/O watcher, calls your 742 <p>This function combines a simple timer and an I/O watcher, calls your
671callback on whichever event happens first and automatically stop both 743callback on whichever event happens first and automatically stop both
672watchers. This is useful if you want to wait for a single event on an fd 744watchers. This is useful if you want to wait for a single event on an fd
673or timeout without havign to allocate/configure/start/stop/free one or 745or timeout without having to allocate/configure/start/stop/free one or
674more watchers yourself.</p> 746more watchers yourself.</p>
675 <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events is 747 <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events
676ignored. Otherwise, an ev_io watcher for the given <code>fd</code> and <code>events</code> set 748is being ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and
677will be craeted and started.</p> 749<code>events</code> set will be craeted and started.</p>
678 <p>If <code>timeout</code> is less than 0, then no timeout watcher will be 750 <p>If <code>timeout</code> is less than 0, then no timeout watcher will be
679started. Otherwise an ev_timer watcher with after = <code>timeout</code> (and repeat 751started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and
680= 0) will be started.</p> 752repeat = 0) will be started. While <code>0</code> is a valid timeout, it is of
753dubious value.</p>
681 <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and 754 <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and gets
682gets passed an events set (normally a combination of EV_ERROR, EV_READ, 755passed an <code>revents</code> set like normal event callbacks (a combination of
683EV_WRITE or EV_TIMEOUT) and the <code>arg</code> value passed to <code>ev_once</code>:</p> 756<code>EV_ERROR</code>, <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code>
757value passed to <code>ev_once</code>:</p>
684<pre> static void stdin_ready (int revents, void *arg) 758<pre> static void stdin_ready (int revents, void *arg)
685 { 759 {
686 if (revents &amp; EV_TIMEOUT) 760 if (revents &amp; EV_TIMEOUT)
687 /* doh, nothing entered */ 761 /* doh, nothing entered */;
688 else if (revents &amp; EV_READ) 762 else if (revents &amp; EV_READ)
689 /* stdin might have data for us, joy! */ 763 /* stdin might have data for us, joy! */;
690 } 764 }
691 765
692 ev_once (STDIN_FILENO, EV_READm 10., stdin_ready, 0); 766 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
693 767
694</pre> 768</pre>
695 </dd> 769 </dd>
696 <dt>ev_feed_event (loop, watcher, int events)</dt> 770 <dt>ev_feed_event (loop, watcher, int events)</dt>
697 <dd> 771 <dd>
698 <p>Feeds the given event set into the event loop, as if the specified event 772 <p>Feeds the given event set into the event loop, as if the specified event
699has happened for the specified watcher (which must be a pointer to an 773had happened for the specified watcher (which must be a pointer to an
700initialised but not necessarily active event watcher).</p> 774initialised but not necessarily started event watcher).</p>
701 </dd> 775 </dd>
702 <dt>ev_feed_fd_event (loop, int fd, int revents)</dt> 776 <dt>ev_feed_fd_event (loop, int fd, int revents)</dt>
703 <dd> 777 <dd>
704 <p>Feed an event on the given fd, as if a file descriptor backend detected it.</p> 778 <p>Feed an event on the given fd, as if a file descriptor backend detected
779the given events it.</p>
705 </dd> 780 </dd>
706 <dt>ev_feed_signal_event (loop, int signum)</dt> 781 <dt>ev_feed_signal_event (loop, int signum)</dt>
707 <dd> 782 <dd>
708 <p>Feed an event as if the given signal occured (loop must be the default loop!).</p> 783 <p>Feed an event as if the given signal occured (loop must be the default loop!).</p>
709 </dd> 784 </dd>
710</dl> 785</dl>
786
787</div>
788<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1><p><a href="#TOP" class="toplink">Top</a></p>
789<div id="LIBEVENT_EMULATION_CONTENT">
790<p>Libev offers a compatibility emulation layer for libevent. It cannot
791emulate the internals of libevent, so here are some usage hints:</p>
792<dl>
793 <dt>* Use it by including &lt;event.h&gt;, as usual.</dt>
794 <dt>* The following members are fully supported: ev_base, ev_callback,
795ev_arg, ev_fd, ev_res, ev_events.</dt>
796 <dt>* Avoid using ev_flags and the EVLIST_*-macros, while it is
797maintained by libev, it does not work exactly the same way as in libevent (consider
798it a private API).</dt>
799 <dt>* Priorities are not currently supported. Initialising priorities
800will fail and all watchers will have the same priority, even though there
801is an ev_pri field.</dt>
802 <dt>* Other members are not supported.</dt>
803 <dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need
804to use the libev header file and library.</dt>
805</dl>
806
807</div>
808<h1 id="C_SUPPORT">C++ SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p>
809<div id="C_SUPPORT_CONTENT">
810<p>TBD.</p>
711 811
712</div> 812</div>
713<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> 813<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
714<div id="AUTHOR_CONTENT"> 814<div id="AUTHOR_CONTENT">
715<p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p> 815<p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p>

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines