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

Comparing libev/ev.html (file contents):
Revision 1.5 by root, Mon Nov 12 08:11:56 2007 UTC vs.
Revision 1.35 by root, Fri Nov 23 16:17:12 2007 UTC

… …
4<head> 4<head>
5 <title>libev</title> 5 <title>libev</title>
6 <meta name="description" content="Pod documentation for libev" /> 6 <meta name="description" content="Pod documentation for libev" />
7 <meta name="inputfile" content="&lt;standard input&gt;" /> 7 <meta name="inputfile" content="&lt;standard input&gt;" />
8 <meta name="outputfile" content="&lt;standard output&gt;" /> 8 <meta name="outputfile" content="&lt;standard output&gt;" />
9 <meta name="created" content="Mon Nov 12 09:11:56 2007" /> 9 <meta name="created" content="Fri Nov 23 17:17:04 2007" />
10 <meta name="generator" content="Pod::Xhtml 1.57" /> 10 <meta name="generator" content="Pod::Xhtml 1.57" />
11<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> 11<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
12<body> 12<body>
13<div class="pod"> 13<div class="pod">
14<!-- INDEX START --> 14<!-- INDEX START -->
… …
17<ul><li><a href="#NAME">NAME</a></li> 17<ul><li><a href="#NAME">NAME</a></li>
18<li><a href="#SYNOPSIS">SYNOPSIS</a></li> 18<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
19<li><a href="#DESCRIPTION">DESCRIPTION</a></li> 19<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
20<li><a href="#FEATURES">FEATURES</a></li> 20<li><a href="#FEATURES">FEATURES</a></li>
21<li><a href="#CONVENTIONS">CONVENTIONS</a></li> 21<li><a href="#CONVENTIONS">CONVENTIONS</a></li>
22<li><a href="#TIME_REPRESENTATION">TIME REPRESENTATION</a></li>
22<li><a href="#TIME_AND_OTHER_GLOBAL_FUNCTIONS">TIME AND OTHER GLOBAL FUNCTIONS</a></li> 23<li><a href="#GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</a></li>
23<li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li> 24<li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li>
24<li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a> 25<li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a>
25<ul><li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li> 26<ul><li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li>
26</ul> 27</ul>
27</li> 28</li>
28<li><a href="#WATCHER_TYPES">WATCHER TYPES</a> 29<li><a href="#WATCHER_TYPES">WATCHER TYPES</a>
29<ul><li><a href="#struct_ev_io_is_my_file_descriptor_r">struct ev_io - is my file descriptor readable or writable</a></li> 30<ul><li><a href="#code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</a></li>
30<li><a href="#struct_ev_timer_relative_and_optiona">struct ev_timer - relative and optionally recurring timeouts</a></li> 31<li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</a></li>
31<li><a href="#ev_periodic_to_cron_or_not_to_cron_i">ev_periodic - to cron or not to cron it</a></li> 32<li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</a></li>
32<li><a href="#ev_signal_signal_me_when_a_signal_ge">ev_signal - signal me when a signal gets signalled</a></li> 33<li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</a></li>
33<li><a href="#ev_child_wait_for_pid_status_changes">ev_child - wait for pid status changes</a></li> 34<li><a href="#code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</a></li>
34<li><a href="#ev_idle_when_you_ve_got_nothing_bett">ev_idle - when you've got nothing better to do</a></li> 35<li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</a></li>
35<li><a href="#prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</a></li> 36<li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</a></li>
36</ul> 37</ul>
37</li> 38</li>
38<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> 39<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li>
40<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li>
41<li><a href="#C_SUPPORT">C++ SUPPORT</a></li>
39<li><a href="#AUTHOR">AUTHOR</a> 42<li><a href="#AUTHOR">AUTHOR</a>
40</li> 43</li>
41</ul><hr /> 44</ul><hr />
42<!-- INDEX END --> 45<!-- INDEX END -->
43 46
… …
72<p>Libev supports select, poll, the linux-specific epoll and the bsd-specific 75<p>Libev supports select, poll, the linux-specific epoll and the bsd-specific
73kqueue mechanisms for file descriptor events, relative timers, absolute 76kqueue mechanisms for file descriptor events, relative timers, absolute
74timers with customised rescheduling, signal events, process status change 77timers with customised rescheduling, signal events, process status change
75events (related to SIGCHLD), and event watchers dealing with the event 78events (related to SIGCHLD), and event watchers dealing with the event
76loop mechanism itself (idle, prepare and check watchers). It also is quite 79loop mechanism itself (idle, prepare and check watchers). It also is quite
77fast (see a <b>http://libev.schmorp.de/bench.html</b> (<cite>benchmark</cite>) comparing it 80fast (see this <a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing
78to libevent).</p> 81it to libevent for example).</p>
79 82
80</div> 83</div>
81<h1 id="CONVENTIONS">CONVENTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 84<h1 id="CONVENTIONS">CONVENTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
82<div id="CONVENTIONS_CONTENT"> 85<div id="CONVENTIONS_CONTENT">
83<p>Libev is very configurable. In this manual the default configuration 86<p>Libev is very configurable. In this manual the default configuration
84will be described, which supports multiple event loops. For more info 87will be described, which supports multiple event loops. For more info
85about various configuraiton options please have a look at the file 88about various configuration options please have a look at the file
86<cite>README.embed</cite> in the libev distribution. If libev was configured without 89<cite>README.embed</cite> in the libev distribution. If libev was configured without
87support for multiple event loops, then all functions taking an initial 90support for multiple event loops, then all functions taking an initial
88argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>) 91argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>)
89will not have this argument.</p> 92will not have this argument.</p>
90 93
91</div> 94</div>
92<h1 id="TIME_AND_OTHER_GLOBAL_FUNCTIONS">TIME AND OTHER GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 95<h1 id="TIME_REPRESENTATION">TIME REPRESENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p>
93<div id="TIME_AND_OTHER_GLOBAL_FUNCTIONS_CONT"> 96<div id="TIME_REPRESENTATION_CONTENT">
94<p>Libev represents time as a single floating point number, representing the 97<p>Libev represents time as a single floating point number, representing the
95(fractional) number of seconds since the (POSIX) epoch (somewhere near 98(fractional) number of seconds since the (POSIX) epoch (somewhere near
96the beginning of 1970, details are complicated, don't ask). This type is 99the beginning of 1970, details are complicated, don't ask). This type is
97called <code>ev_tstamp</code>, which is what you should use too. It usually aliases 100called <code>ev_tstamp</code>, which is what you should use too. It usually aliases
98to the double type in C.</p> 101to the <code>double</code> type in C, and when you need to do any calculations on
102it, you should treat it as such.</p>
103
104
105
106
107
108</div>
109<h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
110<div id="GLOBAL_FUNCTIONS_CONTENT">
111<p>These functions can be called anytime, even before initialising the
112library in any way.</p>
99<dl> 113<dl>
100 <dt>ev_tstamp ev_time ()</dt> 114 <dt>ev_tstamp ev_time ()</dt>
101 <dd> 115 <dd>
102 <p>Returns the current time as libev would use it.</p> 116 <p>Returns the current time as libev would use it. Please note that the
117<code>ev_now</code> function is usually faster and also often returns the timestamp
118you actually want to know.</p>
103 </dd> 119 </dd>
104 <dt>int ev_version_major ()</dt> 120 <dt>int ev_version_major ()</dt>
105 <dt>int ev_version_minor ()</dt> 121 <dt>int ev_version_minor ()</dt>
106 <dd> 122 <dd>
107 <p>You can find out the major and minor version numbers of the library 123 <p>You can find out the major and minor version numbers of the library
108you linked against by calling the functions <code>ev_version_major</code> and 124you linked against by calling the functions <code>ev_version_major</code> and
109<code>ev_version_minor</code>. If you want, you can compare against the global 125<code>ev_version_minor</code>. If you want, you can compare against the global
110symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the 126symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the
111version of the library your program was compiled against.</p> 127version of the library your program was compiled against.</p>
112 <p>Usually, its a good idea to terminate if the major versions mismatch, 128 <p>Usually, it's a good idea to terminate if the major versions mismatch,
113as this indicates an incompatible change. Minor versions are usually 129as this indicates an incompatible change. Minor versions are usually
114compatible to older versions, so a larger minor version alone is usually 130compatible to older versions, so a larger minor version alone is usually
115not a problem.</p> 131not a problem.</p>
132 <p>Example: make sure we haven't accidentally been linked against the wrong
133version:</p>
134<pre> assert ((&quot;libev version mismatch&quot;,
135 ev_version_major () == EV_VERSION_MAJOR
136 &amp;&amp; ev_version_minor () &gt;= EV_VERSION_MINOR));
137
138</pre>
139 </dd>
140 <dt>unsigned int ev_supported_backends ()</dt>
141 <dd>
142 <p>Return the set of all backends (i.e. their corresponding <code>EV_BACKEND_*</code>
143value) compiled into this binary of libev (independent of their
144availability on the system you are running on). See <code>ev_default_loop</code> for
145a description of the set values.</p>
146 <p>Example: make sure we have the epoll method, because yeah this is cool and
147a must have and can we have a torrent of it please!!!11</p>
148<pre> assert ((&quot;sorry, no epoll, no sex&quot;,
149 ev_supported_backends () &amp; EVBACKEND_EPOLL));
150
151</pre>
152 </dd>
153 <dt>unsigned int ev_recommended_backends ()</dt>
154 <dd>
155 <p>Return the set of all backends compiled into this binary of libev and also
156recommended for this platform. This set is often smaller than the one
157returned by <code>ev_supported_backends</code>, as for example kqueue is broken on
158most BSDs and will not be autodetected unless you explicitly request it
159(assuming you know what you are doing). This is the set of backends that
160libev will probe for if you specify no backends explicitly.</p>
116 </dd> 161 </dd>
117 <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> 162 <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt>
118 <dd> 163 <dd>
119 <p>Sets the allocation function to use (the prototype is similar to the 164 <p>Sets the allocation function to use (the prototype is similar to the
120realloc function). It is used to allocate and free memory (no surprises 165realloc C function, the semantics are identical). It is used to allocate
121here). If it returns zero when memory needs to be allocated, the library 166and free memory (no surprises here). If it returns zero when memory
122might abort or take some potentially destructive action. The default is 167needs to be allocated, the library might abort or take some potentially
123your system realloc function.</p> 168destructive action. The default is your system realloc function.</p>
124 <p>You could override this function in high-availability programs to, say, 169 <p>You could override this function in high-availability programs to, say,
125free some memory if it cannot allocate memory, to use a special allocator, 170free some memory if it cannot allocate memory, to use a special allocator,
126or even to sleep a while and retry until some memory is available.</p> 171or even to sleep a while and retry until some memory is available.</p>
172 <p>Example: replace the libev allocator with one that waits a bit and then
173retries: better than mine).</p>
174<pre> static void *
175 persistent_realloc (void *ptr, long size)
176 {
177 for (;;)
178 {
179 void *newptr = realloc (ptr, size);
180
181 if (newptr)
182 return newptr;
183
184 sleep (60);
185 }
186 }
187
188 ...
189 ev_set_allocator (persistent_realloc);
190
191</pre>
127 </dd> 192 </dd>
128 <dt>ev_set_syserr_cb (void (*cb)(const char *msg));</dt> 193 <dt>ev_set_syserr_cb (void (*cb)(const char *msg));</dt>
129 <dd> 194 <dd>
130 <p>Set the callback function to call on a retryable syscall error (such 195 <p>Set the callback function to call on a retryable syscall error (such
131as failed select, poll, epoll_wait). The message is a printable string 196as failed select, poll, epoll_wait). The message is a printable string
132indicating the system call or subsystem causing the problem. If this 197indicating the system call or subsystem causing the problem. If this
133callback is set, then libev will expect it to remedy the sitution, no 198callback is set, then libev will expect it to remedy the sitution, no
134matter what, when it returns. That is, libev will geenrally retry the 199matter what, when it returns. That is, libev will generally retry the
135requested operation, or, if the condition doesn't go away, do bad stuff 200requested operation, or, if the condition doesn't go away, do bad stuff
136(such as abort).</p> 201(such as abort).</p>
202 <p>Example: do the same thing as libev does internally:</p>
203<pre> static void
204 fatal_error (const char *msg)
205 {
206 perror (msg);
207 abort ();
208 }
209
210 ...
211 ev_set_syserr_cb (fatal_error);
212
213</pre>
137 </dd> 214 </dd>
138</dl> 215</dl>
139 216
140</div> 217</div>
141<h1 id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</h1><p><a href="#TOP" class="toplink">Top</a></p> 218<h1 id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</h1><p><a href="#TOP" class="toplink">Top</a></p>
142<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2"> 219<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2">
143<p>An event loop is described by a <code>struct ev_loop *</code>. The library knows two 220<p>An event loop is described by a <code>struct ev_loop *</code>. The library knows two
144types of such loops, the <i>default</i> loop, which supports signals and child 221types of such loops, the <i>default</i> loop, which supports signals and child
145events, and dynamically created loops which do not.</p> 222events, and dynamically created loops which do not.</p>
146<p>If you use threads, a common model is to run the default event loop 223<p>If you use threads, a common model is to run the default event loop
147in your main thread (or in a separate thrad) and for each thread you 224in your main thread (or in a separate thread) and for each thread you
148create, you also create another event loop. Libev itself does no lockign 225create, you also create another event loop. Libev itself does no locking
149whatsoever, so if you mix calls to different event loops, make sure you 226whatsoever, so if you mix calls to the same event loop in different
150lock (this is usually a bad idea, though, even if done right).</p> 227threads, make sure you lock (this is usually a bad idea, though, even if
228done correctly, because it's hideous and inefficient).</p>
151<dl> 229<dl>
152 <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt> 230 <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt>
153 <dd> 231 <dd>
154 <p>This will initialise the default event loop if it hasn't been initialised 232 <p>This will initialise the default event loop if it hasn't been initialised
155yet and return it. If the default loop could not be initialised, returns 233yet and return it. If the default loop could not be initialised, returns
156false. If it already was initialised it simply returns it (and ignores the 234false. If it already was initialised it simply returns it (and ignores the
157flags).</p> 235flags. If that is troubling you, check <code>ev_backend ()</code> afterwards).</p>
158 <p>If you don't know what event loop to use, use the one returned from this 236 <p>If you don't know what event loop to use, use the one returned from this
159function.</p> 237function.</p>
160 <p>The flags argument can be used to specify special behaviour or specific 238 <p>The flags argument can be used to specify special behaviour or specific
161backends to use, and is usually specified as 0 (or EVFLAG_AUTO)</p> 239backends to use, and is usually specified as <code>0</code> (or <code>EVFLAG_AUTO</code>).</p>
162 <p>It supports the following flags:</p> 240 <p>The following flags are supported:</p>
163 <p> 241 <p>
164 <dl> 242 <dl>
165 <dt>EVFLAG_AUTO</dt> 243 <dt><code>EVFLAG_AUTO</code></dt>
166 <dd> 244 <dd>
167 <p>The default flags value. Use this if you have no clue (its the right 245 <p>The default flags value. Use this if you have no clue (it's the right
168thing, believe me).</p> 246thing, believe me).</p>
169 </dd> 247 </dd>
170 <dt>EVFLAG_NOENV</dt> 248 <dt><code>EVFLAG_NOENV</code></dt>
171 <dd> 249 <dd>
172 <p>If this flag bit is ored into the flag value then libev will <i>not</i> look 250 <p>If this flag bit is ored into the flag value (or the program runs setuid
173at the environment variable <code>LIBEV_FLAGS</code>. Otherwise (the default), this 251or setgid) then libev will <i>not</i> look at the environment variable
174environment variable will override the flags completely. This is useful 252<code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will
253override the flags completely if it is found in the environment. This is
175to try out specific backends to tets their performance, or to work around 254useful to try out specific backends to test their performance, or to work
176bugs.</p> 255around bugs.</p>
177 </dd> 256 </dd>
178 <dt>EVMETHOD_SELECT portable select backend</dt> 257 <dt><code>EVBACKEND_SELECT</code> (value 1, portable select backend)</dt>
179 <dt>EVMETHOD_POLL poll backend (everywhere except windows)</dt>
180 <dt>EVMETHOD_EPOLL linux only</dt>
181 <dt>EVMETHOD_KQUEUE some bsds only</dt>
182 <dt>EVMETHOD_DEVPOLL solaris 8 only</dt>
183 <dt>EVMETHOD_PORT solaris 10 only</dt>
184 <dd> 258 <dd>
185 <p>If one or more of these are ored into the flags value, then only these 259 <p>This is your standard select(2) backend. Not <i>completely</i> standard, as
186backends will be tried (in the reverse order as given here). If one are 260libev tries to roll its own fd_set with no limits on the number of fds,
187specified, any backend will do.</p> 261but if that fails, expect a fairly low limit on the number of fds when
262using this backend. It doesn't scale too well (O(highest_fd)), but its usually
263the fastest backend for a low number of fds.</p>
264 </dd>
265 <dt><code>EVBACKEND_POLL</code> (value 2, poll backend, available everywhere except on windows)</dt>
266 <dd>
267 <p>And this is your standard poll(2) backend. It's more complicated than
268select, but handles sparse fds better and has no artificial limit on the
269number of fds you can use (except it will slow down considerably with a
270lot of inactive fds). It scales similarly to select, i.e. O(total_fds).</p>
271 </dd>
272 <dt><code>EVBACKEND_EPOLL</code> (value 4, Linux)</dt>
273 <dd>
274 <p>For few fds, this backend is a bit little slower than poll and select,
275but it scales phenomenally better. While poll and select usually scale like
276O(total_fds) where n is the total number of fds (or the highest fd), epoll scales
277either O(1) or O(active_fds).</p>
278 <p>While stopping and starting an I/O watcher in the same iteration will
279result in some caching, there is still a syscall per such incident
280(because the fd could point to a different file description now), so its
281best to avoid that. Also, dup()ed file descriptors might not work very
282well if you register events for both fds.</p>
283 <p>Please note that epoll sometimes generates spurious notifications, so you
284need to use non-blocking I/O or other means to avoid blocking when no data
285(or space) is available.</p>
286 </dd>
287 <dt><code>EVBACKEND_KQUEUE</code> (value 8, most BSD clones)</dt>
288 <dd>
289 <p>Kqueue deserves special mention, as at the time of this writing, it
290was broken on all BSDs except NetBSD (usually it doesn't work with
291anything but sockets and pipes, except on Darwin, where of course its
292completely useless). For this reason its not being &quot;autodetected&quot;
293unless you explicitly specify it explicitly in the flags (i.e. using
294<code>EVBACKEND_KQUEUE</code>).</p>
295 <p>It scales in the same way as the epoll backend, but the interface to the
296kernel is more efficient (which says nothing about its actual speed, of
297course). While starting and stopping an I/O watcher does not cause an
298extra syscall as with epoll, it still adds up to four event changes per
299incident, so its best to avoid that.</p>
300 </dd>
301 <dt><code>EVBACKEND_DEVPOLL</code> (value 16, Solaris 8)</dt>
302 <dd>
303 <p>This is not implemented yet (and might never be).</p>
304 </dd>
305 <dt><code>EVBACKEND_PORT</code> (value 32, Solaris 10)</dt>
306 <dd>
307 <p>This uses the Solaris 10 port mechanism. As with everything on Solaris,
308it's really slow, but it still scales very well (O(active_fds)).</p>
309 <p>Please note that solaris ports can result in a lot of spurious
310notifications, so you need to use non-blocking I/O or other means to avoid
311blocking when no data (or space) is available.</p>
312 </dd>
313 <dt><code>EVBACKEND_ALL</code></dt>
314 <dd>
315 <p>Try all backends (even potentially broken ones that wouldn't be tried
316with <code>EVFLAG_AUTO</code>). Since this is a mask, you can do stuff such as
317<code>EVBACKEND_ALL &amp; ~EVBACKEND_KQUEUE</code>.</p>
188 </dd> 318 </dd>
189 </dl> 319 </dl>
190 </p> 320 </p>
321 <p>If one or more of these are ored into the flags value, then only these
322backends will be tried (in the reverse order as given here). If none are
323specified, most compiled-in backend will be tried, usually in reverse
324order of their flag values :)</p>
325 <p>The most typical usage is like this:</p>
326<pre> if (!ev_default_loop (0))
327 fatal (&quot;could not initialise libev, bad $LIBEV_FLAGS in environment?&quot;);
328
329</pre>
330 <p>Restrict libev to the select and poll backends, and do not allow
331environment settings to be taken into account:</p>
332<pre> ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
333
334</pre>
335 <p>Use whatever libev has to offer, but make sure that kqueue is used if
336available (warning, breaks stuff, best use only with your own private
337event loop and only if you know the OS supports your types of fds):</p>
338<pre> ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
339
340</pre>
191 </dd> 341 </dd>
192 <dt>struct ev_loop *ev_loop_new (unsigned int flags)</dt> 342 <dt>struct ev_loop *ev_loop_new (unsigned int flags)</dt>
193 <dd> 343 <dd>
194 <p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is 344 <p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is
195always distinct from the default loop. Unlike the default loop, it cannot 345always distinct from the default loop. Unlike the default loop, it cannot
196handle signal and child watchers, and attempts to do so will be greeted by 346handle signal and child watchers, and attempts to do so will be greeted by
197undefined behaviour (or a failed assertion if assertions are enabled).</p> 347undefined behaviour (or a failed assertion if assertions are enabled).</p>
348 <p>Example: try to create a event loop that uses epoll and nothing else.</p>
349<pre> struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
350 if (!epoller)
351 fatal (&quot;no epoll found here, maybe it hides under your chair&quot;);
352
353</pre>
198 </dd> 354 </dd>
199 <dt>ev_default_destroy ()</dt> 355 <dt>ev_default_destroy ()</dt>
200 <dd> 356 <dd>
201 <p>Destroys the default loop again (frees all memory and kernel state 357 <p>Destroys the default loop again (frees all memory and kernel state
202etc.). This stops all registered event watchers (by not touching them in 358etc.). This stops all registered event watchers (by not touching them in
203any way whatsoever, although you cnanot rely on this :).</p> 359any way whatsoever, although you cannot rely on this :).</p>
204 </dd> 360 </dd>
205 <dt>ev_loop_destroy (loop)</dt> 361 <dt>ev_loop_destroy (loop)</dt>
206 <dd> 362 <dd>
207 <p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an 363 <p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an
208earlier call to <code>ev_loop_new</code>.</p> 364earlier call to <code>ev_loop_new</code>.</p>
… …
211 <dd> 367 <dd>
212 <p>This function reinitialises the kernel state for backends that have 368 <p>This function reinitialises the kernel state for backends that have
213one. Despite the name, you can call it anytime, but it makes most sense 369one. Despite the name, you can call it anytime, but it makes most sense
214after forking, in either the parent or child process (or both, but that 370after forking, in either the parent or child process (or both, but that
215again makes little sense).</p> 371again makes little sense).</p>
216 <p>You <i>must</i> call this function after forking if and only if you want to 372 <p>You <i>must</i> call this function in the child process after forking if and
217use the event library in both processes. If you just fork+exec, you don't 373only if you want to use the event library in both processes. If you just
218have to call it.</p> 374fork+exec, you don't have to call it.</p>
219 <p>The function itself is quite fast and its usually not a problem to call 375 <p>The function itself is quite fast and it's usually not a problem to call
220it just in case after a fork. To make this easy, the function will fit in 376it just in case after a fork. To make this easy, the function will fit in
221quite nicely into a call to <code>pthread_atfork</code>:</p> 377quite nicely into a call to <code>pthread_atfork</code>:</p>
222<pre> pthread_atfork (0, 0, ev_default_fork); 378<pre> pthread_atfork (0, 0, ev_default_fork);
223 379
224</pre> 380</pre>
381 <p>At the moment, <code>EVBACKEND_SELECT</code> and <code>EVBACKEND_POLL</code> are safe to use
382without calling this function, so if you force one of those backends you
383do not need to care.</p>
225 </dd> 384 </dd>
226 <dt>ev_loop_fork (loop)</dt> 385 <dt>ev_loop_fork (loop)</dt>
227 <dd> 386 <dd>
228 <p>Like <code>ev_default_fork</code>, but acts on an event loop created by 387 <p>Like <code>ev_default_fork</code>, but acts on an event loop created by
229<code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop 388<code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop
230after fork, and how you do this is entirely your own problem.</p> 389after fork, and how you do this is entirely your own problem.</p>
231 </dd> 390 </dd>
232 <dt>unsigned int ev_method (loop)</dt> 391 <dt>unsigned int ev_backend (loop)</dt>
233 <dd> 392 <dd>
234 <p>Returns one of the <code>EVMETHOD_*</code> flags indicating the event backend in 393 <p>Returns one of the <code>EVBACKEND_*</code> flags indicating the event backend in
235use.</p> 394use.</p>
236 </dd> 395 </dd>
237 <dt>ev_tstamp = ev_now (loop)</dt> 396 <dt>ev_tstamp ev_now (loop)</dt>
238 <dd> 397 <dd>
239 <p>Returns the current &quot;event loop time&quot;, which is the time the event loop 398 <p>Returns the current &quot;event loop time&quot;, which is the time the event loop
240got events and started processing them. This timestamp does not change 399received events and started processing them. This timestamp does not
241as long as callbacks are being processed, and this is also the base time 400change as long as callbacks are being processed, and this is also the base
242used for relative timers. You can treat it as the timestamp of the event 401time used for relative timers. You can treat it as the timestamp of the
243occuring (or more correctly, the mainloop finding out about it).</p> 402event occuring (or more correctly, libev finding out about it).</p>
244 </dd> 403 </dd>
245 <dt>ev_loop (loop, int flags)</dt> 404 <dt>ev_loop (loop, int flags)</dt>
246 <dd> 405 <dd>
247 <p>Finally, this is it, the event handler. This function usually is called 406 <p>Finally, this is it, the event handler. This function usually is called
248after you initialised all your watchers and you want to start handling 407after you initialised all your watchers and you want to start handling
249events.</p> 408events.</p>
250 <p>If the flags argument is specified as 0, it will not return until either 409 <p>If the flags argument is specified as <code>0</code>, it will not return until
251no event watchers are active anymore or <code>ev_unloop</code> was called.</p> 410either no event watchers are active anymore or <code>ev_unloop</code> was called.</p>
411 <p>Please note that an explicit <code>ev_unloop</code> is usually better than
412relying on all watchers to be stopped when deciding when a program has
413finished (especially in interactive programs), but having a program that
414automatically loops as long as it has to and no longer by virtue of
415relying on its watchers stopping correctly is a thing of beauty.</p>
252 <p>A flags value of <code>EVLOOP_NONBLOCK</code> will look for new events, will handle 416 <p>A flags value of <code>EVLOOP_NONBLOCK</code> will look for new events, will handle
253those events and any outstanding ones, but will not block your process in 417those events and any outstanding ones, but will not block your process in
254case there are no events.</p> 418case there are no events and will return after one iteration of the loop.</p>
255 <p>A flags value of <code>EVLOOP_ONESHOT</code> will look for new events (waiting if 419 <p>A flags value of <code>EVLOOP_ONESHOT</code> will look for new events (waiting if
256neccessary) and will handle those and any outstanding ones. It will block 420neccessary) and will handle those and any outstanding ones. It will block
257your process until at least one new event arrives.</p> 421your process until at least one new event arrives, and will return after
258 <p>This flags value could be used to implement alternative looping 422one iteration of the loop. This is useful if you are waiting for some
259constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and 423external event in conjunction with something not expressible using other
260more generic mechanism.</p> 424libev watchers. However, a pair of <code>ev_prepare</code>/<code>ev_check</code> watchers is
425usually a better approach for this kind of thing.</p>
426 <p>Here are the gory details of what <code>ev_loop</code> does:</p>
427<pre> * If there are no active watchers (reference count is zero), return.
428 - Queue prepare watchers and then call all outstanding watchers.
429 - If we have been forked, recreate the kernel state.
430 - Update the kernel state with all outstanding changes.
431 - Update the &quot;event loop time&quot;.
432 - Calculate for how long to block.
433 - Block the process, waiting for any events.
434 - Queue all outstanding I/O (fd) events.
435 - Update the &quot;event loop time&quot; and do time jump handling.
436 - Queue all outstanding timers.
437 - Queue all outstanding periodics.
438 - If no events are pending now, queue all idle watchers.
439 - Queue all check watchers.
440 - Call all queued watchers in reverse order (i.e. check watchers first).
441 Signals and child watchers are implemented as I/O watchers, and will
442 be handled here by queueing them when their watcher gets executed.
443 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
444 were used, return, otherwise continue with step *.
445
446</pre>
447 <p>Example: queue some jobs and then loop until no events are outsanding
448anymore.</p>
449<pre> ... queue jobs here, make sure they register event watchers as long
450 ... as they still have work to do (even an idle watcher will do..)
451 ev_loop (my_loop, 0);
452 ... jobs done. yeah!
453
454</pre>
261 </dd> 455 </dd>
262 <dt>ev_unloop (loop, how)</dt> 456 <dt>ev_unloop (loop, how)</dt>
263 <dd> 457 <dd>
264 <p>Can be used to make a call to <code>ev_loop</code> return early. The <code>how</code> argument 458 <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it
459has processed all outstanding events). The <code>how</code> argument must be either
265must be either <code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> 460<code>EVUNLOOP_ONE</code>, which will make the innermost <code>ev_loop</code> call return, or
266call return, or <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> 461<code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p>
267calls return.</p>
268 </dd> 462 </dd>
269 <dt>ev_ref (loop)</dt> 463 <dt>ev_ref (loop)</dt>
270 <dt>ev_unref (loop)</dt> 464 <dt>ev_unref (loop)</dt>
271 <dd> 465 <dd>
272 <p>Ref/unref can be used to add or remove a refcount on the event loop: Every 466 <p>Ref/unref can be used to add or remove a reference count on the event
273watcher keeps one reference. If you have a long-runing watcher you never 467loop: Every watcher keeps one reference, and as long as the reference
274unregister that should not keep ev_loop from running, ev_unref() after 468count is nonzero, <code>ev_loop</code> will not return on its own. If you have
275starting, and ev_ref() before stopping it. Libev itself uses this for 469a watcher you never unregister that should not keep <code>ev_loop</code> from
276example for its internal signal pipe: It is not visible to you as a user 470returning, ev_unref() after starting, and ev_ref() before stopping it. For
277and should not keep <code>ev_loop</code> from exiting if the work is done. It is 471example, libev itself uses this for its internal signal pipe: It is not
278also an excellent way to do this for generic recurring timers or from 472visible to the libev user and should not keep <code>ev_loop</code> from exiting if
279within third-party libraries. Just remember to unref after start and ref 473no event watchers registered by it are active. It is also an excellent
280before stop.</p> 474way to do this for generic recurring timers or from within third-party
475libraries. Just remember to <i>unref after start</i> and <i>ref before stop</i>.</p>
476 <p>Example: create a signal watcher, but keep it from keeping <code>ev_loop</code>
477running when nothing else is active.</p>
478<pre> struct dv_signal exitsig;
479 ev_signal_init (&amp;exitsig, sig_cb, SIGINT);
480 ev_signal_start (myloop, &amp;exitsig);
481 evf_unref (myloop);
482
483</pre>
484 <p>Example: for some weird reason, unregister the above signal handler again.</p>
485<pre> ev_ref (myloop);
486 ev_signal_stop (myloop, &amp;exitsig);
487
488</pre>
281 </dd> 489 </dd>
282</dl> 490</dl>
283 491
284</div> 492</div>
285<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> 493<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p>
286<div id="ANATOMY_OF_A_WATCHER_CONTENT"> 494<div id="ANATOMY_OF_A_WATCHER_CONTENT">
287<p>A watcher is a structure that you create and register to record your 495<p>A watcher is a structure that you create and register to record your
288interest in some event. For instance, if you want to wait for STDIN to 496interest in some event. For instance, if you want to wait for STDIN to
289become readable, you would create an ev_io watcher for that:</p> 497become readable, you would create an <code>ev_io</code> watcher for that:</p>
290<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 498<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
291 { 499 {
292 ev_io_stop (w); 500 ev_io_stop (w);
293 ev_unloop (loop, EVUNLOOP_ALL); 501 ev_unloop (loop, EVUNLOOP_ALL);
294 } 502 }
… …
317with a watcher-specific start function (<code>ev_&lt;type&gt;_start (loop, watcher 525with a watcher-specific start function (<code>ev_&lt;type&gt;_start (loop, watcher
318*)</code>), and you can stop watching for events at any time by calling the 526*)</code>), and you can stop watching for events at any time by calling the
319corresponding stop function (<code>ev_&lt;type&gt;_stop (loop, watcher *)</code>.</p> 527corresponding stop function (<code>ev_&lt;type&gt;_stop (loop, watcher *)</code>.</p>
320<p>As long as your watcher is active (has been started but not stopped) you 528<p>As long as your watcher is active (has been started but not stopped) you
321must not touch the values stored in it. Most specifically you must never 529must not touch the values stored in it. Most specifically you must never
322reinitialise it or call its set method.</p> 530reinitialise it or call its set macro.</p>
323<p>You cna check whether an event is active by calling the <code>ev_is_active 531<p>You can check whether an event is active by calling the <code>ev_is_active
324(watcher *)</code> macro. To see whether an event is outstanding (but the 532(watcher *)</code> macro. To see whether an event is outstanding (but the
325callback for it has not been called yet) you cna use the <code>ev_is_pending 533callback for it has not been called yet) you can use the <code>ev_is_pending
326(watcher *)</code> macro.</p> 534(watcher *)</code> macro.</p>
327<p>Each and every callback receives the event loop pointer as first, the 535<p>Each and every callback receives the event loop pointer as first, the
328registered watcher structure as second, and a bitset of received events as 536registered watcher structure as second, and a bitset of received events as
329third argument.</p> 537third argument.</p>
330<p>The rceeived events usually include a single bit per event type received 538<p>The received events usually include a single bit per event type received
331(you can receive multiple events at the same time). The possible bit masks 539(you can receive multiple events at the same time). The possible bit masks
332are:</p> 540are:</p>
333<dl> 541<dl>
334 <dt>EV_READ</dt> 542 <dt><code>EV_READ</code></dt>
335 <dt>EV_WRITE</dt> 543 <dt><code>EV_WRITE</code></dt>
336 <dd> 544 <dd>
337 <p>The file descriptor in the ev_io watcher has become readable and/or 545 <p>The file descriptor in the <code>ev_io</code> watcher has become readable and/or
338writable.</p> 546writable.</p>
339 </dd> 547 </dd>
340 <dt>EV_TIMEOUT</dt> 548 <dt><code>EV_TIMEOUT</code></dt>
341 <dd>
342 <p>The ev_timer watcher has timed out.</p>
343 </dd> 549 <dd>
344 <dt>EV_PERIODIC</dt> 550 <p>The <code>ev_timer</code> watcher has timed out.</p>
345 <dd> 551 </dd>
346 <p>The ev_periodic watcher has timed out.</p> 552 <dt><code>EV_PERIODIC</code></dt>
347 </dd> 553 <dd>
348 <dt>EV_SIGNAL</dt> 554 <p>The <code>ev_periodic</code> watcher has timed out.</p>
349 <dd> 555 </dd>
556 <dt><code>EV_SIGNAL</code></dt>
557 <dd>
350 <p>The signal specified in the ev_signal watcher has been received by a thread.</p> 558 <p>The signal specified in the <code>ev_signal</code> watcher has been received by a thread.</p>
351 </dd>
352 <dt>EV_CHILD</dt>
353 <dd> 559 </dd>
560 <dt><code>EV_CHILD</code></dt>
561 <dd>
354 <p>The pid specified in the ev_child watcher has received a status change.</p> 562 <p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p>
355 </dd>
356 <dt>EV_IDLE</dt>
357 <dd> 563 </dd>
564 <dt><code>EV_IDLE</code></dt>
565 <dd>
358 <p>The ev_idle watcher has determined that you have nothing better to do.</p> 566 <p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p>
359 </dd>
360 <dt>EV_PREPARE</dt>
361 <dt>EV_CHECK</dt>
362 <dd> 567 </dd>
568 <dt><code>EV_PREPARE</code></dt>
569 <dt><code>EV_CHECK</code></dt>
570 <dd>
363 <p>All ev_prepare watchers are invoked just <i>before</i> <code>ev_loop</code> starts 571 <p>All <code>ev_prepare</code> watchers are invoked just <i>before</i> <code>ev_loop</code> starts
364to gather new events, and all ev_check watchers are invoked just after 572to gather new events, and all <code>ev_check</code> watchers are invoked just after
365<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any 573<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any
366received events. Callbacks of both watcher types can start and stop as 574received events. Callbacks of both watcher types can start and stop as
367many watchers as they want, and all of them will be taken into account 575many watchers as they want, and all of them will be taken into account
368(for example, a ev_prepare watcher might start an idle watcher to keep 576(for example, a <code>ev_prepare</code> watcher might start an idle watcher to keep
369<code>ev_loop</code> from blocking).</p> 577<code>ev_loop</code> from blocking).</p>
370 </dd> 578 </dd>
371 <dt>EV_ERROR</dt> 579 <dt><code>EV_ERROR</code></dt>
372 <dd> 580 <dd>
373 <p>An unspecified error has occured, the watcher has been stopped. This might 581 <p>An unspecified error has occured, the watcher has been stopped. This might
374happen because the watcher could not be properly started because libev 582happen because the watcher could not be properly started because libev
375ran out of memory, a file descriptor was found to be closed or any other 583ran out of memory, a file descriptor was found to be closed or any other
376problem. You best act on it by reporting the problem and somehow coping 584problem. You best act on it by reporting the problem and somehow coping
… …
385 593
386</div> 594</div>
387<h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2> 595<h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2>
388<div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2"> 596<div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2">
389<p>Each watcher has, by default, a member <code>void *data</code> that you can change 597<p>Each watcher has, by default, a member <code>void *data</code> that you can change
390and read at any time, libev will completely ignore it. This cna be used 598and read at any time, libev will completely ignore it. This can be used
391to associate arbitrary data with your watcher. If you need more data and 599to associate arbitrary data with your watcher. If you need more data and
392don't want to allocate memory and store a pointer to it in that data 600don't want to allocate memory and store a pointer to it in that data
393member, you can also &quot;subclass&quot; the watcher type and provide your own 601member, you can also &quot;subclass&quot; the watcher type and provide your own
394data:</p> 602data:</p>
395<pre> struct my_io 603<pre> struct my_io
… …
421<h1 id="WATCHER_TYPES">WATCHER TYPES</h1><p><a href="#TOP" class="toplink">Top</a></p> 629<h1 id="WATCHER_TYPES">WATCHER TYPES</h1><p><a href="#TOP" class="toplink">Top</a></p>
422<div id="WATCHER_TYPES_CONTENT"> 630<div id="WATCHER_TYPES_CONTENT">
423<p>This section describes each watcher in detail, but will not repeat 631<p>This section describes each watcher in detail, but will not repeat
424information given in the last section.</p> 632information given in the last section.</p>
425 633
634
635
636
637
426</div> 638</div>
427<h2 id="struct_ev_io_is_my_file_descriptor_r">struct ev_io - is my file descriptor readable or writable</h2> 639<h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</h2>
428<div id="struct_ev_io_is_my_file_descriptor_r-2"> 640<div id="code_ev_io_code_is_this_file_descrip-2">
429<p>I/O watchers check whether a file descriptor is readable or writable 641<p>I/O watchers check whether a file descriptor is readable or writable
430in each iteration of the event loop (This behaviour is called 642in each iteration of the event loop (This behaviour is called
431level-triggering because you keep receiving events as long as the 643level-triggering because you keep receiving events as long as the
432condition persists. Remember you cna stop the watcher if you don't want to 644condition persists. Remember you can stop the watcher if you don't want to
433act on the event and neither want to receive future events).</p> 645act on the event and neither want to receive future events).</p>
646<p>In general you can register as many read and/or write event watchers per
647fd as you want (as long as you don't confuse yourself). Setting all file
648descriptors to non-blocking mode is also usually a good idea (but not
649required if you know what you are doing).</p>
650<p>You have to be careful with dup'ed file descriptors, though. Some backends
651(the linux epoll backend is a notable example) cannot handle dup'ed file
652descriptors correctly if you register interest in two or more fds pointing
653to the same underlying file/socket etc. description (that is, they share
654the same underlying &quot;file open&quot;).</p>
655<p>If you must do this, then force the use of a known-to-be-good backend
656(at the time of this writing, this includes only <code>EVBACKEND_SELECT</code> and
657<code>EVBACKEND_POLL</code>).</p>
434<dl> 658<dl>
435 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> 659 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>
436 <dt>ev_io_set (ev_io *, int fd, int events)</dt> 660 <dt>ev_io_set (ev_io *, int fd, int events)</dt>
437 <dd> 661 <dd>
438 <p>Configures an ev_io watcher. The fd is the file descriptor to rceeive 662 <p>Configures an <code>ev_io</code> watcher. The fd is the file descriptor to rceeive
439events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ | 663events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ |
440EV_WRITE</code> to receive the given events.</p> 664EV_WRITE</code> to receive the given events.</p>
665 <p>Please note that most of the more scalable backend mechanisms (for example
666epoll and solaris ports) can result in spurious readyness notifications
667for file descriptors, so you practically need to use non-blocking I/O (and
668treat callback invocation as hint only), or retest separately with a safe
669interface before doing I/O (XLib can do this), or force the use of either
670<code>EVBACKEND_SELECT</code> or <code>EVBACKEND_POLL</code>, which don't suffer from this
671problem. Also note that it is quite easy to have your callback invoked
672when the readyness condition is no longer valid even when employing
673typical ways of handling events, so its a good idea to use non-blocking
674I/O unconditionally.</p>
441 </dd> 675 </dd>
442</dl> 676</dl>
677<p>Example: call <code>stdin_readable_cb</code> when STDIN_FILENO has become, well
678readable, but only once. Since it is likely line-buffered, you could
679attempt to read a whole line in the callback:</p>
680<pre> static void
681 stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
682 {
683 ev_io_stop (loop, w);
684 .. read from stdin here (or from w-&gt;fd) and haqndle any I/O errors
685 }
443 686
687 ...
688 struct ev_loop *loop = ev_default_init (0);
689 struct ev_io stdin_readable;
690 ev_io_init (&amp;stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
691 ev_io_start (loop, &amp;stdin_readable);
692 ev_loop (loop, 0);
693
694
695
696
697</pre>
698
444</div> 699</div>
445<h2 id="struct_ev_timer_relative_and_optiona">struct ev_timer - relative and optionally recurring timeouts</h2> 700<h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2>
446<div id="struct_ev_timer_relative_and_optiona-2"> 701<div id="code_ev_timer_code_relative_and_opti-2">
447<p>Timer watchers are simple relative timers that generate an event after a 702<p>Timer watchers are simple relative timers that generate an event after a
448given time, and optionally repeating in regular intervals after that.</p> 703given time, and optionally repeating in regular intervals after that.</p>
449<p>The timers are based on real time, that is, if you register an event that 704<p>The timers are based on real time, that is, if you register an event that
450times out after an hour and youreset your system clock to last years 705times out after an hour and you reset your system clock to last years
451time, it will still time out after (roughly) and hour. &quot;Roughly&quot; because 706time, it will still time out after (roughly) and hour. &quot;Roughly&quot; because
452detecting time jumps is hard, and soem inaccuracies are unavoidable (the 707detecting time jumps is hard, and some inaccuracies are unavoidable (the
453monotonic clock option helps a lot here).</p> 708monotonic clock option helps a lot here).</p>
709<p>The relative timeouts are calculated relative to the <code>ev_now ()</code>
710time. This is usually the right thing as this timestamp refers to the time
711of the event triggering whatever timeout you are modifying/starting. If
712you suspect event processing to be delayed and you <i>need</i> to base the timeout
713on the current time, use something like this to adjust for this:</p>
714<pre> ev_timer_set (&amp;timer, after + ev_now () - ev_time (), 0.);
715
716</pre>
717<p>The callback is guarenteed to be invoked only when its timeout has passed,
718but if multiple timers become ready during the same loop iteration then
719order of execution is undefined.</p>
454<dl> 720<dl>
455 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> 721 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt>
456 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> 722 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt>
457 <dd> 723 <dd>
458 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is 724 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is
… …
460timer will automatically be configured to trigger again <code>repeat</code> seconds 726timer will automatically be configured to trigger again <code>repeat</code> seconds
461later, again, and again, until stopped manually.</p> 727later, again, and again, until stopped manually.</p>
462 <p>The timer itself will do a best-effort at avoiding drift, that is, if you 728 <p>The timer itself will do a best-effort at avoiding drift, that is, if you
463configure a timer to trigger every 10 seconds, then it will trigger at 729configure a timer to trigger every 10 seconds, then it will trigger at
464exactly 10 second intervals. If, however, your program cannot keep up with 730exactly 10 second intervals. If, however, your program cannot keep up with
465the timer (ecause it takes longer than those 10 seconds to do stuff) the 731the timer (because it takes longer than those 10 seconds to do stuff) the
466timer will not fire more than once per event loop iteration.</p> 732timer will not fire more than once per event loop iteration.</p>
467 </dd> 733 </dd>
468 <dt>ev_timer_again (loop)</dt> 734 <dt>ev_timer_again (loop)</dt>
469 <dd> 735 <dd>
470 <p>This will act as if the timer timed out and restart it again if it is 736 <p>This will act as if the timer timed out and restart it again if it is
… …
474value), or reset the running timer to the repeat value.</p> 740value), or reset the running timer to the repeat value.</p>
475 <p>This sounds a bit complicated, but here is a useful and typical 741 <p>This sounds a bit complicated, but here is a useful and typical
476example: Imagine you have a tcp connection and you want a so-called idle 742example: Imagine you have a tcp connection and you want a so-called idle
477timeout, that is, you want to be called when there have been, say, 60 743timeout, that is, you want to be called when there have been, say, 60
478seconds of inactivity on the socket. The easiest way to do this is to 744seconds of inactivity on the socket. The easiest way to do this is to
479configure an ev_timer with after=repeat=60 and calling ev_timer_again each 745configure an <code>ev_timer</code> with after=repeat=60 and calling ev_timer_again each
480time you successfully read or write some data. If you go into an idle 746time you successfully read or write some data. If you go into an idle
481state where you do not expect data to travel on the socket, you can stop 747state where you do not expect data to travel on the socket, you can stop
482the timer, and again will automatically restart it if need be.</p> 748the timer, and again will automatically restart it if need be.</p>
483 </dd> 749 </dd>
484</dl> 750</dl>
751<p>Example: create a timer that fires after 60 seconds.</p>
752<pre> static void
753 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
754 {
755 .. one minute over, w is actually stopped right here
756 }
485 757
758 struct ev_timer mytimer;
759 ev_timer_init (&amp;mytimer, one_minute_cb, 60., 0.);
760 ev_timer_start (loop, &amp;mytimer);
761
762</pre>
763<p>Example: create a timeout timer that times out after 10 seconds of
764inactivity.</p>
765<pre> static void
766 timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
767 {
768 .. ten seconds without any activity
769 }
770
771 struct ev_timer mytimer;
772 ev_timer_init (&amp;mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
773 ev_timer_again (&amp;mytimer); /* start timer */
774 ev_loop (loop, 0);
775
776 // and in some piece of code that gets executed on any &quot;activity&quot;:
777 // reset the timeout to start ticking again at 10 seconds
778 ev_timer_again (&amp;mytimer);
779
780
781
782
783</pre>
784
486</div> 785</div>
487<h2 id="ev_periodic_to_cron_or_not_to_cron_i">ev_periodic - to cron or not to cron it</h2> 786<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</h2>
488<div id="ev_periodic_to_cron_or_not_to_cron_i-2"> 787<div id="code_ev_periodic_code_to_cron_or_not-2">
489<p>Periodic watchers are also timers of a kind, but they are very versatile 788<p>Periodic watchers are also timers of a kind, but they are very versatile
490(and unfortunately a bit complex).</p> 789(and unfortunately a bit complex).</p>
491<p>Unlike ev_timer's, they are not based on real time (or relative time) 790<p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time)
492but on wallclock time (absolute time). You can tell a periodic watcher 791but on wallclock time (absolute time). You can tell a periodic watcher
493to trigger &quot;at&quot; some specific point in time. For example, if you tell a 792to trigger &quot;at&quot; some specific point in time. For example, if you tell a
494periodic watcher to trigger in 10 seconds (by specifiying e.g. c&lt;ev_now () 793periodic watcher to trigger in 10 seconds (by specifiying e.g. c&lt;ev_now ()
495+ 10.&gt;) and then reset your system clock to the last year, then it will 794+ 10.&gt;) and then reset your system clock to the last year, then it will
496take a year to trigger the event (unlike an ev_timer, which would trigger 795take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger
497roughly 10 seconds later and of course not if you reset your system time 796roughly 10 seconds later and of course not if you reset your system time
498again).</p> 797again).</p>
499<p>They can also be used to implement vastly more complex timers, such as 798<p>They can also be used to implement vastly more complex timers, such as
500triggering an event on eahc midnight, local time.</p> 799triggering an event on eahc midnight, local time.</p>
800<p>As with timers, the callback is guarenteed to be invoked only when the
801time (<code>at</code>) has been passed, but if multiple periodic timers become ready
802during the same loop iteration then order of execution is undefined.</p>
501<dl> 803<dl>
502 <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> 804 <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt>
503 <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt> 805 <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt>
504 <dd> 806 <dd>
505 <p>Lots of arguments, lets sort it out... There are basically three modes of 807 <p>Lots of arguments, lets sort it out... There are basically three modes of
506operation, and we will explain them from simplest to complex:</p> 808operation, and we will explain them from simplest to complex:</p>
507
508
509
510
511 <p> 809 <p>
512 <dl> 810 <dl>
513 <dt>* absolute timer (interval = reschedule_cb = 0)</dt> 811 <dt>* absolute timer (interval = reschedule_cb = 0)</dt>
514 <dd> 812 <dd>
515 <p>In this configuration the watcher triggers an event at the wallclock time 813 <p>In this configuration the watcher triggers an event at the wallclock time
… …
527<pre> ev_periodic_set (&amp;periodic, 0., 3600., 0); 825<pre> ev_periodic_set (&amp;periodic, 0., 3600., 0);
528 826
529</pre> 827</pre>
530 <p>This doesn't mean there will always be 3600 seconds in between triggers, 828 <p>This doesn't mean there will always be 3600 seconds in between triggers,
531but only that the the callback will be called when the system time shows a 829but only that the the callback will be called when the system time shows a
532full hour (UTC), or more correct, when the system time is evenly divisible 830full hour (UTC), or more correctly, when the system time is evenly divisible
533by 3600.</p> 831by 3600.</p>
534 <p>Another way to think about it (for the mathematically inclined) is that 832 <p>Another way to think about it (for the mathematically inclined) is that
535ev_periodic will try to run the callback in this mode at the next possible 833<code>ev_periodic</code> will try to run the callback in this mode at the next possible
536time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p> 834time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p>
537 </dd> 835 </dd>
538 <dt>* manual reschedule mode (reschedule_cb = callback)</dt> 836 <dt>* manual reschedule mode (reschedule_cb = callback)</dt>
539 <dd> 837 <dd>
540 <p>In this mode the values for <code>interval</code> and <code>at</code> are both being 838 <p>In this mode the values for <code>interval</code> and <code>at</code> are both being
541ignored. Instead, each time the periodic watcher gets scheduled, the 839ignored. Instead, each time the periodic watcher gets scheduled, the
542reschedule callback will be called with the watcher as first, and the 840reschedule callback will be called with the watcher as first, and the
543current time as second argument.</p> 841current time as second argument.</p>
544 <p>NOTE: <i>This callback MUST NOT stop or destroy the periodic or any other 842 <p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher,
545periodic watcher, ever, or make any event loop modificstions</i>. If you need 843ever, or make any event loop modifications</i>. If you need to stop it,
546to stop it, return 1e30 (or so, fudge fudge) and stop it afterwards.</p> 844return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by
845starting a prepare watcher).</p>
547 <p>Its prototype is c&lt;ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 846 <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
548ev_tstamp now)&gt;, e.g.:</p> 847ev_tstamp now)</code>, e.g.:</p>
549<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 848<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
550 { 849 {
551 return now + 60.; 850 return now + 60.;
552 } 851 }
553 852
554</pre> 853</pre>
555 <p>It must return the next time to trigger, based on the passed time value 854 <p>It must return the next time to trigger, based on the passed time value
556(that is, the lowest time value larger than to the second argument). It 855(that is, the lowest time value larger than to the second argument). It
557will usually be called just before the callback will be triggered, but 856will usually be called just before the callback will be triggered, but
558might be called at other times, too.</p> 857might be called at other times, too.</p>
858 <p>NOTE: <i>This callback must always return a time that is later than the
859passed <code>now</code> value</i>. Not even <code>now</code> itself will do, it <i>must</i> be larger.</p>
559 <p>This can be used to create very complex timers, such as a timer that 860 <p>This can be used to create very complex timers, such as a timer that
560triggers on each midnight, local time. To do this, you would calculate the 861triggers on each midnight, local time. To do this, you would calculate the
561next midnight after <code>now</code> and return the timestamp value for this. How you do this 862next midnight after <code>now</code> and return the timestamp value for this. How
562is, again, up to you (but it is not trivial).</p> 863you do this is, again, up to you (but it is not trivial, which is the main
864reason I omitted it as an example).</p>
563 </dd> 865 </dd>
564 </dl> 866 </dl>
565 </p> 867 </p>
566 </dd> 868 </dd>
567 <dt>ev_periodic_again (loop, ev_periodic *)</dt> 869 <dt>ev_periodic_again (loop, ev_periodic *)</dt>
… …
570when you changed some parameters or the reschedule callback would return 872when you changed some parameters or the reschedule callback would return
571a different time than the last time it was called (e.g. in a crond like 873a different time than the last time it was called (e.g. in a crond like
572program when the crontabs have changed).</p> 874program when the crontabs have changed).</p>
573 </dd> 875 </dd>
574</dl> 876</dl>
877<p>Example: call a callback every hour, or, more precisely, whenever the
878system clock is divisible by 3600. The callback invocation times have
879potentially a lot of jittering, but good long-term stability.</p>
880<pre> static void
881 clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
882 {
883 ... its now a full hour (UTC, or TAI or whatever your clock follows)
884 }
575 885
886 struct ev_periodic hourly_tick;
887 ev_periodic_init (&amp;hourly_tick, clock_cb, 0., 3600., 0);
888 ev_periodic_start (loop, &amp;hourly_tick);
889
890</pre>
891<p>Example: the same as above, but use a reschedule callback to do it:</p>
892<pre> #include &lt;math.h&gt;
893
894 static ev_tstamp
895 my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
896 {
897 return fmod (now, 3600.) + 3600.;
898 }
899
900 ev_periodic_init (&amp;hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
901
902</pre>
903<p>Example: call a callback every hour, starting now:</p>
904<pre> struct ev_periodic hourly_tick;
905 ev_periodic_init (&amp;hourly_tick, clock_cb,
906 fmod (ev_now (loop), 3600.), 3600., 0);
907 ev_periodic_start (loop, &amp;hourly_tick);
908
909
910
911
912</pre>
913
576</div> 914</div>
577<h2 id="ev_signal_signal_me_when_a_signal_ge">ev_signal - signal me when a signal gets signalled</h2> 915<h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</h2>
578<div id="ev_signal_signal_me_when_a_signal_ge-2"> 916<div id="code_ev_signal_code_signal_me_when_a-2">
579<p>Signal watchers will trigger an event when the process receives a specific 917<p>Signal watchers will trigger an event when the process receives a specific
580signal one or more times. Even though signals are very asynchronous, libev 918signal one or more times. Even though signals are very asynchronous, libev
581will try its best to deliver signals synchronously, i.e. as part of the 919will try it's best to deliver signals synchronously, i.e. as part of the
582normal event processing, like any other event.</p> 920normal event processing, like any other event.</p>
583<p>You cna configure as many watchers as you like per signal. Only when the 921<p>You can configure as many watchers as you like per signal. Only when the
584first watcher gets started will libev actually register a signal watcher 922first watcher gets started will libev actually register a signal watcher
585with the kernel (thus it coexists with your own signal handlers as long 923with the kernel (thus it coexists with your own signal handlers as long
586as you don't register any with libev). Similarly, when the last signal 924as you don't register any with libev). Similarly, when the last signal
587watcher for a signal is stopped libev will reset the signal handler to 925watcher for a signal is stopped libev will reset the signal handler to
588SIG_DFL (regardless of what it was set to before).</p> 926SIG_DFL (regardless of what it was set to before).</p>
… …
594of the <code>SIGxxx</code> constants).</p> 932of the <code>SIGxxx</code> constants).</p>
595 </dd> 933 </dd>
596</dl> 934</dl>
597 935
598</div> 936</div>
599<h2 id="ev_child_wait_for_pid_status_changes">ev_child - wait for pid status changes</h2> 937<h2 id="code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</h2>
600<div id="ev_child_wait_for_pid_status_changes-2"> 938<div id="code_ev_child_code_wait_for_pid_stat-2">
601<p>Child watchers trigger when your process receives a SIGCHLD in response to 939<p>Child watchers trigger when your process receives a SIGCHLD in response to
602some child status changes (most typically when a child of yours dies).</p> 940some child status changes (most typically when a child of yours dies).</p>
603<dl> 941<dl>
604 <dt>ev_child_init (ev_child *, callback, int pid)</dt> 942 <dt>ev_child_init (ev_child *, callback, int pid)</dt>
605 <dt>ev_child_set (ev_child *, int pid)</dt> 943 <dt>ev_child_set (ev_child *, int pid)</dt>
606 <dd> 944 <dd>
607 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or 945 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or
608<i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look 946<i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look
609at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see 947at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see
610the status word (use the macros from <code>sys/wait.h</code>). The <code>rpid</code> member 948the status word (use the macros from <code>sys/wait.h</code> and see your systems
949<code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the
611contains the pid of the process causing the status change.</p> 950process causing the status change.</p>
612 </dd> 951 </dd>
613</dl> 952</dl>
953<p>Example: try to exit cleanly on SIGINT and SIGTERM.</p>
954<pre> static void
955 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
956 {
957 ev_unloop (loop, EVUNLOOP_ALL);
958 }
614 959
960 struct ev_signal signal_watcher;
961 ev_signal_init (&amp;signal_watcher, sigint_cb, SIGINT);
962 ev_signal_start (loop, &amp;sigint_cb);
963
964
965
966
967</pre>
968
615</div> 969</div>
616<h2 id="ev_idle_when_you_ve_got_nothing_bett">ev_idle - when you've got nothing better to do</h2> 970<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</h2>
617<div id="ev_idle_when_you_ve_got_nothing_bett-2"> 971<div id="code_ev_idle_code_when_you_ve_got_no-2">
618<p>Idle watchers trigger events when there are no other I/O or timer (or 972<p>Idle watchers trigger events when there are no other events are pending
619periodic) events pending. That is, as long as your process is busy 973(prepare, check and other idle watchers do not count). That is, as long
620handling sockets or timeouts it will not be called. But when your process 974as your process is busy handling sockets or timeouts (or even signals,
621is idle all idle watchers are being called again and again - until 975imagine) it will not be triggered. But when your process is idle all idle
976watchers are being called again and again, once per event loop iteration -
622stopped, that is, or your process receives more events.</p> 977until stopped, that is, or your process receives more events and becomes
978busy.</p>
623<p>The most noteworthy effect is that as long as any idle watchers are 979<p>The most noteworthy effect is that as long as any idle watchers are
624active, the process will not block when waiting for new events.</p> 980active, the process will not block when waiting for new events.</p>
625<p>Apart from keeping your process non-blocking (which is a useful 981<p>Apart from keeping your process non-blocking (which is a useful
626effect on its own sometimes), idle watchers are a good place to do 982effect on its own sometimes), idle watchers are a good place to do
627&quot;pseudo-background processing&quot;, or delay processing stuff to after the 983&quot;pseudo-background processing&quot;, or delay processing stuff to after the
… …
632 <p>Initialises and configures the idle watcher - it has no parameters of any 988 <p>Initialises and configures the idle watcher - it has no parameters of any
633kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless, 989kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless,
634believe me.</p> 990believe me.</p>
635 </dd> 991 </dd>
636</dl> 992</dl>
993<p>Example: dynamically allocate an <code>ev_idle</code>, start it, and in the
994callback, free it. Alos, use no error checking, as usual.</p>
995<pre> static void
996 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
997 {
998 free (w);
999 // now do something you wanted to do when the program has
1000 // no longer asnything immediate to do.
1001 }
637 1002
1003 struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1004 ev_idle_init (idle_watcher, idle_cb);
1005 ev_idle_start (loop, idle_cb);
1006
1007
1008
1009
1010</pre>
1011
638</div> 1012</div>
639<h2 id="prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</h2> 1013<h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2>
640<div id="prepare_and_check_your_hooks_into_th-2"> 1014<div id="code_ev_prepare_code_and_code_ev_che-2">
641<p>Prepare and check watchers usually (but not always) are used in 1015<p>Prepare and check watchers are usually (but not always) used in tandem:
642tandom. Prepare watchers get invoked before the process blocks and check 1016prepare watchers get invoked before the process blocks and check watchers
643watchers afterwards.</p> 1017afterwards.</p>
644<p>Their main purpose is to integrate other event mechanisms into libev. This 1018<p>Their main purpose is to integrate other event mechanisms into libev. This
645could be used, for example, to track variable changes, implement your own 1019could be used, for example, to track variable changes, implement your own
646watchers, integrate net-snmp or a coroutine library and lots more.</p> 1020watchers, integrate net-snmp or a coroutine library and lots more.</p>
647<p>This is done by examining in each prepare call which file descriptors need 1021<p>This is done by examining in each prepare call which file descriptors need
648to be watched by the other library, registering ev_io watchers for them 1022to be watched by the other library, registering <code>ev_io</code> watchers for
649and starting an ev_timer watcher for any timeouts (many libraries provide 1023them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries
650just this functionality). Then, in the check watcher you check for any 1024provide just this functionality). Then, in the check watcher you check for
651events that occured (by making your callbacks set soem flags for example) 1025any events that occured (by checking the pending status of all watchers
652and call back into the library.</p> 1026and stopping them) and call back into the library. The I/O and timer
1027callbacks will never actually be called (but must be valid nevertheless,
1028because you never know, you know?).</p>
653<p>As another example, the perl Coro module uses these hooks to integrate 1029<p>As another example, the Perl Coro module uses these hooks to integrate
654coroutines into libev programs, by yielding to other active coroutines 1030coroutines into libev programs, by yielding to other active coroutines
655during each prepare and only letting the process block if no coroutines 1031during each prepare and only letting the process block if no coroutines
656are ready to run.</p> 1032are ready to run (it's actually more complicated: it only runs coroutines
1033with priority higher than or equal to the event loop and one coroutine
1034of lower priority, but only once, using idle watchers to keep the event
1035loop from blocking if lower-priority coroutines are active, thus mapping
1036low-priority coroutines to idle/background tasks).</p>
657<dl> 1037<dl>
658 <dt>ev_prepare_init (ev_prepare *, callback)</dt> 1038 <dt>ev_prepare_init (ev_prepare *, callback)</dt>
659 <dt>ev_check_init (ev_check *, callback)</dt> 1039 <dt>ev_check_init (ev_check *, callback)</dt>
660 <dd> 1040 <dd>
661 <p>Initialises and configures the prepare or check watcher - they have no 1041 <p>Initialises and configures the prepare or check watcher - they have no
662parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> 1042parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code>
663macros, but using them is utterly, utterly pointless.</p> 1043macros, but using them is utterly, utterly and completely pointless.</p>
664 </dd> 1044 </dd>
665</dl> 1045</dl>
1046<p>Example: *TODO*.</p>
1047
1048
1049
1050
666 1051
667</div> 1052</div>
668<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 1053<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
669<div id="OTHER_FUNCTIONS_CONTENT"> 1054<div id="OTHER_FUNCTIONS_CONTENT">
670<p>There are some other fucntions of possible interest. Described. Here. Now.</p> 1055<p>There are some other functions of possible interest. Described. Here. Now.</p>
671<dl> 1056<dl>
672 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> 1057 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt>
673 <dd> 1058 <dd>
674 <p>This function combines a simple timer and an I/O watcher, calls your 1059 <p>This function combines a simple timer and an I/O watcher, calls your
675callback on whichever event happens first and automatically stop both 1060callback on whichever event happens first and automatically stop both
676watchers. This is useful if you want to wait for a single event on an fd 1061watchers. This is useful if you want to wait for a single event on an fd
677or timeout without havign to allocate/configure/start/stop/free one or 1062or timeout without having to allocate/configure/start/stop/free one or
678more watchers yourself.</p> 1063more watchers yourself.</p>
679 <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events is 1064 <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events
680ignored. Otherwise, an ev_io watcher for the given <code>fd</code> and <code>events</code> set 1065is being ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and
681will be craeted and started.</p> 1066<code>events</code> set will be craeted and started.</p>
682 <p>If <code>timeout</code> is less than 0, then no timeout watcher will be 1067 <p>If <code>timeout</code> is less than 0, then no timeout watcher will be
683started. Otherwise an ev_timer watcher with after = <code>timeout</code> (and repeat 1068started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and
684= 0) will be started.</p> 1069repeat = 0) will be started. While <code>0</code> is a valid timeout, it is of
1070dubious value.</p>
685 <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and 1071 <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and gets
686gets passed an events set (normally a combination of EV_ERROR, EV_READ, 1072passed an <code>revents</code> set like normal event callbacks (a combination of
687EV_WRITE or EV_TIMEOUT) and the <code>arg</code> value passed to <code>ev_once</code>:</p> 1073<code>EV_ERROR</code>, <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code>
1074value passed to <code>ev_once</code>:</p>
688<pre> static void stdin_ready (int revents, void *arg) 1075<pre> static void stdin_ready (int revents, void *arg)
689 { 1076 {
690 if (revents &amp; EV_TIMEOUT) 1077 if (revents &amp; EV_TIMEOUT)
691 /* doh, nothing entered */ 1078 /* doh, nothing entered */;
692 else if (revents &amp; EV_READ) 1079 else if (revents &amp; EV_READ)
693 /* stdin might have data for us, joy! */ 1080 /* stdin might have data for us, joy! */;
694 } 1081 }
695 1082
696 ev_once (STDIN_FILENO, EV_READm 10., stdin_ready, 0); 1083 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
697 1084
698</pre> 1085</pre>
699 </dd> 1086 </dd>
700 <dt>ev_feed_event (loop, watcher, int events)</dt> 1087 <dt>ev_feed_event (loop, watcher, int events)</dt>
701 <dd> 1088 <dd>
702 <p>Feeds the given event set into the event loop, as if the specified event 1089 <p>Feeds the given event set into the event loop, as if the specified event
703has happened for the specified watcher (which must be a pointer to an 1090had happened for the specified watcher (which must be a pointer to an
704initialised but not necessarily active event watcher).</p> 1091initialised but not necessarily started event watcher).</p>
705 </dd> 1092 </dd>
706 <dt>ev_feed_fd_event (loop, int fd, int revents)</dt> 1093 <dt>ev_feed_fd_event (loop, int fd, int revents)</dt>
707 <dd> 1094 <dd>
708 <p>Feed an event on the given fd, as if a file descriptor backend detected it.</p> 1095 <p>Feed an event on the given fd, as if a file descriptor backend detected
1096the given events it.</p>
709 </dd> 1097 </dd>
710 <dt>ev_feed_signal_event (loop, int signum)</dt> 1098 <dt>ev_feed_signal_event (loop, int signum)</dt>
711 <dd> 1099 <dd>
712 <p>Feed an event as if the given signal occured (loop must be the default loop!).</p> 1100 <p>Feed an event as if the given signal occured (loop must be the default loop!).</p>
713 </dd> 1101 </dd>
714</dl> 1102</dl>
1103
1104
1105
1106
1107
1108</div>
1109<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1><p><a href="#TOP" class="toplink">Top</a></p>
1110<div id="LIBEVENT_EMULATION_CONTENT">
1111<p>Libev offers a compatibility emulation layer for libevent. It cannot
1112emulate the internals of libevent, so here are some usage hints:</p>
1113<dl>
1114 <dt>* Use it by including &lt;event.h&gt;, as usual.</dt>
1115 <dt>* The following members are fully supported: ev_base, ev_callback,
1116ev_arg, ev_fd, ev_res, ev_events.</dt>
1117 <dt>* Avoid using ev_flags and the EVLIST_*-macros, while it is
1118maintained by libev, it does not work exactly the same way as in libevent (consider
1119it a private API).</dt>
1120 <dt>* Priorities are not currently supported. Initialising priorities
1121will fail and all watchers will have the same priority, even though there
1122is an ev_pri field.</dt>
1123 <dt>* Other members are not supported.</dt>
1124 <dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need
1125to use the libev header file and library.</dt>
1126</dl>
1127
1128</div>
1129<h1 id="C_SUPPORT">C++ SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p>
1130<div id="C_SUPPORT_CONTENT">
1131<p>TBD.</p>
715 1132
716</div> 1133</div>
717<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> 1134<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
718<div id="AUTHOR_CONTENT"> 1135<div id="AUTHOR_CONTENT">
719<p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p> 1136<p>Marc Lehmann &lt;libev@schmorp.de&gt;.</p>

Diff Legend

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