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

Comparing libev/ev.html (file contents):
Revision 1.50 by root, Tue Nov 27 10:59:11 2007 UTC vs.
Revision 1.58 by root, Wed Nov 28 11:31:34 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="Tue Nov 27 11:59:06 2007" /> 9 <meta name="created" content="Wed Nov 28 12:31:29 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>
… …
59<li><a href="#AUTHOR">AUTHOR</a> 60<li><a href="#AUTHOR">AUTHOR</a>
60</li> 61</li>
61</ul><hr /> 62</ul><hr />
62<!-- INDEX END --> 63<!-- INDEX END -->
63 64
64<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p> 65<h1 id="NAME">NAME</h1>
65<div id="NAME_CONTENT"> 66<div id="NAME_CONTENT">
66<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>
67 68
68</div> 69</div>
69<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p> 70<h1 id="SYNOPSIS">SYNOPSIS</h1>
70<div id="SYNOPSIS_CONTENT"> 71<div id="SYNOPSIS_CONTENT">
71<pre> #include &lt;ev.h&gt; 72<pre> #include &lt;ev.h&gt;
72 73
73</pre> 74</pre>
74 75
75</div> 76</div>
76<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>
77<div id="DESCRIPTION_CONTENT"> 123<div id="DESCRIPTION_CONTENT">
78<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
79file descriptor being readable or a timeout occuring), and it will manage 125file descriptor being readable or a timeout occuring), and it will manage
80these event sources and provide your program with events.</p> 126these event sources and provide your program with events.</p>
81<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
… …
85watchers</i>, which are relatively small C structures you initialise with the 131watchers</i>, which are relatively small C structures you initialise with the
86details 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
87watcher.</p> 133watcher.</p>
88 134
89</div> 135</div>
90<h1 id="FEATURES">FEATURES</h1><p><a href="#TOP" class="toplink">Top</a></p> 136<h1 id="FEATURES">FEATURES</h1>
91<div id="FEATURES_CONTENT"> 137<div id="FEATURES_CONTENT">
92<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
93kqueue mechanisms for file descriptor events, relative timers, absolute 139BSD-specific <code>kqueue</code> and the Solaris-specific event port mechanisms
94timers with customised rescheduling, signal events, process status change 140for file descriptor events (<code>ev_io</code>), the Linux <code>inotify</code> interface
95events (related to SIGCHLD), and event watchers dealing with the event 141(for <code>ev_stat</code>), relative timers (<code>ev_timer</code>), absolute timers
96loop mechanism itself (idle, prepare and check watchers). It also is quite 142with customised rescheduling (<code>ev_periodic</code>), synchronous signals
143(<code>ev_signal</code>), process status change events (<code>ev_child</code>), and event
144watchers dealing with the event loop mechanism itself (<code>ev_idle</code>,
145<code>ev_embed</code>, <code>ev_prepare</code> and <code>ev_check</code> watchers) as well as
146file watchers (<code>ev_stat</code>) and even limited support for fork events
147(<code>ev_fork</code>).</p>
148<p>It also is quite fast (see this
97fast (see this <a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing 149<a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing it to libevent
98it to libevent for example).</p> 150for example).</p>
99 151
100</div> 152</div>
101<h1 id="CONVENTIONS">CONVENTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 153<h1 id="CONVENTIONS">CONVENTIONS</h1>
102<div id="CONVENTIONS_CONTENT"> 154<div id="CONVENTIONS_CONTENT">
103<p>Libev is very configurable. In this manual the default configuration 155<p>Libev is very configurable. In this manual the default configuration will
104will be described, which supports multiple event loops. For more info 156be described, which supports multiple event loops. For more info about
105about various configuration options please have a look at the file 157various configuration options please have a look at <strong>EMBED</strong> section in
106<cite>README.embed</cite> in the libev distribution. If libev was configured without 158this manual. If libev was configured without support for multiple event
107support for multiple event loops, then all functions taking an initial 159loops, then all functions taking an initial argument of name <code>loop</code>
108argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>) 160(which is always of type <code>struct ev_loop *</code>) will not have this argument.</p>
109will not have this argument.</p>
110 161
111</div> 162</div>
112<h1 id="TIME_REPRESENTATION">TIME REPRESENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p> 163<h1 id="TIME_REPRESENTATION">TIME REPRESENTATION</h1>
113<div id="TIME_REPRESENTATION_CONTENT"> 164<div id="TIME_REPRESENTATION_CONTENT">
114<p>Libev represents time as a single floating point number, representing the 165<p>Libev represents time as a single floating point number, representing the
115(fractional) number of seconds since the (POSIX) epoch (somewhere near 166(fractional) number of seconds since the (POSIX) epoch (somewhere near
116the beginning of 1970, details are complicated, don't ask). This type is 167the beginning of 1970, details are complicated, don't ask). This type is
117called <code>ev_tstamp</code>, which is what you should use too. It usually aliases 168called <code>ev_tstamp</code>, which is what you should use too. It usually aliases
118to the <code>double</code> type in C, and when you need to do any calculations on 169to the <code>double</code> type in C, and when you need to do any calculations on
119it, you should treat it as such.</p> 170it, you should treat it as such.</p>
120 171
121</div> 172</div>
122<h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 173<h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1>
123<div id="GLOBAL_FUNCTIONS_CONTENT"> 174<div id="GLOBAL_FUNCTIONS_CONTENT">
124<p>These functions can be called anytime, even before initialising the 175<p>These functions can be called anytime, even before initialising the
125library in any way.</p> 176library in any way.</p>
126<dl> 177<dl>
127 <dt>ev_tstamp ev_time ()</dt> 178 <dt>ev_tstamp ev_time ()</dt>
… …
140version of the library your program was compiled against.</p> 191version of the library your program was compiled against.</p>
141 <p>Usually, it's a good idea to terminate if the major versions mismatch, 192 <p>Usually, it's a good idea to terminate if the major versions mismatch,
142as this indicates an incompatible change. Minor versions are usually 193as this indicates an incompatible change. Minor versions are usually
143compatible to older versions, so a larger minor version alone is usually 194compatible to older versions, so a larger minor version alone is usually
144not a problem.</p> 195not a problem.</p>
145 <p>Example: make sure we haven't accidentally been linked against the wrong 196 <p>Example: Make sure we haven't accidentally been linked against the wrong
146version:</p> 197version.</p>
147<pre> assert ((&quot;libev version mismatch&quot;, 198<pre> assert ((&quot;libev version mismatch&quot;,
148 ev_version_major () == EV_VERSION_MAJOR 199 ev_version_major () == EV_VERSION_MAJOR
149 &amp;&amp; ev_version_minor () &gt;= EV_VERSION_MINOR)); 200 &amp;&amp; ev_version_minor () &gt;= EV_VERSION_MINOR));
150 201
151</pre> 202</pre>
… …
179might be supported on the current system, you would need to look at 230might be supported on the current system, you would need to look at
180<code>ev_embeddable_backends () &amp; ev_supported_backends ()</code>, likewise for 231<code>ev_embeddable_backends () &amp; ev_supported_backends ()</code>, likewise for
181recommended ones.</p> 232recommended ones.</p>
182 <p>See the description of <code>ev_embed</code> watchers for more info.</p> 233 <p>See the description of <code>ev_embed</code> watchers for more info.</p>
183 </dd> 234 </dd>
184 <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> 235 <dt>ev_set_allocator (void *(*cb)(void *ptr, size_t size))</dt>
185 <dd> 236 <dd>
186 <p>Sets the allocation function to use (the prototype is similar to the 237 <p>Sets the allocation function to use (the prototype and semantics are
187realloc C function, the semantics are identical). It is used to allocate 238identical to the realloc C function). It is used to allocate and free
188and free memory (no surprises here). If it returns zero when memory 239memory (no surprises here). If it returns zero when memory needs to be
189needs to be allocated, the library might abort or take some potentially 240allocated, the library might abort or take some potentially destructive
190destructive action. The default is your system realloc function.</p> 241action. The default is your system realloc function.</p>
191 <p>You could override this function in high-availability programs to, say, 242 <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, 243free 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> 244or 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 245 <p>Example: Replace the libev allocator with one that waits a bit and then
195retries: better than mine).</p> 246retries).</p>
196<pre> static void * 247<pre> static void *
197 persistent_realloc (void *ptr, long size) 248 persistent_realloc (void *ptr, size_t size)
198 { 249 {
199 for (;;) 250 for (;;)
200 { 251 {
201 void *newptr = realloc (ptr, size); 252 void *newptr = realloc (ptr, size);
202 253
… …
219indicating the system call or subsystem causing the problem. If this 270indicating the system call or subsystem causing the problem. If this
220callback is set, then libev will expect it to remedy the sitution, no 271callback is set, then libev will expect it to remedy the sitution, no
221matter what, when it returns. That is, libev will generally retry the 272matter what, when it returns. That is, libev will generally retry the
222requested operation, or, if the condition doesn't go away, do bad stuff 273requested operation, or, if the condition doesn't go away, do bad stuff
223(such as abort).</p> 274(such as abort).</p>
224 <p>Example: do the same thing as libev does internally:</p> 275 <p>Example: This is basically the same thing that libev does internally, too.</p>
225<pre> static void 276<pre> static void
226 fatal_error (const char *msg) 277 fatal_error (const char *msg)
227 { 278 {
228 perror (msg); 279 perror (msg);
229 abort (); 280 abort ();
… …
235</pre> 286</pre>
236 </dd> 287 </dd>
237</dl> 288</dl>
238 289
239</div> 290</div>
240<h1 id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</h1><p><a href="#TOP" class="toplink">Top</a></p> 291<h1 id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</h1>
241<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2"> 292<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 293<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 294types of such loops, the <i>default</i> loop, which supports signals and child
244events, and dynamically created loops which do not.</p> 295events, and dynamically created loops which do not.</p>
245<p>If you use threads, a common model is to run the default event loop 296<p>If you use threads, a common model is to run the default event loop
… …
365 <dd> 416 <dd>
366 <p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is 417 <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 418always 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 419handle signal and child watchers, and attempts to do so will be greeted by
369undefined behaviour (or a failed assertion if assertions are enabled).</p> 420undefined 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> 421 <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); 422<pre> struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
372 if (!epoller) 423 if (!epoller)
373 fatal (&quot;no epoll found here, maybe it hides under your chair&quot;); 424 fatal (&quot;no epoll found here, maybe it hides under your chair&quot;);
374 425
375</pre> 426</pre>
… …
468 be handled here by queueing them when their watcher gets executed. 519 be handled here by queueing them when their watcher gets executed.
469 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 520 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
470 were used, return, otherwise continue with step *. 521 were used, return, otherwise continue with step *.
471 522
472</pre> 523</pre>
473 <p>Example: queue some jobs and then loop until no events are outsanding 524 <p>Example: Queue some jobs and then loop until no events are outsanding
474anymore.</p> 525anymore.</p>
475<pre> ... queue jobs here, make sure they register event watchers as long 526<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..) 527 ... as they still have work to do (even an idle watcher will do..)
477 ev_loop (my_loop, 0); 528 ev_loop (my_loop, 0);
478 ... jobs done. yeah! 529 ... jobs done. yeah!
… …
497example, libev itself uses this for its internal signal pipe: It is not 548example, 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 549visible 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 550no 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 551way 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> 552libraries. 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> 553 <p>Example: Create a signal watcher, but keep it from keeping <code>ev_loop</code>
503running when nothing else is active.</p> 554running when nothing else is active.</p>
504<pre> struct dv_signal exitsig; 555<pre> struct ev_signal exitsig;
505 ev_signal_init (&amp;exitsig, sig_cb, SIGINT); 556 ev_signal_init (&amp;exitsig, sig_cb, SIGINT);
506 ev_signal_start (myloop, &amp;exitsig); 557 ev_signal_start (loop, &amp;exitsig);
507 evf_unref (myloop); 558 evf_unref (loop);
508 559
509</pre> 560</pre>
510 <p>Example: for some weird reason, unregister the above signal handler again.</p> 561 <p>Example: For some weird reason, unregister the above signal handler again.</p>
511<pre> ev_ref (myloop); 562<pre> ev_ref (loop);
512 ev_signal_stop (myloop, &amp;exitsig); 563 ev_signal_stop (loop, &amp;exitsig);
513 564
514</pre> 565</pre>
515 </dd> 566 </dd>
516</dl> 567</dl>
517 568
518 569
519 570
520 571
521 572
522</div> 573</div>
523<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> 574<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1>
524<div id="ANATOMY_OF_A_WATCHER_CONTENT"> 575<div id="ANATOMY_OF_A_WATCHER_CONTENT">
525<p>A watcher is a structure that you create and register to record your 576<p>A watcher is a structure that you create and register to record your
526interest in some event. For instance, if you want to wait for STDIN to 577interest in some event. For instance, if you want to wait for STDIN to
527become readable, you would create an <code>ev_io</code> watcher for that:</p> 578become readable, you would create an <code>ev_io</code> watcher for that:</p>
528<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 579<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
… …
691events but its callback has not yet been invoked). As long as a watcher 742events but its callback has not yet been invoked). As long as a watcher
692is pending (but not active) you must not call an init function on it (but 743is pending (but not active) you must not call an init function on it (but
693<code>ev_TYPE_set</code> is safe) and you must make sure the watcher is available to 744<code>ev_TYPE_set</code> is safe) and you must make sure the watcher is available to
694libev (e.g. you cnanot <code>free ()</code> it).</p> 745libev (e.g. you cnanot <code>free ()</code> it).</p>
695 </dd> 746 </dd>
696 <dt>callback = ev_cb (ev_TYPE *watcher)</dt> 747 <dt>callback ev_cb (ev_TYPE *watcher)</dt>
697 <dd> 748 <dd>
698 <p>Returns the callback currently set on the watcher.</p> 749 <p>Returns the callback currently set on the watcher.</p>
699 </dd> 750 </dd>
700 <dt>ev_cb_set (ev_TYPE *watcher, callback)</dt> 751 <dt>ev_cb_set (ev_TYPE *watcher, callback)</dt>
701 <dd> 752 <dd>
… …
733 struct my_io *w = (struct my_io *)w_; 784 struct my_io *w = (struct my_io *)w_;
734 ... 785 ...
735 } 786 }
736 787
737</pre> 788</pre>
738<p>More interesting and less C-conformant ways of catsing your callback type 789<p>More interesting and less C-conformant ways of casting your callback type
739have been omitted....</p> 790instead have been omitted.</p>
791<p>Another common scenario is having some data structure with multiple
792watchers:</p>
793<pre> struct my_biggy
794 {
795 int some_data;
796 ev_timer t1;
797 ev_timer t2;
798 }
740 799
800</pre>
801<p>In this case getting the pointer to <code>my_biggy</code> is a bit more complicated,
802you need to use <code>offsetof</code>:</p>
803<pre> #include &lt;stddef.h&gt;
741 804
805 static void
806 t1_cb (EV_P_ struct ev_timer *w, int revents)
807 {
808 struct my_biggy big = (struct my_biggy *
809 (((char *)w) - offsetof (struct my_biggy, t1));
810 }
742 811
812 static void
813 t2_cb (EV_P_ struct ev_timer *w, int revents)
814 {
815 struct my_biggy big = (struct my_biggy *
816 (((char *)w) - offsetof (struct my_biggy, t2));
817 }
743 818
744 819
820
821
822</pre>
823
745</div> 824</div>
746<h1 id="WATCHER_TYPES">WATCHER TYPES</h1><p><a href="#TOP" class="toplink">Top</a></p> 825<h1 id="WATCHER_TYPES">WATCHER TYPES</h1>
747<div id="WATCHER_TYPES_CONTENT"> 826<div id="WATCHER_TYPES_CONTENT">
748<p>This section describes each watcher in detail, but will not repeat 827<p>This section describes each watcher in detail, but will not repeat
749information given in the last section. Any initialisation/set macros, 828information given in the last section. Any initialisation/set macros,
750functions and members specific to the watcher type are explained.</p> 829functions and members specific to the watcher type are explained.</p>
751<p>Members are additionally marked with either <i>[read-only]</i>, meaning that, 830<p>Members are additionally marked with either <i>[read-only]</i>, meaning that,
… …
811 <dt>int events [read-only]</dt> 890 <dt>int events [read-only]</dt>
812 <dd> 891 <dd>
813 <p>The events being watched.</p> 892 <p>The events being watched.</p>
814 </dd> 893 </dd>
815</dl> 894</dl>
816<p>Example: call <code>stdin_readable_cb</code> when STDIN_FILENO has become, well 895<p>Example: Call <code>stdin_readable_cb</code> when STDIN_FILENO has become, well
817readable, but only once. Since it is likely line-buffered, you could 896readable, but only once. Since it is likely line-buffered, you could
818attempt to read a whole line in the callback:</p> 897attempt to read a whole line in the callback.</p>
819<pre> static void 898<pre> static void
820 stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 899 stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
821 { 900 {
822 ev_io_stop (loop, w); 901 ev_io_stop (loop, w);
823 .. read from stdin here (or from w-&gt;fd) and haqndle any I/O errors 902 .. read from stdin here (or from w-&gt;fd) and haqndle any I/O errors
… …
906 <p>The current <code>repeat</code> value. Will be used each time the watcher times out 985 <p>The current <code>repeat</code> value. Will be used each time the watcher times out
907or <code>ev_timer_again</code> is called and determines the next timeout (if any), 986or <code>ev_timer_again</code> is called and determines the next timeout (if any),
908which is also when any modifications are taken into account.</p> 987which is also when any modifications are taken into account.</p>
909 </dd> 988 </dd>
910</dl> 989</dl>
911<p>Example: create a timer that fires after 60 seconds.</p> 990<p>Example: Create a timer that fires after 60 seconds.</p>
912<pre> static void 991<pre> static void
913 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 992 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
914 { 993 {
915 .. one minute over, w is actually stopped right here 994 .. one minute over, w is actually stopped right here
916 } 995 }
… …
918 struct ev_timer mytimer; 997 struct ev_timer mytimer;
919 ev_timer_init (&amp;mytimer, one_minute_cb, 60., 0.); 998 ev_timer_init (&amp;mytimer, one_minute_cb, 60., 0.);
920 ev_timer_start (loop, &amp;mytimer); 999 ev_timer_start (loop, &amp;mytimer);
921 1000
922</pre> 1001</pre>
923<p>Example: create a timeout timer that times out after 10 seconds of 1002<p>Example: Create a timeout timer that times out after 10 seconds of
924inactivity.</p> 1003inactivity.</p>
925<pre> static void 1004<pre> static void
926 timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1005 timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
927 { 1006 {
928 .. ten seconds without any activity 1007 .. ten seconds without any activity
… …
1044 <p>The current reschedule callback, or <code>0</code>, if this functionality is 1123 <p>The current reschedule callback, or <code>0</code>, if this functionality is
1045switched off. Can be changed any time, but changes only take effect when 1124switched off. Can be changed any time, but changes only take effect when
1046the periodic timer fires or <code>ev_periodic_again</code> is being called.</p> 1125the periodic timer fires or <code>ev_periodic_again</code> is being called.</p>
1047 </dd> 1126 </dd>
1048</dl> 1127</dl>
1049<p>Example: call a callback every hour, or, more precisely, whenever the 1128<p>Example: Call a callback every hour, or, more precisely, whenever the
1050system clock is divisible by 3600. The callback invocation times have 1129system clock is divisible by 3600. The callback invocation times have
1051potentially a lot of jittering, but good long-term stability.</p> 1130potentially a lot of jittering, but good long-term stability.</p>
1052<pre> static void 1131<pre> static void
1053 clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1132 clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1054 { 1133 {
… …
1058 struct ev_periodic hourly_tick; 1137 struct ev_periodic hourly_tick;
1059 ev_periodic_init (&amp;hourly_tick, clock_cb, 0., 3600., 0); 1138 ev_periodic_init (&amp;hourly_tick, clock_cb, 0., 3600., 0);
1060 ev_periodic_start (loop, &amp;hourly_tick); 1139 ev_periodic_start (loop, &amp;hourly_tick);
1061 1140
1062</pre> 1141</pre>
1063<p>Example: the same as above, but use a reschedule callback to do it:</p> 1142<p>Example: The same as above, but use a reschedule callback to do it:</p>
1064<pre> #include &lt;math.h&gt; 1143<pre> #include &lt;math.h&gt;
1065 1144
1066 static ev_tstamp 1145 static ev_tstamp
1067 my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 1146 my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
1068 { 1147 {
… …
1070 } 1149 }
1071 1150
1072 ev_periodic_init (&amp;hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1151 ev_periodic_init (&amp;hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1073 1152
1074</pre> 1153</pre>
1075<p>Example: call a callback every hour, starting now:</p> 1154<p>Example: Call a callback every hour, starting now:</p>
1076<pre> struct ev_periodic hourly_tick; 1155<pre> struct ev_periodic hourly_tick;
1077 ev_periodic_init (&amp;hourly_tick, clock_cb, 1156 ev_periodic_init (&amp;hourly_tick, clock_cb,
1078 fmod (ev_now (loop), 3600.), 3600., 0); 1157 fmod (ev_now (loop), 3600.), 3600., 0);
1079 ev_periodic_start (loop, &amp;hourly_tick); 1158 ev_periodic_start (loop, &amp;hourly_tick);
1080 1159
… …
1141 <dd> 1220 <dd>
1142 <p>The process exit/trace status caused by <code>rpid</code> (see your systems 1221 <p>The process exit/trace status caused by <code>rpid</code> (see your systems
1143<code>waitpid</code> and <code>sys/wait.h</code> documentation for details).</p> 1222<code>waitpid</code> and <code>sys/wait.h</code> documentation for details).</p>
1144 </dd> 1223 </dd>
1145</dl> 1224</dl>
1146<p>Example: try to exit cleanly on SIGINT and SIGTERM.</p> 1225<p>Example: Try to exit cleanly on SIGINT and SIGTERM.</p>
1147<pre> static void 1226<pre> static void
1148 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1227 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1149 { 1228 {
1150 ev_unloop (loop, EVUNLOOP_ALL); 1229 ev_unloop (loop, EVUNLOOP_ALL);
1151 } 1230 }
… …
1169not exist&quot; is a status change like any other. The condition &quot;path does 1248not exist&quot; is a status change like any other. The condition &quot;path does
1170not exist&quot; is signified by the <code>st_nlink</code> field being zero (which is 1249not exist&quot; is signified by the <code>st_nlink</code> field being zero (which is
1171otherwise always forced to be at least one) and all the other fields of 1250otherwise always forced to be at least one) and all the other fields of
1172the stat buffer having unspecified contents.</p> 1251the stat buffer having unspecified contents.</p>
1173<p>Since there is no standard to do this, the portable implementation simply 1252<p>Since there is no standard to do this, the portable implementation simply
1174calls <code>stat (2)</code> regulalry on the path to see if it changed somehow. You 1253calls <code>stat (2)</code> regularly on the path to see if it changed somehow. You
1175can specify a recommended polling interval for this case. If you specify 1254can specify a recommended polling interval for this case. If you specify
1176a polling interval of <code>0</code> (highly recommended!) then a <i>suitable, 1255a polling interval of <code>0</code> (highly recommended!) then a <i>suitable,
1177unspecified default</i> value will be used (which you can expect to be around 1256unspecified default</i> value will be used (which you can expect to be around
1178five seconds, although this might change dynamically). Libev will also 1257five seconds, although this might change dynamically). Libev will also
1179impose a minimum interval which is currently around <code>0.1</code>, but thats 1258impose a minimum interval which is currently around <code>0.1</code>, but thats
1180usually overkill.</p> 1259usually overkill.</p>
1181<p>This watcher type is not meant for massive numbers of stat watchers, 1260<p>This watcher type is not meant for massive numbers of stat watchers,
1182as even with OS-supported change notifications, this can be 1261as even with OS-supported change notifications, this can be
1183resource-intensive.</p> 1262resource-intensive.</p>
1184<p>At the time of this writing, no specific OS backends are implemented, but 1263<p>At the time of this writing, only the Linux inotify interface is
1185if demand increases, at least a kqueue and inotify backend will be added.</p> 1264implemented (implementing kqueue support is left as an exercise for the
1265reader). Inotify will be used to give hints only and should not change the
1266semantics of <code>ev_stat</code> watchers, which means that libev sometimes needs
1267to fall back to regular polling again even with inotify, but changes are
1268usually detected immediately, and if the file exists there will be no
1269polling.</p>
1186<dl> 1270<dl>
1187 <dt>ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)</dt> 1271 <dt>ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)</dt>
1188 <dt>ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)</dt> 1272 <dt>ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)</dt>
1189 <dd> 1273 <dd>
1190 <p>Configures the watcher to wait for status changes of the given 1274 <p>Configures the watcher to wait for status changes of the given
… …
1274 <p>Initialises and configures the idle watcher - it has no parameters of any 1358 <p>Initialises and configures the idle watcher - it has no parameters of any
1275kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless, 1359kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless,
1276believe me.</p> 1360believe me.</p>
1277 </dd> 1361 </dd>
1278</dl> 1362</dl>
1279<p>Example: dynamically allocate an <code>ev_idle</code>, start it, and in the 1363<p>Example: Dynamically allocate an <code>ev_idle</code> watcher, start it, and in the
1280callback, free it. Alos, use no error checking, as usual.</p> 1364callback, free it. Also, use no error checking, as usual.</p>
1281<pre> static void 1365<pre> static void
1282 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1366 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1283 { 1367 {
1284 free (w); 1368 free (w);
1285 // now do something you wanted to do when the program has 1369 // now do something you wanted to do when the program has
… …
1510 1594
1511 1595
1512 1596
1513 1597
1514</div> 1598</div>
1515<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 1599<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1>
1516<div id="OTHER_FUNCTIONS_CONTENT"> 1600<div id="OTHER_FUNCTIONS_CONTENT">
1517<p>There are some other functions of possible interest. Described. Here. Now.</p> 1601<p>There are some other functions of possible interest. Described. Here. Now.</p>
1518<dl> 1602<dl>
1519 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> 1603 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt>
1520 <dd> 1604 <dd>
… …
1567 1651
1568 1652
1569 1653
1570 1654
1571</div> 1655</div>
1572<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1><p><a href="#TOP" class="toplink">Top</a></p> 1656<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1>
1573<div id="LIBEVENT_EMULATION_CONTENT"> 1657<div id="LIBEVENT_EMULATION_CONTENT">
1574<p>Libev offers a compatibility emulation layer for libevent. It cannot 1658<p>Libev offers a compatibility emulation layer for libevent. It cannot
1575emulate the internals of libevent, so here are some usage hints:</p> 1659emulate the internals of libevent, so here are some usage hints:</p>
1576<dl> 1660<dl>
1577 <dt>* Use it by including &lt;event.h&gt;, as usual.</dt> 1661 <dt>* Use it by including &lt;event.h&gt;, as usual.</dt>
… …
1587 <dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need 1671 <dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need
1588to use the libev header file and library.</dt> 1672to use the libev header file and library.</dt>
1589</dl> 1673</dl>
1590 1674
1591</div> 1675</div>
1592<h1 id="C_SUPPORT">C++ SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p> 1676<h1 id="C_SUPPORT">C++ SUPPORT</h1>
1593<div id="C_SUPPORT_CONTENT"> 1677<div id="C_SUPPORT_CONTENT">
1594<p>Libev comes with some simplistic wrapper classes for C++ that mainly allow 1678<p>Libev comes with some simplistic wrapper classes for C++ that mainly allow
1595you to use some convinience methods to start/stop watchers and also change 1679you to use some convinience methods to start/stop watchers and also change
1596the callback model to a model using method callbacks on objects.</p> 1680the callback model to a model using method callbacks on objects.</p>
1597<p>To use it,</p> 1681<p>To use it,</p>
… …
1692 1776
1693 1777
1694</pre> 1778</pre>
1695 1779
1696</div> 1780</div>
1697<h1 id="MACRO_MAGIC">MACRO MAGIC</h1><p><a href="#TOP" class="toplink">Top</a></p> 1781<h1 id="MACRO_MAGIC">MACRO MAGIC</h1>
1698<div id="MACRO_MAGIC_CONTENT"> 1782<div id="MACRO_MAGIC_CONTENT">
1699<p>Libev can be compiled with a variety of options, the most fundemantal is 1783<p>Libev can be compiled with a variety of options, the most fundemantal is
1700<code>EV_MULTIPLICITY</code>. This option determines wether (most) functions and 1784<code>EV_MULTIPLICITY</code>. This option determines wether (most) functions and
1701callbacks have an initial <code>struct ev_loop *</code> argument.</p> 1785callbacks have an initial <code>struct ev_loop *</code> argument.</p>
1702<p>To make it easier to write programs that cope with either variant, the 1786<p>To make it easier to write programs that cope with either variant, the
… …
1753 1837
1754 1838
1755</pre> 1839</pre>
1756 1840
1757</div> 1841</div>
1758<h1 id="EMBEDDING">EMBEDDING</h1><p><a href="#TOP" class="toplink">Top</a></p> 1842<h1 id="EMBEDDING">EMBEDDING</h1>
1759<div id="EMBEDDING_CONTENT"> 1843<div id="EMBEDDING_CONTENT">
1760<p>Libev can (and often is) directly embedded into host 1844<p>Libev can (and often is) directly embedded into host
1761applications. Examples of applications that embed it include the Deliantra 1845applications. Examples of applications that embed it include the Deliantra
1762Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) 1846Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
1763and rxvt-unicode.</p> 1847and rxvt-unicode.</p>
… …
1937 </dd> 2021 </dd>
1938 <dt>EV_USE_DEVPOLL</dt> 2022 <dt>EV_USE_DEVPOLL</dt>
1939 <dd> 2023 <dd>
1940 <p>reserved for future expansion, works like the USE symbols above.</p> 2024 <p>reserved for future expansion, works like the USE symbols above.</p>
1941 </dd> 2025 </dd>
2026 <dt>EV_USE_INOTIFY</dt>
2027 <dd>
2028 <p>If defined to be <code>1</code>, libev will compile in support for the Linux inotify
2029interface to speed up <code>ev_stat</code> watchers. Its actual availability will
2030be detected at runtime.</p>
2031 </dd>
1942 <dt>EV_H</dt> 2032 <dt>EV_H</dt>
1943 <dd> 2033 <dd>
1944 <p>The name of the <cite>ev.h</cite> header file used to include it. The default if 2034 <p>The name of the <cite>ev.h</cite> header file used to include it. The default if
1945undefined 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 2035undefined 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
1946can be used to virtually rename the <cite>ev.h</cite> header file in case of conflicts.</p> 2036can be used to virtually rename the <cite>ev.h</cite> header file in case of conflicts.</p>
… …
1995 <dt>EV_MINIMAL</dt> 2085 <dt>EV_MINIMAL</dt>
1996 <dd> 2086 <dd>
1997 <p>If you need to shave off some kilobytes of code at the expense of some 2087 <p>If you need to shave off some kilobytes of code at the expense of some
1998speed, define this symbol to <code>1</code>. Currently only used for gcc to override 2088speed, define this symbol to <code>1</code>. Currently only used for gcc to override
1999some inlining decisions, saves roughly 30% codesize of amd64.</p> 2089some inlining decisions, saves roughly 30% codesize of amd64.</p>
2090 </dd>
2091 <dt>EV_PID_HASHSIZE</dt>
2092 <dd>
2093 <p><code>ev_child</code> watchers use a small hash table to distribute workload by
2094pid. The default size is <code>16</code> (or <code>1</code> with <code>EV_MINIMAL</code>), usually more
2095than enough. If you need to manage thousands of children you might want to
2096increase this value (<i>must</i> be a power of two).</p>
2097 </dd>
2098 <dt>EV_INOTIFY_HASHSIZE</dt>
2099 <dd>
2100 <p><code>ev_staz</code> watchers use a small hash table to distribute workload by
2101inotify watch id. The default size is <code>16</code> (or <code>1</code> with <code>EV_MINIMAL</code>),
2102usually more than enough. If you need to manage thousands of <code>ev_stat</code>
2103watchers you might want to increase this value (<i>must</i> be a power of
2104two).</p>
2000 </dd> 2105 </dd>
2001 <dt>EV_COMMON</dt> 2106 <dt>EV_COMMON</dt>
2002 <dd> 2107 <dd>
2003 <p>By default, all watchers have a <code>void *data</code> member. By redefining 2108 <p>By default, all watchers have a <code>void *data</code> member. By redefining
2004this macro to a something else you can include more and other types of 2109this macro to a something else you can include more and other types of
… …
2050 2155
2051 2156
2052</pre> 2157</pre>
2053 2158
2054</div> 2159</div>
2055<h1 id="COMPLEXITIES">COMPLEXITIES</h1><p><a href="#TOP" class="toplink">Top</a></p> 2160<h1 id="COMPLEXITIES">COMPLEXITIES</h1>
2056<div id="COMPLEXITIES_CONTENT"> 2161<div id="COMPLEXITIES_CONTENT">
2057 <p>In this section the complexities of (many of) the algorithms used inside 2162 <p>In this section the complexities of (many of) the algorithms used inside
2058libev will be explained. For complexity discussions about backends see the 2163libev will be explained. For complexity discussions about backends see the
2059documentation for <code>ev_default_init</code>.</p> 2164documentation for <code>ev_default_init</code>.</p>
2060 <p> 2165 <p>
2061 <dl> 2166 <dl>
2062 <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt> 2167 <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt>
2063 <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt> 2168 <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt>
2064 <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt> 2169 <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt>
2065 <dt>Stopping check/prepare/idle watchers: O(1)</dt> 2170 <dt>Stopping check/prepare/idle watchers: O(1)</dt>
2066 <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))</dt> 2171 <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))</dt>
2067 <dt>Finding the next timer per loop iteration: O(1)</dt> 2172 <dt>Finding the next timer per loop iteration: O(1)</dt>
2068 <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt> 2173 <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt>
2069 <dt>Activating one watcher: O(1)</dt> 2174 <dt>Activating one watcher: O(1)</dt>
2070 </dl> 2175 </dl>
2071 </p> 2176 </p>
… …
2073 2178
2074 2179
2075 2180
2076 2181
2077</div> 2182</div>
2078<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> 2183<h1 id="AUTHOR">AUTHOR</h1>
2079<div id="AUTHOR_CONTENT"> 2184<div id="AUTHOR_CONTENT">
2080 <p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p> 2185 <p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p>
2081 2186
2082</div> 2187</div>
2083</div></body> 2188</div></body>

Diff Legend

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