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

Comparing libev/ev.html (file contents):
Revision 1.10 by root, Mon Nov 12 08:32:27 2007 UTC vs.
Revision 1.29 by root, Thu Nov 22 12:28:27 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:32:26 2007" /> 9 <meta name="created" content="Thu Nov 22 13:26:17 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="#code_ev_io_code_is_my_file_descripto"><code>ev_io</code> - 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="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - 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="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - 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="#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="#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="#code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - 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="#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="#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>
… …
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><code>EVMETHOD_SELECT</code> (portable select backend)</dt> 191 <dt><code>EVMETHOD_SELECT</code> (value 1, portable select backend)</dt>
192 <dd>
193 <p>This is your standard select(2) backend. Not <i>completely</i> standard, as
194libev tries to roll its own fd_set with no limits on the number of fds,
195but if that fails, expect a fairly low limit on the number of fds when
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>
198 </dd>
181 <dt><code>EVMETHOD_POLL</code> (poll backend, available everywhere except on windows)</dt> 199 <dt><code>EVMETHOD_POLL</code> (value 2, poll backend, available everywhere except on windows)</dt>
182 <dt><code>EVMETHOD_EPOLL</code> (linux only)</dt> 200 <dd>
183 <dt><code>EVMETHOD_KQUEUE</code> (some bsds only)</dt> 201 <p>And this is your standard poll(2) backend. It's more complicated than
184 <dt><code>EVMETHOD_DEVPOLL</code> (solaris 8 only)</dt> 202select, but handles sparse fds better and has no artificial limit on the
185 <dt><code>EVMETHOD_PORT</code> (solaris 10 only)</dt> 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>
186 <dd> 205 </dd>
187 <p>If one or more of these are ored into the flags value, then only these 206 <dt><code>EVMETHOD_EPOLL</code> (value 4, Linux)</dt>
188backends will be tried (in the reverse order as given here). If one are 207 <dd>
189specified, any backend will do.</p> 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). Since this is a mask, you
243can do stuff like <code>EVMETHOD_ALL &amp; ~EVMETHOD_KQUEUE</code>.</p>
190 </dd> 244 </dd>
191 </dl> 245 </dl>
192 </p> 246 </p>
247 <p>If one or more of these are ored into the flags value, then only these
248backends will be tried (in the reverse order as given here). If none are
249specified, most compiled-in backend will be tried, usually in reverse
250order of their flag values :)</p>
193 </dd> 251 </dd>
194 <dt>struct ev_loop *ev_loop_new (unsigned int flags)</dt> 252 <dt>struct ev_loop *ev_loop_new (unsigned int flags)</dt>
195 <dd> 253 <dd>
196 <p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is 254 <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 255always distinct from the default loop. Unlike the default loop, it cannot
… …
259your process until at least one new event arrives, and will return after 317your process until at least one new event arrives, and will return after
260one iteration of the loop.</p> 318one iteration of the loop.</p>
261 <p>This flags value could be used to implement alternative looping 319 <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 320constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and
263more generic mechanism.</p> 321more generic mechanism.</p>
322 <p>Here are the gory details of what ev_loop does:</p>
323<pre> 1. If there are no active watchers (reference count is zero), return.
324 2. Queue and immediately call all prepare watchers.
325 3. If we have been forked, recreate the kernel state.
326 4. Update the kernel state with all outstanding changes.
327 5. Update the &quot;event loop time&quot;.
328 6. Calculate for how long to block.
329 7. Block the process, waiting for events.
330 8. Update the &quot;event loop time&quot; and do time jump handling.
331 9. Queue all outstanding timers.
332 10. Queue all outstanding periodics.
333 11. If no events are pending now, queue all idle watchers.
334 12. Queue all check watchers.
335 13. Call all queued watchers in reverse order (i.e. check watchers first).
336 14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
337 was used, return, otherwise continue with step #1.
338
339</pre>
264 </dd> 340 </dd>
265 <dt>ev_unloop (loop, how)</dt> 341 <dt>ev_unloop (loop, how)</dt>
266 <dd> 342 <dd>
267 <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it 343 <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 344has 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 345<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> 346<code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p>
271 </dd> 347 </dd>
272 <dt>ev_ref (loop)</dt> 348 <dt>ev_ref (loop)</dt>
273 <dt>ev_unref (loop)</dt> 349 <dt>ev_unref (loop)</dt>
274 <dd> 350 <dd>
… …
322*)</code>), and you can stop watching for events at any time by calling the 398*)</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> 399corresponding 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 400<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 401must not touch the values stored in it. Most specifically you must never
326reinitialise it or call its set method.</p> 402reinitialise it or call its set method.</p>
327<p>You cna check whether an event is active by calling the <code>ev_is_active 403<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 404(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 405callback for it has not been called yet) you can use the <code>ev_is_pending
330(watcher *)</code> macro.</p> 406(watcher *)</code> macro.</p>
331<p>Each and every callback receives the event loop pointer as first, the 407<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 408registered watcher structure as second, and a bitset of received events as
333third argument.</p> 409third argument.</p>
334<p>The rceeived events usually include a single bit per event type received 410<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 411(you can receive multiple events at the same time). The possible bit masks
336are:</p> 412are:</p>
337<dl> 413<dl>
338 <dt><code>EV_READ</code></dt> 414 <dt><code>EV_READ</code></dt>
339 <dt><code>EV_WRITE</code></dt> 415 <dt><code>EV_WRITE</code></dt>
… …
389 465
390</div> 466</div>
391<h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2> 467<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"> 468<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 469<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 470and 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 471to 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 472don'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 473member, you can also &quot;subclass&quot; the watcher type and provide your own
398data:</p> 474data:</p>
399<pre> struct my_io 475<pre> struct my_io
… …
426<div id="WATCHER_TYPES_CONTENT"> 502<div id="WATCHER_TYPES_CONTENT">
427<p>This section describes each watcher in detail, but will not repeat 503<p>This section describes each watcher in detail, but will not repeat
428information given in the last section.</p> 504information given in the last section.</p>
429 505
430</div> 506</div>
431<h2 id="code_ev_io_code_is_my_file_descripto"><code>ev_io</code> - is my file descriptor readable or writable</h2> 507<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="code_ev_io_code_is_my_file_descripto-2"> 508<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 509<p>I/O watchers check whether a file descriptor is readable or writable
434in each iteration of the event loop (This behaviour is called 510in each iteration of the event loop (This behaviour is called
435level-triggering because you keep receiving events as long as the 511level-triggering because you keep receiving events as long as the
436condition persists. Remember you cna stop the watcher if you don't want to 512condition 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> 513act 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 514<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 515fd 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 516descriptors to non-blocking mode is also usually a good idea (but not
441required if you know what you are doing).</p> 517required if you know what you are doing).</p>
442<p>You have to be careful with dup'ed file descriptors, though. Some backends 518<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 519(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 520descriptors correctly if you register interest in two or more fds pointing
445to the same file/socket etc. description.</p> 521to the same underlying file/socket etc. description (that is, they share
522the 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 523<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 524(at the time of this writing, this includes only EVMETHOD_SELECT and
448EVMETHOD_POLL).</p> 525EVMETHOD_POLL).</p>
449<dl> 526<dl>
450 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> 527 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>
… …
460<h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2> 537<h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2>
461<div id="code_ev_timer_code_relative_and_opti-2"> 538<div id="code_ev_timer_code_relative_and_opti-2">
462<p>Timer watchers are simple relative timers that generate an event after a 539<p>Timer watchers are simple relative timers that generate an event after a
463given time, and optionally repeating in regular intervals after that.</p> 540given 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 541<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 542times 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 543time, it will still time out after (roughly) and hour. &quot;Roughly&quot; because
467detecting time jumps is hard, and soem inaccuracies are unavoidable (the 544detecting time jumps is hard, and some inaccuracies are unavoidable (the
468monotonic clock option helps a lot here).</p> 545monotonic clock option helps a lot here).</p>
469<p>The relative timeouts are calculated relative to the <code>ev_now ()</code> 546<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 547time. This is usually the right thing as this timestamp refers to the time
471of the event triggering whatever timeout you are modifying/starting. If 548of the event triggering whatever timeout you are modifying/starting. If
472you suspect event processing to be delayed and you *need* to base the timeout 549you 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> 550on 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.); 551<pre> ev_timer_set (&amp;timer, after + ev_now () - ev_time (), 0.);
475 552
476</pre> 553</pre>
554<p>The callback is guarenteed to be invoked only when its timeout has passed,
555but if multiple timers become ready during the same loop iteration then
556order of execution is undefined.</p>
477<dl> 557<dl>
478 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> 558 <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> 559 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt>
480 <dd> 560 <dd>
481 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is 561 <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 563timer will automatically be configured to trigger again <code>repeat</code> seconds
484later, again, and again, until stopped manually.</p> 564later, again, and again, until stopped manually.</p>
485 <p>The timer itself will do a best-effort at avoiding drift, that is, if you 565 <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 566configure a timer to trigger every 10 seconds, then it will trigger at
487exactly 10 second intervals. If, however, your program cannot keep up with 567exactly 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 568the 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> 569timer will not fire more than once per event loop iteration.</p>
490 </dd> 570 </dd>
491 <dt>ev_timer_again (loop)</dt> 571 <dt>ev_timer_again (loop)</dt>
492 <dd> 572 <dd>
493 <p>This will act as if the timer timed out and restart it again if it is 573 <p>This will act as if the timer timed out and restart it again if it is
… …
505the timer, and again will automatically restart it if need be.</p> 585the timer, and again will automatically restart it if need be.</p>
506 </dd> 586 </dd>
507</dl> 587</dl>
508 588
509</div> 589</div>
510<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron it</h2> 590<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</h2>
511<div id="code_ev_periodic_code_to_cron_or_not-2"> 591<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 592<p>Periodic watchers are also timers of a kind, but they are very versatile
513(and unfortunately a bit complex).</p> 593(and unfortunately a bit complex).</p>
514<p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time) 594<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 595but on wallclock time (absolute time). You can tell a periodic watcher
… …
519take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger 599take 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 600roughly 10 seconds later and of course not if you reset your system time
521again).</p> 601again).</p>
522<p>They can also be used to implement vastly more complex timers, such as 602<p>They can also be used to implement vastly more complex timers, such as
523triggering an event on eahc midnight, local time.</p> 603triggering an event on eahc midnight, local time.</p>
604<p>As with timers, the callback is guarenteed to be invoked only when the
605time (<code>at</code>) has been passed, but if multiple periodic timers become ready
606during the same loop iteration then order of execution is undefined.</p>
524<dl> 607<dl>
525 <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> 608 <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> 609 <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt>
527 <dd> 610 <dd>
528 <p>Lots of arguments, lets sort it out... There are basically three modes of 611 <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> 612operation, and we will explain them from simplest to complex:</p>
530
531
532
533
534 <p> 613 <p>
535 <dl> 614 <dl>
536 <dt>* absolute timer (interval = reschedule_cb = 0)</dt> 615 <dt>* absolute timer (interval = reschedule_cb = 0)</dt>
537 <dd> 616 <dd>
538 <p>In this configuration the watcher triggers an event at the wallclock time 617 <p>In this configuration the watcher triggers an event at the wallclock time
… …
550<pre> ev_periodic_set (&amp;periodic, 0., 3600., 0); 629<pre> ev_periodic_set (&amp;periodic, 0., 3600., 0);
551 630
552</pre> 631</pre>
553 <p>This doesn't mean there will always be 3600 seconds in between triggers, 632 <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 633but 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 634full hour (UTC), or more correctly, when the system time is evenly divisible
556by 3600.</p> 635by 3600.</p>
557 <p>Another way to think about it (for the mathematically inclined) is that 636 <p>Another way to think about it (for the mathematically inclined) is that
558<code>ev_periodic</code> will try to run the callback in this mode at the next possible 637<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> 638time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p>
560 </dd> 639 </dd>
… …
562 <dd> 641 <dd>
563 <p>In this mode the values for <code>interval</code> and <code>at</code> are both being 642 <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 643ignored. Instead, each time the periodic watcher gets scheduled, the
565reschedule callback will be called with the watcher as first, and the 644reschedule callback will be called with the watcher as first, and the
566current time as second argument.</p> 645current time as second argument.</p>
567 <p>NOTE: <i>This callback MUST NOT stop or destroy the periodic or any other 646 <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 647ever, 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> 648return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by
649starting a prepare watcher).</p>
570 <p>Its prototype is c&lt;ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 650 <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
571ev_tstamp now)&gt;, e.g.:</p> 651ev_tstamp now)</code>, e.g.:</p>
572<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 652<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
573 { 653 {
574 return now + 60.; 654 return now + 60.;
575 } 655 }
576 656
577</pre> 657</pre>
578 <p>It must return the next time to trigger, based on the passed time value 658 <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 659(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 660will usually be called just before the callback will be triggered, but
581might be called at other times, too.</p> 661might be called at other times, too.</p>
662 <p>NOTE: <i>This callback must always return a time that is later than the
663passed <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 664 <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 665triggers 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 666next midnight after <code>now</code> and return the timestamp value for this. How
585is, again, up to you (but it is not trivial).</p> 667you do this is, again, up to you (but it is not trivial, which is the main
668reason I omitted it as an example).</p>
586 </dd> 669 </dd>
587 </dl> 670 </dl>
588 </p> 671 </p>
589 </dd> 672 </dd>
590 <dt>ev_periodic_again (loop, ev_periodic *)</dt> 673 <dt>ev_periodic_again (loop, ev_periodic *)</dt>
… …
601<div id="code_ev_signal_code_signal_me_when_a-2"> 684<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 685<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 686signal 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 687will try it's best to deliver signals synchronously, i.e. as part of the
605normal event processing, like any other event.</p> 688normal event processing, like any other event.</p>
606<p>You cna configure as many watchers as you like per signal. Only when the 689<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 690first watcher gets started will libev actually register a signal watcher
608with the kernel (thus it coexists with your own signal handlers as long 691with 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 692as 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 693watcher for a signal is stopped libev will reset the signal handler to
611SIG_DFL (regardless of what it was set to before).</p> 694SIG_DFL (regardless of what it was set to before).</p>
… …
628 <dt>ev_child_set (ev_child *, int pid)</dt> 711 <dt>ev_child_set (ev_child *, int pid)</dt>
629 <dd> 712 <dd>
630 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or 713 <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 714<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 715at 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 716the status word (use the macros from <code>sys/wait.h</code> and see your systems
717<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> 718process causing the status change.</p>
635 </dd> 719 </dd>
636</dl> 720</dl>
637 721
638</div> 722</div>
639<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</h2> 723<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="code_ev_idle_code_when_you_ve_got_no-2"> 724<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 725<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 726(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 727as your process is busy handling sockets or timeouts (or even signals,
644is idle all idle watchers are being called again and again - until 728imagine) it will not be triggered. But when your process is idle all idle
729watchers are being called again and again, once per event loop iteration -
645stopped, that is, or your process receives more events.</p> 730until stopped, that is, or your process receives more events and becomes
731busy.</p>
646<p>The most noteworthy effect is that as long as any idle watchers are 732<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> 733active, the process will not block when waiting for new events.</p>
648<p>Apart from keeping your process non-blocking (which is a useful 734<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 735effect 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 736&quot;pseudo-background processing&quot;, or delay processing stuff to after the
… …
657believe me.</p> 743believe me.</p>
658 </dd> 744 </dd>
659</dl> 745</dl>
660 746
661</div> 747</div>
662<h2 id="prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</h2> 748<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"> 749<div id="code_ev_prepare_code_and_code_ev_che-2">
664<p>Prepare and check watchers usually (but not always) are used in 750<p>Prepare and check watchers are usually (but not always) used in tandem:
665tandom. Prepare watchers get invoked before the process blocks and check 751prepare watchers get invoked before the process blocks and check watchers
666watchers afterwards.</p> 752afterwards.</p>
667<p>Their main purpose is to integrate other event mechanisms into libev. This 753<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 754could be used, for example, to track variable changes, implement your own
669watchers, integrate net-snmp or a coroutine library and lots more.</p> 755watchers, 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 756<p>This is done by examining in each prepare call which file descriptors need
671to be watched by the other library, registering <code>ev_io</code> watchers for them 757to be watched by the other library, registering <code>ev_io</code> watchers for
672and starting an <code>ev_timer</code> watcher for any timeouts (many libraries provide 758them 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 759provide just this functionality). Then, in the check watcher you check for
674events that occured (by making your callbacks set soem flags for example) 760any events that occured (by checking the pending status of all watchers
675and call back into the library.</p> 761and stopping them) and call back into the library. The I/O and timer
762callbacks will never actually be called (but must be valid nevertheless,
763because you never know, you know?).</p>
676<p>As another example, the perl Coro module uses these hooks to integrate 764<p>As another example, the Perl Coro module uses these hooks to integrate
677coroutines into libev programs, by yielding to other active coroutines 765coroutines into libev programs, by yielding to other active coroutines
678during each prepare and only letting the process block if no coroutines 766during each prepare and only letting the process block if no coroutines
679are ready to run.</p> 767are ready to run (it's actually more complicated: it only runs coroutines
768with priority higher than or equal to the event loop and one coroutine
769of lower priority, but only once, using idle watchers to keep the event
770loop from blocking if lower-priority coroutines are active, thus mapping
771low-priority coroutines to idle/background tasks).</p>
680<dl> 772<dl>
681 <dt>ev_prepare_init (ev_prepare *, callback)</dt> 773 <dt>ev_prepare_init (ev_prepare *, callback)</dt>
682 <dt>ev_check_init (ev_check *, callback)</dt> 774 <dt>ev_check_init (ev_check *, callback)</dt>
683 <dd> 775 <dd>
684 <p>Initialises and configures the prepare or check watcher - they have no 776 <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> 777parameters 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> 778macros, but using them is utterly, utterly and completely pointless.</p>
687 </dd> 779 </dd>
688</dl> 780</dl>
689 781
690</div> 782</div>
691<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 783<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
692<div id="OTHER_FUNCTIONS_CONTENT"> 784<div id="OTHER_FUNCTIONS_CONTENT">
693<p>There are some other fucntions of possible interest. Described. Here. Now.</p> 785<p>There are some other functions of possible interest. Described. Here. Now.</p>
694<dl> 786<dl>
695 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> 787 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt>
696 <dd> 788 <dd>
697 <p>This function combines a simple timer and an I/O watcher, calls your 789 <p>This function combines a simple timer and an I/O watcher, calls your
698callback on whichever event happens first and automatically stop both 790callback 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 791watchers. 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 792or timeout without having to allocate/configure/start/stop/free one or
701more watchers yourself.</p> 793more watchers yourself.</p>
702 <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events is 794 <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events
703ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and <code>events</code> set 795is being ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and
704will be craeted and started.</p> 796<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 797 <p>If <code>timeout</code> is less than 0, then no timeout watcher will be
706started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and repeat 798started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and
707= 0) will be started.</p> 799repeat = 0) will be started. While <code>0</code> is a valid timeout, it is of
800dubious value.</p>
708 <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and 801 <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 <code>EV_ERROR</code>, <code>EV_READ</code>, 802passed an <code>revents</code> set like normal event callbacks (a combination of
710<code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code> value passed to <code>ev_once</code>:</p> 803<code>EV_ERROR</code>, <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code>
804value passed to <code>ev_once</code>:</p>
711<pre> static void stdin_ready (int revents, void *arg) 805<pre> static void stdin_ready (int revents, void *arg)
712 { 806 {
713 if (revents &amp; EV_TIMEOUT) 807 if (revents &amp; EV_TIMEOUT)
714 /* doh, nothing entered */ 808 /* doh, nothing entered */;
715 else if (revents &amp; EV_READ) 809 else if (revents &amp; EV_READ)
716 /* stdin might have data for us, joy! */ 810 /* stdin might have data for us, joy! */;
717 } 811 }
718 812
719 ev_once (STDIN_FILENO, EV_READm 10., stdin_ready, 0); 813 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
720 814
721</pre> 815</pre>
722 </dd> 816 </dd>
723 <dt>ev_feed_event (loop, watcher, int events)</dt> 817 <dt>ev_feed_event (loop, watcher, int events)</dt>
724 <dd> 818 <dd>
725 <p>Feeds the given event set into the event loop, as if the specified event 819 <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 820had happened for the specified watcher (which must be a pointer to an
727initialised but not necessarily active event watcher).</p> 821initialised but not necessarily started event watcher).</p>
728 </dd> 822 </dd>
729 <dt>ev_feed_fd_event (loop, int fd, int revents)</dt> 823 <dt>ev_feed_fd_event (loop, int fd, int revents)</dt>
730 <dd> 824 <dd>
731 <p>Feed an event on the given fd, as if a file descriptor backend detected it.</p> 825 <p>Feed an event on the given fd, as if a file descriptor backend detected
826the given events it.</p>
732 </dd> 827 </dd>
733 <dt>ev_feed_signal_event (loop, int signum)</dt> 828 <dt>ev_feed_signal_event (loop, int signum)</dt>
734 <dd> 829 <dd>
735 <p>Feed an event as if the given signal occured (loop must be the default loop!).</p> 830 <p>Feed an event as if the given signal occured (loop must be the default loop!).</p>
736 </dd> 831 </dd>
737</dl> 832</dl>
833
834</div>
835<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1><p><a href="#TOP" class="toplink">Top</a></p>
836<div id="LIBEVENT_EMULATION_CONTENT">
837<p>Libev offers a compatibility emulation layer for libevent. It cannot
838emulate the internals of libevent, so here are some usage hints:</p>
839<dl>
840 <dt>* Use it by including &lt;event.h&gt;, as usual.</dt>
841 <dt>* The following members are fully supported: ev_base, ev_callback,
842ev_arg, ev_fd, ev_res, ev_events.</dt>
843 <dt>* Avoid using ev_flags and the EVLIST_*-macros, while it is
844maintained by libev, it does not work exactly the same way as in libevent (consider
845it a private API).</dt>
846 <dt>* Priorities are not currently supported. Initialising priorities
847will fail and all watchers will have the same priority, even though there
848is an ev_pri field.</dt>
849 <dt>* Other members are not supported.</dt>
850 <dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need
851to use the libev header file and library.</dt>
852</dl>
853
854</div>
855<h1 id="C_SUPPORT">C++ SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p>
856<div id="C_SUPPORT_CONTENT">
857<p>TBD.</p>
738 858
739</div> 859</div>
740<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> 860<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
741<div id="AUTHOR_CONTENT"> 861<div id="AUTHOR_CONTENT">
742<p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p> 862<p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p>

Diff Legend

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