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

Comparing libev/ev.html (file contents):
Revision 1.62 by root, Thu Nov 29 17:28:13 2007 UTC vs.
Revision 1.78 by root, Wed Dec 12 17:55:06 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="Thu Nov 29 18:28:02 2007" /> 9 <meta name="created" content="Wed Dec 12 18:55:04 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 -->
… …
27<ul><li><a href="#GENERIC_WATCHER_FUNCTIONS">GENERIC WATCHER FUNCTIONS</a></li> 27<ul><li><a href="#GENERIC_WATCHER_FUNCTIONS">GENERIC WATCHER FUNCTIONS</a></li>
28<li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li> 28<li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li>
29</ul> 29</ul>
30</li> 30</li>
31<li><a href="#WATCHER_TYPES">WATCHER TYPES</a> 31<li><a href="#WATCHER_TYPES">WATCHER TYPES</a>
32<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> 32<ul><li><a href="#code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable?</a>
33<ul><li><a href="#The_special_problem_of_disappearing_">The special problem of disappearing file descriptors</a></li>
34<li><a href="#Watcher_Specific_Functions">Watcher-Specific Functions</a></li>
35</ul>
36</li>
33<li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally repeating timeouts</a></li> 37<li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally repeating timeouts</a>
38<ul><li><a href="#Watcher_Specific_Functions_and_Data_">Watcher-Specific Functions and Data Members</a></li>
39</ul>
40</li>
34<li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron?</a></li> 41<li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron?</a>
42<ul><li><a href="#Watcher_Specific_Functions_and_Data_-3">Watcher-Specific Functions and Data Members</a></li>
43</ul>
44</li>
35<li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled!</a></li> 45<li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled!</a>
46<ul><li><a href="#Watcher_Specific_Functions_and_Data_-4">Watcher-Specific Functions and Data Members</a></li>
47</ul>
48</li>
36<li><a href="#code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</a></li> 49<li><a href="#code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</a>
50<ul><li><a href="#Watcher_Specific_Functions_and_Data_-5">Watcher-Specific Functions and Data Members</a></li>
51</ul>
52</li>
37<li><a href="#code_ev_stat_code_did_the_file_attri"><code>ev_stat</code> - did the file attributes just change?</a></li> 53<li><a href="#code_ev_stat_code_did_the_file_attri"><code>ev_stat</code> - did the file attributes just change?</a>
54<ul><li><a href="#Watcher_Specific_Functions_and_Data_-6">Watcher-Specific Functions and Data Members</a></li>
55</ul>
56</li>
38<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> 57<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>
58<ul><li><a href="#Watcher_Specific_Functions_and_Data_-7">Watcher-Specific Functions and Data Members</a></li>
59</ul>
60</li>
39<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> 61<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>
62<ul><li><a href="#Watcher_Specific_Functions_and_Data_-8">Watcher-Specific Functions and Data Members</a></li>
63</ul>
64</li>
40<li><a href="#code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough...</a></li> 65<li><a href="#code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough...</a>
66<ul><li><a href="#Watcher_Specific_Functions_and_Data_-9">Watcher-Specific Functions and Data Members</a></li>
67</ul>
68</li>
41<li><a href="#code_ev_fork_code_the_audacity_to_re"><code>ev_fork</code> - the audacity to resume the event loop after a fork</a></li> 69<li><a href="#code_ev_fork_code_the_audacity_to_re"><code>ev_fork</code> - the audacity to resume the event loop after a fork</a></li>
42</ul> 70</ul>
43</li> 71</li>
44<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> 72<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li>
45<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li> 73<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li>
… …
119</pre> 147</pre>
120 148
121</div> 149</div>
122<h1 id="DESCRIPTION">DESCRIPTION</h1> 150<h1 id="DESCRIPTION">DESCRIPTION</h1>
123<div id="DESCRIPTION_CONTENT"> 151<div id="DESCRIPTION_CONTENT">
152<p>The newest version of this document is also available as a html-formatted
153web page you might find easier to navigate when reading it for the first
154time: <a href="http://cvs.schmorp.de/libev/ev.html">http://cvs.schmorp.de/libev/ev.html</a>.</p>
124<p>Libev is an event loop: you register interest in certain events (such as a 155<p>Libev is an event loop: you register interest in certain events (such as a
125file descriptor being readable or a timeout occuring), and it will manage 156file descriptor being readable or a timeout occuring), and it will manage
126these event sources and provide your program with events.</p> 157these event sources and provide your program with events.</p>
127<p>To do this, it must take more or less complete control over your process 158<p>To do this, it must take more or less complete control over your process
128(or thread) by executing the <i>event loop</i> handler, and will then 159(or thread) by executing the <i>event loop</i> handler, and will then
… …
182you actually want to know.</p> 213you actually want to know.</p>
183 </dd> 214 </dd>
184 <dt>int ev_version_major ()</dt> 215 <dt>int ev_version_major ()</dt>
185 <dt>int ev_version_minor ()</dt> 216 <dt>int ev_version_minor ()</dt>
186 <dd> 217 <dd>
187 <p>You can find out the major and minor version numbers of the library 218 <p>You can find out the major and minor ABI version numbers of the library
188you linked against by calling the functions <code>ev_version_major</code> and 219you linked against by calling the functions <code>ev_version_major</code> and
189<code>ev_version_minor</code>. If you want, you can compare against the global 220<code>ev_version_minor</code>. If you want, you can compare against the global
190symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the 221symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the
191version of the library your program was compiled against.</p> 222version of the library your program was compiled against.</p>
223 <p>These version numbers refer to the ABI version of the library, not the
224release version.</p>
192 <p>Usually, it's a good idea to terminate if the major versions mismatch, 225 <p>Usually, it's a good idea to terminate if the major versions mismatch,
193as this indicates an incompatible change. Minor versions are usually 226as this indicates an incompatible change. Minor versions are usually
194compatible to older versions, so a larger minor version alone is usually 227compatible to older versions, so a larger minor version alone is usually
195not a problem.</p> 228not a problem.</p>
196 <p>Example: Make sure we haven't accidentally been linked against the wrong 229 <p>Example: Make sure we haven't accidentally been linked against the wrong
197version.</p> 230version.</p>
198<pre> assert ((&quot;libev version mismatch&quot;, 231<pre> assert ((&quot;libev version mismatch&quot;,
… …
333 <p>Instead of calling <code>ev_default_fork</code> or <code>ev_loop_fork</code> manually after 366 <p>Instead of calling <code>ev_default_fork</code> or <code>ev_loop_fork</code> manually after
334a fork, you can also make libev check for a fork in each iteration by 367a fork, you can also make libev check for a fork in each iteration by
335enabling this flag.</p> 368enabling this flag.</p>
336 <p>This works by calling <code>getpid ()</code> on every iteration of the loop, 369 <p>This works by calling <code>getpid ()</code> on every iteration of the loop,
337and thus this might slow down your event loop if you do a lot of loop 370and thus this might slow down your event loop if you do a lot of loop
338iterations and little real work, but is usually not noticable (on my 371iterations and little real work, but is usually not noticeable (on my
339Linux system for example, <code>getpid</code> is actually a simple 5-insn sequence 372Linux system for example, <code>getpid</code> is actually a simple 5-insn sequence
340without a syscall and thus <i>very</i> fast, but my Linux system also has 373without a syscall and thus <i>very</i> fast, but my Linux system also has
341<code>pthread_atfork</code> which is even faster).</p> 374<code>pthread_atfork</code> which is even faster).</p>
342 <p>The big advantage of this flag is that you can forget about fork (and 375 <p>The big advantage of this flag is that you can forget about fork (and
343forget about forgetting to tell libev about forking) when you use this 376forget about forgetting to tell libev about forking) when you use this
… …
480 <dt>ev_loop_fork (loop)</dt> 513 <dt>ev_loop_fork (loop)</dt>
481 <dd> 514 <dd>
482 <p>Like <code>ev_default_fork</code>, but acts on an event loop created by 515 <p>Like <code>ev_default_fork</code>, but acts on an event loop created by
483<code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop 516<code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop
484after fork, and how you do this is entirely your own problem.</p> 517after fork, and how you do this is entirely your own problem.</p>
518 </dd>
519 <dt>unsigned int ev_loop_count (loop)</dt>
520 <dd>
521 <p>Returns the count of loop iterations for the loop, which is identical to
522the number of times libev did poll for new events. It starts at <code>0</code> and
523happily wraps around with enough iterations.</p>
524 <p>This value can sometimes be useful as a generation counter of sorts (it
525&quot;ticks&quot; the number of loop iterations), as it roughly corresponds with
526<code>ev_prepare</code> and <code>ev_check</code> calls.</p>
485 </dd> 527 </dd>
486 <dt>unsigned int ev_backend (loop)</dt> 528 <dt>unsigned int ev_backend (loop)</dt>
487 <dd> 529 <dd>
488 <p>Returns one of the <code>EVBACKEND_*</code> flags indicating the event backend in 530 <p>Returns one of the <code>EVBACKEND_*</code> flags indicating the event backend in
489use.</p> 531use.</p>
… …
517one iteration of the loop. This is useful if you are waiting for some 559one iteration of the loop. This is useful if you are waiting for some
518external event in conjunction with something not expressible using other 560external event in conjunction with something not expressible using other
519libev watchers. However, a pair of <code>ev_prepare</code>/<code>ev_check</code> watchers is 561libev watchers. However, a pair of <code>ev_prepare</code>/<code>ev_check</code> watchers is
520usually a better approach for this kind of thing.</p> 562usually a better approach for this kind of thing.</p>
521 <p>Here are the gory details of what <code>ev_loop</code> does:</p> 563 <p>Here are the gory details of what <code>ev_loop</code> does:</p>
564<pre> - Before the first iteration, call any pending watchers.
522<pre> * If there are no active watchers (reference count is zero), return. 565 * If there are no active watchers (reference count is zero), return.
523 - Queue prepare watchers and then call all outstanding watchers. 566 - Queue all prepare watchers and then call all outstanding watchers.
524 - If we have been forked, recreate the kernel state. 567 - If we have been forked, recreate the kernel state.
525 - Update the kernel state with all outstanding changes. 568 - Update the kernel state with all outstanding changes.
526 - Update the &quot;event loop time&quot;. 569 - Update the &quot;event loop time&quot;.
527 - Calculate for how long to block. 570 - Calculate for how long to block.
528 - Block the process, waiting for any events. 571 - Block the process, waiting for any events.
… …
757 <dt>bool ev_is_pending (ev_TYPE *watcher)</dt> 800 <dt>bool ev_is_pending (ev_TYPE *watcher)</dt>
758 <dd> 801 <dd>
759 <p>Returns a true value iff the watcher is pending, (i.e. it has outstanding 802 <p>Returns a true value iff the watcher is pending, (i.e. it has outstanding
760events but its callback has not yet been invoked). As long as a watcher 803events but its callback has not yet been invoked). As long as a watcher
761is pending (but not active) you must not call an init function on it (but 804is pending (but not active) you must not call an init function on it (but
762<code>ev_TYPE_set</code> is safe) and you must make sure the watcher is available to 805<code>ev_TYPE_set</code> is safe), you must not change its priority, and you must
763libev (e.g. you cnanot <code>free ()</code> it).</p> 806make sure the watcher is available to libev (e.g. you cannot <code>free ()</code>
807it).</p>
764 </dd> 808 </dd>
765 <dt>callback ev_cb (ev_TYPE *watcher)</dt> 809 <dt>callback ev_cb (ev_TYPE *watcher)</dt>
766 <dd> 810 <dd>
767 <p>Returns the callback currently set on the watcher.</p> 811 <p>Returns the callback currently set on the watcher.</p>
768 </dd> 812 </dd>
769 <dt>ev_cb_set (ev_TYPE *watcher, callback)</dt> 813 <dt>ev_cb_set (ev_TYPE *watcher, callback)</dt>
770 <dd> 814 <dd>
771 <p>Change the callback. You can change the callback at virtually any time 815 <p>Change the callback. You can change the callback at virtually any time
772(modulo threads).</p> 816(modulo threads).</p>
817 </dd>
818 <dt>ev_set_priority (ev_TYPE *watcher, priority)</dt>
819 <dt>int ev_priority (ev_TYPE *watcher)</dt>
820 <dd>
821 <p>Set and query the priority of the watcher. The priority is a small
822integer between <code>EV_MAXPRI</code> (default: <code>2</code>) and <code>EV_MINPRI</code>
823(default: <code>-2</code>). Pending watchers with higher priority will be invoked
824before watchers with lower priority, but priority will not keep watchers
825from being executed (except for <code>ev_idle</code> watchers).</p>
826 <p>This means that priorities are <i>only</i> used for ordering callback
827invocation after new events have been received. This is useful, for
828example, to reduce latency after idling, or more often, to bind two
829watchers on the same event and make sure one is called first.</p>
830 <p>If you need to suppress invocation when higher priority events are pending
831you need to look at <code>ev_idle</code> watchers, which provide this functionality.</p>
832 <p>You <i>must not</i> change the priority of a watcher as long as it is active or
833pending.</p>
834 <p>The default priority used by watchers when no priority has been set is
835always <code>0</code>, which is supposed to not be too high and not be too low :).</p>
836 <p>Setting a priority outside the range of <code>EV_MINPRI</code> to <code>EV_MAXPRI</code> is
837fine, as long as you do not mind that the priority value you query might
838or might not have been adjusted to be within valid range.</p>
839 </dd>
840 <dt>ev_invoke (loop, ev_TYPE *watcher, int revents)</dt>
841 <dd>
842 <p>Invoke the <code>watcher</code> with the given <code>loop</code> and <code>revents</code>. Neither
843<code>loop</code> nor <code>revents</code> need to be valid as long as the watcher callback
844can deal with that fact.</p>
845 </dd>
846 <dt>int ev_clear_pending (loop, ev_TYPE *watcher)</dt>
847 <dd>
848 <p>If the watcher is pending, this function returns clears its pending status
849and returns its <code>revents</code> bitset (as if its callback was invoked). If the
850watcher isn't pending it does nothing and returns <code>0</code>.</p>
773 </dd> 851 </dd>
774</dl> 852</dl>
775 853
776 854
777 855
… …
888this situation even with a relatively standard program structure. Thus 966this situation even with a relatively standard program structure. Thus
889it is best to always use non-blocking I/O: An extra <code>read</code>(2) returning 967it is best to always use non-blocking I/O: An extra <code>read</code>(2) returning
890<code>EAGAIN</code> is far preferable to a program hanging until some data arrives.</p> 968<code>EAGAIN</code> is far preferable to a program hanging until some data arrives.</p>
891<p>If you cannot run the fd in non-blocking mode (for example you should not 969<p>If you cannot run the fd in non-blocking mode (for example you should not
892play around with an Xlib connection), then you have to seperately re-test 970play around with an Xlib connection), then you have to seperately re-test
893wether a file descriptor is really ready with a known-to-be good interface 971whether a file descriptor is really ready with a known-to-be good interface
894such as poll (fortunately in our Xlib example, Xlib already does this on 972such as poll (fortunately in our Xlib example, Xlib already does this on
895its own, so its quite safe to use).</p> 973its own, so its quite safe to use).</p>
974
975</div>
976<h3 id="The_special_problem_of_disappearing_">The special problem of disappearing file descriptors</h3>
977<div id="The_special_problem_of_disappearing_-2">
978<p>Some backends (e.g kqueue, epoll) need to be told about closing a file
979descriptor (either by calling <code>close</code> explicitly or by any other means,
980such as <code>dup</code>). The reason is that you register interest in some file
981descriptor, but when it goes away, the operating system will silently drop
982this interest. If another file descriptor with the same number then is
983registered with libev, there is no efficient way to see that this is, in
984fact, a different file descriptor.</p>
985<p>To avoid having to explicitly tell libev about such cases, libev follows
986the following policy: Each time <code>ev_io_set</code> is being called, libev
987will assume that this is potentially a new file descriptor, otherwise
988it is assumed that the file descriptor stays the same. That means that
989you <i>have</i> to call <code>ev_io_set</code> (or <code>ev_io_init</code>) when you change the
990descriptor even if the file descriptor number itself did not change.</p>
991<p>This is how one would do it normally anyway, the important point is that
992the libev application should not optimise around libev but should leave
993optimisations to libev.</p>
994
995
996
997
998
999</div>
1000<h3 id="Watcher_Specific_Functions">Watcher-Specific Functions</h3>
1001<div id="Watcher_Specific_Functions_CONTENT">
896<dl> 1002<dl>
897 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> 1003 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>
898 <dt>ev_io_set (ev_io *, int fd, int events)</dt> 1004 <dt>ev_io_set (ev_io *, int fd, int events)</dt>
899 <dd> 1005 <dd>
900 <p>Configures an <code>ev_io</code> watcher. The <code>fd</code> is the file descriptor to 1006 <p>Configures an <code>ev_io</code> watcher. The <code>fd</code> is the file descriptor to
… …
951 1057
952</pre> 1058</pre>
953<p>The callback is guarenteed to be invoked only when its timeout has passed, 1059<p>The callback is guarenteed to be invoked only when its timeout has passed,
954but if multiple timers become ready during the same loop iteration then 1060but if multiple timers become ready during the same loop iteration then
955order of execution is undefined.</p> 1061order of execution is undefined.</p>
1062
1063</div>
1064<h3 id="Watcher_Specific_Functions_and_Data_">Watcher-Specific Functions and Data Members</h3>
1065<div id="Watcher_Specific_Functions_and_Data_-2">
956<dl> 1066<dl>
957 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> 1067 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt>
958 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> 1068 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt>
959 <dd> 1069 <dd>
960 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is 1070 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is
… …
1049but on wallclock time (absolute time). You can tell a periodic watcher 1159but on wallclock time (absolute time). You can tell a periodic watcher
1050to trigger &quot;at&quot; some specific point in time. For example, if you tell a 1160to trigger &quot;at&quot; some specific point in time. For example, if you tell a
1051periodic watcher to trigger in 10 seconds (by specifiying e.g. <code>ev_now () 1161periodic watcher to trigger in 10 seconds (by specifiying e.g. <code>ev_now ()
1052+ 10.</code>) and then reset your system clock to the last year, then it will 1162+ 10.</code>) and then reset your system clock to the last year, then it will
1053take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger 1163take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger
1054roughly 10 seconds later and of course not if you reset your system time 1164roughly 10 seconds later).</p>
1055again).</p>
1056<p>They can also be used to implement vastly more complex timers, such as 1165<p>They can also be used to implement vastly more complex timers, such as
1057triggering an event on eahc midnight, local time.</p> 1166triggering an event on each midnight, local time or other, complicated,
1167rules.</p>
1058<p>As with timers, the callback is guarenteed to be invoked only when the 1168<p>As with timers, the callback is guarenteed to be invoked only when the
1059time (<code>at</code>) has been passed, but if multiple periodic timers become ready 1169time (<code>at</code>) has been passed, but if multiple periodic timers become ready
1060during the same loop iteration then order of execution is undefined.</p> 1170during the same loop iteration then order of execution is undefined.</p>
1171
1172</div>
1173<h3 id="Watcher_Specific_Functions_and_Data_-3">Watcher-Specific Functions and Data Members</h3>
1174<div id="Watcher_Specific_Functions_and_Data_-2">
1061<dl> 1175<dl>
1062 <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> 1176 <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt>
1063 <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt> 1177 <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt>
1064 <dd> 1178 <dd>
1065 <p>Lots of arguments, lets sort it out... There are basically three modes of 1179 <p>Lots of arguments, lets sort it out... There are basically three modes of
1066operation, and we will explain them from simplest to complex:</p> 1180operation, and we will explain them from simplest to complex:</p>
1067 <p> 1181 <p>
1068 <dl> 1182 <dl>
1069 <dt>* absolute timer (interval = reschedule_cb = 0)</dt> 1183 <dt>* absolute timer (at = time, interval = reschedule_cb = 0)</dt>
1070 <dd> 1184 <dd>
1071 <p>In this configuration the watcher triggers an event at the wallclock time 1185 <p>In this configuration the watcher triggers an event at the wallclock time
1072<code>at</code> and doesn't repeat. It will not adjust when a time jump occurs, 1186<code>at</code> and doesn't repeat. It will not adjust when a time jump occurs,
1073that is, if it is to be run at January 1st 2011 then it will run when the 1187that is, if it is to be run at January 1st 2011 then it will run when the
1074system time reaches or surpasses this time.</p> 1188system time reaches or surpasses this time.</p>
1075 </dd> 1189 </dd>
1076 <dt>* non-repeating interval timer (interval &gt; 0, reschedule_cb = 0)</dt> 1190 <dt>* non-repeating interval timer (at = offset, interval &gt; 0, reschedule_cb = 0)</dt>
1077 <dd> 1191 <dd>
1078 <p>In this mode the watcher will always be scheduled to time out at the next 1192 <p>In this mode the watcher will always be scheduled to time out at the next
1079<code>at + N * interval</code> time (for some integer N) and then repeat, regardless 1193<code>at + N * interval</code> time (for some integer N, which can also be negative)
1080of any time jumps.</p> 1194and then repeat, regardless of any time jumps.</p>
1081 <p>This can be used to create timers that do not drift with respect to system 1195 <p>This can be used to create timers that do not drift with respect to system
1082time:</p> 1196time:</p>
1083<pre> ev_periodic_set (&amp;periodic, 0., 3600., 0); 1197<pre> ev_periodic_set (&amp;periodic, 0., 3600., 0);
1084 1198
1085</pre> 1199</pre>
… …
1088full hour (UTC), or more correctly, when the system time is evenly divisible 1202full hour (UTC), or more correctly, when the system time is evenly divisible
1089by 3600.</p> 1203by 3600.</p>
1090 <p>Another way to think about it (for the mathematically inclined) is that 1204 <p>Another way to think about it (for the mathematically inclined) is that
1091<code>ev_periodic</code> will try to run the callback in this mode at the next possible 1205<code>ev_periodic</code> will try to run the callback in this mode at the next possible
1092time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p> 1206time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p>
1207 <p>For numerical stability it is preferable that the <code>at</code> value is near
1208<code>ev_now ()</code> (the current time), but there is no range requirement for
1209this value.</p>
1093 </dd> 1210 </dd>
1094 <dt>* manual reschedule mode (reschedule_cb = callback)</dt> 1211 <dt>* manual reschedule mode (at and interval ignored, reschedule_cb = callback)</dt>
1095 <dd> 1212 <dd>
1096 <p>In this mode the values for <code>interval</code> and <code>at</code> are both being 1213 <p>In this mode the values for <code>interval</code> and <code>at</code> are both being
1097ignored. Instead, each time the periodic watcher gets scheduled, the 1214ignored. Instead, each time the periodic watcher gets scheduled, the
1098reschedule callback will be called with the watcher as first, and the 1215reschedule callback will be called with the watcher as first, and the
1099current time as second argument.</p> 1216current time as second argument.</p>
1100 <p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher, 1217 <p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher,
1101ever, or make any event loop modifications</i>. If you need to stop it, 1218ever, or make any event loop modifications</i>. If you need to stop it,
1102return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by 1219return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by
1103starting a prepare watcher).</p> 1220starting an <code>ev_prepare</code> watcher, which is legal).</p>
1104 <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 1221 <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
1105ev_tstamp now)</code>, e.g.:</p> 1222ev_tstamp now)</code>, e.g.:</p>
1106<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 1223<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
1107 { 1224 {
1108 return now + 60.; 1225 return now + 60.;
… …
1128 <dd> 1245 <dd>
1129 <p>Simply stops and restarts the periodic watcher again. This is only useful 1246 <p>Simply stops and restarts the periodic watcher again. This is only useful
1130when you changed some parameters or the reschedule callback would return 1247when you changed some parameters or the reschedule callback would return
1131a different time than the last time it was called (e.g. in a crond like 1248a different time than the last time it was called (e.g. in a crond like
1132program when the crontabs have changed).</p> 1249program when the crontabs have changed).</p>
1250 </dd>
1251 <dt>ev_tstamp offset [read-write]</dt>
1252 <dd>
1253 <p>When repeating, this contains the offset value, otherwise this is the
1254absolute point in time (the <code>at</code> value passed to <code>ev_periodic_set</code>).</p>
1255 <p>Can be modified any time, but changes only take effect when the periodic
1256timer fires or <code>ev_periodic_again</code> is being called.</p>
1133 </dd> 1257 </dd>
1134 <dt>ev_tstamp interval [read-write]</dt> 1258 <dt>ev_tstamp interval [read-write]</dt>
1135 <dd> 1259 <dd>
1136 <p>The current interval value. Can be modified any time, but changes only 1260 <p>The current interval value. Can be modified any time, but changes only
1137take effect when the periodic timer fires or <code>ev_periodic_again</code> is being 1261take effect when the periodic timer fires or <code>ev_periodic_again</code> is being
… …
1192first watcher gets started will libev actually register a signal watcher 1316first watcher gets started will libev actually register a signal watcher
1193with the kernel (thus it coexists with your own signal handlers as long 1317with the kernel (thus it coexists with your own signal handlers as long
1194as you don't register any with libev). Similarly, when the last signal 1318as you don't register any with libev). Similarly, when the last signal
1195watcher for a signal is stopped libev will reset the signal handler to 1319watcher for a signal is stopped libev will reset the signal handler to
1196SIG_DFL (regardless of what it was set to before).</p> 1320SIG_DFL (regardless of what it was set to before).</p>
1321
1322</div>
1323<h3 id="Watcher_Specific_Functions_and_Data_-4">Watcher-Specific Functions and Data Members</h3>
1324<div id="Watcher_Specific_Functions_and_Data_-2-2">
1197<dl> 1325<dl>
1198 <dt>ev_signal_init (ev_signal *, callback, int signum)</dt> 1326 <dt>ev_signal_init (ev_signal *, callback, int signum)</dt>
1199 <dt>ev_signal_set (ev_signal *, int signum)</dt> 1327 <dt>ev_signal_set (ev_signal *, int signum)</dt>
1200 <dd> 1328 <dd>
1201 <p>Configures the watcher to trigger on the given signal number (usually one 1329 <p>Configures the watcher to trigger on the given signal number (usually one
… …
1214</div> 1342</div>
1215<h2 id="code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</h2> 1343<h2 id="code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</h2>
1216<div id="code_ev_child_code_watch_out_for_pro-2"> 1344<div id="code_ev_child_code_watch_out_for_pro-2">
1217<p>Child watchers trigger when your process receives a SIGCHLD in response to 1345<p>Child watchers trigger when your process receives a SIGCHLD in response to
1218some child status changes (most typically when a child of yours dies).</p> 1346some child status changes (most typically when a child of yours dies).</p>
1347
1348</div>
1349<h3 id="Watcher_Specific_Functions_and_Data_-5">Watcher-Specific Functions and Data Members</h3>
1350<div id="Watcher_Specific_Functions_and_Data_-2-3">
1219<dl> 1351<dl>
1220 <dt>ev_child_init (ev_child *, callback, int pid)</dt> 1352 <dt>ev_child_init (ev_child *, callback, int pid)</dt>
1221 <dt>ev_child_set (ev_child *, int pid)</dt> 1353 <dt>ev_child_set (ev_child *, int pid)</dt>
1222 <dd> 1354 <dd>
1223 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or 1355 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or
… …
1286reader). Inotify will be used to give hints only and should not change the 1418reader). Inotify will be used to give hints only and should not change the
1287semantics of <code>ev_stat</code> watchers, which means that libev sometimes needs 1419semantics of <code>ev_stat</code> watchers, which means that libev sometimes needs
1288to fall back to regular polling again even with inotify, but changes are 1420to fall back to regular polling again even with inotify, but changes are
1289usually detected immediately, and if the file exists there will be no 1421usually detected immediately, and if the file exists there will be no
1290polling.</p> 1422polling.</p>
1423
1424</div>
1425<h3 id="Watcher_Specific_Functions_and_Data_-6">Watcher-Specific Functions and Data Members</h3>
1426<div id="Watcher_Specific_Functions_and_Data_-2-4">
1291<dl> 1427<dl>
1292 <dt>ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)</dt> 1428 <dt>ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)</dt>
1293 <dt>ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)</dt> 1429 <dt>ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)</dt>
1294 <dd> 1430 <dd>
1295 <p>Configures the watcher to wait for status changes of the given 1431 <p>Configures the watcher to wait for status changes of the given
… …
1358</pre> 1494</pre>
1359 1495
1360</div> 1496</div>
1361<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</h2> 1497<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</h2>
1362<div id="code_ev_idle_code_when_you_ve_got_no-2"> 1498<div id="code_ev_idle_code_when_you_ve_got_no-2">
1363<p>Idle watchers trigger events when there are no other events are pending 1499<p>Idle watchers trigger events when no other events of the same or higher
1364(prepare, check and other idle watchers do not count). That is, as long 1500priority are pending (prepare, check and other idle watchers do not
1365as your process is busy handling sockets or timeouts (or even signals, 1501count).</p>
1366imagine) it will not be triggered. But when your process is idle all idle 1502<p>That is, as long as your process is busy handling sockets or timeouts
1367watchers are being called again and again, once per event loop iteration - 1503(or even signals, imagine) of the same or higher priority it will not be
1504triggered. But when your process is idle (or only lower-priority watchers
1505are pending), the idle watchers are being called once per event loop
1368until stopped, that is, or your process receives more events and becomes 1506iteration - until stopped, that is, or your process receives more events
1369busy.</p> 1507and becomes busy again with higher priority stuff.</p>
1370<p>The most noteworthy effect is that as long as any idle watchers are 1508<p>The most noteworthy effect is that as long as any idle watchers are
1371active, the process will not block when waiting for new events.</p> 1509active, the process will not block when waiting for new events.</p>
1372<p>Apart from keeping your process non-blocking (which is a useful 1510<p>Apart from keeping your process non-blocking (which is a useful
1373effect on its own sometimes), idle watchers are a good place to do 1511effect on its own sometimes), idle watchers are a good place to do
1374&quot;pseudo-background processing&quot;, or delay processing stuff to after the 1512&quot;pseudo-background processing&quot;, or delay processing stuff to after the
1375event loop has handled all outstanding events.</p> 1513event loop has handled all outstanding events.</p>
1514
1515</div>
1516<h3 id="Watcher_Specific_Functions_and_Data_-7">Watcher-Specific Functions and Data Members</h3>
1517<div id="Watcher_Specific_Functions_and_Data_-2-5">
1376<dl> 1518<dl>
1377 <dt>ev_idle_init (ev_signal *, callback)</dt> 1519 <dt>ev_idle_init (ev_signal *, callback)</dt>
1378 <dd> 1520 <dd>
1379 <p>Initialises and configures the idle watcher - it has no parameters of any 1521 <p>Initialises and configures the idle watcher - it has no parameters of any
1380kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless, 1522kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless,
… …
1434are ready to run (it's actually more complicated: it only runs coroutines 1576are ready to run (it's actually more complicated: it only runs coroutines
1435with priority higher than or equal to the event loop and one coroutine 1577with priority higher than or equal to the event loop and one coroutine
1436of lower priority, but only once, using idle watchers to keep the event 1578of lower priority, but only once, using idle watchers to keep the event
1437loop from blocking if lower-priority coroutines are active, thus mapping 1579loop from blocking if lower-priority coroutines are active, thus mapping
1438low-priority coroutines to idle/background tasks).</p> 1580low-priority coroutines to idle/background tasks).</p>
1581<p>It is recommended to give <code>ev_check</code> watchers highest (<code>EV_MAXPRI</code>)
1582priority, to ensure that they are being run before any other watchers
1583after the poll. Also, <code>ev_check</code> watchers (and <code>ev_prepare</code> watchers,
1584too) should not activate (&quot;feed&quot;) events into libev. While libev fully
1585supports this, they will be called before other <code>ev_check</code> watchers did
1586their job. As <code>ev_check</code> watchers are often used to embed other event
1587loops those other event loops might be in an unusable state until their
1588<code>ev_check</code> watcher ran (always remind yourself to coexist peacefully with
1589others).</p>
1590
1591</div>
1592<h3 id="Watcher_Specific_Functions_and_Data_-8">Watcher-Specific Functions and Data Members</h3>
1593<div id="Watcher_Specific_Functions_and_Data_-2-6">
1439<dl> 1594<dl>
1440 <dt>ev_prepare_init (ev_prepare *, callback)</dt> 1595 <dt>ev_prepare_init (ev_prepare *, callback)</dt>
1441 <dt>ev_check_init (ev_check *, callback)</dt> 1596 <dt>ev_check_init (ev_check *, callback)</dt>
1442 <dd> 1597 <dd>
1443 <p>Initialises and configures the prepare or check watcher - they have no 1598 <p>Initialises and configures the prepare or check watcher - they have no
1444parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> 1599parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code>
1445macros, but using them is utterly, utterly and completely pointless.</p> 1600macros, but using them is utterly, utterly and completely pointless.</p>
1446 </dd> 1601 </dd>
1447</dl> 1602</dl>
1448<p>Example: To include a library such as adns, you would add IO watchers 1603<p>There are a number of principal ways to embed other event loops or modules
1449and a timeout watcher in a prepare handler, as required by libadns, and 1604into libev. Here are some ideas on how to include libadns into libev
1605(there is a Perl module named <code>EV::ADNS</code> that does this, which you could
1606use for an actually working example. Another Perl module named <code>EV::Glib</code>
1607embeds a Glib main context into libev, and finally, <code>Glib::EV</code> embeds EV
1608into the Glib event loop).</p>
1609<p>Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1450in a check watcher, destroy them and call into libadns. What follows is 1610and in a check watcher, destroy them and call into libadns. What follows
1451pseudo-code only of course:</p> 1611is pseudo-code only of course. This requires you to either use a low
1612priority for the check watcher or use <code>ev_clear_pending</code> explicitly, as
1613the callbacks for the IO/timeout watchers might not have been called yet.</p>
1452<pre> static ev_io iow [nfd]; 1614<pre> static ev_io iow [nfd];
1453 static ev_timer tw; 1615 static ev_timer tw;
1454 1616
1455 static void 1617 static void
1456 io_cb (ev_loop *loop, ev_io *w, int revents) 1618 io_cb (ev_loop *loop, ev_io *w, int revents)
1457 { 1619 {
1458 // set the relevant poll flags
1459 // could also call adns_processreadable etc. here
1460 struct pollfd *fd = (struct pollfd *)w-&gt;data;
1461 if (revents &amp; EV_READ ) fd-&gt;revents |= fd-&gt;events &amp; POLLIN;
1462 if (revents &amp; EV_WRITE) fd-&gt;revents |= fd-&gt;events &amp; POLLOUT;
1463 } 1620 }
1464 1621
1465 // create io watchers for each fd and a timer before blocking 1622 // create io watchers for each fd and a timer before blocking
1466 static void 1623 static void
1467 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 1624 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1468 { 1625 {
1469 int timeout = 3600000;truct pollfd fds [nfd]; 1626 int timeout = 3600000;
1627 struct pollfd fds [nfd];
1470 // actual code will need to loop here and realloc etc. 1628 // actual code will need to loop here and realloc etc.
1471 adns_beforepoll (ads, fds, &amp;nfd, &amp;timeout, timeval_from (ev_time ())); 1629 adns_beforepoll (ads, fds, &amp;nfd, &amp;timeout, timeval_from (ev_time ()));
1472 1630
1473 /* the callback is illegal, but won't be called as we stop during check */ 1631 /* the callback is illegal, but won't be called as we stop during check */
1474 ev_timer_init (&amp;tw, 0, timeout * 1e-3); 1632 ev_timer_init (&amp;tw, 0, timeout * 1e-3);
1475 ev_timer_start (loop, &amp;tw); 1633 ev_timer_start (loop, &amp;tw);
1476 1634
1477 // create on ev_io per pollfd 1635 // create one ev_io per pollfd
1478 for (int i = 0; i &lt; nfd; ++i) 1636 for (int i = 0; i &lt; nfd; ++i)
1479 { 1637 {
1480 ev_io_init (iow + i, io_cb, fds [i].fd, 1638 ev_io_init (iow + i, io_cb, fds [i].fd,
1481 ((fds [i].events &amp; POLLIN ? EV_READ : 0) 1639 ((fds [i].events &amp; POLLIN ? EV_READ : 0)
1482 | (fds [i].events &amp; POLLOUT ? EV_WRITE : 0))); 1640 | (fds [i].events &amp; POLLOUT ? EV_WRITE : 0)));
1483 1641
1484 fds [i].revents = 0; 1642 fds [i].revents = 0;
1485 iow [i].data = fds + i;
1486 ev_io_start (loop, iow + i); 1643 ev_io_start (loop, iow + i);
1487 } 1644 }
1488 } 1645 }
1489 1646
1490 // stop all watchers after blocking 1647 // stop all watchers after blocking
… …
1492 adns_check_cb (ev_loop *loop, ev_check *w, int revents) 1649 adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1493 { 1650 {
1494 ev_timer_stop (loop, &amp;tw); 1651 ev_timer_stop (loop, &amp;tw);
1495 1652
1496 for (int i = 0; i &lt; nfd; ++i) 1653 for (int i = 0; i &lt; nfd; ++i)
1654 {
1655 // set the relevant poll flags
1656 // could also call adns_processreadable etc. here
1657 struct pollfd *fd = fds + i;
1658 int revents = ev_clear_pending (iow + i);
1659 if (revents &amp; EV_READ ) fd-&gt;revents |= fd-&gt;events &amp; POLLIN;
1660 if (revents &amp; EV_WRITE) fd-&gt;revents |= fd-&gt;events &amp; POLLOUT;
1661
1662 // now stop the watcher
1497 ev_io_stop (loop, iow + i); 1663 ev_io_stop (loop, iow + i);
1664 }
1498 1665
1499 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); 1666 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1667 }
1668
1669</pre>
1670<p>Method 2: This would be just like method 1, but you run <code>adns_afterpoll</code>
1671in the prepare watcher and would dispose of the check watcher.</p>
1672<p>Method 3: If the module to be embedded supports explicit event
1673notification (adns does), you can also make use of the actual watcher
1674callbacks, and only destroy/create the watchers in the prepare watcher.</p>
1675<pre> static void
1676 timer_cb (EV_P_ ev_timer *w, int revents)
1677 {
1678 adns_state ads = (adns_state)w-&gt;data;
1679 update_now (EV_A);
1680
1681 adns_processtimeouts (ads, &amp;tv_now);
1682 }
1683
1684 static void
1685 io_cb (EV_P_ ev_io *w, int revents)
1686 {
1687 adns_state ads = (adns_state)w-&gt;data;
1688 update_now (EV_A);
1689
1690 if (revents &amp; EV_READ ) adns_processreadable (ads, w-&gt;fd, &amp;tv_now);
1691 if (revents &amp; EV_WRITE) adns_processwriteable (ads, w-&gt;fd, &amp;tv_now);
1692 }
1693
1694 // do not ever call adns_afterpoll
1695
1696</pre>
1697<p>Method 4: Do not use a prepare or check watcher because the module you
1698want to embed is too inflexible to support it. Instead, youc na override
1699their poll function. The drawback with this solution is that the main
1700loop is now no longer controllable by EV. The <code>Glib::EV</code> module does
1701this.</p>
1702<pre> static gint
1703 event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1704 {
1705 int got_events = 0;
1706
1707 for (n = 0; n &lt; nfds; ++n)
1708 // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1709
1710 if (timeout &gt;= 0)
1711 // create/start timer
1712
1713 // poll
1714 ev_loop (EV_A_ 0);
1715
1716 // stop timer again
1717 if (timeout &gt;= 0)
1718 ev_timer_stop (EV_A_ &amp;to);
1719
1720 // stop io watchers again - their callbacks should have set
1721 for (n = 0; n &lt; nfds; ++n)
1722 ev_io_stop (EV_A_ iow [n]);
1723
1724 return got_events;
1500 } 1725 }
1501 1726
1502 1727
1503 1728
1504 1729
… …
1565 } 1790 }
1566 else 1791 else
1567 loop_lo = loop_hi; 1792 loop_lo = loop_hi;
1568 1793
1569</pre> 1794</pre>
1795
1796</div>
1797<h3 id="Watcher_Specific_Functions_and_Data_-9">Watcher-Specific Functions and Data Members</h3>
1798<div id="Watcher_Specific_Functions_and_Data_-2-7">
1570<dl> 1799<dl>
1571 <dt>ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)</dt> 1800 <dt>ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)</dt>
1572 <dt>ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)</dt> 1801 <dt>ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)</dt>
1573 <dd> 1802 <dd>
1574 <p>Configures the watcher to embed the given loop, which must be 1803 <p>Configures the watcher to embed the given loop, which must be
… …
1701the callback model to a model using method callbacks on objects.</p> 1930the callback model to a model using method callbacks on objects.</p>
1702<p>To use it,</p> 1931<p>To use it,</p>
1703<pre> #include &lt;ev++.h&gt; 1932<pre> #include &lt;ev++.h&gt;
1704 1933
1705</pre> 1934</pre>
1706<p>(it is not installed by default). This automatically includes <cite>ev.h</cite> 1935<p>This automatically includes <cite>ev.h</cite> and puts all of its definitions (many
1707and puts all of its definitions (many of them macros) into the global 1936of them macros) into the global namespace. All C++ specific things are
1708namespace. All C++ specific things are put into the <code>ev</code> namespace.</p> 1937put into the <code>ev</code> namespace. It should support all the same embedding
1709<p>It should support all the same embedding options as <cite>ev.h</cite>, most notably 1938options as <cite>ev.h</cite>, most notably <code>EV_MULTIPLICITY</code>.</p>
1710<code>EV_MULTIPLICITY</code>.</p> 1939<p>Care has been taken to keep the overhead low. The only data member the C++
1940classes add (compared to plain C-style watchers) is the event loop pointer
1941that the watcher is associated with (or no additional members at all if
1942you disable <code>EV_MULTIPLICITY</code> when embedding libev).</p>
1943<p>Currently, functions, and static and non-static member functions can be
1944used as callbacks. Other types should be easy to add as long as they only
1945need one additional pointer for context. If you need support for other
1946types of functors please contact the author (preferably after implementing
1947it).</p>
1711<p>Here is a list of things available in the <code>ev</code> namespace:</p> 1948<p>Here is a list of things available in the <code>ev</code> namespace:</p>
1712<dl> 1949<dl>
1713 <dt><code>ev::READ</code>, <code>ev::WRITE</code> etc.</dt> 1950 <dt><code>ev::READ</code>, <code>ev::WRITE</code> etc.</dt>
1714 <dd> 1951 <dd>
1715 <p>These are just enum values with the same values as the <code>EV_READ</code> etc. 1952 <p>These are just enum values with the same values as the <code>EV_READ</code> etc.
… …
1726which is called <code>ev::sig</code> to avoid clashes with the <code>signal</code> macro 1963which is called <code>ev::sig</code> to avoid clashes with the <code>signal</code> macro
1727defines by many implementations.</p> 1964defines by many implementations.</p>
1728 <p>All of those classes have these methods:</p> 1965 <p>All of those classes have these methods:</p>
1729 <p> 1966 <p>
1730 <dl> 1967 <dl>
1731 <dt>ev::TYPE::TYPE (object *, object::method *)</dt> 1968 <dt>ev::TYPE::TYPE ()</dt>
1732 <dt>ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)</dt> 1969 <dt>ev::TYPE::TYPE (struct ev_loop *)</dt>
1733 <dt>ev::TYPE::~TYPE</dt> 1970 <dt>ev::TYPE::~TYPE</dt>
1734 <dd> 1971 <dd>
1735 <p>The constructor takes a pointer to an object and a method pointer to 1972 <p>The constructor (optionally) takes an event loop to associate the watcher
1736the event handler callback to call in this class. The constructor calls 1973with. If it is omitted, it will use <code>EV_DEFAULT</code>.</p>
1737<code>ev_init</code> for you, which means you have to call the <code>set</code> method 1974 <p>The constructor calls <code>ev_init</code> for you, which means you have to call the
1738before starting it. If you do not specify a loop then the constructor 1975<code>set</code> method before starting it.</p>
1739automatically associates the default loop with this watcher.</p> 1976 <p>It will not set a callback, however: You have to call the templated <code>set</code>
1977method to set a callback before you can start the watcher.</p>
1978 <p>(The reason why you have to use a method is a limitation in C++ which does
1979not allow explicit template arguments for constructors).</p>
1740 <p>The destructor automatically stops the watcher if it is active.</p> 1980 <p>The destructor automatically stops the watcher if it is active.</p>
1981 </dd>
1982 <dt>w-&gt;set&lt;class, &amp;class::method&gt; (object *)</dt>
1983 <dd>
1984 <p>This method sets the callback method to call. The method has to have a
1985signature of <code>void (*)(ev_TYPE &amp;, int)</code>, it receives the watcher as
1986first argument and the <code>revents</code> as second. The object must be given as
1987parameter and is stored in the <code>data</code> member of the watcher.</p>
1988 <p>This method synthesizes efficient thunking code to call your method from
1989the C callback that libev requires. If your compiler can inline your
1990callback (i.e. it is visible to it at the place of the <code>set</code> call and
1991your compiler is good :), then the method will be fully inlined into the
1992thunking function, making it as fast as a direct C callback.</p>
1993 <p>Example: simple class declaration and watcher initialisation</p>
1994<pre> struct myclass
1995 {
1996 void io_cb (ev::io &amp;w, int revents) { }
1997 }
1998
1999 myclass obj;
2000 ev::io iow;
2001 iow.set &lt;myclass, &amp;myclass::io_cb&gt; (&amp;obj);
2002
2003</pre>
2004 </dd>
2005 <dt>w-&gt;set&lt;function&gt; (void *data = 0)</dt>
2006 <dd>
2007 <p>Also sets a callback, but uses a static method or plain function as
2008callback. The optional <code>data</code> argument will be stored in the watcher's
2009<code>data</code> member and is free for you to use.</p>
2010 <p>The prototype of the <code>function</code> must be <code>void (*)(ev::TYPE &amp;w, int)</code>.</p>
2011 <p>See the method-<code>set</code> above for more details.</p>
2012 <p>Example:</p>
2013<pre> static void io_cb (ev::io &amp;w, int revents) { }
2014 iow.set &lt;io_cb&gt; ();
2015
2016</pre>
1741 </dd> 2017 </dd>
1742 <dt>w-&gt;set (struct ev_loop *)</dt> 2018 <dt>w-&gt;set (struct ev_loop *)</dt>
1743 <dd> 2019 <dd>
1744 <p>Associates a different <code>struct ev_loop</code> with this watcher. You can only 2020 <p>Associates a different <code>struct ev_loop</code> with this watcher. You can only
1745do this when the watcher is inactive (and not pending either).</p> 2021do this when the watcher is inactive (and not pending either).</p>
1746 </dd> 2022 </dd>
1747 <dt>w-&gt;set ([args])</dt> 2023 <dt>w-&gt;set ([args])</dt>
1748 <dd> 2024 <dd>
1749 <p>Basically the same as <code>ev_TYPE_set</code>, with the same args. Must be 2025 <p>Basically the same as <code>ev_TYPE_set</code>, with the same args. Must be
1750called at least once. Unlike the C counterpart, an active watcher gets 2026called at least once. Unlike the C counterpart, an active watcher gets
1751automatically stopped and restarted.</p> 2027automatically stopped and restarted when reconfiguring it with this
2028method.</p>
1752 </dd> 2029 </dd>
1753 <dt>w-&gt;start ()</dt> 2030 <dt>w-&gt;start ()</dt>
1754 <dd> 2031 <dd>
1755 <p>Starts the watcher. Note that there is no <code>loop</code> argument as the 2032 <p>Starts the watcher. Note that there is no <code>loop</code> argument, as the
1756constructor already takes the loop.</p> 2033constructor already stores the event loop.</p>
1757 </dd> 2034 </dd>
1758 <dt>w-&gt;stop ()</dt> 2035 <dt>w-&gt;stop ()</dt>
1759 <dd> 2036 <dd>
1760 <p>Stops the watcher if it is active. Again, no <code>loop</code> argument.</p> 2037 <p>Stops the watcher if it is active. Again, no <code>loop</code> argument.</p>
1761 </dd> 2038 </dd>
… …
1785 2062
1786 myclass (); 2063 myclass ();
1787 } 2064 }
1788 2065
1789 myclass::myclass (int fd) 2066 myclass::myclass (int fd)
1790 : io (this, &amp;myclass::io_cb),
1791 idle (this, &amp;myclass::idle_cb)
1792 { 2067 {
2068 io .set &lt;myclass, &amp;myclass::io_cb &gt; (this);
2069 idle.set &lt;myclass, &amp;myclass::idle_cb&gt; (this);
2070
1793 io.start (fd, ev::READ); 2071 io.start (fd, ev::READ);
1794 } 2072 }
1795 2073
1796 2074
1797 2075
… …
1800 2078
1801</div> 2079</div>
1802<h1 id="MACRO_MAGIC">MACRO MAGIC</h1> 2080<h1 id="MACRO_MAGIC">MACRO MAGIC</h1>
1803<div id="MACRO_MAGIC_CONTENT"> 2081<div id="MACRO_MAGIC_CONTENT">
1804<p>Libev can be compiled with a variety of options, the most fundemantal is 2082<p>Libev can be compiled with a variety of options, the most fundemantal is
1805<code>EV_MULTIPLICITY</code>. This option determines wether (most) functions and 2083<code>EV_MULTIPLICITY</code>. This option determines whether (most) functions and
1806callbacks have an initial <code>struct ev_loop *</code> argument.</p> 2084callbacks have an initial <code>struct ev_loop *</code> argument.</p>
1807<p>To make it easier to write programs that cope with either variant, the 2085<p>To make it easier to write programs that cope with either variant, the
1808following macros are defined:</p> 2086following macros are defined:</p>
1809<dl> 2087<dl>
1810 <dt><code>EV_A</code>, <code>EV_A_</code></dt> 2088 <dt><code>EV_A</code>, <code>EV_A_</code></dt>
… …
1839 <dd> 2117 <dd>
1840 <p>Similar to the other two macros, this gives you the value of the default 2118 <p>Similar to the other two macros, this gives you the value of the default
1841loop, if multiple loops are supported (&quot;ev loop default&quot;).</p> 2119loop, if multiple loops are supported (&quot;ev loop default&quot;).</p>
1842 </dd> 2120 </dd>
1843</dl> 2121</dl>
1844<p>Example: Declare and initialise a check watcher, working regardless of 2122<p>Example: Declare and initialise a check watcher, utilising the above
1845wether multiple loops are supported or not.</p> 2123macros so it will work regardless of whether multiple loops are supported
2124or not.</p>
1846<pre> static void 2125<pre> static void
1847 check_cb (EV_P_ ev_timer *w, int revents) 2126 check_cb (EV_P_ ev_timer *w, int revents)
1848 { 2127 {
1849 ev_check_stop (EV_A_ w); 2128 ev_check_stop (EV_A_ w);
1850 } 2129 }
1851 2130
1852 ev_check check; 2131 ev_check check;
1853 ev_check_init (&amp;check, check_cb); 2132 ev_check_init (&amp;check, check_cb);
1854 ev_check_start (EV_DEFAULT_ &amp;check); 2133 ev_check_start (EV_DEFAULT_ &amp;check);
1855 ev_loop (EV_DEFAULT_ 0); 2134 ev_loop (EV_DEFAULT_ 0);
1856
1857
1858
1859 2135
1860</pre> 2136</pre>
1861 2137
1862</div> 2138</div>
1863<h1 id="EMBEDDING">EMBEDDING</h1> 2139<h1 id="EMBEDDING">EMBEDDING</h1>
… …
1905 ev_vars.h 2181 ev_vars.h
1906 ev_wrap.h 2182 ev_wrap.h
1907 2183
1908 ev_win32.c required on win32 platforms only 2184 ev_win32.c required on win32 platforms only
1909 2185
1910 ev_select.c only when select backend is enabled (which is by default) 2186 ev_select.c only when select backend is enabled (which is enabled by default)
1911 ev_poll.c only when poll backend is enabled (disabled by default) 2187 ev_poll.c only when poll backend is enabled (disabled by default)
1912 ev_epoll.c only when the epoll backend is enabled (disabled by default) 2188 ev_epoll.c only when the epoll backend is enabled (disabled by default)
1913 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 2189 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1914 ev_port.c only when the solaris port backend is enabled (disabled by default) 2190 ev_port.c only when the solaris port backend is enabled (disabled by default)
1915 2191
… …
2080will have the <code>struct ev_loop *</code> as first argument, and you can create 2356will have the <code>struct ev_loop *</code> as first argument, and you can create
2081additional independent event loops. Otherwise there will be no support 2357additional independent event loops. Otherwise there will be no support
2082for multiple event loops and there is no first event loop pointer 2358for multiple event loops and there is no first event loop pointer
2083argument. Instead, all functions act on the single default loop.</p> 2359argument. Instead, all functions act on the single default loop.</p>
2084 </dd> 2360 </dd>
2361 <dt>EV_MINPRI</dt>
2362 <dt>EV_MAXPRI</dt>
2363 <dd>
2364 <p>The range of allowed priorities. <code>EV_MINPRI</code> must be smaller or equal to
2365<code>EV_MAXPRI</code>, but otherwise there are no non-obvious limitations. You can
2366provide for more priorities by overriding those symbols (usually defined
2367to be <code>-2</code> and <code>2</code>, respectively).</p>
2368 <p>When doing priority-based operations, libev usually has to linearly search
2369all the priorities, so having many of them (hundreds) uses a lot of space
2370and time, so using the defaults of five priorities (-2 .. +2) is usually
2371fine.</p>
2372 <p>If your embedding app does not need any priorities, defining these both to
2373<code>0</code> will save some memory and cpu.</p>
2374 </dd>
2085 <dt>EV_PERIODIC_ENABLE</dt> 2375 <dt>EV_PERIODIC_ENABLE</dt>
2086 <dd> 2376 <dd>
2087 <p>If undefined or defined to be <code>1</code>, then periodic timers are supported. If 2377 <p>If undefined or defined to be <code>1</code>, then periodic timers are supported. If
2378defined to be <code>0</code>, then they are not. Disabling them saves a few kB of
2379code.</p>
2380 </dd>
2381 <dt>EV_IDLE_ENABLE</dt>
2382 <dd>
2383 <p>If undefined or defined to be <code>1</code>, then idle watchers are supported. If
2088defined to be <code>0</code>, then they are not. Disabling them saves a few kB of 2384defined to be <code>0</code>, then they are not. Disabling them saves a few kB of
2089code.</p> 2385code.</p>
2090 </dd> 2386 </dd>
2091 <dt>EV_EMBED_ENABLE</dt> 2387 <dt>EV_EMBED_ENABLE</dt>
2092 <dd> 2388 <dd>
… …
2157the <cite>libev/</cite> subdirectory and includes them in the <cite>EV/EVAPI.h</cite> (public 2453the <cite>libev/</cite> subdirectory and includes them in the <cite>EV/EVAPI.h</cite> (public
2158interface) and <cite>EV.xs</cite> (implementation) files. Only the <cite>EV.xs</cite> file 2454interface) and <cite>EV.xs</cite> (implementation) files. Only the <cite>EV.xs</cite> file
2159will be compiled. It is pretty complex because it provides its own header 2455will be compiled. It is pretty complex because it provides its own header
2160file.</p> 2456file.</p>
2161 <p>The usage in rxvt-unicode is simpler. It has a <cite>ev_cpp.h</cite> header file 2457 <p>The usage in rxvt-unicode is simpler. It has a <cite>ev_cpp.h</cite> header file
2162that everybody includes and which overrides some autoconf choices:</p> 2458that everybody includes and which overrides some configure choices:</p>
2459<pre> #define EV_MINIMAL 1
2163<pre> #define EV_USE_POLL 0 2460 #define EV_USE_POLL 0
2164 #define EV_MULTIPLICITY 0 2461 #define EV_MULTIPLICITY 0
2165 #define EV_PERIODICS 0 2462 #define EV_PERIODIC_ENABLE 0
2463 #define EV_STAT_ENABLE 0
2464 #define EV_FORK_ENABLE 0
2166 #define EV_CONFIG_H &lt;config.h&gt; 2465 #define EV_CONFIG_H &lt;config.h&gt;
2466 #define EV_MINPRI 0
2467 #define EV_MAXPRI 0
2167 2468
2168 #include &quot;ev++.h&quot; 2469 #include &quot;ev++.h&quot;
2169 2470
2170</pre> 2471</pre>
2171 <p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p> 2472 <p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p>
… …
2181<h1 id="COMPLEXITIES">COMPLEXITIES</h1> 2482<h1 id="COMPLEXITIES">COMPLEXITIES</h1>
2182<div id="COMPLEXITIES_CONTENT"> 2483<div id="COMPLEXITIES_CONTENT">
2183 <p>In this section the complexities of (many of) the algorithms used inside 2484 <p>In this section the complexities of (many of) the algorithms used inside
2184libev will be explained. For complexity discussions about backends see the 2485libev will be explained. For complexity discussions about backends see the
2185documentation for <code>ev_default_init</code>.</p> 2486documentation for <code>ev_default_init</code>.</p>
2487 <p>All of the following are about amortised time: If an array needs to be
2488extended, libev needs to realloc and move the whole array, but this
2489happens asymptotically never with higher number of elements, so O(1) might
2490mean it might do a lengthy realloc operation in rare cases, but on average
2491it is much faster and asymptotically approaches constant time.</p>
2186 <p> 2492 <p>
2187 <dl> 2493 <dl>
2188 <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt> 2494 <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt>
2495 <dd>
2496 <p>This means that, when you have a watcher that triggers in one hour and
2497there are 100 watchers that would trigger before that then inserting will
2498have to skip those 100 watchers.</p>
2499 </dd>
2189 <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt> 2500 <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt>
2501 <dd>
2502 <p>That means that for changing a timer costs less than removing/adding them
2503as only the relative motion in the event queue has to be paid for.</p>
2504 </dd>
2190 <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt> 2505 <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt>
2506 <dd>
2507 <p>These just add the watcher into an array or at the head of a list.
2191 <dt>Stopping check/prepare/idle watchers: O(1)</dt> 2508=item Stopping check/prepare/idle watchers: O(1)</p>
2509 </dd>
2192 <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))</dt> 2510 <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))</dt>
2511 <dd>
2512 <p>These watchers are stored in lists then need to be walked to find the
2513correct watcher to remove. The lists are usually short (you don't usually
2514have many watchers waiting for the same fd or signal).</p>
2515 </dd>
2193 <dt>Finding the next timer per loop iteration: O(1)</dt> 2516 <dt>Finding the next timer per loop iteration: O(1)</dt>
2194 <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt> 2517 <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt>
2518 <dd>
2519 <p>A change means an I/O watcher gets started or stopped, which requires
2520libev to recalculate its status (and possibly tell the kernel).</p>
2521 </dd>
2195 <dt>Activating one watcher: O(1)</dt> 2522 <dt>Activating one watcher: O(1)</dt>
2523 <dt>Priority handling: O(number_of_priorities)</dt>
2524 <dd>
2525 <p>Priorities are implemented by allocating some space for each
2526priority. When doing priority-based operations, libev usually has to
2527linearly search all the priorities.</p>
2528 </dd>
2196 </dl> 2529 </dl>
2197 </p> 2530 </p>
2198 2531
2199 2532
2200 2533

Diff Legend

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