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

Comparing libev/ev.html (file contents):
Revision 1.9 by root, Mon Nov 12 08:29:11 2007 UTC vs.
Revision 1.30 by root, Thu Nov 22 12:28:35 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 09:29:10 2007" /> 9 <meta name="created" content="Thu Nov 22 13:28:34 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_to_cron_or_not_to_cron_i">ev_periodic - to cron or not to cron it</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
… …
87support for multiple event loops, then all functions taking an initial 90support for multiple event loops, then all functions taking an initial
88argument 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>)
89will not have this argument.</p> 92will not have this argument.</p>
90 93
91</div> 94</div>
92<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>
93<div id="TIME_AND_OTHER_GLOBAL_FUNCTIONS_CONT"> 96<div id="TIME_REPRESENTATION_CONTENT">
94<p>Libev represents time as a single floating point number, representing the 97<p>Libev represents time as a single floating point number, representing the
95(fractional) number of seconds since the (POSIX) epoch (somewhere near 98(fractional) number of seconds since the (POSIX) epoch (somewhere near
96the beginning of 1970, details are complicated, don't ask). This type is 99the beginning of 1970, details are complicated, don't ask). This type is
97called <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
98to 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>
99<dl> 108<dl>
100 <dt>ev_tstamp ev_time ()</dt> 109 <dt>ev_tstamp ev_time ()</dt>
101 <dd> 110 <dd>
102 <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>
103 </dd> 114 </dd>
104 <dt>int ev_version_major ()</dt> 115 <dt>int ev_version_major ()</dt>
105 <dt>int ev_version_minor ()</dt> 116 <dt>int ev_version_minor ()</dt>
106 <dd> 117 <dd>
107 <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
… …
142<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2"> 153<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2">
143<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
144types 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
145events, and dynamically created loops which do not.</p> 156events, and dynamically created loops which do not.</p>
146<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
147in 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
148create, you also create another event loop. Libev itself does no locking 159create, you also create another event loop. Libev itself does no locking
149whatsoever, so if you mix calls to the same event loop in different 160whatsoever, so if you mix calls to the same event loop in different
150threads, make sure you lock (this is usually a bad idea, though, even if 161threads, make sure you lock (this is usually a bad idea, though, even if
151done correctly, because it's hideous and inefficient).</p> 162done correctly, because it's hideous and inefficient).</p>
152<dl> 163<dl>
… …
161 <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
162backends 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>
163 <p>It supports the following flags:</p> 174 <p>It supports the following flags:</p>
164 <p> 175 <p>
165 <dl> 176 <dl>
166 <dt>EVFLAG_AUTO</dt> 177 <dt><code>EVFLAG_AUTO</code></dt>
167 <dd> 178 <dd>
168 <p>The default flags value. Use this if you have no clue (it's the right 179 <p>The default flags value. Use this if you have no clue (it's the right
169thing, believe me).</p> 180thing, believe me).</p>
170 </dd> 181 </dd>
171 <dt>EVFLAG_NOENV</dt> 182 <dt><code>EVFLAG_NOENV</code></dt>
172 <dd> 183 <dd>
173 <p>If this flag bit is ored into the flag value (or the program runs setuid 184 <p>If this flag bit is ored into the flag value (or the program runs setuid
174or setgid) then libev will <i>not</i> look at the environment variable 185or setgid) then libev will <i>not</i> look at the environment variable
175<code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will 186<code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will
176override the flags completely if it is found in the environment. This is 187override the flags completely if it is found in the environment. This is
177useful to try out specific backends to test their performance, or to work 188useful to try out specific backends to test their performance, or to work
178around bugs.</p> 189around bugs.</p>
179 </dd> 190 </dd>
180 <dt>EVMETHOD_SELECT (portable select backend)</dt> 191 <dt><code>EVMETHOD_SELECT</code> (value 1, portable select backend)</dt>
181 <dt>EVMETHOD_POLL (poll backend, available everywhere except on windows)</dt> 192 <dd>
182 <dt>EVMETHOD_EPOLL (linux only)</dt> 193 <p>This is your standard select(2) backend. Not <i>completely</i> standard, as
183 <dt>EVMETHOD_KQUEUE (some bsds only)</dt> 194libev tries to roll its own fd_set with no limits on the number of fds,
184 <dt>EVMETHOD_DEVPOLL (solaris 8 only)</dt> 195but if that fails, expect a fairly low limit on the number of fds when
185 <dt>EVMETHOD_PORT (solaris 10 only)</dt> 196using this backend. It doesn't scale too well (O(highest_fd)), but its usually
197the fastest backend for a low number of fds.</p>
186 <dd> 198 </dd>
187 <p>If one or more of these are ored into the flags value, then only these 199 <dt><code>EVMETHOD_POLL</code> (value 2, poll backend, available everywhere except on windows)</dt>
188backends will be tried (in the reverse order as given here). If one are 200 <dd>
189specified, any backend will do.</p> 201 <p>And this is your standard poll(2) backend. It's more complicated than
202select, but handles sparse fds better and has no artificial limit on the
203number of fds you can use (except it will slow down considerably with a
204lot of inactive fds). It scales similarly to select, i.e. O(total_fds).</p>
205 </dd>
206 <dt><code>EVMETHOD_EPOLL</code> (value 4, Linux)</dt>
207 <dd>
208 <p>For few fds, this backend is a bit little slower than poll and select,
209but it scales phenomenally better. While poll and select usually scale like
210O(total_fds) where n is the total number of fds (or the highest fd), epoll scales
211either O(1) or O(active_fds).</p>
212 <p>While stopping and starting an I/O watcher in the same iteration will
213result in some caching, there is still a syscall per such incident
214(because the fd could point to a different file description now), so its
215best to avoid that. Also, dup()ed file descriptors might not work very
216well if you register events for both fds.</p>
217 </dd>
218 <dt><code>EVMETHOD_KQUEUE</code> (value 8, most BSD clones)</dt>
219 <dd>
220 <p>Kqueue deserves special mention, as at the time of this writing, it
221was broken on all BSDs except NetBSD (usually it doesn't work with
222anything but sockets and pipes, except on Darwin, where of course its
223completely useless). For this reason its not being &quot;autodetected&quot; unless
224you explicitly specify the flags (i.e. you don't use EVFLAG_AUTO).</p>
225 <p>It scales in the same way as the epoll backend, but the interface to the
226kernel is more efficient (which says nothing about its actual speed, of
227course). While starting and stopping an I/O watcher does not cause an
228extra syscall as with epoll, it still adds up to four event changes per
229incident, so its best to avoid that.</p>
230 </dd>
231 <dt><code>EVMETHOD_DEVPOLL</code> (value 16, Solaris 8)</dt>
232 <dd>
233 <p>This is not implemented yet (and might never be).</p>
234 </dd>
235 <dt><code>EVMETHOD_PORT</code> (value 32, Solaris 10)</dt>
236 <dd>
237 <p>This uses the Solaris 10 port mechanism. As with everything on Solaris,
238it's really slow, but it still scales very well (O(active_fds)).</p>
239 </dd>
240 <dt><code>EVMETHOD_ALL</code></dt>
241 <dd>
242 <p>Try all backends (even potentially broken ones that wouldn't be tried
243with <code>EVFLAG_AUTO</code>). Since this is a mask, you can do stuff such as
244<code>EVMETHOD_ALL &amp; ~EVMETHOD_KQUEUE</code>.</p>
190 </dd> 245 </dd>
191 </dl> 246 </dl>
192 </p> 247 </p>
248 <p>If one or more of these are ored into the flags value, then only these
249backends will be tried (in the reverse order as given here). If none are
250specified, most compiled-in backend will be tried, usually in reverse
251order of their flag values :)</p>
193 </dd> 252 </dd>
194 <dt>struct ev_loop *ev_loop_new (unsigned int flags)</dt> 253 <dt>struct ev_loop *ev_loop_new (unsigned int flags)</dt>
195 <dd> 254 <dd>
196 <p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is 255 <p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is
197always distinct from the default loop. Unlike the default loop, it cannot 256always distinct from the default loop. Unlike the default loop, it cannot
… …
259your process until at least one new event arrives, and will return after 318your process until at least one new event arrives, and will return after
260one iteration of the loop.</p> 319one iteration of the loop.</p>
261 <p>This flags value could be used to implement alternative looping 320 <p>This flags value could be used to implement alternative looping
262constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and 321constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and
263more generic mechanism.</p> 322more generic mechanism.</p>
323 <p>Here are the gory details of what ev_loop does:</p>
324<pre> 1. If there are no active watchers (reference count is zero), return.
325 2. Queue and immediately call all prepare watchers.
326 3. If we have been forked, recreate the kernel state.
327 4. Update the kernel state with all outstanding changes.
328 5. Update the &quot;event loop time&quot;.
329 6. Calculate for how long to block.
330 7. Block the process, waiting for events.
331 8. Update the &quot;event loop time&quot; and do time jump handling.
332 9. Queue all outstanding timers.
333 10. Queue all outstanding periodics.
334 11. If no events are pending now, queue all idle watchers.
335 12. Queue all check watchers.
336 13. Call all queued watchers in reverse order (i.e. check watchers first).
337 14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
338 was used, return, otherwise continue with step #1.
339
340</pre>
264 </dd> 341 </dd>
265 <dt>ev_unloop (loop, how)</dt> 342 <dt>ev_unloop (loop, how)</dt>
266 <dd> 343 <dd>
267 <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it 344 <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it
268has processed all outstanding events). The <code>how</code> argument must be either 345has processed all outstanding events). The <code>how</code> argument must be either
269<code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> call return, or 346<code>EVUNLOOP_ONE</code>, which will make the innermost <code>ev_loop</code> call return, or
270<code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p> 347<code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p>
271 </dd> 348 </dd>
272 <dt>ev_ref (loop)</dt> 349 <dt>ev_ref (loop)</dt>
273 <dt>ev_unref (loop)</dt> 350 <dt>ev_unref (loop)</dt>
274 <dd> 351 <dd>
… …
288</div> 365</div>
289<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> 366<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p>
290<div id="ANATOMY_OF_A_WATCHER_CONTENT"> 367<div id="ANATOMY_OF_A_WATCHER_CONTENT">
291<p>A watcher is a structure that you create and register to record your 368<p>A watcher is a structure that you create and register to record your
292interest in some event. For instance, if you want to wait for STDIN to 369interest in some event. For instance, if you want to wait for STDIN to
293become readable, you would create an ev_io watcher for that:</p> 370become readable, you would create an <code>ev_io</code> watcher for that:</p>
294<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 371<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
295 { 372 {
296 ev_io_stop (w); 373 ev_io_stop (w);
297 ev_unloop (loop, EVUNLOOP_ALL); 374 ev_unloop (loop, EVUNLOOP_ALL);
298 } 375 }
… …
322*)</code>), and you can stop watching for events at any time by calling the 399*)</code>), and you can stop watching for events at any time by calling the
323corresponding stop function (<code>ev_&lt;type&gt;_stop (loop, watcher *)</code>.</p> 400corresponding stop function (<code>ev_&lt;type&gt;_stop (loop, watcher *)</code>.</p>
324<p>As long as your watcher is active (has been started but not stopped) you 401<p>As long as your watcher is active (has been started but not stopped) you
325must not touch the values stored in it. Most specifically you must never 402must not touch the values stored in it. Most specifically you must never
326reinitialise it or call its set method.</p> 403reinitialise it or call its set method.</p>
327<p>You cna check whether an event is active by calling the <code>ev_is_active 404<p>You can check whether an event is active by calling the <code>ev_is_active
328(watcher *)</code> macro. To see whether an event is outstanding (but the 405(watcher *)</code> macro. To see whether an event is outstanding (but the
329callback for it has not been called yet) you cna use the <code>ev_is_pending 406callback for it has not been called yet) you can use the <code>ev_is_pending
330(watcher *)</code> macro.</p> 407(watcher *)</code> macro.</p>
331<p>Each and every callback receives the event loop pointer as first, the 408<p>Each and every callback receives the event loop pointer as first, the
332registered watcher structure as second, and a bitset of received events as 409registered watcher structure as second, and a bitset of received events as
333third argument.</p> 410third argument.</p>
334<p>The rceeived events usually include a single bit per event type received 411<p>The received events usually include a single bit per event type received
335(you can receive multiple events at the same time). The possible bit masks 412(you can receive multiple events at the same time). The possible bit masks
336are:</p> 413are:</p>
337<dl> 414<dl>
338 <dt>EV_READ</dt> 415 <dt><code>EV_READ</code></dt>
339 <dt>EV_WRITE</dt> 416 <dt><code>EV_WRITE</code></dt>
340 <dd> 417 <dd>
341 <p>The file descriptor in the ev_io watcher has become readable and/or 418 <p>The file descriptor in the <code>ev_io</code> watcher has become readable and/or
342writable.</p> 419writable.</p>
343 </dd> 420 </dd>
344 <dt>EV_TIMEOUT</dt> 421 <dt><code>EV_TIMEOUT</code></dt>
345 <dd>
346 <p>The ev_timer watcher has timed out.</p>
347 </dd> 422 <dd>
348 <dt>EV_PERIODIC</dt> 423 <p>The <code>ev_timer</code> watcher has timed out.</p>
349 <dd> 424 </dd>
350 <p>The ev_periodic watcher has timed out.</p> 425 <dt><code>EV_PERIODIC</code></dt>
351 </dd> 426 <dd>
352 <dt>EV_SIGNAL</dt> 427 <p>The <code>ev_periodic</code> watcher has timed out.</p>
353 <dd> 428 </dd>
429 <dt><code>EV_SIGNAL</code></dt>
430 <dd>
354 <p>The signal specified in the ev_signal watcher has been received by a thread.</p> 431 <p>The signal specified in the <code>ev_signal</code> watcher has been received by a thread.</p>
355 </dd>
356 <dt>EV_CHILD</dt>
357 <dd> 432 </dd>
433 <dt><code>EV_CHILD</code></dt>
434 <dd>
358 <p>The pid specified in the ev_child watcher has received a status change.</p> 435 <p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p>
359 </dd>
360 <dt>EV_IDLE</dt>
361 <dd> 436 </dd>
437 <dt><code>EV_IDLE</code></dt>
438 <dd>
362 <p>The ev_idle watcher has determined that you have nothing better to do.</p> 439 <p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p>
363 </dd>
364 <dt>EV_PREPARE</dt>
365 <dt>EV_CHECK</dt>
366 <dd> 440 </dd>
441 <dt><code>EV_PREPARE</code></dt>
442 <dt><code>EV_CHECK</code></dt>
443 <dd>
367 <p>All ev_prepare watchers are invoked just <i>before</i> <code>ev_loop</code> starts 444 <p>All <code>ev_prepare</code> watchers are invoked just <i>before</i> <code>ev_loop</code> starts
368to gather new events, and all ev_check watchers are invoked just after 445to gather new events, and all <code>ev_check</code> watchers are invoked just after
369<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any 446<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any
370received events. Callbacks of both watcher types can start and stop as 447received events. Callbacks of both watcher types can start and stop as
371many watchers as they want, and all of them will be taken into account 448many watchers as they want, and all of them will be taken into account
372(for example, a ev_prepare watcher might start an idle watcher to keep 449(for example, a <code>ev_prepare</code> watcher might start an idle watcher to keep
373<code>ev_loop</code> from blocking).</p> 450<code>ev_loop</code> from blocking).</p>
374 </dd> 451 </dd>
375 <dt>EV_ERROR</dt> 452 <dt><code>EV_ERROR</code></dt>
376 <dd> 453 <dd>
377 <p>An unspecified error has occured, the watcher has been stopped. This might 454 <p>An unspecified error has occured, the watcher has been stopped. This might
378happen because the watcher could not be properly started because libev 455happen because the watcher could not be properly started because libev
379ran out of memory, a file descriptor was found to be closed or any other 456ran out of memory, a file descriptor was found to be closed or any other
380problem. You best act on it by reporting the problem and somehow coping 457problem. You best act on it by reporting the problem and somehow coping
… …
389 466
390</div> 467</div>
391<h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2> 468<h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2>
392<div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2"> 469<div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2">
393<p>Each watcher has, by default, a member <code>void *data</code> that you can change 470<p>Each watcher has, by default, a member <code>void *data</code> that you can change
394and read at any time, libev will completely ignore it. This cna be used 471and read at any time, libev will completely ignore it. This can be used
395to associate arbitrary data with your watcher. If you need more data and 472to associate arbitrary data with your watcher. If you need more data and
396don't want to allocate memory and store a pointer to it in that data 473don't want to allocate memory and store a pointer to it in that data
397member, you can also &quot;subclass&quot; the watcher type and provide your own 474member, you can also &quot;subclass&quot; the watcher type and provide your own
398data:</p> 475data:</p>
399<pre> struct my_io 476<pre> struct my_io
… …
426<div id="WATCHER_TYPES_CONTENT"> 503<div id="WATCHER_TYPES_CONTENT">
427<p>This section describes each watcher in detail, but will not repeat 504<p>This section describes each watcher in detail, but will not repeat
428information given in the last section.</p> 505information given in the last section.</p>
429 506
430</div> 507</div>
431<h2 id="struct_ev_io_is_my_file_descriptor_r">struct ev_io - is my file descriptor readable or writable</h2> 508<h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</h2>
432<div id="struct_ev_io_is_my_file_descriptor_r-2"> 509<div id="code_ev_io_code_is_this_file_descrip-2">
433<p>I/O watchers check whether a file descriptor is readable or writable 510<p>I/O watchers check whether a file descriptor is readable or writable
434in each iteration of the event loop (This behaviour is called 511in each iteration of the event loop (This behaviour is called
435level-triggering because you keep receiving events as long as the 512level-triggering because you keep receiving events as long as the
436condition persists. Remember you cna stop the watcher if you don't want to 513condition persists. Remember you can stop the watcher if you don't want to
437act on the event and neither want to receive future events).</p> 514act on the event and neither want to receive future events).</p>
438<p>In general you can register as many read and/or write event watchers oer 515<p>In general you can register as many read and/or write event watchers per
439fd as you want (as long as you don't confuse yourself). Setting all file 516fd as you want (as long as you don't confuse yourself). Setting all file
440descriptors to non-blocking mode is also usually a good idea (but not 517descriptors to non-blocking mode is also usually a good idea (but not
441required if you know what you are doing).</p> 518required if you know what you are doing).</p>
442<p>You have to be careful with dup'ed file descriptors, though. Some backends 519<p>You have to be careful with dup'ed file descriptors, though. Some backends
443(the linux epoll backend is a notable example) cannot handle dup'ed file 520(the linux epoll backend is a notable example) cannot handle dup'ed file
444descriptors correctly if you register interest in two or more fds pointing 521descriptors correctly if you register interest in two or more fds pointing
445to the same file/socket etc. description.</p> 522to the same underlying file/socket etc. description (that is, they share
523the same underlying &quot;file open&quot;).</p>
446<p>If you must do this, then force the use of a known-to-be-good backend 524<p>If you must do this, then force the use of a known-to-be-good backend
447(at the time of this writing, this includes only EVMETHOD_SELECT and 525(at the time of this writing, this includes only EVMETHOD_SELECT and
448EVMETHOD_POLL).</p> 526EVMETHOD_POLL).</p>
449<dl> 527<dl>
450 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> 528 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>
451 <dt>ev_io_set (ev_io *, int fd, int events)</dt> 529 <dt>ev_io_set (ev_io *, int fd, int events)</dt>
452 <dd> 530 <dd>
453 <p>Configures an ev_io watcher. The fd is the file descriptor to rceeive 531 <p>Configures an <code>ev_io</code> watcher. The fd is the file descriptor to rceeive
454events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ | 532events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ |
455EV_WRITE</code> to receive the given events.</p> 533EV_WRITE</code> to receive the given events.</p>
456 </dd> 534 </dd>
457</dl> 535</dl>
458 536
459</div> 537</div>
460<h2 id="struct_ev_timer_relative_and_optiona">struct ev_timer - relative and optionally recurring timeouts</h2> 538<h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2>
461<div id="struct_ev_timer_relative_and_optiona-2"> 539<div id="code_ev_timer_code_relative_and_opti-2">
462<p>Timer watchers are simple relative timers that generate an event after a 540<p>Timer watchers are simple relative timers that generate an event after a
463given time, and optionally repeating in regular intervals after that.</p> 541given time, and optionally repeating in regular intervals after that.</p>
464<p>The timers are based on real time, that is, if you register an event that 542<p>The timers are based on real time, that is, if you register an event that
465times out after an hour and youreset your system clock to last years 543times out after an hour and you reset your system clock to last years
466time, it will still time out after (roughly) and hour. &quot;Roughly&quot; because 544time, it will still time out after (roughly) and hour. &quot;Roughly&quot; because
467detecting time jumps is hard, and soem inaccuracies are unavoidable (the 545detecting time jumps is hard, and some inaccuracies are unavoidable (the
468monotonic clock option helps a lot here).</p> 546monotonic clock option helps a lot here).</p>
469<p>The relative timeouts are calculated relative to the <code>ev_now ()</code> 547<p>The relative timeouts are calculated relative to the <code>ev_now ()</code>
470time. This is usually the right thing as this timestamp refers to the time 548time. This is usually the right thing as this timestamp refers to the time
471of the event triggering whatever timeout you are modifying/starting. If 549of the event triggering whatever timeout you are modifying/starting. If
472you suspect event processing to be delayed and you *need* to base the timeout 550you suspect event processing to be delayed and you <i>need</i> to base the timeout
473ion the current time, use something like this to adjust for this:</p> 551on the current time, use something like this to adjust for this:</p>
474<pre> ev_timer_set (&amp;timer, after + ev_now () - ev_time (), 0.); 552<pre> ev_timer_set (&amp;timer, after + ev_now () - ev_time (), 0.);
475 553
476</pre> 554</pre>
555<p>The callback is guarenteed to be invoked only when its timeout has passed,
556but if multiple timers become ready during the same loop iteration then
557order of execution is undefined.</p>
477<dl> 558<dl>
478 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> 559 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt>
479 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> 560 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt>
480 <dd> 561 <dd>
481 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is 562 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is
… …
483timer will automatically be configured to trigger again <code>repeat</code> seconds 564timer will automatically be configured to trigger again <code>repeat</code> seconds
484later, again, and again, until stopped manually.</p> 565later, again, and again, until stopped manually.</p>
485 <p>The timer itself will do a best-effort at avoiding drift, that is, if you 566 <p>The timer itself will do a best-effort at avoiding drift, that is, if you
486configure a timer to trigger every 10 seconds, then it will trigger at 567configure a timer to trigger every 10 seconds, then it will trigger at
487exactly 10 second intervals. If, however, your program cannot keep up with 568exactly 10 second intervals. If, however, your program cannot keep up with
488the timer (ecause it takes longer than those 10 seconds to do stuff) the 569the timer (because it takes longer than those 10 seconds to do stuff) the
489timer will not fire more than once per event loop iteration.</p> 570timer will not fire more than once per event loop iteration.</p>
490 </dd> 571 </dd>
491 <dt>ev_timer_again (loop)</dt> 572 <dt>ev_timer_again (loop)</dt>
492 <dd> 573 <dd>
493 <p>This will act as if the timer timed out and restart it again if it is 574 <p>This will act as if the timer timed out and restart it again if it is
… …
497value), or reset the running timer to the repeat value.</p> 578value), or reset the running timer to the repeat value.</p>
498 <p>This sounds a bit complicated, but here is a useful and typical 579 <p>This sounds a bit complicated, but here is a useful and typical
499example: Imagine you have a tcp connection and you want a so-called idle 580example: Imagine you have a tcp connection and you want a so-called idle
500timeout, that is, you want to be called when there have been, say, 60 581timeout, that is, you want to be called when there have been, say, 60
501seconds of inactivity on the socket. The easiest way to do this is to 582seconds of inactivity on the socket. The easiest way to do this is to
502configure an ev_timer with after=repeat=60 and calling ev_timer_again each 583configure an <code>ev_timer</code> with after=repeat=60 and calling ev_timer_again each
503time you successfully read or write some data. If you go into an idle 584time you successfully read or write some data. If you go into an idle
504state where you do not expect data to travel on the socket, you can stop 585state where you do not expect data to travel on the socket, you can stop
505the timer, and again will automatically restart it if need be.</p> 586the timer, and again will automatically restart it if need be.</p>
506 </dd> 587 </dd>
507</dl> 588</dl>
508 589
509</div> 590</div>
510<h2 id="ev_periodic_to_cron_or_not_to_cron_i">ev_periodic - to cron or not to cron it</h2> 591<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</h2>
511<div id="ev_periodic_to_cron_or_not_to_cron_i-2"> 592<div id="code_ev_periodic_code_to_cron_or_not-2">
512<p>Periodic watchers are also timers of a kind, but they are very versatile 593<p>Periodic watchers are also timers of a kind, but they are very versatile
513(and unfortunately a bit complex).</p> 594(and unfortunately a bit complex).</p>
514<p>Unlike ev_timer's, they are not based on real time (or relative time) 595<p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time)
515but on wallclock time (absolute time). You can tell a periodic watcher 596but on wallclock time (absolute time). You can tell a periodic watcher
516to trigger &quot;at&quot; some specific point in time. For example, if you tell a 597to trigger &quot;at&quot; some specific point in time. For example, if you tell a
517periodic watcher to trigger in 10 seconds (by specifiying e.g. c&lt;ev_now () 598periodic watcher to trigger in 10 seconds (by specifiying e.g. c&lt;ev_now ()
518+ 10.&gt;) and then reset your system clock to the last year, then it will 599+ 10.&gt;) and then reset your system clock to the last year, then it will
519take a year to trigger the event (unlike an ev_timer, which would trigger 600take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger
520roughly 10 seconds later and of course not if you reset your system time 601roughly 10 seconds later and of course not if you reset your system time
521again).</p> 602again).</p>
522<p>They can also be used to implement vastly more complex timers, such as 603<p>They can also be used to implement vastly more complex timers, such as
523triggering an event on eahc midnight, local time.</p> 604triggering an event on eahc midnight, local time.</p>
605<p>As with timers, the callback is guarenteed to be invoked only when the
606time (<code>at</code>) has been passed, but if multiple periodic timers become ready
607during the same loop iteration then order of execution is undefined.</p>
524<dl> 608<dl>
525 <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> 609 <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt>
526 <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt> 610 <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt>
527 <dd> 611 <dd>
528 <p>Lots of arguments, lets sort it out... There are basically three modes of 612 <p>Lots of arguments, lets sort it out... There are basically three modes of
529operation, and we will explain them from simplest to complex:</p> 613operation, and we will explain them from simplest to complex:</p>
530
531
532
533
534 <p> 614 <p>
535 <dl> 615 <dl>
536 <dt>* absolute timer (interval = reschedule_cb = 0)</dt> 616 <dt>* absolute timer (interval = reschedule_cb = 0)</dt>
537 <dd> 617 <dd>
538 <p>In this configuration the watcher triggers an event at the wallclock time 618 <p>In this configuration the watcher triggers an event at the wallclock time
… …
550<pre> ev_periodic_set (&amp;periodic, 0., 3600., 0); 630<pre> ev_periodic_set (&amp;periodic, 0., 3600., 0);
551 631
552</pre> 632</pre>
553 <p>This doesn't mean there will always be 3600 seconds in between triggers, 633 <p>This doesn't mean there will always be 3600 seconds in between triggers,
554but only that the the callback will be called when the system time shows a 634but only that the the callback will be called when the system time shows a
555full hour (UTC), or more correct, when the system time is evenly divisible 635full hour (UTC), or more correctly, when the system time is evenly divisible
556by 3600.</p> 636by 3600.</p>
557 <p>Another way to think about it (for the mathematically inclined) is that 637 <p>Another way to think about it (for the mathematically inclined) is that
558ev_periodic will try to run the callback in this mode at the next possible 638<code>ev_periodic</code> will try to run the callback in this mode at the next possible
559time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p> 639time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p>
560 </dd> 640 </dd>
561 <dt>* manual reschedule mode (reschedule_cb = callback)</dt> 641 <dt>* manual reschedule mode (reschedule_cb = callback)</dt>
562 <dd> 642 <dd>
563 <p>In this mode the values for <code>interval</code> and <code>at</code> are both being 643 <p>In this mode the values for <code>interval</code> and <code>at</code> are both being
564ignored. Instead, each time the periodic watcher gets scheduled, the 644ignored. Instead, each time the periodic watcher gets scheduled, the
565reschedule callback will be called with the watcher as first, and the 645reschedule callback will be called with the watcher as first, and the
566current time as second argument.</p> 646current time as second argument.</p>
567 <p>NOTE: <i>This callback MUST NOT stop or destroy the periodic or any other 647 <p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher,
568periodic watcher, ever, or make any event loop modificstions</i>. If you need 648ever, or make any event loop modifications</i>. If you need to stop it,
569to stop it, return 1e30 (or so, fudge fudge) and stop it afterwards.</p> 649return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by
650starting a prepare watcher).</p>
570 <p>Its prototype is c&lt;ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 651 <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
571ev_tstamp now)&gt;, e.g.:</p> 652ev_tstamp now)</code>, e.g.:</p>
572<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 653<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
573 { 654 {
574 return now + 60.; 655 return now + 60.;
575 } 656 }
576 657
577</pre> 658</pre>
578 <p>It must return the next time to trigger, based on the passed time value 659 <p>It must return the next time to trigger, based on the passed time value
579(that is, the lowest time value larger than to the second argument). It 660(that is, the lowest time value larger than to the second argument). It
580will usually be called just before the callback will be triggered, but 661will usually be called just before the callback will be triggered, but
581might be called at other times, too.</p> 662might be called at other times, too.</p>
663 <p>NOTE: <i>This callback must always return a time that is later than the
664passed <code>now</code> value</i>. Not even <code>now</code> itself will do, it <i>must</i> be larger.</p>
582 <p>This can be used to create very complex timers, such as a timer that 665 <p>This can be used to create very complex timers, such as a timer that
583triggers on each midnight, local time. To do this, you would calculate the 666triggers on each midnight, local time. To do this, you would calculate the
584next midnight after <code>now</code> and return the timestamp value for this. How you do this 667next midnight after <code>now</code> and return the timestamp value for this. How
585is, again, up to you (but it is not trivial).</p> 668you do this is, again, up to you (but it is not trivial, which is the main
669reason I omitted it as an example).</p>
586 </dd> 670 </dd>
587 </dl> 671 </dl>
588 </p> 672 </p>
589 </dd> 673 </dd>
590 <dt>ev_periodic_again (loop, ev_periodic *)</dt> 674 <dt>ev_periodic_again (loop, ev_periodic *)</dt>
… …
595program when the crontabs have changed).</p> 679program when the crontabs have changed).</p>
596 </dd> 680 </dd>
597</dl> 681</dl>
598 682
599</div> 683</div>
600<h2 id="ev_signal_signal_me_when_a_signal_ge">ev_signal - signal me when a signal gets signalled</h2> 684<h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</h2>
601<div id="ev_signal_signal_me_when_a_signal_ge-2"> 685<div id="code_ev_signal_code_signal_me_when_a-2">
602<p>Signal watchers will trigger an event when the process receives a specific 686<p>Signal watchers will trigger an event when the process receives a specific
603signal one or more times. Even though signals are very asynchronous, libev 687signal one or more times. Even though signals are very asynchronous, libev
604will try it's best to deliver signals synchronously, i.e. as part of the 688will try it's best to deliver signals synchronously, i.e. as part of the
605normal event processing, like any other event.</p> 689normal event processing, like any other event.</p>
606<p>You cna configure as many watchers as you like per signal. Only when the 690<p>You can configure as many watchers as you like per signal. Only when the
607first watcher gets started will libev actually register a signal watcher 691first watcher gets started will libev actually register a signal watcher
608with the kernel (thus it coexists with your own signal handlers as long 692with the kernel (thus it coexists with your own signal handlers as long
609as you don't register any with libev). Similarly, when the last signal 693as you don't register any with libev). Similarly, when the last signal
610watcher for a signal is stopped libev will reset the signal handler to 694watcher for a signal is stopped libev will reset the signal handler to
611SIG_DFL (regardless of what it was set to before).</p> 695SIG_DFL (regardless of what it was set to before).</p>
… …
617of the <code>SIGxxx</code> constants).</p> 701of the <code>SIGxxx</code> constants).</p>
618 </dd> 702 </dd>
619</dl> 703</dl>
620 704
621</div> 705</div>
622<h2 id="ev_child_wait_for_pid_status_changes">ev_child - wait for pid status changes</h2> 706<h2 id="code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</h2>
623<div id="ev_child_wait_for_pid_status_changes-2"> 707<div id="code_ev_child_code_wait_for_pid_stat-2">
624<p>Child watchers trigger when your process receives a SIGCHLD in response to 708<p>Child watchers trigger when your process receives a SIGCHLD in response to
625some child status changes (most typically when a child of yours dies).</p> 709some child status changes (most typically when a child of yours dies).</p>
626<dl> 710<dl>
627 <dt>ev_child_init (ev_child *, callback, int pid)</dt> 711 <dt>ev_child_init (ev_child *, callback, int pid)</dt>
628 <dt>ev_child_set (ev_child *, int pid)</dt> 712 <dt>ev_child_set (ev_child *, int pid)</dt>
629 <dd> 713 <dd>
630 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or 714 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or
631<i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look 715<i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look
632at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see 716at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see
633the status word (use the macros from <code>sys/wait.h</code>). The <code>rpid</code> member 717the status word (use the macros from <code>sys/wait.h</code> and see your systems
718<code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the
634contains the pid of the process causing the status change.</p> 719process causing the status change.</p>
635 </dd> 720 </dd>
636</dl> 721</dl>
637 722
638</div> 723</div>
639<h2 id="ev_idle_when_you_ve_got_nothing_bett">ev_idle - when you've got nothing better to do</h2> 724<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</h2>
640<div id="ev_idle_when_you_ve_got_nothing_bett-2"> 725<div id="code_ev_idle_code_when_you_ve_got_no-2">
641<p>Idle watchers trigger events when there are no other I/O or timer (or 726<p>Idle watchers trigger events when there are no other events are pending
642periodic) events pending. That is, as long as your process is busy 727(prepare, check and other idle watchers do not count). That is, as long
643handling sockets or timeouts it will not be called. But when your process 728as your process is busy handling sockets or timeouts (or even signals,
644is idle all idle watchers are being called again and again - until 729imagine) it will not be triggered. But when your process is idle all idle
730watchers are being called again and again, once per event loop iteration -
645stopped, that is, or your process receives more events.</p> 731until stopped, that is, or your process receives more events and becomes
732busy.</p>
646<p>The most noteworthy effect is that as long as any idle watchers are 733<p>The most noteworthy effect is that as long as any idle watchers are
647active, the process will not block when waiting for new events.</p> 734active, the process will not block when waiting for new events.</p>
648<p>Apart from keeping your process non-blocking (which is a useful 735<p>Apart from keeping your process non-blocking (which is a useful
649effect on its own sometimes), idle watchers are a good place to do 736effect on its own sometimes), idle watchers are a good place to do
650&quot;pseudo-background processing&quot;, or delay processing stuff to after the 737&quot;pseudo-background processing&quot;, or delay processing stuff to after the
… …
657believe me.</p> 744believe me.</p>
658 </dd> 745 </dd>
659</dl> 746</dl>
660 747
661</div> 748</div>
662<h2 id="prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</h2> 749<h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2>
663<div id="prepare_and_check_your_hooks_into_th-2"> 750<div id="code_ev_prepare_code_and_code_ev_che-2">
664<p>Prepare and check watchers usually (but not always) are used in 751<p>Prepare and check watchers are usually (but not always) used in tandem:
665tandom. Prepare watchers get invoked before the process blocks and check 752prepare watchers get invoked before the process blocks and check watchers
666watchers afterwards.</p> 753afterwards.</p>
667<p>Their main purpose is to integrate other event mechanisms into libev. This 754<p>Their main purpose is to integrate other event mechanisms into libev. This
668could be used, for example, to track variable changes, implement your own 755could be used, for example, to track variable changes, implement your own
669watchers, integrate net-snmp or a coroutine library and lots more.</p> 756watchers, integrate net-snmp or a coroutine library and lots more.</p>
670<p>This is done by examining in each prepare call which file descriptors need 757<p>This is done by examining in each prepare call which file descriptors need
671to be watched by the other library, registering ev_io watchers for them 758to be watched by the other library, registering <code>ev_io</code> watchers for
672and starting an ev_timer watcher for any timeouts (many libraries provide 759them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries
673just this functionality). Then, in the check watcher you check for any 760provide just this functionality). Then, in the check watcher you check for
674events that occured (by making your callbacks set soem flags for example) 761any events that occured (by checking the pending status of all watchers
675and call back into the library.</p> 762and stopping them) and call back into the library. The I/O and timer
763callbacks will never actually be called (but must be valid nevertheless,
764because you never know, you know?).</p>
676<p>As another example, the perl Coro module uses these hooks to integrate 765<p>As another example, the Perl Coro module uses these hooks to integrate
677coroutines into libev programs, by yielding to other active coroutines 766coroutines into libev programs, by yielding to other active coroutines
678during each prepare and only letting the process block if no coroutines 767during each prepare and only letting the process block if no coroutines
679are ready to run.</p> 768are ready to run (it's actually more complicated: it only runs coroutines
769with priority higher than or equal to the event loop and one coroutine
770of lower priority, but only once, using idle watchers to keep the event
771loop from blocking if lower-priority coroutines are active, thus mapping
772low-priority coroutines to idle/background tasks).</p>
680<dl> 773<dl>
681 <dt>ev_prepare_init (ev_prepare *, callback)</dt> 774 <dt>ev_prepare_init (ev_prepare *, callback)</dt>
682 <dt>ev_check_init (ev_check *, callback)</dt> 775 <dt>ev_check_init (ev_check *, callback)</dt>
683 <dd> 776 <dd>
684 <p>Initialises and configures the prepare or check watcher - they have no 777 <p>Initialises and configures the prepare or check watcher - they have no
685parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> 778parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code>
686macros, but using them is utterly, utterly pointless.</p> 779macros, but using them is utterly, utterly and completely pointless.</p>
687 </dd> 780 </dd>
688</dl> 781</dl>
689 782
690</div> 783</div>
691<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 784<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
692<div id="OTHER_FUNCTIONS_CONTENT"> 785<div id="OTHER_FUNCTIONS_CONTENT">
693<p>There are some other fucntions of possible interest. Described. Here. Now.</p> 786<p>There are some other functions of possible interest. Described. Here. Now.</p>
694<dl> 787<dl>
695 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> 788 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt>
696 <dd> 789 <dd>
697 <p>This function combines a simple timer and an I/O watcher, calls your 790 <p>This function combines a simple timer and an I/O watcher, calls your
698callback on whichever event happens first and automatically stop both 791callback on whichever event happens first and automatically stop both
699watchers. This is useful if you want to wait for a single event on an fd 792watchers. This is useful if you want to wait for a single event on an fd
700or timeout without havign to allocate/configure/start/stop/free one or 793or timeout without having to allocate/configure/start/stop/free one or
701more watchers yourself.</p> 794more watchers yourself.</p>
702 <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events is 795 <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events
703ignored. Otherwise, an ev_io watcher for the given <code>fd</code> and <code>events</code> set 796is being ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and
704will be craeted and started.</p> 797<code>events</code> set will be craeted and started.</p>
705 <p>If <code>timeout</code> is less than 0, then no timeout watcher will be 798 <p>If <code>timeout</code> is less than 0, then no timeout watcher will be
706started. Otherwise an ev_timer watcher with after = <code>timeout</code> (and repeat 799started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and
707= 0) will be started.</p> 800repeat = 0) will be started. While <code>0</code> is a valid timeout, it is of
801dubious value.</p>
708 <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and 802 <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and gets
709gets passed an events set (normally a combination of EV_ERROR, EV_READ, 803passed an <code>revents</code> set like normal event callbacks (a combination of
710EV_WRITE or EV_TIMEOUT) and the <code>arg</code> value passed to <code>ev_once</code>:</p> 804<code>EV_ERROR</code>, <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code>
805value passed to <code>ev_once</code>:</p>
711<pre> static void stdin_ready (int revents, void *arg) 806<pre> static void stdin_ready (int revents, void *arg)
712 { 807 {
713 if (revents &amp; EV_TIMEOUT) 808 if (revents &amp; EV_TIMEOUT)
714 /* doh, nothing entered */ 809 /* doh, nothing entered */;
715 else if (revents &amp; EV_READ) 810 else if (revents &amp; EV_READ)
716 /* stdin might have data for us, joy! */ 811 /* stdin might have data for us, joy! */;
717 } 812 }
718 813
719 ev_once (STDIN_FILENO, EV_READm 10., stdin_ready, 0); 814 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
720 815
721</pre> 816</pre>
722 </dd> 817 </dd>
723 <dt>ev_feed_event (loop, watcher, int events)</dt> 818 <dt>ev_feed_event (loop, watcher, int events)</dt>
724 <dd> 819 <dd>
725 <p>Feeds the given event set into the event loop, as if the specified event 820 <p>Feeds the given event set into the event loop, as if the specified event
726has happened for the specified watcher (which must be a pointer to an 821had happened for the specified watcher (which must be a pointer to an
727initialised but not necessarily active event watcher).</p> 822initialised but not necessarily started event watcher).</p>
728 </dd> 823 </dd>
729 <dt>ev_feed_fd_event (loop, int fd, int revents)</dt> 824 <dt>ev_feed_fd_event (loop, int fd, int revents)</dt>
730 <dd> 825 <dd>
731 <p>Feed an event on the given fd, as if a file descriptor backend detected it.</p> 826 <p>Feed an event on the given fd, as if a file descriptor backend detected
827the given events it.</p>
732 </dd> 828 </dd>
733 <dt>ev_feed_signal_event (loop, int signum)</dt> 829 <dt>ev_feed_signal_event (loop, int signum)</dt>
734 <dd> 830 <dd>
735 <p>Feed an event as if the given signal occured (loop must be the default loop!).</p> 831 <p>Feed an event as if the given signal occured (loop must be the default loop!).</p>
736 </dd> 832 </dd>
737</dl> 833</dl>
834
835</div>
836<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1><p><a href="#TOP" class="toplink">Top</a></p>
837<div id="LIBEVENT_EMULATION_CONTENT">
838<p>Libev offers a compatibility emulation layer for libevent. It cannot
839emulate the internals of libevent, so here are some usage hints:</p>
840<dl>
841 <dt>* Use it by including &lt;event.h&gt;, as usual.</dt>
842 <dt>* The following members are fully supported: ev_base, ev_callback,
843ev_arg, ev_fd, ev_res, ev_events.</dt>
844 <dt>* Avoid using ev_flags and the EVLIST_*-macros, while it is
845maintained by libev, it does not work exactly the same way as in libevent (consider
846it a private API).</dt>
847 <dt>* Priorities are not currently supported. Initialising priorities
848will fail and all watchers will have the same priority, even though there
849is an ev_pri field.</dt>
850 <dt>* Other members are not supported.</dt>
851 <dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need
852to use the libev header file and library.</dt>
853</dl>
854
855</div>
856<h1 id="C_SUPPORT">C++ SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p>
857<div id="C_SUPPORT_CONTENT">
858<p>TBD.</p>
738 859
739</div> 860</div>
740<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> 861<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
741<div id="AUTHOR_CONTENT"> 862<div id="AUTHOR_CONTENT">
742<p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p> 863<p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p>

Diff Legend

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