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

Comparing libev/ev.html (file contents):
Revision 1.41 by root, Sat Nov 24 10:15:16 2007 UTC vs.
Revision 1.57 by root, Wed Nov 28 11:27:29 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="Sat Nov 24 11:15:15 2007" /> 9 <meta name="created" content="Wed Nov 28 12:27:27 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 -->
15<h3 id="TOP">Index</h3> 15<h3 id="TOP">Index</h3>
16 16
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="#EXAMPLE_PROGRAM">EXAMPLE PROGRAM</a></li>
19<li><a href="#DESCRIPTION">DESCRIPTION</a></li> 20<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
20<li><a href="#FEATURES">FEATURES</a></li> 21<li><a href="#FEATURES">FEATURES</a></li>
21<li><a href="#CONVENTIONS">CONVENTIONS</a></li> 22<li><a href="#CONVENTIONS">CONVENTIONS</a></li>
22<li><a href="#TIME_REPRESENTATION">TIME REPRESENTATION</a></li> 23<li><a href="#TIME_REPRESENTATION">TIME REPRESENTATION</a></li>
23<li><a href="#GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</a></li> 24<li><a href="#GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</a></li>
24<li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li> 25<li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li>
25<li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a> 26<li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a>
26<ul><li><a href="#SUMMARY_OF_GENERIC_WATCHER_FUNCTIONS">SUMMARY OF GENERIC WATCHER FUNCTIONS</a></li> 27<ul><li><a href="#GENERIC_WATCHER_FUNCTIONS">GENERIC WATCHER FUNCTIONS</a></li>
27<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>
28</ul> 29</ul>
29</li> 30</li>
30<li><a href="#WATCHER_TYPES">WATCHER TYPES</a> 31<li><a href="#WATCHER_TYPES">WATCHER TYPES</a>
31<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></li>
32<li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</a></li> 33<li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally repeating timeouts</a></li>
33<li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</a></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>
34<li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</a></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>
35<li><a href="#code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</a></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>
37<li><a href="#code_ev_stat_code_did_the_file_attri"><code>ev_stat</code> - did the file attributes just change?</a></li>
36<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> 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>
37<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> 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>
38<li><a href="#code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough</a></li> 40<li><a href="#code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough...</a></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>
39</ul> 42</ul>
40</li> 43</li>
41<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> 44<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li>
42<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li> 45<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li>
43<li><a href="#C_SUPPORT">C++ SUPPORT</a></li> 46<li><a href="#C_SUPPORT">C++ SUPPORT</a></li>
47<li><a href="#MACRO_MAGIC">MACRO MAGIC</a></li>
44<li><a href="#EMBEDDING">EMBEDDING</a> 48<li><a href="#EMBEDDING">EMBEDDING</a>
45<ul><li><a href="#FILESETS">FILESETS</a> 49<ul><li><a href="#FILESETS">FILESETS</a>
46<ul><li><a href="#CORE_EVENT_LOOP">CORE EVENT LOOP</a></li> 50<ul><li><a href="#CORE_EVENT_LOOP">CORE EVENT LOOP</a></li>
47<li><a href="#LIBEVENT_COMPATIBILITY_API">LIBEVENT COMPATIBILITY API</a></li> 51<li><a href="#LIBEVENT_COMPATIBILITY_API">LIBEVENT COMPATIBILITY API</a></li>
48<li><a href="#AUTOCONF_SUPPORT">AUTOCONF SUPPORT</a></li> 52<li><a href="#AUTOCONF_SUPPORT">AUTOCONF SUPPORT</a></li>
… …
50</li> 54</li>
51<li><a href="#PREPROCESSOR_SYMBOLS_MACROS">PREPROCESSOR SYMBOLS/MACROS</a></li> 55<li><a href="#PREPROCESSOR_SYMBOLS_MACROS">PREPROCESSOR SYMBOLS/MACROS</a></li>
52<li><a href="#EXAMPLES">EXAMPLES</a></li> 56<li><a href="#EXAMPLES">EXAMPLES</a></li>
53</ul> 57</ul>
54</li> 58</li>
59<li><a href="#COMPLEXITIES">COMPLEXITIES</a></li>
55<li><a href="#AUTHOR">AUTHOR</a> 60<li><a href="#AUTHOR">AUTHOR</a>
56</li> 61</li>
57</ul><hr /> 62</ul><hr />
58<!-- INDEX END --> 63<!-- INDEX END -->
59 64
60<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p> 65<h1 id="NAME">NAME</h1>
61<div id="NAME_CONTENT"> 66<div id="NAME_CONTENT">
62<p>libev - a high performance full-featured event loop written in C</p> 67<p>libev - a high performance full-featured event loop written in C</p>
63 68
64</div> 69</div>
65<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p> 70<h1 id="SYNOPSIS">SYNOPSIS</h1>
66<div id="SYNOPSIS_CONTENT"> 71<div id="SYNOPSIS_CONTENT">
67<pre> #include &lt;ev.h&gt; 72<pre> #include &lt;ev.h&gt;
68 73
69</pre> 74</pre>
70 75
71</div> 76</div>
72<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p> 77<h1 id="EXAMPLE_PROGRAM">EXAMPLE PROGRAM</h1>
78<div id="EXAMPLE_PROGRAM_CONTENT">
79<pre> #include &lt;ev.h&gt;
80
81 ev_io stdin_watcher;
82 ev_timer timeout_watcher;
83
84 /* called when data readable on stdin */
85 static void
86 stdin_cb (EV_P_ struct ev_io *w, int revents)
87 {
88 /* puts (&quot;stdin ready&quot;); */
89 ev_io_stop (EV_A_ w); /* just a syntax example */
90 ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */
91 }
92
93 static void
94 timeout_cb (EV_P_ struct ev_timer *w, int revents)
95 {
96 /* puts (&quot;timeout&quot;); */
97 ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */
98 }
99
100 int
101 main (void)
102 {
103 struct ev_loop *loop = ev_default_loop (0);
104
105 /* initialise an io watcher, then start it */
106 ev_io_init (&amp;stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
107 ev_io_start (loop, &amp;stdin_watcher);
108
109 /* simple non-repeating 5.5 second timeout */
110 ev_timer_init (&amp;timeout_watcher, timeout_cb, 5.5, 0.);
111 ev_timer_start (loop, &amp;timeout_watcher);
112
113 /* loop till timeout or data ready */
114 ev_loop (loop, 0);
115
116 return 0;
117 }
118
119</pre>
120
121</div>
122<h1 id="DESCRIPTION">DESCRIPTION</h1>
73<div id="DESCRIPTION_CONTENT"> 123<div id="DESCRIPTION_CONTENT">
74<p>Libev is an event loop: you register interest in certain events (such as a 124<p>Libev is an event loop: you register interest in certain events (such as a
75file descriptor being readable or a timeout occuring), and it will manage 125file descriptor being readable or a timeout occuring), and it will manage
76these event sources and provide your program with events.</p> 126these event sources and provide your program with events.</p>
77<p>To do this, it must take more or less complete control over your process 127<p>To do this, it must take more or less complete control over your process
… …
81watchers</i>, which are relatively small C structures you initialise with the 131watchers</i>, which are relatively small C structures you initialise with the
82details of the event, and then hand it over to libev by <i>starting</i> the 132details of the event, and then hand it over to libev by <i>starting</i> the
83watcher.</p> 133watcher.</p>
84 134
85</div> 135</div>
86<h1 id="FEATURES">FEATURES</h1><p><a href="#TOP" class="toplink">Top</a></p> 136<h1 id="FEATURES">FEATURES</h1>
87<div id="FEATURES_CONTENT"> 137<div id="FEATURES_CONTENT">
88<p>Libev supports select, poll, the linux-specific epoll and the bsd-specific 138<p>Libev supports <code>select</code>, <code>poll</code>, the linux-specific <code>epoll</code>, the
89kqueue mechanisms for file descriptor events, relative timers, absolute 139bsd-specific <code>kqueue</code> and the solaris-specific event port mechanisms
90timers with customised rescheduling, signal events, process status change 140for file descriptor events (<code>ev_io</code>), relative timers (<code>ev_timer</code>),
91events (related to SIGCHLD), and event watchers dealing with the event 141absolute timers with customised rescheduling (<code>ev_periodic</code>), synchronous
92loop mechanism itself (idle, prepare and check watchers). It also is quite 142signals (<code>ev_signal</code>), process status change events (<code>ev_child</code>), and
143event watchers dealing with the event loop mechanism itself (<code>ev_idle</code>,
144<code>ev_embed</code>, <code>ev_prepare</code> and <code>ev_check</code> watchers) as well as
145file watchers (<code>ev_stat</code>) and even limited support for fork events
146(<code>ev_fork</code>).</p>
147<p>It also is quite fast (see this
93fast (see this <a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing 148<a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing it to libevent
94it to libevent for example).</p> 149for example).</p>
95 150
96</div> 151</div>
97<h1 id="CONVENTIONS">CONVENTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 152<h1 id="CONVENTIONS">CONVENTIONS</h1>
98<div id="CONVENTIONS_CONTENT"> 153<div id="CONVENTIONS_CONTENT">
99<p>Libev is very configurable. In this manual the default configuration 154<p>Libev is very configurable. In this manual the default configuration will
100will be described, which supports multiple event loops. For more info 155be described, which supports multiple event loops. For more info about
101about various configuration options please have a look at the file 156various configuration options please have a look at <strong>EMBED</strong> section in
102<cite>README.embed</cite> in the libev distribution. If libev was configured without 157this manual. If libev was configured without support for multiple event
103support for multiple event loops, then all functions taking an initial 158loops, then all functions taking an initial argument of name <code>loop</code>
104argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>) 159(which is always of type <code>struct ev_loop *</code>) will not have this argument.</p>
105will not have this argument.</p>
106 160
107</div> 161</div>
108<h1 id="TIME_REPRESENTATION">TIME REPRESENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p> 162<h1 id="TIME_REPRESENTATION">TIME REPRESENTATION</h1>
109<div id="TIME_REPRESENTATION_CONTENT"> 163<div id="TIME_REPRESENTATION_CONTENT">
110<p>Libev represents time as a single floating point number, representing the 164<p>Libev represents time as a single floating point number, representing the
111(fractional) number of seconds since the (POSIX) epoch (somewhere near 165(fractional) number of seconds since the (POSIX) epoch (somewhere near
112the beginning of 1970, details are complicated, don't ask). This type is 166the beginning of 1970, details are complicated, don't ask). This type is
113called <code>ev_tstamp</code>, which is what you should use too. It usually aliases 167called <code>ev_tstamp</code>, which is what you should use too. It usually aliases
114to the <code>double</code> type in C, and when you need to do any calculations on 168to the <code>double</code> type in C, and when you need to do any calculations on
115it, you should treat it as such.</p> 169it, you should treat it as such.</p>
116 170
117
118
119
120
121</div> 171</div>
122<h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 172<h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1>
123<div id="GLOBAL_FUNCTIONS_CONTENT"> 173<div id="GLOBAL_FUNCTIONS_CONTENT">
124<p>These functions can be called anytime, even before initialising the 174<p>These functions can be called anytime, even before initialising the
125library in any way.</p> 175library in any way.</p>
126<dl> 176<dl>
127 <dt>ev_tstamp ev_time ()</dt> 177 <dt>ev_tstamp ev_time ()</dt>
… …
140version of the library your program was compiled against.</p> 190version of the library your program was compiled against.</p>
141 <p>Usually, it's a good idea to terminate if the major versions mismatch, 191 <p>Usually, it's a good idea to terminate if the major versions mismatch,
142as this indicates an incompatible change. Minor versions are usually 192as this indicates an incompatible change. Minor versions are usually
143compatible to older versions, so a larger minor version alone is usually 193compatible to older versions, so a larger minor version alone is usually
144not a problem.</p> 194not a problem.</p>
145 <p>Example: make sure we haven't accidentally been linked against the wrong 195 <p>Example: Make sure we haven't accidentally been linked against the wrong
146version:</p> 196version.</p>
147<pre> assert ((&quot;libev version mismatch&quot;, 197<pre> assert ((&quot;libev version mismatch&quot;,
148 ev_version_major () == EV_VERSION_MAJOR 198 ev_version_major () == EV_VERSION_MAJOR
149 &amp;&amp; ev_version_minor () &gt;= EV_VERSION_MINOR)); 199 &amp;&amp; ev_version_minor () &gt;= EV_VERSION_MINOR));
150 200
151</pre> 201</pre>
… …
179might be supported on the current system, you would need to look at 229might be supported on the current system, you would need to look at
180<code>ev_embeddable_backends () &amp; ev_supported_backends ()</code>, likewise for 230<code>ev_embeddable_backends () &amp; ev_supported_backends ()</code>, likewise for
181recommended ones.</p> 231recommended ones.</p>
182 <p>See the description of <code>ev_embed</code> watchers for more info.</p> 232 <p>See the description of <code>ev_embed</code> watchers for more info.</p>
183 </dd> 233 </dd>
184 <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> 234 <dt>ev_set_allocator (void *(*cb)(void *ptr, size_t size))</dt>
185 <dd> 235 <dd>
186 <p>Sets the allocation function to use (the prototype is similar to the 236 <p>Sets the allocation function to use (the prototype and semantics are
187realloc C function, the semantics are identical). It is used to allocate 237identical to the realloc C function). It is used to allocate and free
188and free memory (no surprises here). If it returns zero when memory 238memory (no surprises here). If it returns zero when memory needs to be
189needs to be allocated, the library might abort or take some potentially 239allocated, the library might abort or take some potentially destructive
190destructive action. The default is your system realloc function.</p> 240action. The default is your system realloc function.</p>
191 <p>You could override this function in high-availability programs to, say, 241 <p>You could override this function in high-availability programs to, say,
192free some memory if it cannot allocate memory, to use a special allocator, 242free some memory if it cannot allocate memory, to use a special allocator,
193or even to sleep a while and retry until some memory is available.</p> 243or even to sleep a while and retry until some memory is available.</p>
194 <p>Example: replace the libev allocator with one that waits a bit and then 244 <p>Example: Replace the libev allocator with one that waits a bit and then
195retries: better than mine).</p> 245retries).</p>
196<pre> static void * 246<pre> static void *
197 persistent_realloc (void *ptr, long size) 247 persistent_realloc (void *ptr, size_t size)
198 { 248 {
199 for (;;) 249 for (;;)
200 { 250 {
201 void *newptr = realloc (ptr, size); 251 void *newptr = realloc (ptr, size);
202 252
… …
219indicating the system call or subsystem causing the problem. If this 269indicating the system call or subsystem causing the problem. If this
220callback is set, then libev will expect it to remedy the sitution, no 270callback is set, then libev will expect it to remedy the sitution, no
221matter what, when it returns. That is, libev will generally retry the 271matter what, when it returns. That is, libev will generally retry the
222requested operation, or, if the condition doesn't go away, do bad stuff 272requested operation, or, if the condition doesn't go away, do bad stuff
223(such as abort).</p> 273(such as abort).</p>
224 <p>Example: do the same thing as libev does internally:</p> 274 <p>Example: This is basically the same thing that libev does internally, too.</p>
225<pre> static void 275<pre> static void
226 fatal_error (const char *msg) 276 fatal_error (const char *msg)
227 { 277 {
228 perror (msg); 278 perror (msg);
229 abort (); 279 abort ();
… …
235</pre> 285</pre>
236 </dd> 286 </dd>
237</dl> 287</dl>
238 288
239</div> 289</div>
240<h1 id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</h1><p><a href="#TOP" class="toplink">Top</a></p> 290<h1 id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</h1>
241<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2"> 291<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2">
242<p>An event loop is described by a <code>struct ev_loop *</code>. The library knows two 292<p>An event loop is described by a <code>struct ev_loop *</code>. The library knows two
243types of such loops, the <i>default</i> loop, which supports signals and child 293types of such loops, the <i>default</i> loop, which supports signals and child
244events, and dynamically created loops which do not.</p> 294events, and dynamically created loops which do not.</p>
245<p>If you use threads, a common model is to run the default event loop 295<p>If you use threads, a common model is to run the default event loop
… …
365 <dd> 415 <dd>
366 <p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is 416 <p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is
367always distinct from the default loop. Unlike the default loop, it cannot 417always distinct from the default loop. Unlike the default loop, it cannot
368handle signal and child watchers, and attempts to do so will be greeted by 418handle signal and child watchers, and attempts to do so will be greeted by
369undefined behaviour (or a failed assertion if assertions are enabled).</p> 419undefined behaviour (or a failed assertion if assertions are enabled).</p>
370 <p>Example: try to create a event loop that uses epoll and nothing else.</p> 420 <p>Example: Try to create a event loop that uses epoll and nothing else.</p>
371<pre> struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 421<pre> struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
372 if (!epoller) 422 if (!epoller)
373 fatal (&quot;no epoll found here, maybe it hides under your chair&quot;); 423 fatal (&quot;no epoll found here, maybe it hides under your chair&quot;);
374 424
375</pre> 425</pre>
… …
468 be handled here by queueing them when their watcher gets executed. 518 be handled here by queueing them when their watcher gets executed.
469 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 519 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
470 were used, return, otherwise continue with step *. 520 were used, return, otherwise continue with step *.
471 521
472</pre> 522</pre>
473 <p>Example: queue some jobs and then loop until no events are outsanding 523 <p>Example: Queue some jobs and then loop until no events are outsanding
474anymore.</p> 524anymore.</p>
475<pre> ... queue jobs here, make sure they register event watchers as long 525<pre> ... queue jobs here, make sure they register event watchers as long
476 ... as they still have work to do (even an idle watcher will do..) 526 ... as they still have work to do (even an idle watcher will do..)
477 ev_loop (my_loop, 0); 527 ev_loop (my_loop, 0);
478 ... jobs done. yeah! 528 ... jobs done. yeah!
… …
497example, libev itself uses this for its internal signal pipe: It is not 547example, libev itself uses this for its internal signal pipe: It is not
498visible to the libev user and should not keep <code>ev_loop</code> from exiting if 548visible to the libev user and should not keep <code>ev_loop</code> from exiting if
499no event watchers registered by it are active. It is also an excellent 549no event watchers registered by it are active. It is also an excellent
500way to do this for generic recurring timers or from within third-party 550way to do this for generic recurring timers or from within third-party
501libraries. Just remember to <i>unref after start</i> and <i>ref before stop</i>.</p> 551libraries. Just remember to <i>unref after start</i> and <i>ref before stop</i>.</p>
502 <p>Example: create a signal watcher, but keep it from keeping <code>ev_loop</code> 552 <p>Example: Create a signal watcher, but keep it from keeping <code>ev_loop</code>
503running when nothing else is active.</p> 553running when nothing else is active.</p>
504<pre> struct dv_signal exitsig; 554<pre> struct ev_signal exitsig;
505 ev_signal_init (&amp;exitsig, sig_cb, SIGINT); 555 ev_signal_init (&amp;exitsig, sig_cb, SIGINT);
506 ev_signal_start (myloop, &amp;exitsig); 556 ev_signal_start (loop, &amp;exitsig);
507 evf_unref (myloop); 557 evf_unref (loop);
508 558
509</pre> 559</pre>
510 <p>Example: for some weird reason, unregister the above signal handler again.</p> 560 <p>Example: For some weird reason, unregister the above signal handler again.</p>
511<pre> ev_ref (myloop); 561<pre> ev_ref (loop);
512 ev_signal_stop (myloop, &amp;exitsig); 562 ev_signal_stop (loop, &amp;exitsig);
513 563
514</pre> 564</pre>
515 </dd> 565 </dd>
516</dl> 566</dl>
517 567
568
569
570
571
518</div> 572</div>
519<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> 573<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1>
520<div id="ANATOMY_OF_A_WATCHER_CONTENT"> 574<div id="ANATOMY_OF_A_WATCHER_CONTENT">
521<p>A watcher is a structure that you create and register to record your 575<p>A watcher is a structure that you create and register to record your
522interest in some event. For instance, if you want to wait for STDIN to 576interest in some event. For instance, if you want to wait for STDIN to
523become readable, you would create an <code>ev_io</code> watcher for that:</p> 577become readable, you would create an <code>ev_io</code> watcher for that:</p>
524<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 578<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
… …
581 </dd> 635 </dd>
582 <dt><code>EV_CHILD</code></dt> 636 <dt><code>EV_CHILD</code></dt>
583 <dd> 637 <dd>
584 <p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p> 638 <p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p>
585 </dd> 639 </dd>
640 <dt><code>EV_STAT</code></dt>
641 <dd>
642 <p>The path specified in the <code>ev_stat</code> watcher changed its attributes somehow.</p>
643 </dd>
586 <dt><code>EV_IDLE</code></dt> 644 <dt><code>EV_IDLE</code></dt>
587 <dd> 645 <dd>
588 <p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p> 646 <p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p>
589 </dd> 647 </dd>
590 <dt><code>EV_PREPARE</code></dt> 648 <dt><code>EV_PREPARE</code></dt>
… …
595<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any 653<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any
596received events. Callbacks of both watcher types can start and stop as 654received events. Callbacks of both watcher types can start and stop as
597many watchers as they want, and all of them will be taken into account 655many watchers as they want, and all of them will be taken into account
598(for example, a <code>ev_prepare</code> watcher might start an idle watcher to keep 656(for example, a <code>ev_prepare</code> watcher might start an idle watcher to keep
599<code>ev_loop</code> from blocking).</p> 657<code>ev_loop</code> from blocking).</p>
658 </dd>
659 <dt><code>EV_EMBED</code></dt>
660 <dd>
661 <p>The embedded event loop specified in the <code>ev_embed</code> watcher needs attention.</p>
662 </dd>
663 <dt><code>EV_FORK</code></dt>
664 <dd>
665 <p>The event loop has been resumed in the child process after fork (see
666<code>ev_fork</code>).</p>
600 </dd> 667 </dd>
601 <dt><code>EV_ERROR</code></dt> 668 <dt><code>EV_ERROR</code></dt>
602 <dd> 669 <dd>
603 <p>An unspecified error has occured, the watcher has been stopped. This might 670 <p>An unspecified error has occured, the watcher has been stopped. This might
604happen because the watcher could not be properly started because libev 671happen because the watcher could not be properly started because libev
… …
612programs, though, so beware.</p> 679programs, though, so beware.</p>
613 </dd> 680 </dd>
614</dl> 681</dl>
615 682
616</div> 683</div>
617<h2 id="SUMMARY_OF_GENERIC_WATCHER_FUNCTIONS">SUMMARY OF GENERIC WATCHER FUNCTIONS</h2> 684<h2 id="GENERIC_WATCHER_FUNCTIONS">GENERIC WATCHER FUNCTIONS</h2>
618<div id="SUMMARY_OF_GENERIC_WATCHER_FUNCTIONS-2"> 685<div id="GENERIC_WATCHER_FUNCTIONS_CONTENT">
619<p>In the following description, <code>TYPE</code> stands for the watcher type, 686<p>In the following description, <code>TYPE</code> stands for the watcher type,
620e.g. <code>timer</code> for <code>ev_timer</code> watchers and <code>io</code> for <code>ev_io</code> watchers.</p> 687e.g. <code>timer</code> for <code>ev_timer</code> watchers and <code>io</code> for <code>ev_io</code> watchers.</p>
621<dl> 688<dl>
622 <dt><code>ev_init</code> (ev_TYPE *watcher, callback)</dt> 689 <dt><code>ev_init</code> (ev_TYPE *watcher, callback)</dt>
623 <dd> 690 <dd>
… …
627the type-specific <code>ev_TYPE_set</code> macro afterwards to initialise the 694the type-specific <code>ev_TYPE_set</code> macro afterwards to initialise the
628type-specific parts. For each type there is also a <code>ev_TYPE_init</code> macro 695type-specific parts. For each type there is also a <code>ev_TYPE_init</code> macro
629which rolls both calls into one.</p> 696which rolls both calls into one.</p>
630 <p>You can reinitialise a watcher at any time as long as it has been stopped 697 <p>You can reinitialise a watcher at any time as long as it has been stopped
631(or never started) and there are no pending events outstanding.</p> 698(or never started) and there are no pending events outstanding.</p>
632 <p>The callbakc is always of type <code>void (*)(ev_loop *loop, ev_TYPE *watcher, 699 <p>The callback is always of type <code>void (*)(ev_loop *loop, ev_TYPE *watcher,
633int revents)</code>.</p> 700int revents)</code>.</p>
634 </dd> 701 </dd>
635 <dt><code>ev_TYPE_set</code> (ev_TYPE *, [args])</dt> 702 <dt><code>ev_TYPE_set</code> (ev_TYPE *, [args])</dt>
636 <dd> 703 <dd>
637 <p>This macro initialises the type-specific parts of a watcher. You need to 704 <p>This macro initialises the type-specific parts of a watcher. You need to
… …
674events but its callback has not yet been invoked). As long as a watcher 741events but its callback has not yet been invoked). As long as a watcher
675is pending (but not active) you must not call an init function on it (but 742is pending (but not active) you must not call an init function on it (but
676<code>ev_TYPE_set</code> is safe) and you must make sure the watcher is available to 743<code>ev_TYPE_set</code> is safe) and you must make sure the watcher is available to
677libev (e.g. you cnanot <code>free ()</code> it).</p> 744libev (e.g. you cnanot <code>free ()</code> it).</p>
678 </dd> 745 </dd>
679 <dt>callback = ev_cb (ev_TYPE *watcher)</dt> 746 <dt>callback ev_cb (ev_TYPE *watcher)</dt>
680 <dd> 747 <dd>
681 <p>Returns the callback currently set on the watcher.</p> 748 <p>Returns the callback currently set on the watcher.</p>
682 </dd> 749 </dd>
683 <dt>ev_cb_set (ev_TYPE *watcher, callback)</dt> 750 <dt>ev_cb_set (ev_TYPE *watcher, callback)</dt>
684 <dd> 751 <dd>
… …
716 struct my_io *w = (struct my_io *)w_; 783 struct my_io *w = (struct my_io *)w_;
717 ... 784 ...
718 } 785 }
719 786
720</pre> 787</pre>
721<p>More interesting and less C-conformant ways of catsing your callback type 788<p>More interesting and less C-conformant ways of casting your callback type
722have been omitted....</p> 789instead have been omitted.</p>
790<p>Another common scenario is having some data structure with multiple
791watchers:</p>
792<pre> struct my_biggy
793 {
794 int some_data;
795 ev_timer t1;
796 ev_timer t2;
797 }
723 798
799</pre>
800<p>In this case getting the pointer to <code>my_biggy</code> is a bit more complicated,
801you need to use <code>offsetof</code>:</p>
802<pre> #include &lt;stddef.h&gt;
724 803
804 static void
805 t1_cb (EV_P_ struct ev_timer *w, int revents)
806 {
807 struct my_biggy big = (struct my_biggy *
808 (((char *)w) - offsetof (struct my_biggy, t1));
809 }
725 810
811 static void
812 t2_cb (EV_P_ struct ev_timer *w, int revents)
813 {
814 struct my_biggy big = (struct my_biggy *
815 (((char *)w) - offsetof (struct my_biggy, t2));
816 }
726 817
727 818
819
820
821</pre>
822
728</div> 823</div>
729<h1 id="WATCHER_TYPES">WATCHER TYPES</h1><p><a href="#TOP" class="toplink">Top</a></p> 824<h1 id="WATCHER_TYPES">WATCHER TYPES</h1>
730<div id="WATCHER_TYPES_CONTENT"> 825<div id="WATCHER_TYPES_CONTENT">
731<p>This section describes each watcher in detail, but will not repeat 826<p>This section describes each watcher in detail, but will not repeat
732information given in the last section.</p> 827information given in the last section. Any initialisation/set macros,
828functions and members specific to the watcher type are explained.</p>
829<p>Members are additionally marked with either <i>[read-only]</i>, meaning that,
830while the watcher is active, you can look at the member and expect some
831sensible content, but you must not modify it (you can modify it while the
832watcher is stopped to your hearts content), or <i>[read-write]</i>, which
833means you can expect it to have some sensible content while the watcher
834is active, but you can also modify it. Modifying it may not do something
835sensible or take immediate effect (or do anything at all), but libev will
836not crash or malfunction in any way.</p>
733 837
734 838
735 839
736 840
737 841
738</div> 842</div>
739<h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</h2> 843<h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable?</h2>
740<div id="code_ev_io_code_is_this_file_descrip-2"> 844<div id="code_ev_io_code_is_this_file_descrip-2">
741<p>I/O watchers check whether a file descriptor is readable or writable 845<p>I/O watchers check whether a file descriptor is readable or writable
742in each iteration of the event loop (This behaviour is called 846in each iteration of the event loop, or, more precisely, when reading
743level-triggering because you keep receiving events as long as the 847would not block the process and writing would at least be able to write
744condition persists. Remember you can stop the watcher if you don't want to 848some data. This behaviour is called level-triggering because you keep
745act on the event and neither want to receive future events).</p> 849receiving events as long as the condition persists. Remember you can stop
850the watcher if you don't want to act on the event and neither want to
851receive future events.</p>
746<p>In general you can register as many read and/or write event watchers per 852<p>In general you can register as many read and/or write event watchers per
747fd as you want (as long as you don't confuse yourself). Setting all file 853fd as you want (as long as you don't confuse yourself). Setting all file
748descriptors to non-blocking mode is also usually a good idea (but not 854descriptors to non-blocking mode is also usually a good idea (but not
749required if you know what you are doing).</p> 855required if you know what you are doing).</p>
750<p>You have to be careful with dup'ed file descriptors, though. Some backends 856<p>You have to be careful with dup'ed file descriptors, though. Some backends
751(the linux epoll backend is a notable example) cannot handle dup'ed file 857(the linux epoll backend is a notable example) cannot handle dup'ed file
752descriptors correctly if you register interest in two or more fds pointing 858descriptors correctly if you register interest in two or more fds pointing
753to the same underlying file/socket etc. description (that is, they share 859to the same underlying file/socket/etc. description (that is, they share
754the same underlying &quot;file open&quot;).</p> 860the same underlying &quot;file open&quot;).</p>
755<p>If you must do this, then force the use of a known-to-be-good backend 861<p>If you must do this, then force the use of a known-to-be-good backend
756(at the time of this writing, this includes only <code>EVBACKEND_SELECT</code> and 862(at the time of this writing, this includes only <code>EVBACKEND_SELECT</code> and
757<code>EVBACKEND_POLL</code>).</p> 863<code>EVBACKEND_POLL</code>).</p>
864<p>Another thing you have to watch out for is that it is quite easy to
865receive &quot;spurious&quot; readyness notifications, that is your callback might
866be called with <code>EV_READ</code> but a subsequent <code>read</code>(2) will actually block
867because there is no data. Not only are some backends known to create a
868lot of those (for example solaris ports), it is very easy to get into
869this situation even with a relatively standard program structure. Thus
870it is best to always use non-blocking I/O: An extra <code>read</code>(2) returning
871<code>EAGAIN</code> is far preferable to a program hanging until some data arrives.</p>
872<p>If you cannot run the fd in non-blocking mode (for example you should not
873play around with an Xlib connection), then you have to seperately re-test
874wether a file descriptor is really ready with a known-to-be good interface
875such as poll (fortunately in our Xlib example, Xlib already does this on
876its own, so its quite safe to use).</p>
758<dl> 877<dl>
759 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> 878 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>
760 <dt>ev_io_set (ev_io *, int fd, int events)</dt> 879 <dt>ev_io_set (ev_io *, int fd, int events)</dt>
761 <dd> 880 <dd>
762 <p>Configures an <code>ev_io</code> watcher. The fd is the file descriptor to rceeive 881 <p>Configures an <code>ev_io</code> watcher. The <code>fd</code> is the file descriptor to
763events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ | 882rceeive events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or
764EV_WRITE</code> to receive the given events.</p> 883<code>EV_READ | EV_WRITE</code> to receive the given events.</p>
765 <p>Please note that most of the more scalable backend mechanisms (for example 884 </dd>
766epoll and solaris ports) can result in spurious readyness notifications 885 <dt>int fd [read-only]</dt>
767for file descriptors, so you practically need to use non-blocking I/O (and 886 <dd>
768treat callback invocation as hint only), or retest separately with a safe 887 <p>The file descriptor being watched.</p>
769interface before doing I/O (XLib can do this), or force the use of either 888 </dd>
770<code>EVBACKEND_SELECT</code> or <code>EVBACKEND_POLL</code>, which don't suffer from this 889 <dt>int events [read-only]</dt>
771problem. Also note that it is quite easy to have your callback invoked 890 <dd>
772when the readyness condition is no longer valid even when employing 891 <p>The events being watched.</p>
773typical ways of handling events, so its a good idea to use non-blocking
774I/O unconditionally.</p>
775 </dd> 892 </dd>
776</dl> 893</dl>
777<p>Example: call <code>stdin_readable_cb</code> when STDIN_FILENO has become, well 894<p>Example: Call <code>stdin_readable_cb</code> when STDIN_FILENO has become, well
778readable, but only once. Since it is likely line-buffered, you could 895readable, but only once. Since it is likely line-buffered, you could
779attempt to read a whole line in the callback:</p> 896attempt to read a whole line in the callback.</p>
780<pre> static void 897<pre> static void
781 stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 898 stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
782 { 899 {
783 ev_io_stop (loop, w); 900 ev_io_stop (loop, w);
784 .. read from stdin here (or from w-&gt;fd) and haqndle any I/O errors 901 .. read from stdin here (or from w-&gt;fd) and haqndle any I/O errors
… …
795 912
796 913
797</pre> 914</pre>
798 915
799</div> 916</div>
800<h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2> 917<h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally repeating timeouts</h2>
801<div id="code_ev_timer_code_relative_and_opti-2"> 918<div id="code_ev_timer_code_relative_and_opti-2">
802<p>Timer watchers are simple relative timers that generate an event after a 919<p>Timer watchers are simple relative timers that generate an event after a
803given time, and optionally repeating in regular intervals after that.</p> 920given time, and optionally repeating in regular intervals after that.</p>
804<p>The timers are based on real time, that is, if you register an event that 921<p>The timers are based on real time, that is, if you register an event that
805times out after an hour and you reset your system clock to last years 922times out after an hour and you reset your system clock to last years
… …
837repeating. The exact semantics are:</p> 954repeating. The exact semantics are:</p>
838 <p>If the timer is started but nonrepeating, stop it.</p> 955 <p>If the timer is started but nonrepeating, stop it.</p>
839 <p>If the timer is repeating, either start it if necessary (with the repeat 956 <p>If the timer is repeating, either start it if necessary (with the repeat
840value), or reset the running timer to the repeat value.</p> 957value), or reset the running timer to the repeat value.</p>
841 <p>This sounds a bit complicated, but here is a useful and typical 958 <p>This sounds a bit complicated, but here is a useful and typical
842example: Imagine you have a tcp connection and you want a so-called idle 959example: Imagine you have a tcp connection and you want a so-called
843timeout, that is, you want to be called when there have been, say, 60 960idle timeout, that is, you want to be called when there have been,
844seconds of inactivity on the socket. The easiest way to do this is to 961say, 60 seconds of inactivity on the socket. The easiest way to do
845configure an <code>ev_timer</code> with after=repeat=60 and calling ev_timer_again each 962this is to configure an <code>ev_timer</code> with <code>after</code>=<code>repeat</code>=<code>60</code> and calling
846time you successfully read or write some data. If you go into an idle 963<code>ev_timer_again</code> each time you successfully read or write some data. If
847state where you do not expect data to travel on the socket, you can stop 964you go into an idle state where you do not expect data to travel on the
848the timer, and again will automatically restart it if need be.</p> 965socket, you can stop the timer, and again will automatically restart it if
966need be.</p>
967 <p>You can also ignore the <code>after</code> value and <code>ev_timer_start</code> altogether
968and only ever use the <code>repeat</code> value:</p>
969<pre> ev_timer_init (timer, callback, 0., 5.);
970 ev_timer_again (loop, timer);
971 ...
972 timer-&gt;again = 17.;
973 ev_timer_again (loop, timer);
974 ...
975 timer-&gt;again = 10.;
976 ev_timer_again (loop, timer);
977
978</pre>
979 <p>This is more efficient then stopping/starting the timer eahc time you want
980to modify its timeout value.</p>
981 </dd>
982 <dt>ev_tstamp repeat [read-write]</dt>
983 <dd>
984 <p>The current <code>repeat</code> value. Will be used each time the watcher times out
985or <code>ev_timer_again</code> is called and determines the next timeout (if any),
986which is also when any modifications are taken into account.</p>
849 </dd> 987 </dd>
850</dl> 988</dl>
851<p>Example: create a timer that fires after 60 seconds.</p> 989<p>Example: Create a timer that fires after 60 seconds.</p>
852<pre> static void 990<pre> static void
853 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 991 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
854 { 992 {
855 .. one minute over, w is actually stopped right here 993 .. one minute over, w is actually stopped right here
856 } 994 }
… …
858 struct ev_timer mytimer; 996 struct ev_timer mytimer;
859 ev_timer_init (&amp;mytimer, one_minute_cb, 60., 0.); 997 ev_timer_init (&amp;mytimer, one_minute_cb, 60., 0.);
860 ev_timer_start (loop, &amp;mytimer); 998 ev_timer_start (loop, &amp;mytimer);
861 999
862</pre> 1000</pre>
863<p>Example: create a timeout timer that times out after 10 seconds of 1001<p>Example: Create a timeout timer that times out after 10 seconds of
864inactivity.</p> 1002inactivity.</p>
865<pre> static void 1003<pre> static void
866 timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1004 timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
867 { 1005 {
868 .. ten seconds without any activity 1006 .. ten seconds without any activity
… …
881 1019
882 1020
883</pre> 1021</pre>
884 1022
885</div> 1023</div>
886<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</h2> 1024<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron?</h2>
887<div id="code_ev_periodic_code_to_cron_or_not-2"> 1025<div id="code_ev_periodic_code_to_cron_or_not-2">
888<p>Periodic watchers are also timers of a kind, but they are very versatile 1026<p>Periodic watchers are also timers of a kind, but they are very versatile
889(and unfortunately a bit complex).</p> 1027(and unfortunately a bit complex).</p>
890<p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time) 1028<p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time)
891but on wallclock time (absolute time). You can tell a periodic watcher 1029but on wallclock time (absolute time). You can tell a periodic watcher
… …
971 <p>Simply stops and restarts the periodic watcher again. This is only useful 1109 <p>Simply stops and restarts the periodic watcher again. This is only useful
972when you changed some parameters or the reschedule callback would return 1110when you changed some parameters or the reschedule callback would return
973a different time than the last time it was called (e.g. in a crond like 1111a different time than the last time it was called (e.g. in a crond like
974program when the crontabs have changed).</p> 1112program when the crontabs have changed).</p>
975 </dd> 1113 </dd>
1114 <dt>ev_tstamp interval [read-write]</dt>
1115 <dd>
1116 <p>The current interval value. Can be modified any time, but changes only
1117take effect when the periodic timer fires or <code>ev_periodic_again</code> is being
1118called.</p>
1119 </dd>
1120 <dt>ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]</dt>
1121 <dd>
1122 <p>The current reschedule callback, or <code>0</code>, if this functionality is
1123switched off. Can be changed any time, but changes only take effect when
1124the periodic timer fires or <code>ev_periodic_again</code> is being called.</p>
1125 </dd>
976</dl> 1126</dl>
977<p>Example: call a callback every hour, or, more precisely, whenever the 1127<p>Example: Call a callback every hour, or, more precisely, whenever the
978system clock is divisible by 3600. The callback invocation times have 1128system clock is divisible by 3600. The callback invocation times have
979potentially a lot of jittering, but good long-term stability.</p> 1129potentially a lot of jittering, but good long-term stability.</p>
980<pre> static void 1130<pre> static void
981 clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1131 clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
982 { 1132 {
… …
986 struct ev_periodic hourly_tick; 1136 struct ev_periodic hourly_tick;
987 ev_periodic_init (&amp;hourly_tick, clock_cb, 0., 3600., 0); 1137 ev_periodic_init (&amp;hourly_tick, clock_cb, 0., 3600., 0);
988 ev_periodic_start (loop, &amp;hourly_tick); 1138 ev_periodic_start (loop, &amp;hourly_tick);
989 1139
990</pre> 1140</pre>
991<p>Example: the same as above, but use a reschedule callback to do it:</p> 1141<p>Example: The same as above, but use a reschedule callback to do it:</p>
992<pre> #include &lt;math.h&gt; 1142<pre> #include &lt;math.h&gt;
993 1143
994 static ev_tstamp 1144 static ev_tstamp
995 my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 1145 my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
996 { 1146 {
… …
998 } 1148 }
999 1149
1000 ev_periodic_init (&amp;hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1150 ev_periodic_init (&amp;hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1001 1151
1002</pre> 1152</pre>
1003<p>Example: call a callback every hour, starting now:</p> 1153<p>Example: Call a callback every hour, starting now:</p>
1004<pre> struct ev_periodic hourly_tick; 1154<pre> struct ev_periodic hourly_tick;
1005 ev_periodic_init (&amp;hourly_tick, clock_cb, 1155 ev_periodic_init (&amp;hourly_tick, clock_cb,
1006 fmod (ev_now (loop), 3600.), 3600., 0); 1156 fmod (ev_now (loop), 3600.), 3600., 0);
1007 ev_periodic_start (loop, &amp;hourly_tick); 1157 ev_periodic_start (loop, &amp;hourly_tick);
1008 1158
… …
1010 1160
1011 1161
1012</pre> 1162</pre>
1013 1163
1014</div> 1164</div>
1015<h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</h2> 1165<h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled!</h2>
1016<div id="code_ev_signal_code_signal_me_when_a-2"> 1166<div id="code_ev_signal_code_signal_me_when_a-2">
1017<p>Signal watchers will trigger an event when the process receives a specific 1167<p>Signal watchers will trigger an event when the process receives a specific
1018signal one or more times. Even though signals are very asynchronous, libev 1168signal one or more times. Even though signals are very asynchronous, libev
1019will try it's best to deliver signals synchronously, i.e. as part of the 1169will try it's best to deliver signals synchronously, i.e. as part of the
1020normal event processing, like any other event.</p> 1170normal event processing, like any other event.</p>
… …
1029 <dt>ev_signal_set (ev_signal *, int signum)</dt> 1179 <dt>ev_signal_set (ev_signal *, int signum)</dt>
1030 <dd> 1180 <dd>
1031 <p>Configures the watcher to trigger on the given signal number (usually one 1181 <p>Configures the watcher to trigger on the given signal number (usually one
1032of the <code>SIGxxx</code> constants).</p> 1182of the <code>SIGxxx</code> constants).</p>
1033 </dd> 1183 </dd>
1184 <dt>int signum [read-only]</dt>
1185 <dd>
1186 <p>The signal the watcher watches out for.</p>
1187 </dd>
1034</dl> 1188</dl>
1035 1189
1036 1190
1037 1191
1038 1192
1039 1193
1040</div> 1194</div>
1041<h2 id="code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</h2> 1195<h2 id="code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</h2>
1042<div id="code_ev_child_code_wait_for_pid_stat-2"> 1196<div id="code_ev_child_code_watch_out_for_pro-2">
1043<p>Child watchers trigger when your process receives a SIGCHLD in response to 1197<p>Child watchers trigger when your process receives a SIGCHLD in response to
1044some child status changes (most typically when a child of yours dies).</p> 1198some child status changes (most typically when a child of yours dies).</p>
1045<dl> 1199<dl>
1046 <dt>ev_child_init (ev_child *, callback, int pid)</dt> 1200 <dt>ev_child_init (ev_child *, callback, int pid)</dt>
1047 <dt>ev_child_set (ev_child *, int pid)</dt> 1201 <dt>ev_child_set (ev_child *, int pid)</dt>
… …
1051at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see 1205at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see
1052the status word (use the macros from <code>sys/wait.h</code> and see your systems 1206the status word (use the macros from <code>sys/wait.h</code> and see your systems
1053<code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the 1207<code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the
1054process causing the status change.</p> 1208process causing the status change.</p>
1055 </dd> 1209 </dd>
1210 <dt>int pid [read-only]</dt>
1211 <dd>
1212 <p>The process id this watcher watches out for, or <code>0</code>, meaning any process id.</p>
1213 </dd>
1214 <dt>int rpid [read-write]</dt>
1215 <dd>
1216 <p>The process id that detected a status change.</p>
1217 </dd>
1218 <dt>int rstatus [read-write]</dt>
1219 <dd>
1220 <p>The process exit/trace status caused by <code>rpid</code> (see your systems
1221<code>waitpid</code> and <code>sys/wait.h</code> documentation for details).</p>
1222 </dd>
1056</dl> 1223</dl>
1057<p>Example: try to exit cleanly on SIGINT and SIGTERM.</p> 1224<p>Example: Try to exit cleanly on SIGINT and SIGTERM.</p>
1058<pre> static void 1225<pre> static void
1059 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1226 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1060 { 1227 {
1061 ev_unloop (loop, EVUNLOOP_ALL); 1228 ev_unloop (loop, EVUNLOOP_ALL);
1062 } 1229 }
… …
1069 1236
1070 1237
1071</pre> 1238</pre>
1072 1239
1073</div> 1240</div>
1241<h2 id="code_ev_stat_code_did_the_file_attri"><code>ev_stat</code> - did the file attributes just change?</h2>
1242<div id="code_ev_stat_code_did_the_file_attri-2">
1243<p>This watches a filesystem path for attribute changes. That is, it calls
1244<code>stat</code> regularly (or when the OS says it changed) and sees if it changed
1245compared to the last time, invoking the callback if it did.</p>
1246<p>The path does not need to exist: changing from &quot;path exists&quot; to &quot;path does
1247not exist&quot; is a status change like any other. The condition &quot;path does
1248not exist&quot; is signified by the <code>st_nlink</code> field being zero (which is
1249otherwise always forced to be at least one) and all the other fields of
1250the stat buffer having unspecified contents.</p>
1251<p>Since there is no standard to do this, the portable implementation simply
1252calls <code>stat (2)</code> regularly on the path to see if it changed somehow. You
1253can specify a recommended polling interval for this case. If you specify
1254a polling interval of <code>0</code> (highly recommended!) then a <i>suitable,
1255unspecified default</i> value will be used (which you can expect to be around
1256five seconds, although this might change dynamically). Libev will also
1257impose a minimum interval which is currently around <code>0.1</code>, but thats
1258usually overkill.</p>
1259<p>This watcher type is not meant for massive numbers of stat watchers,
1260as even with OS-supported change notifications, this can be
1261resource-intensive.</p>
1262<p>At the time of this writing, only the Linux inotify interface is
1263implemented (implementing kqueue support is left as an exercise for the
1264reader). Inotify will be used to give hints only and should not change the
1265semantics of <code>ev_stat</code> watchers, which means that libev sometimes needs
1266to fall back to regular polling again even with inotify, but changes are
1267usually detected immediately, and if the file exists there will be no
1268polling.</p>
1269<dl>
1270 <dt>ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)</dt>
1271 <dt>ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)</dt>
1272 <dd>
1273 <p>Configures the watcher to wait for status changes of the given
1274<code>path</code>. The <code>interval</code> is a hint on how quickly a change is expected to
1275be detected and should normally be specified as <code>0</code> to let libev choose
1276a suitable value. The memory pointed to by <code>path</code> must point to the same
1277path for as long as the watcher is active.</p>
1278 <p>The callback will be receive <code>EV_STAT</code> when a change was detected,
1279relative to the attributes at the time the watcher was started (or the
1280last change was detected).</p>
1281 </dd>
1282 <dt>ev_stat_stat (ev_stat *)</dt>
1283 <dd>
1284 <p>Updates the stat buffer immediately with new values. If you change the
1285watched path in your callback, you could call this fucntion to avoid
1286detecting this change (while introducing a race condition). Can also be
1287useful simply to find out the new values.</p>
1288 </dd>
1289 <dt>ev_statdata attr [read-only]</dt>
1290 <dd>
1291 <p>The most-recently detected attributes of the file. Although the type is of
1292<code>ev_statdata</code>, this is usually the (or one of the) <code>struct stat</code> types
1293suitable for your system. If the <code>st_nlink</code> member is <code>0</code>, then there
1294was some error while <code>stat</code>ing the file.</p>
1295 </dd>
1296 <dt>ev_statdata prev [read-only]</dt>
1297 <dd>
1298 <p>The previous attributes of the file. The callback gets invoked whenever
1299<code>prev</code> != <code>attr</code>.</p>
1300 </dd>
1301 <dt>ev_tstamp interval [read-only]</dt>
1302 <dd>
1303 <p>The specified interval.</p>
1304 </dd>
1305 <dt>const char *path [read-only]</dt>
1306 <dd>
1307 <p>The filesystem path that is being watched.</p>
1308 </dd>
1309</dl>
1310<p>Example: Watch <code>/etc/passwd</code> for attribute changes.</p>
1311<pre> static void
1312 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1313 {
1314 /* /etc/passwd changed in some way */
1315 if (w-&gt;attr.st_nlink)
1316 {
1317 printf (&quot;passwd current size %ld\n&quot;, (long)w-&gt;attr.st_size);
1318 printf (&quot;passwd current atime %ld\n&quot;, (long)w-&gt;attr.st_mtime);
1319 printf (&quot;passwd current mtime %ld\n&quot;, (long)w-&gt;attr.st_mtime);
1320 }
1321 else
1322 /* you shalt not abuse printf for puts */
1323 puts (&quot;wow, /etc/passwd is not there, expect problems. &quot;
1324 &quot;if this is windows, they already arrived\n&quot;);
1325 }
1326
1327 ...
1328 ev_stat passwd;
1329
1330 ev_stat_init (&amp;passwd, passwd_cb, &quot;/etc/passwd&quot;);
1331 ev_stat_start (loop, &amp;passwd);
1332
1333
1334
1335
1336</pre>
1337
1338</div>
1074<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</h2> 1339<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</h2>
1075<div id="code_ev_idle_code_when_you_ve_got_no-2"> 1340<div id="code_ev_idle_code_when_you_ve_got_no-2">
1076<p>Idle watchers trigger events when there are no other events are pending 1341<p>Idle watchers trigger events when there are no other events are pending
1077(prepare, check and other idle watchers do not count). That is, as long 1342(prepare, check and other idle watchers do not count). That is, as long
1078as your process is busy handling sockets or timeouts (or even signals, 1343as your process is busy handling sockets or timeouts (or even signals,
1079imagine) it will not be triggered. But when your process is idle all idle 1344imagine) it will not be triggered. But when your process is idle all idle
… …
1092 <p>Initialises and configures the idle watcher - it has no parameters of any 1357 <p>Initialises and configures the idle watcher - it has no parameters of any
1093kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless, 1358kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless,
1094believe me.</p> 1359believe me.</p>
1095 </dd> 1360 </dd>
1096</dl> 1361</dl>
1097<p>Example: dynamically allocate an <code>ev_idle</code>, start it, and in the 1362<p>Example: Dynamically allocate an <code>ev_idle</code> watcher, start it, and in the
1098callback, free it. Alos, use no error checking, as usual.</p> 1363callback, free it. Also, use no error checking, as usual.</p>
1099<pre> static void 1364<pre> static void
1100 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1365 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1101 { 1366 {
1102 free (w); 1367 free (w);
1103 // now do something you wanted to do when the program has 1368 // now do something you wanted to do when the program has
… …
1112 1377
1113 1378
1114</pre> 1379</pre>
1115 1380
1116</div> 1381</div>
1117<h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2> 1382<h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop!</h2>
1118<div id="code_ev_prepare_code_and_code_ev_che-2"> 1383<div id="code_ev_prepare_code_and_code_ev_che-2">
1119<p>Prepare and check watchers are usually (but not always) used in tandem: 1384<p>Prepare and check watchers are usually (but not always) used in tandem:
1120prepare watchers get invoked before the process blocks and check watchers 1385prepare watchers get invoked before the process blocks and check watchers
1121afterwards.</p> 1386afterwards.</p>
1387<p>You <i>must not</i> call <code>ev_loop</code> or similar functions that enter
1388the current event loop from either <code>ev_prepare</code> or <code>ev_check</code>
1389watchers. Other loops than the current one are fine, however. The
1390rationale behind this is that you do not need to check for recursion in
1391those watchers, i.e. the sequence will always be <code>ev_prepare</code>, blocking,
1392<code>ev_check</code> so if you have one watcher of each kind they will always be
1393called in pairs bracketing the blocking call.</p>
1122<p>Their main purpose is to integrate other event mechanisms into libev and 1394<p>Their main purpose is to integrate other event mechanisms into libev and
1123their use is somewhat advanced. This could be used, for example, to track 1395their use is somewhat advanced. This could be used, for example, to track
1124variable changes, implement your own watchers, integrate net-snmp or a 1396variable changes, implement your own watchers, integrate net-snmp or a
1125coroutine library and lots more.</p> 1397coroutine library and lots more. They are also occasionally useful if
1398you cache some data and want to flush it before blocking (for example,
1399in X programs you might want to do an <code>XFlush ()</code> in an <code>ev_prepare</code>
1400watcher).</p>
1126<p>This is done by examining in each prepare call which file descriptors need 1401<p>This is done by examining in each prepare call which file descriptors need
1127to be watched by the other library, registering <code>ev_io</code> watchers for 1402to be watched by the other library, registering <code>ev_io</code> watchers for
1128them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries 1403them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries
1129provide just this functionality). Then, in the check watcher you check for 1404provide just this functionality). Then, in the check watcher you check for
1130any events that occured (by checking the pending status of all watchers 1405any events that occured (by checking the pending status of all watchers
… …
1146 <p>Initialises and configures the prepare or check watcher - they have no 1421 <p>Initialises and configures the prepare or check watcher - they have no
1147parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> 1422parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code>
1148macros, but using them is utterly, utterly and completely pointless.</p> 1423macros, but using them is utterly, utterly and completely pointless.</p>
1149 </dd> 1424 </dd>
1150</dl> 1425</dl>
1151<p>Example: *TODO*.</p> 1426<p>Example: To include a library such as adns, you would add IO watchers
1427and a timeout watcher in a prepare handler, as required by libadns, and
1428in a check watcher, destroy them and call into libadns. What follows is
1429pseudo-code only of course:</p>
1430<pre> static ev_io iow [nfd];
1431 static ev_timer tw;
1152 1432
1433 static void
1434 io_cb (ev_loop *loop, ev_io *w, int revents)
1435 {
1436 // set the relevant poll flags
1437 // could also call adns_processreadable etc. here
1438 struct pollfd *fd = (struct pollfd *)w-&gt;data;
1439 if (revents &amp; EV_READ ) fd-&gt;revents |= fd-&gt;events &amp; POLLIN;
1440 if (revents &amp; EV_WRITE) fd-&gt;revents |= fd-&gt;events &amp; POLLOUT;
1441 }
1153 1442
1443 // create io watchers for each fd and a timer before blocking
1444 static void
1445 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1446 {
1447 int timeout = 3600000;truct pollfd fds [nfd];
1448 // actual code will need to loop here and realloc etc.
1449 adns_beforepoll (ads, fds, &amp;nfd, &amp;timeout, timeval_from (ev_time ()));
1154 1450
1451 /* the callback is illegal, but won't be called as we stop during check */
1452 ev_timer_init (&amp;tw, 0, timeout * 1e-3);
1453 ev_timer_start (loop, &amp;tw);
1155 1454
1455 // create on ev_io per pollfd
1456 for (int i = 0; i &lt; nfd; ++i)
1457 {
1458 ev_io_init (iow + i, io_cb, fds [i].fd,
1459 ((fds [i].events &amp; POLLIN ? EV_READ : 0)
1460 | (fds [i].events &amp; POLLOUT ? EV_WRITE : 0)));
1156 1461
1462 fds [i].revents = 0;
1463 iow [i].data = fds + i;
1464 ev_io_start (loop, iow + i);
1465 }
1466 }
1467
1468 // stop all watchers after blocking
1469 static void
1470 adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1471 {
1472 ev_timer_stop (loop, &amp;tw);
1473
1474 for (int i = 0; i &lt; nfd; ++i)
1475 ev_io_stop (loop, iow + i);
1476
1477 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1478 }
1479
1480
1481
1482
1483</pre>
1484
1157</div> 1485</div>
1158<h2 id="code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough</h2> 1486<h2 id="code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough...</h2>
1159<div id="code_ev_embed_code_when_one_backend_-2"> 1487<div id="code_ev_embed_code_when_one_backend_-2">
1160<p>This is a rather advanced watcher type that lets you embed one event loop 1488<p>This is a rather advanced watcher type that lets you embed one event loop
1161into another (currently only <code>ev_io</code> events are supported in the embedded 1489into another (currently only <code>ev_io</code> events are supported in the embedded
1162loop, other types of watchers might be handled in a delayed or incorrect 1490loop, other types of watchers might be handled in a delayed or incorrect
1163fashion and must not be used).</p> 1491fashion and must not be used).</p>
… …
1231 <dd> 1559 <dd>
1232 <p>Make a single, non-blocking sweep over the embedded loop. This works 1560 <p>Make a single, non-blocking sweep over the embedded loop. This works
1233similarly to <code>ev_loop (embedded_loop, EVLOOP_NONBLOCK)</code>, but in the most 1561similarly to <code>ev_loop (embedded_loop, EVLOOP_NONBLOCK)</code>, but in the most
1234apropriate way for embedded loops.</p> 1562apropriate way for embedded loops.</p>
1235 </dd> 1563 </dd>
1564 <dt>struct ev_loop *loop [read-only]</dt>
1565 <dd>
1566 <p>The embedded event loop.</p>
1567 </dd>
1236</dl> 1568</dl>
1237 1569
1238 1570
1239 1571
1240 1572
1241 1573
1242</div> 1574</div>
1243<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 1575<h2 id="code_ev_fork_code_the_audacity_to_re"><code>ev_fork</code> - the audacity to resume the event loop after a fork</h2>
1576<div id="code_ev_fork_code_the_audacity_to_re-2">
1577<p>Fork watchers are called when a <code>fork ()</code> was detected (usually because
1578whoever is a good citizen cared to tell libev about it by calling
1579<code>ev_default_fork</code> or <code>ev_loop_fork</code>). The invocation is done before the
1580event loop blocks next and before <code>ev_check</code> watchers are being called,
1581and only in the child after the fork. If whoever good citizen calling
1582<code>ev_default_fork</code> cheats and calls it in the wrong process, the fork
1583handlers will be invoked, too, of course.</p>
1584<dl>
1585 <dt>ev_fork_init (ev_signal *, callback)</dt>
1586 <dd>
1587 <p>Initialises and configures the fork watcher - it has no parameters of any
1588kind. There is a <code>ev_fork_set</code> macro, but using it is utterly pointless,
1589believe me.</p>
1590 </dd>
1591</dl>
1592
1593
1594
1595
1596
1597</div>
1598<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1>
1244<div id="OTHER_FUNCTIONS_CONTENT"> 1599<div id="OTHER_FUNCTIONS_CONTENT">
1245<p>There are some other functions of possible interest. Described. Here. Now.</p> 1600<p>There are some other functions of possible interest. Described. Here. Now.</p>
1246<dl> 1601<dl>
1247 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> 1602 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt>
1248 <dd> 1603 <dd>
… …
1295 1650
1296 1651
1297 1652
1298 1653
1299</div> 1654</div>
1300<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1><p><a href="#TOP" class="toplink">Top</a></p> 1655<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1>
1301<div id="LIBEVENT_EMULATION_CONTENT"> 1656<div id="LIBEVENT_EMULATION_CONTENT">
1302<p>Libev offers a compatibility emulation layer for libevent. It cannot 1657<p>Libev offers a compatibility emulation layer for libevent. It cannot
1303emulate the internals of libevent, so here are some usage hints:</p> 1658emulate the internals of libevent, so here are some usage hints:</p>
1304<dl> 1659<dl>
1305 <dt>* Use it by including &lt;event.h&gt;, as usual.</dt> 1660 <dt>* Use it by including &lt;event.h&gt;, as usual.</dt>
… …
1315 <dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need 1670 <dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need
1316to use the libev header file and library.</dt> 1671to use the libev header file and library.</dt>
1317</dl> 1672</dl>
1318 1673
1319</div> 1674</div>
1320<h1 id="C_SUPPORT">C++ SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p> 1675<h1 id="C_SUPPORT">C++ SUPPORT</h1>
1321<div id="C_SUPPORT_CONTENT"> 1676<div id="C_SUPPORT_CONTENT">
1322<p>Libev comes with some simplistic wrapper classes for C++ that mainly allow 1677<p>Libev comes with some simplistic wrapper classes for C++ that mainly allow
1323you to use some convinience methods to start/stop watchers and also change 1678you to use some convinience methods to start/stop watchers and also change
1324the callback model to a model using method callbacks on objects.</p> 1679the callback model to a model using method callbacks on objects.</p>
1325<p>To use it,</p> 1680<p>To use it,</p>
… …
1389 </dd> 1744 </dd>
1390 <dt>w-&gt;sweep () <code>ev::embed</code> only</dt> 1745 <dt>w-&gt;sweep () <code>ev::embed</code> only</dt>
1391 <dd> 1746 <dd>
1392 <p>Invokes <code>ev_embed_sweep</code>.</p> 1747 <p>Invokes <code>ev_embed_sweep</code>.</p>
1393 </dd> 1748 </dd>
1749 <dt>w-&gt;update () <code>ev::stat</code> only</dt>
1750 <dd>
1751 <p>Invokes <code>ev_stat_stat</code>.</p>
1752 </dd>
1394 </dl> 1753 </dl>
1395 </p> 1754 </p>
1396 </dd> 1755 </dd>
1397</dl> 1756</dl>
1398<p>Example: Define a class with an IO and idle watcher, start one of them in 1757<p>Example: Define a class with an IO and idle watcher, start one of them in
… …
1410 idle (this, &amp;myclass::idle_cb) 1769 idle (this, &amp;myclass::idle_cb)
1411 { 1770 {
1412 io.start (fd, ev::READ); 1771 io.start (fd, ev::READ);
1413 } 1772 }
1414 1773
1415</pre>
1416 1774
1775
1776
1777</pre>
1778
1417</div> 1779</div>
1418<h1 id="EMBEDDING">EMBEDDING</h1><p><a href="#TOP" class="toplink">Top</a></p> 1780<h1 id="MACRO_MAGIC">MACRO MAGIC</h1>
1781<div id="MACRO_MAGIC_CONTENT">
1782<p>Libev can be compiled with a variety of options, the most fundemantal is
1783<code>EV_MULTIPLICITY</code>. This option determines wether (most) functions and
1784callbacks have an initial <code>struct ev_loop *</code> argument.</p>
1785<p>To make it easier to write programs that cope with either variant, the
1786following macros are defined:</p>
1787<dl>
1788 <dt><code>EV_A</code>, <code>EV_A_</code></dt>
1789 <dd>
1790 <p>This provides the loop <i>argument</i> for functions, if one is required (&quot;ev
1791loop argument&quot;). The <code>EV_A</code> form is used when this is the sole argument,
1792<code>EV_A_</code> is used when other arguments are following. Example:</p>
1793<pre> ev_unref (EV_A);
1794 ev_timer_add (EV_A_ watcher);
1795 ev_loop (EV_A_ 0);
1796
1797</pre>
1798 <p>It assumes the variable <code>loop</code> of type <code>struct ev_loop *</code> is in scope,
1799which is often provided by the following macro.</p>
1800 </dd>
1801 <dt><code>EV_P</code>, <code>EV_P_</code></dt>
1802 <dd>
1803 <p>This provides the loop <i>parameter</i> for functions, if one is required (&quot;ev
1804loop parameter&quot;). The <code>EV_P</code> form is used when this is the sole parameter,
1805<code>EV_P_</code> is used when other parameters are following. Example:</p>
1806<pre> // this is how ev_unref is being declared
1807 static void ev_unref (EV_P);
1808
1809 // this is how you can declare your typical callback
1810 static void cb (EV_P_ ev_timer *w, int revents)
1811
1812</pre>
1813 <p>It declares a parameter <code>loop</code> of type <code>struct ev_loop *</code>, quite
1814suitable for use with <code>EV_A</code>.</p>
1815 </dd>
1816 <dt><code>EV_DEFAULT</code>, <code>EV_DEFAULT_</code></dt>
1817 <dd>
1818 <p>Similar to the other two macros, this gives you the value of the default
1819loop, if multiple loops are supported (&quot;ev loop default&quot;).</p>
1820 </dd>
1821</dl>
1822<p>Example: Declare and initialise a check watcher, working regardless of
1823wether multiple loops are supported or not.</p>
1824<pre> static void
1825 check_cb (EV_P_ ev_timer *w, int revents)
1826 {
1827 ev_check_stop (EV_A_ w);
1828 }
1829
1830 ev_check check;
1831 ev_check_init (&amp;check, check_cb);
1832 ev_check_start (EV_DEFAULT_ &amp;check);
1833 ev_loop (EV_DEFAULT_ 0);
1834
1835
1836
1837
1838</pre>
1839
1840</div>
1841<h1 id="EMBEDDING">EMBEDDING</h1>
1419<div id="EMBEDDING_CONTENT"> 1842<div id="EMBEDDING_CONTENT">
1420<p>Libev can (and often is) directly embedded into host 1843<p>Libev can (and often is) directly embedded into host
1421applications. Examples of applications that embed it include the Deliantra 1844applications. Examples of applications that embed it include the Deliantra
1422Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) 1845Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
1423and rxvt-unicode.</p> 1846and rxvt-unicode.</p>
… …
1460 ev_vars.h 1883 ev_vars.h
1461 ev_wrap.h 1884 ev_wrap.h
1462 1885
1463 ev_win32.c required on win32 platforms only 1886 ev_win32.c required on win32 platforms only
1464 1887
1465 ev_select.c only when select backend is enabled (which is is by default) 1888 ev_select.c only when select backend is enabled (which is by default)
1466 ev_poll.c only when poll backend is enabled (disabled by default) 1889 ev_poll.c only when poll backend is enabled (disabled by default)
1467 ev_epoll.c only when the epoll backend is enabled (disabled by default) 1890 ev_epoll.c only when the epoll backend is enabled (disabled by default)
1468 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 1891 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1469 ev_port.c only when the solaris port backend is enabled (disabled by default) 1892 ev_port.c only when the solaris port backend is enabled (disabled by default)
1470 1893
1471</pre> 1894</pre>
1472<p><cite>ev.c</cite> includes the backend files directly when enabled, so you only need 1895<p><cite>ev.c</cite> includes the backend files directly when enabled, so you only need
1473to compile a single file.</p> 1896to compile this single file.</p>
1474 1897
1475</div> 1898</div>
1476<h3 id="LIBEVENT_COMPATIBILITY_API">LIBEVENT COMPATIBILITY API</h3> 1899<h3 id="LIBEVENT_COMPATIBILITY_API">LIBEVENT COMPATIBILITY API</h3>
1477<div id="LIBEVENT_COMPATIBILITY_API_CONTENT"> 1900<div id="LIBEVENT_COMPATIBILITY_API_CONTENT">
1478<p>To include the libevent compatibility API, also include:</p> 1901<p>To include the libevent compatibility API, also include:</p>
… …
1493</div> 1916</div>
1494<h3 id="AUTOCONF_SUPPORT">AUTOCONF SUPPORT</h3> 1917<h3 id="AUTOCONF_SUPPORT">AUTOCONF SUPPORT</h3>
1495<div id="AUTOCONF_SUPPORT_CONTENT"> 1918<div id="AUTOCONF_SUPPORT_CONTENT">
1496<p>Instead of using <code>EV_STANDALONE=1</code> and providing your config in 1919<p>Instead of using <code>EV_STANDALONE=1</code> and providing your config in
1497whatever way you want, you can also <code>m4_include([libev.m4])</code> in your 1920whatever way you want, you can also <code>m4_include([libev.m4])</code> in your
1498<cite>configure.ac</cite> and leave <code>EV_STANDALONE</code> off. <cite>ev.c</cite> will then include 1921<cite>configure.ac</cite> and leave <code>EV_STANDALONE</code> undefined. <cite>ev.c</cite> will then
1499<cite>config.h</cite> and configure itself accordingly.</p> 1922include <cite>config.h</cite> and configure itself accordingly.</p>
1500<p>For this of course you need the m4 file:</p> 1923<p>For this of course you need the m4 file:</p>
1501<pre> libev.m4 1924<pre> libev.m4
1502 1925
1503</pre> 1926</pre>
1504 1927
… …
1583otherwise another method will be used as fallback. This is the preferred 2006otherwise another method will be used as fallback. This is the preferred
1584backend for BSD and BSD-like systems, although on most BSDs kqueue only 2007backend for BSD and BSD-like systems, although on most BSDs kqueue only
1585supports some types of fds correctly (the only platform we found that 2008supports some types of fds correctly (the only platform we found that
1586supports ptys for example was NetBSD), so kqueue might be compiled in, but 2009supports ptys for example was NetBSD), so kqueue might be compiled in, but
1587not be used unless explicitly requested. The best way to use it is to find 2010not be used unless explicitly requested. The best way to use it is to find
1588out wether kqueue supports your type of fd properly and use an embedded 2011out whether kqueue supports your type of fd properly and use an embedded
1589kqueue loop.</p> 2012kqueue loop.</p>
1590 </dd> 2013 </dd>
1591 <dt>EV_USE_PORT</dt> 2014 <dt>EV_USE_PORT</dt>
1592 <dd> 2015 <dd>
1593 <p>If defined to be <code>1</code>, libev will compile in support for the Solaris 2016 <p>If defined to be <code>1</code>, libev will compile in support for the Solaris
… …
1596backend for Solaris 10 systems.</p> 2019backend for Solaris 10 systems.</p>
1597 </dd> 2020 </dd>
1598 <dt>EV_USE_DEVPOLL</dt> 2021 <dt>EV_USE_DEVPOLL</dt>
1599 <dd> 2022 <dd>
1600 <p>reserved for future expansion, works like the USE symbols above.</p> 2023 <p>reserved for future expansion, works like the USE symbols above.</p>
2024 </dd>
2025 <dt>EV_USE_INOTIFY</dt>
2026 <dd>
2027 <p>If defined to be <code>1</code>, libev will compile in support for the Linux inotify
2028interface to speed up <code>ev_stat</code> watchers. Its actual availability will
2029be detected at runtime.</p>
1601 </dd> 2030 </dd>
1602 <dt>EV_H</dt> 2031 <dt>EV_H</dt>
1603 <dd> 2032 <dd>
1604 <p>The name of the <cite>ev.h</cite> header file used to include it. The default if 2033 <p>The name of the <cite>ev.h</cite> header file used to include it. The default if
1605undefined is <code>&lt;ev.h&gt;</code> in <cite>event.h</cite> and <code>&quot;ev.h&quot;</code> in <cite>ev.c</cite>. This 2034undefined is <code>&lt;ev.h&gt;</code> in <cite>event.h</cite> and <code>&quot;ev.h&quot;</code> in <cite>ev.c</cite>. This
… …
1629will have the <code>struct ev_loop *</code> as first argument, and you can create 2058will have the <code>struct ev_loop *</code> as first argument, and you can create
1630additional independent event loops. Otherwise there will be no support 2059additional independent event loops. Otherwise there will be no support
1631for multiple event loops and there is no first event loop pointer 2060for multiple event loops and there is no first event loop pointer
1632argument. Instead, all functions act on the single default loop.</p> 2061argument. Instead, all functions act on the single default loop.</p>
1633 </dd> 2062 </dd>
1634 <dt>EV_PERIODICS</dt> 2063 <dt>EV_PERIODIC_ENABLE</dt>
1635 <dd> 2064 <dd>
1636 <p>If undefined or defined to be <code>1</code>, then periodic timers are supported, 2065 <p>If undefined or defined to be <code>1</code>, then periodic timers are supported. If
1637otherwise not. This saves a few kb of code.</p> 2066defined to be <code>0</code>, then they are not. Disabling them saves a few kB of
2067code.</p>
2068 </dd>
2069 <dt>EV_EMBED_ENABLE</dt>
2070 <dd>
2071 <p>If undefined or defined to be <code>1</code>, then embed watchers are supported. If
2072defined to be <code>0</code>, then they are not.</p>
2073 </dd>
2074 <dt>EV_STAT_ENABLE</dt>
2075 <dd>
2076 <p>If undefined or defined to be <code>1</code>, then stat watchers are supported. If
2077defined to be <code>0</code>, then they are not.</p>
2078 </dd>
2079 <dt>EV_FORK_ENABLE</dt>
2080 <dd>
2081 <p>If undefined or defined to be <code>1</code>, then fork watchers are supported. If
2082defined to be <code>0</code>, then they are not.</p>
2083 </dd>
2084 <dt>EV_MINIMAL</dt>
2085 <dd>
2086 <p>If you need to shave off some kilobytes of code at the expense of some
2087speed, define this symbol to <code>1</code>. Currently only used for gcc to override
2088some inlining decisions, saves roughly 30% codesize of amd64.</p>
2089 </dd>
2090 <dt>EV_PID_HASHSIZE</dt>
2091 <dd>
2092 <p><code>ev_child</code> watchers use a small hash table to distribute workload by
2093pid. The default size is <code>16</code> (or <code>1</code> with <code>EV_MINIMAL</code>), usually more
2094than enough. If you need to manage thousands of children you might want to
2095increase this value (<i>must</i> be a power of two).</p>
2096 </dd>
2097 <dt>EV_INOTIFY_HASHSIZE</dt>
2098 <dd>
2099 <p><code>ev_staz</code> watchers use a small hash table to distribute workload by
2100inotify watch id. The default size is <code>16</code> (or <code>1</code> with <code>EV_MINIMAL</code>),
2101usually more than enough. If you need to manage thousands of <code>ev_stat</code>
2102watchers you might want to increase this value (<i>must</i> be a power of
2103two).</p>
1638 </dd> 2104 </dd>
1639 <dt>EV_COMMON</dt> 2105 <dt>EV_COMMON</dt>
1640 <dd> 2106 <dd>
1641 <p>By default, all watchers have a <code>void *data</code> member. By redefining 2107 <p>By default, all watchers have a <code>void *data</code> member. By redefining
1642this macro to a something else you can include more and other types of 2108this macro to a something else you can include more and other types of
… …
1647 SV *self; /* contains this struct */ \ 2113 SV *self; /* contains this struct */ \
1648 SV *cb_sv, *fh /* note no trailing &quot;;&quot; */ 2114 SV *cb_sv, *fh /* note no trailing &quot;;&quot; */
1649 2115
1650</pre> 2116</pre>
1651 </dd> 2117 </dd>
1652 <dt>EV_CB_DECLARE(type)</dt> 2118 <dt>EV_CB_DECLARE (type)</dt>
1653 <dt>EV_CB_INVOKE(watcher,revents)</dt> 2119 <dt>EV_CB_INVOKE (watcher, revents)</dt>
1654 <dt>ev_set_cb(ev,cb)</dt> 2120 <dt>ev_set_cb (ev, cb)</dt>
1655 <dd> 2121 <dd>
1656 <p>Can be used to change the callback member declaration in each watcher, 2122 <p>Can be used to change the callback member declaration in each watcher,
1657and the way callbacks are invoked and set. Must expand to a struct member 2123and the way callbacks are invoked and set. Must expand to a struct member
1658definition and a statement, respectively. See the <cite>ev.v</cite> header file for 2124definition and a statement, respectively. See the <cite>ev.v</cite> header file for
1659their default definitions. One possible use for overriding these is to 2125their default definitions. One possible use for overriding these is to
1660avoid the ev_loop pointer as first argument in all cases, or to use method 2126avoid the <code>struct ev_loop *</code> as first argument in all cases, or to use
1661calls instead of plain function calls in C++.</p> 2127method calls instead of plain function calls in C++.</p>
1662 2128
1663</div> 2129</div>
1664<h2 id="EXAMPLES">EXAMPLES</h2> 2130<h2 id="EXAMPLES">EXAMPLES</h2>
1665<div id="EXAMPLES_CONTENT"> 2131<div id="EXAMPLES_CONTENT">
1666 <p>For a real-world example of a program the includes libev 2132 <p>For a real-world example of a program the includes libev
… …
1682</pre> 2148</pre>
1683 <p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p> 2149 <p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p>
1684<pre> #include &quot;ev_cpp.h&quot; 2150<pre> #include &quot;ev_cpp.h&quot;
1685 #include &quot;ev.c&quot; 2151 #include &quot;ev.c&quot;
1686 2152
1687</pre>
1688 2153
2154
2155
2156</pre>
2157
1689</div> 2158</div>
1690<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> 2159<h1 id="COMPLEXITIES">COMPLEXITIES</h1>
2160<div id="COMPLEXITIES_CONTENT">
2161 <p>In this section the complexities of (many of) the algorithms used inside
2162libev will be explained. For complexity discussions about backends see the
2163documentation for <code>ev_default_init</code>.</p>
2164 <p>
2165 <dl>
2166 <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt>
2167 <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt>
2168 <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt>
2169 <dt>Stopping check/prepare/idle watchers: O(1)</dt>
2170 <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))</dt>
2171 <dt>Finding the next timer per loop iteration: O(1)</dt>
2172 <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt>
2173 <dt>Activating one watcher: O(1)</dt>
2174 </dl>
2175 </p>
2176
2177
2178
2179
2180
2181</div>
2182<h1 id="AUTHOR">AUTHOR</h1>
1691<div id="AUTHOR_CONTENT"> 2183<div id="AUTHOR_CONTENT">
1692 <p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p> 2184 <p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p>
1693 2185
1694</div> 2186</div>
1695</div></body> 2187</div></body>

Diff Legend

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