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

Comparing libev/ev.html (file contents):
Revision 1.7 by root, Mon Nov 12 08:16:02 2007 UTC vs.
Revision 1.22 by root, Mon Nov 12 09:02:16 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:16:01 2007" /> 9 <meta name="created" content="Mon Nov 12 10:02:16 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>
39<li><a href="#AUTHOR">AUTHOR</a> 40<li><a href="#AUTHOR">AUTHOR</a>
40</li> 41</li>
… …
87support for multiple event loops, then all functions taking an initial 88support 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>) 89argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>)
89will not have this argument.</p> 90will not have this argument.</p>
90 91
91</div> 92</div>
92<h1 id="TIME_AND_OTHER_GLOBAL_FUNCTIONS">TIME AND OTHER GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 93<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"> 94<div id="TIME_REPRESENTATION_CONTENT">
94<p>Libev represents time as a single floating point number, representing the 95<p>Libev represents time as a single floating point number, representing the
95(fractional) number of seconds since the (POSIX) epoch (somewhere near 96(fractional) number of seconds since the (POSIX) epoch (somewhere near
96the beginning of 1970, details are complicated, don't ask). This type is 97the 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 98called <code>ev_tstamp</code>, which is what you should use too. It usually aliases
98to the double type in C.</p> 99to the double type in C.</p>
100
101</div>
102<h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
103<div id="GLOBAL_FUNCTIONS_CONTENT">
104<p>These functions can be called anytime, even before initialising the
105library in any way.</p>
99<dl> 106<dl>
100 <dt>ev_tstamp ev_time ()</dt> 107 <dt>ev_tstamp ev_time ()</dt>
101 <dd> 108 <dd>
102 <p>Returns the current time as libev would use it.</p> 109 <p>Returns the current time as libev would use it.</p>
103 </dd> 110 </dd>
… …
107 <p>You can find out the major and minor version numbers of the library 114 <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 115you 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 116<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 117symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the
111version of the library your program was compiled against.</p> 118version of the library your program was compiled against.</p>
112 <p>Usually, its a good idea to terminate if the major versions mismatch, 119 <p>Usually, it's a good idea to terminate if the major versions mismatch,
113as this indicates an incompatible change. Minor versions are usually 120as this indicates an incompatible change. Minor versions are usually
114compatible to older versions, so a larger minor version alone is usually 121compatible to older versions, so a larger minor version alone is usually
115not a problem.</p> 122not a problem.</p>
116 </dd> 123 </dd>
117 <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> 124 <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt>
… …
142<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2"> 149<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 150<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 151types of such loops, the <i>default</i> loop, which supports signals and child
145events, and dynamically created loops which do not.</p> 152events, and dynamically created loops which do not.</p>
146<p>If you use threads, a common model is to run the default event loop 153<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 154in your main thread (or in a separate thread) and for each thread you
148create, you also create another event loop. Libev itself does no locking 155create, you also create another event loop. Libev itself does no locking
149whatsoever, so if you mix calls to the same event loop in different 156whatsoever, so if you mix calls to the same event loop in different
150threads, make sure you lock (this is usually a bad idea, though, even if 157threads, make sure you lock (this is usually a bad idea, though, even if
151done correctly, because its hideous and inefficient).</p> 158done correctly, because it's hideous and inefficient).</p>
152<dl> 159<dl>
153 <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt> 160 <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt>
154 <dd> 161 <dd>
155 <p>This will initialise the default event loop if it hasn't been initialised 162 <p>This will initialise the default event loop if it hasn't been initialised
156yet and return it. If the default loop could not be initialised, returns 163yet and return it. If the default loop could not be initialised, returns
157false. If it already was initialised it simply returns it (and ignores the 164false. If it already was initialised it simply returns it (and ignores the
158flags).</p> 165flags).</p>
159 <p>If you don't know what event loop to use, use the one returned from this 166 <p>If you don't know what event loop to use, use the one returned from this
160function.</p> 167function.</p>
161 <p>The flags argument can be used to specify special behaviour or specific 168 <p>The flags argument can be used to specify special behaviour or specific
162backends to use, and is usually specified as 0 (or EVFLAG_AUTO)</p> 169backends to use, and is usually specified as 0 (or EVFLAG_AUTO).</p>
163 <p>It supports the following flags:</p> 170 <p>It supports the following flags:</p>
164 <p> 171 <p>
165 <dl> 172 <dl>
166 <dt>EVFLAG_AUTO</dt> 173 <dt><code>EVFLAG_AUTO</code></dt>
167 <dd> 174 <dd>
168 <p>The default flags value. Use this if you have no clue (its the right 175 <p>The default flags value. Use this if you have no clue (it's the right
169thing, believe me).</p> 176thing, believe me).</p>
170 </dd> 177 </dd>
171 <dt>EVFLAG_NOENV</dt> 178 <dt><code>EVFLAG_NOENV</code></dt>
172 <dd> 179 <dd>
173 <p>If this flag bit is ored into the flag value then libev will <i>not</i> look 180 <p>If this flag bit is ored into the flag value (or the program runs setuid
174at the environment variable <code>LIBEV_FLAGS</code>. Otherwise (the default), this 181or setgid) then libev will <i>not</i> look at the environment variable
175environment variable will override the flags completely. This is useful 182<code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will
183override the flags completely if it is found in the environment. This is
176to try out specific backends to tets their performance, or to work around 184useful to try out specific backends to test their performance, or to work
177bugs.</p> 185around bugs.</p>
178 </dd> 186 </dd>
179 <dt>EVMETHOD_SELECT portable select backend</dt> 187 <dt><code>EVMETHOD_SELECT</code> (portable select backend)</dt>
180 <dt>EVMETHOD_POLL poll backend (everywhere except windows)</dt> 188 <dt><code>EVMETHOD_POLL</code> (poll backend, available everywhere except on windows)</dt>
181 <dt>EVMETHOD_EPOLL linux only</dt> 189 <dt><code>EVMETHOD_EPOLL</code> (linux only)</dt>
182 <dt>EVMETHOD_KQUEUE some bsds only</dt> 190 <dt><code>EVMETHOD_KQUEUE</code> (some bsds only)</dt>
183 <dt>EVMETHOD_DEVPOLL solaris 8 only</dt> 191 <dt><code>EVMETHOD_DEVPOLL</code> (solaris 8 only)</dt>
184 <dt>EVMETHOD_PORT solaris 10 only</dt> 192 <dt><code>EVMETHOD_PORT</code> (solaris 10 only)</dt>
185 <dd> 193 <dd>
186 <p>If one or more of these are ored into the flags value, then only these 194 <p>If one or more of these are ored into the flags value, then only these
187backends will be tried (in the reverse order as given here). If one are 195backends will be tried (in the reverse order as given here). If one are
188specified, any backend will do.</p> 196specified, any backend will do.</p>
189 </dd> 197 </dd>
… …
199 </dd> 207 </dd>
200 <dt>ev_default_destroy ()</dt> 208 <dt>ev_default_destroy ()</dt>
201 <dd> 209 <dd>
202 <p>Destroys the default loop again (frees all memory and kernel state 210 <p>Destroys the default loop again (frees all memory and kernel state
203etc.). This stops all registered event watchers (by not touching them in 211etc.). This stops all registered event watchers (by not touching them in
204any way whatsoever, although you cnanot rely on this :).</p> 212any way whatsoever, although you cannot rely on this :).</p>
205 </dd> 213 </dd>
206 <dt>ev_loop_destroy (loop)</dt> 214 <dt>ev_loop_destroy (loop)</dt>
207 <dd> 215 <dd>
208 <p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an 216 <p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an
209earlier call to <code>ev_loop_new</code>.</p> 217earlier call to <code>ev_loop_new</code>.</p>
… …
215after forking, in either the parent or child process (or both, but that 223after forking, in either the parent or child process (or both, but that
216again makes little sense).</p> 224again makes little sense).</p>
217 <p>You <i>must</i> call this function after forking if and only if you want to 225 <p>You <i>must</i> call this function after forking if and only if you want to
218use the event library in both processes. If you just fork+exec, you don't 226use the event library in both processes. If you just fork+exec, you don't
219have to call it.</p> 227have to call it.</p>
220 <p>The function itself is quite fast and its usually not a problem to call 228 <p>The function itself is quite fast and it's usually not a problem to call
221it just in case after a fork. To make this easy, the function will fit in 229it just in case after a fork. To make this easy, the function will fit in
222quite nicely into a call to <code>pthread_atfork</code>:</p> 230quite nicely into a call to <code>pthread_atfork</code>:</p>
223<pre> pthread_atfork (0, 0, ev_default_fork); 231<pre> pthread_atfork (0, 0, ev_default_fork);
224 232
225</pre> 233</pre>
… …
233 <dt>unsigned int ev_method (loop)</dt> 241 <dt>unsigned int ev_method (loop)</dt>
234 <dd> 242 <dd>
235 <p>Returns one of the <code>EVMETHOD_*</code> flags indicating the event backend in 243 <p>Returns one of the <code>EVMETHOD_*</code> flags indicating the event backend in
236use.</p> 244use.</p>
237 </dd> 245 </dd>
238 <dt>ev_tstamp = ev_now (loop)</dt> 246 <dt>ev_tstamp ev_now (loop)</dt>
239 <dd> 247 <dd>
240 <p>Returns the current &quot;event loop time&quot;, which is the time the event loop 248 <p>Returns the current &quot;event loop time&quot;, which is the time the event loop
241got events and started processing them. This timestamp does not change 249got events and started processing them. This timestamp does not change
242as long as callbacks are being processed, and this is also the base time 250as long as callbacks are being processed, and this is also the base time
243used for relative timers. You can treat it as the timestamp of the event 251used for relative timers. You can treat it as the timestamp of the event
… …
250events.</p> 258events.</p>
251 <p>If the flags argument is specified as 0, it will not return until either 259 <p>If the flags argument is specified as 0, it will not return until either
252no event watchers are active anymore or <code>ev_unloop</code> was called.</p> 260no event watchers are active anymore or <code>ev_unloop</code> was called.</p>
253 <p>A flags value of <code>EVLOOP_NONBLOCK</code> will look for new events, will handle 261 <p>A flags value of <code>EVLOOP_NONBLOCK</code> will look for new events, will handle
254those events and any outstanding ones, but will not block your process in 262those events and any outstanding ones, but will not block your process in
255case there are no events.</p> 263case there are no events and will return after one iteration of the loop.</p>
256 <p>A flags value of <code>EVLOOP_ONESHOT</code> will look for new events (waiting if 264 <p>A flags value of <code>EVLOOP_ONESHOT</code> will look for new events (waiting if
257neccessary) and will handle those and any outstanding ones. It will block 265neccessary) and will handle those and any outstanding ones. It will block
258your process until at least one new event arrives.</p> 266your process until at least one new event arrives, and will return after
267one iteration of the loop.</p>
259 <p>This flags value could be used to implement alternative looping 268 <p>This flags value could be used to implement alternative looping
260constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and 269constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and
261more generic mechanism.</p> 270more generic mechanism.</p>
262 </dd> 271 </dd>
263 <dt>ev_unloop (loop, how)</dt> 272 <dt>ev_unloop (loop, how)</dt>
264 <dd> 273 <dd>
265 <p>Can be used to make a call to <code>ev_loop</code> return early. The <code>how</code> argument 274 <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it
275has processed all outstanding events). The <code>how</code> argument must be either
266must be either <code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> 276<code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> call return, or
267call return, or <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> 277<code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p>
268calls return.</p>
269 </dd> 278 </dd>
270 <dt>ev_ref (loop)</dt> 279 <dt>ev_ref (loop)</dt>
271 <dt>ev_unref (loop)</dt> 280 <dt>ev_unref (loop)</dt>
272 <dd> 281 <dd>
273 <p>Ref/unref can be used to add or remove a refcount on the event loop: Every 282 <p>Ref/unref can be used to add or remove a reference count on the event
274watcher keeps one reference. If you have a long-runing watcher you never 283loop: Every watcher keeps one reference, and as long as the reference
275unregister that should not keep ev_loop from running, ev_unref() after 284count is nonzero, <code>ev_loop</code> will not return on its own. If you have
276starting, and ev_ref() before stopping it. Libev itself uses this for 285a watcher you never unregister that should not keep <code>ev_loop</code> from
277example for its internal signal pipe: It is not visible to you as a user 286returning, ev_unref() after starting, and ev_ref() before stopping it. For
278and should not keep <code>ev_loop</code> from exiting if the work is done. It is 287example, libev itself uses this for its internal signal pipe: It is not
279also an excellent way to do this for generic recurring timers or from 288visible to the libev user and should not keep <code>ev_loop</code> from exiting if
280within third-party libraries. Just remember to unref after start and ref 289no event watchers registered by it are active. It is also an excellent
281before stop.</p> 290way to do this for generic recurring timers or from within third-party
291libraries. Just remember to <i>unref after start</i> and <i>ref before stop</i>.</p>
282 </dd> 292 </dd>
283</dl> 293</dl>
284 294
285</div> 295</div>
286<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> 296<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p>
287<div id="ANATOMY_OF_A_WATCHER_CONTENT"> 297<div id="ANATOMY_OF_A_WATCHER_CONTENT">
288<p>A watcher is a structure that you create and register to record your 298<p>A watcher is a structure that you create and register to record your
289interest in some event. For instance, if you want to wait for STDIN to 299interest in some event. For instance, if you want to wait for STDIN to
290become readable, you would create an ev_io watcher for that:</p> 300become readable, you would create an <code>ev_io</code> watcher for that:</p>
291<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 301<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
292 { 302 {
293 ev_io_stop (w); 303 ev_io_stop (w);
294 ev_unloop (loop, EVUNLOOP_ALL); 304 ev_unloop (loop, EVUNLOOP_ALL);
295 } 305 }
… …
319*)</code>), and you can stop watching for events at any time by calling the 329*)</code>), and you can stop watching for events at any time by calling the
320corresponding stop function (<code>ev_&lt;type&gt;_stop (loop, watcher *)</code>.</p> 330corresponding stop function (<code>ev_&lt;type&gt;_stop (loop, watcher *)</code>.</p>
321<p>As long as your watcher is active (has been started but not stopped) you 331<p>As long as your watcher is active (has been started but not stopped) you
322must not touch the values stored in it. Most specifically you must never 332must not touch the values stored in it. Most specifically you must never
323reinitialise it or call its set method.</p> 333reinitialise it or call its set method.</p>
324<p>You cna check whether an event is active by calling the <code>ev_is_active 334<p>You can check whether an event is active by calling the <code>ev_is_active
325(watcher *)</code> macro. To see whether an event is outstanding (but the 335(watcher *)</code> macro. To see whether an event is outstanding (but the
326callback for it has not been called yet) you cna use the <code>ev_is_pending 336callback for it has not been called yet) you can use the <code>ev_is_pending
327(watcher *)</code> macro.</p> 337(watcher *)</code> macro.</p>
328<p>Each and every callback receives the event loop pointer as first, the 338<p>Each and every callback receives the event loop pointer as first, the
329registered watcher structure as second, and a bitset of received events as 339registered watcher structure as second, and a bitset of received events as
330third argument.</p> 340third argument.</p>
331<p>The rceeived events usually include a single bit per event type received 341<p>The received events usually include a single bit per event type received
332(you can receive multiple events at the same time). The possible bit masks 342(you can receive multiple events at the same time). The possible bit masks
333are:</p> 343are:</p>
334<dl> 344<dl>
335 <dt>EV_READ</dt> 345 <dt><code>EV_READ</code></dt>
336 <dt>EV_WRITE</dt> 346 <dt><code>EV_WRITE</code></dt>
337 <dd> 347 <dd>
338 <p>The file descriptor in the ev_io watcher has become readable and/or 348 <p>The file descriptor in the <code>ev_io</code> watcher has become readable and/or
339writable.</p> 349writable.</p>
340 </dd> 350 </dd>
341 <dt>EV_TIMEOUT</dt> 351 <dt><code>EV_TIMEOUT</code></dt>
342 <dd>
343 <p>The ev_timer watcher has timed out.</p>
344 </dd> 352 <dd>
345 <dt>EV_PERIODIC</dt> 353 <p>The <code>ev_timer</code> watcher has timed out.</p>
346 <dd> 354 </dd>
347 <p>The ev_periodic watcher has timed out.</p> 355 <dt><code>EV_PERIODIC</code></dt>
348 </dd> 356 <dd>
349 <dt>EV_SIGNAL</dt> 357 <p>The <code>ev_periodic</code> watcher has timed out.</p>
350 <dd> 358 </dd>
359 <dt><code>EV_SIGNAL</code></dt>
360 <dd>
351 <p>The signal specified in the ev_signal watcher has been received by a thread.</p> 361 <p>The signal specified in the <code>ev_signal</code> watcher has been received by a thread.</p>
352 </dd>
353 <dt>EV_CHILD</dt>
354 <dd> 362 </dd>
363 <dt><code>EV_CHILD</code></dt>
364 <dd>
355 <p>The pid specified in the ev_child watcher has received a status change.</p> 365 <p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p>
356 </dd>
357 <dt>EV_IDLE</dt>
358 <dd> 366 </dd>
367 <dt><code>EV_IDLE</code></dt>
368 <dd>
359 <p>The ev_idle watcher has determined that you have nothing better to do.</p> 369 <p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p>
360 </dd>
361 <dt>EV_PREPARE</dt>
362 <dt>EV_CHECK</dt>
363 <dd> 370 </dd>
371 <dt><code>EV_PREPARE</code></dt>
372 <dt><code>EV_CHECK</code></dt>
373 <dd>
364 <p>All ev_prepare watchers are invoked just <i>before</i> <code>ev_loop</code> starts 374 <p>All <code>ev_prepare</code> watchers are invoked just <i>before</i> <code>ev_loop</code> starts
365to gather new events, and all ev_check watchers are invoked just after 375to gather new events, and all <code>ev_check</code> watchers are invoked just after
366<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any 376<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any
367received events. Callbacks of both watcher types can start and stop as 377received events. Callbacks of both watcher types can start and stop as
368many watchers as they want, and all of them will be taken into account 378many watchers as they want, and all of them will be taken into account
369(for example, a ev_prepare watcher might start an idle watcher to keep 379(for example, a <code>ev_prepare</code> watcher might start an idle watcher to keep
370<code>ev_loop</code> from blocking).</p> 380<code>ev_loop</code> from blocking).</p>
371 </dd> 381 </dd>
372 <dt>EV_ERROR</dt> 382 <dt><code>EV_ERROR</code></dt>
373 <dd> 383 <dd>
374 <p>An unspecified error has occured, the watcher has been stopped. This might 384 <p>An unspecified error has occured, the watcher has been stopped. This might
375happen because the watcher could not be properly started because libev 385happen because the watcher could not be properly started because libev
376ran out of memory, a file descriptor was found to be closed or any other 386ran out of memory, a file descriptor was found to be closed or any other
377problem. You best act on it by reporting the problem and somehow coping 387problem. You best act on it by reporting the problem and somehow coping
… …
386 396
387</div> 397</div>
388<h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2> 398<h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2>
389<div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2"> 399<div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2">
390<p>Each watcher has, by default, a member <code>void *data</code> that you can change 400<p>Each watcher has, by default, a member <code>void *data</code> that you can change
391and read at any time, libev will completely ignore it. This cna be used 401and read at any time, libev will completely ignore it. This can be used
392to associate arbitrary data with your watcher. If you need more data and 402to associate arbitrary data with your watcher. If you need more data and
393don't want to allocate memory and store a pointer to it in that data 403don't want to allocate memory and store a pointer to it in that data
394member, you can also &quot;subclass&quot; the watcher type and provide your own 404member, you can also &quot;subclass&quot; the watcher type and provide your own
395data:</p> 405data:</p>
396<pre> struct my_io 406<pre> struct my_io
… …
423<div id="WATCHER_TYPES_CONTENT"> 433<div id="WATCHER_TYPES_CONTENT">
424<p>This section describes each watcher in detail, but will not repeat 434<p>This section describes each watcher in detail, but will not repeat
425information given in the last section.</p> 435information given in the last section.</p>
426 436
427</div> 437</div>
428<h2 id="struct_ev_io_is_my_file_descriptor_r">struct ev_io - is my file descriptor readable or writable</h2> 438<h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</h2>
429<div id="struct_ev_io_is_my_file_descriptor_r-2"> 439<div id="code_ev_io_code_is_this_file_descrip-2">
430<p>I/O watchers check whether a file descriptor is readable or writable 440<p>I/O watchers check whether a file descriptor is readable or writable
431in each iteration of the event loop (This behaviour is called 441in each iteration of the event loop (This behaviour is called
432level-triggering because you keep receiving events as long as the 442level-triggering because you keep receiving events as long as the
433condition persists. Remember you cna stop the watcher if you don't want to 443condition persists. Remember you can stop the watcher if you don't want to
434act on the event and neither want to receive future events).</p> 444act on the event and neither want to receive future events).</p>
445<p>In general you can register as many read and/or write event watchers oer
446fd as you want (as long as you don't confuse yourself). Setting all file
447descriptors to non-blocking mode is also usually a good idea (but not
448required if you know what you are doing).</p>
449<p>You have to be careful with dup'ed file descriptors, though. Some backends
450(the linux epoll backend is a notable example) cannot handle dup'ed file
451descriptors correctly if you register interest in two or more fds pointing
452to the same file/socket etc. description.</p>
453<p>If you must do this, then force the use of a known-to-be-good backend
454(at the time of this writing, this includes only EVMETHOD_SELECT and
455EVMETHOD_POLL).</p>
435<dl> 456<dl>
436 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> 457 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>
437 <dt>ev_io_set (ev_io *, int fd, int events)</dt> 458 <dt>ev_io_set (ev_io *, int fd, int events)</dt>
438 <dd> 459 <dd>
439 <p>Configures an ev_io watcher. The fd is the file descriptor to rceeive 460 <p>Configures an <code>ev_io</code> watcher. The fd is the file descriptor to rceeive
440events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ | 461events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ |
441EV_WRITE</code> to receive the given events.</p> 462EV_WRITE</code> to receive the given events.</p>
442 </dd> 463 </dd>
443</dl> 464</dl>
444 465
445</div> 466</div>
446<h2 id="struct_ev_timer_relative_and_optiona">struct ev_timer - relative and optionally recurring timeouts</h2> 467<h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2>
447<div id="struct_ev_timer_relative_and_optiona-2"> 468<div id="code_ev_timer_code_relative_and_opti-2">
448<p>Timer watchers are simple relative timers that generate an event after a 469<p>Timer watchers are simple relative timers that generate an event after a
449given time, and optionally repeating in regular intervals after that.</p> 470given time, and optionally repeating in regular intervals after that.</p>
450<p>The timers are based on real time, that is, if you register an event that 471<p>The timers are based on real time, that is, if you register an event that
451times out after an hour and youreset your system clock to last years 472times out after an hour and youreset your system clock to last years
452time, it will still time out after (roughly) and hour. &quot;Roughly&quot; because 473time, it will still time out after (roughly) and hour. &quot;Roughly&quot; because
453detecting time jumps is hard, and soem inaccuracies are unavoidable (the 474detecting time jumps is hard, and soem inaccuracies are unavoidable (the
454monotonic clock option helps a lot here).</p> 475monotonic clock option helps a lot here).</p>
476<p>The relative timeouts are calculated relative to the <code>ev_now ()</code>
477time. This is usually the right thing as this timestamp refers to the time
478of the event triggering whatever timeout you are modifying/starting. If
479you suspect event processing to be delayed and you *need* to base the timeout
480ion the current time, use something like this to adjust for this:</p>
481<pre> ev_timer_set (&amp;timer, after + ev_now () - ev_time (), 0.);
482
483</pre>
455<dl> 484<dl>
456 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> 485 <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt>
457 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> 486 <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt>
458 <dd> 487 <dd>
459 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is 488 <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is
… …
475value), or reset the running timer to the repeat value.</p> 504value), or reset the running timer to the repeat value.</p>
476 <p>This sounds a bit complicated, but here is a useful and typical 505 <p>This sounds a bit complicated, but here is a useful and typical
477example: Imagine you have a tcp connection and you want a so-called idle 506example: Imagine you have a tcp connection and you want a so-called idle
478timeout, that is, you want to be called when there have been, say, 60 507timeout, that is, you want to be called when there have been, say, 60
479seconds of inactivity on the socket. The easiest way to do this is to 508seconds of inactivity on the socket. The easiest way to do this is to
480configure an ev_timer with after=repeat=60 and calling ev_timer_again each 509configure an <code>ev_timer</code> with after=repeat=60 and calling ev_timer_again each
481time you successfully read or write some data. If you go into an idle 510time you successfully read or write some data. If you go into an idle
482state where you do not expect data to travel on the socket, you can stop 511state where you do not expect data to travel on the socket, you can stop
483the timer, and again will automatically restart it if need be.</p> 512the timer, and again will automatically restart it if need be.</p>
484 </dd> 513 </dd>
485</dl> 514</dl>
486 515
487</div> 516</div>
488<h2 id="ev_periodic_to_cron_or_not_to_cron_i">ev_periodic - to cron or not to cron it</h2> 517<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</h2>
489<div id="ev_periodic_to_cron_or_not_to_cron_i-2"> 518<div id="code_ev_periodic_code_to_cron_or_not-2">
490<p>Periodic watchers are also timers of a kind, but they are very versatile 519<p>Periodic watchers are also timers of a kind, but they are very versatile
491(and unfortunately a bit complex).</p> 520(and unfortunately a bit complex).</p>
492<p>Unlike ev_timer's, they are not based on real time (or relative time) 521<p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time)
493but on wallclock time (absolute time). You can tell a periodic watcher 522but on wallclock time (absolute time). You can tell a periodic watcher
494to trigger &quot;at&quot; some specific point in time. For example, if you tell a 523to trigger &quot;at&quot; some specific point in time. For example, if you tell a
495periodic watcher to trigger in 10 seconds (by specifiying e.g. c&lt;ev_now () 524periodic watcher to trigger in 10 seconds (by specifiying e.g. c&lt;ev_now ()
496+ 10.&gt;) and then reset your system clock to the last year, then it will 525+ 10.&gt;) and then reset your system clock to the last year, then it will
497take a year to trigger the event (unlike an ev_timer, which would trigger 526take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger
498roughly 10 seconds later and of course not if you reset your system time 527roughly 10 seconds later and of course not if you reset your system time
499again).</p> 528again).</p>
500<p>They can also be used to implement vastly more complex timers, such as 529<p>They can also be used to implement vastly more complex timers, such as
501triggering an event on eahc midnight, local time.</p> 530triggering an event on eahc midnight, local time.</p>
502<dl> 531<dl>
… …
528<pre> ev_periodic_set (&amp;periodic, 0., 3600., 0); 557<pre> ev_periodic_set (&amp;periodic, 0., 3600., 0);
529 558
530</pre> 559</pre>
531 <p>This doesn't mean there will always be 3600 seconds in between triggers, 560 <p>This doesn't mean there will always be 3600 seconds in between triggers,
532but only that the the callback will be called when the system time shows a 561but only that the the callback will be called when the system time shows a
533full hour (UTC), or more correct, when the system time is evenly divisible 562full hour (UTC), or more correctly, when the system time is evenly divisible
534by 3600.</p> 563by 3600.</p>
535 <p>Another way to think about it (for the mathematically inclined) is that 564 <p>Another way to think about it (for the mathematically inclined) is that
536ev_periodic will try to run the callback in this mode at the next possible 565<code>ev_periodic</code> will try to run the callback in this mode at the next possible
537time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p> 566time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p>
538 </dd> 567 </dd>
539 <dt>* manual reschedule mode (reschedule_cb = callback)</dt> 568 <dt>* manual reschedule mode (reschedule_cb = callback)</dt>
540 <dd> 569 <dd>
541 <p>In this mode the values for <code>interval</code> and <code>at</code> are both being 570 <p>In this mode the values for <code>interval</code> and <code>at</code> are both being
542ignored. Instead, each time the periodic watcher gets scheduled, the 571ignored. Instead, each time the periodic watcher gets scheduled, the
543reschedule callback will be called with the watcher as first, and the 572reschedule callback will be called with the watcher as first, and the
544current time as second argument.</p> 573current time as second argument.</p>
545 <p>NOTE: <i>This callback MUST NOT stop or destroy the periodic or any other 574 <p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher,
546periodic watcher, ever, or make any event loop modificstions</i>. If you need 575ever, or make any event loop modifications</i>. If you need to stop it,
547to stop it, return 1e30 (or so, fudge fudge) and stop it afterwards.</p> 576return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by
577starting a prepare watcher).</p>
548 <p>Its prototype is c&lt;ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 578 <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
549ev_tstamp now)&gt;, e.g.:</p> 579ev_tstamp now)</code>, e.g.:</p>
550<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 580<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
551 { 581 {
552 return now + 60.; 582 return now + 60.;
553 } 583 }
554 584
555</pre> 585</pre>
556 <p>It must return the next time to trigger, based on the passed time value 586 <p>It must return the next time to trigger, based on the passed time value
557(that is, the lowest time value larger than to the second argument). It 587(that is, the lowest time value larger than to the second argument). It
558will usually be called just before the callback will be triggered, but 588will usually be called just before the callback will be triggered, but
559might be called at other times, too.</p> 589might be called at other times, too.</p>
590 <p>NOTE: <i>This callback must always return a time that is later than the
591passed <code>now</code> value</i>. Not even <code>now</code> itself will do, it <i>must</i> be larger.</p>
560 <p>This can be used to create very complex timers, such as a timer that 592 <p>This can be used to create very complex timers, such as a timer that
561triggers on each midnight, local time. To do this, you would calculate the 593triggers on each midnight, local time. To do this, you would calculate the
562next midnight after <code>now</code> and return the timestamp value for this. How you do this 594next midnight after <code>now</code> and return the timestamp value for this. How
563is, again, up to you (but it is not trivial).</p> 595you do this is, again, up to you (but it is not trivial, which is the main
596reason I omitted it as an example).</p>
564 </dd> 597 </dd>
565 </dl> 598 </dl>
566 </p> 599 </p>
567 </dd> 600 </dd>
568 <dt>ev_periodic_again (loop, ev_periodic *)</dt> 601 <dt>ev_periodic_again (loop, ev_periodic *)</dt>
… …
573program when the crontabs have changed).</p> 606program when the crontabs have changed).</p>
574 </dd> 607 </dd>
575</dl> 608</dl>
576 609
577</div> 610</div>
578<h2 id="ev_signal_signal_me_when_a_signal_ge">ev_signal - signal me when a signal gets signalled</h2> 611<h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</h2>
579<div id="ev_signal_signal_me_when_a_signal_ge-2"> 612<div id="code_ev_signal_code_signal_me_when_a-2">
580<p>Signal watchers will trigger an event when the process receives a specific 613<p>Signal watchers will trigger an event when the process receives a specific
581signal one or more times. Even though signals are very asynchronous, libev 614signal one or more times. Even though signals are very asynchronous, libev
582will try its best to deliver signals synchronously, i.e. as part of the 615will try it's best to deliver signals synchronously, i.e. as part of the
583normal event processing, like any other event.</p> 616normal event processing, like any other event.</p>
584<p>You cna configure as many watchers as you like per signal. Only when the 617<p>You can configure as many watchers as you like per signal. Only when the
585first watcher gets started will libev actually register a signal watcher 618first watcher gets started will libev actually register a signal watcher
586with the kernel (thus it coexists with your own signal handlers as long 619with the kernel (thus it coexists with your own signal handlers as long
587as you don't register any with libev). Similarly, when the last signal 620as you don't register any with libev). Similarly, when the last signal
588watcher for a signal is stopped libev will reset the signal handler to 621watcher for a signal is stopped libev will reset the signal handler to
589SIG_DFL (regardless of what it was set to before).</p> 622SIG_DFL (regardless of what it was set to before).</p>
… …
595of the <code>SIGxxx</code> constants).</p> 628of the <code>SIGxxx</code> constants).</p>
596 </dd> 629 </dd>
597</dl> 630</dl>
598 631
599</div> 632</div>
600<h2 id="ev_child_wait_for_pid_status_changes">ev_child - wait for pid status changes</h2> 633<h2 id="code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</h2>
601<div id="ev_child_wait_for_pid_status_changes-2"> 634<div id="code_ev_child_code_wait_for_pid_stat-2">
602<p>Child watchers trigger when your process receives a SIGCHLD in response to 635<p>Child watchers trigger when your process receives a SIGCHLD in response to
603some child status changes (most typically when a child of yours dies).</p> 636some child status changes (most typically when a child of yours dies).</p>
604<dl> 637<dl>
605 <dt>ev_child_init (ev_child *, callback, int pid)</dt> 638 <dt>ev_child_init (ev_child *, callback, int pid)</dt>
606 <dt>ev_child_set (ev_child *, int pid)</dt> 639 <dt>ev_child_set (ev_child *, int pid)</dt>
607 <dd> 640 <dd>
608 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or 641 <p>Configures the watcher to wait for status changes of process <code>pid</code> (or
609<i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look 642<i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look
610at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see 643at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see
611the status word (use the macros from <code>sys/wait.h</code>). The <code>rpid</code> member 644the status word (use the macros from <code>sys/wait.h</code> and see your systems
645<code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the
612contains the pid of the process causing the status change.</p> 646process causing the status change.</p>
613 </dd> 647 </dd>
614</dl> 648</dl>
615 649
616</div> 650</div>
617<h2 id="ev_idle_when_you_ve_got_nothing_bett">ev_idle - when you've got nothing better to do</h2> 651<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</h2>
618<div id="ev_idle_when_you_ve_got_nothing_bett-2"> 652<div id="code_ev_idle_code_when_you_ve_got_no-2">
619<p>Idle watchers trigger events when there are no other I/O or timer (or 653<p>Idle watchers trigger events when there are no other events are pending
620periodic) events pending. That is, as long as your process is busy 654(prepare, check and other idle watchers do not count). That is, as long
621handling sockets or timeouts it will not be called. But when your process 655as your process is busy handling sockets or timeouts (or even signals,
622is idle all idle watchers are being called again and again - until 656imagine) it will not be triggered. But when your process is idle all idle
657watchers are being called again and again, once per event loop iteration -
623stopped, that is, or your process receives more events.</p> 658until stopped, that is, or your process receives more events and becomes
659busy.</p>
624<p>The most noteworthy effect is that as long as any idle watchers are 660<p>The most noteworthy effect is that as long as any idle watchers are
625active, the process will not block when waiting for new events.</p> 661active, the process will not block when waiting for new events.</p>
626<p>Apart from keeping your process non-blocking (which is a useful 662<p>Apart from keeping your process non-blocking (which is a useful
627effect on its own sometimes), idle watchers are a good place to do 663effect on its own sometimes), idle watchers are a good place to do
628&quot;pseudo-background processing&quot;, or delay processing stuff to after the 664&quot;pseudo-background processing&quot;, or delay processing stuff to after the
… …
635believe me.</p> 671believe me.</p>
636 </dd> 672 </dd>
637</dl> 673</dl>
638 674
639</div> 675</div>
640<h2 id="prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</h2> 676<h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2>
641<div id="prepare_and_check_your_hooks_into_th-2"> 677<div id="code_ev_prepare_code_and_code_ev_che-2">
642<p>Prepare and check watchers usually (but not always) are used in 678<p>Prepare and check watchers are usually (but not always) used in tandem:
643tandom. Prepare watchers get invoked before the process blocks and check 679Prepare watchers get invoked before the process blocks and check watchers
644watchers afterwards.</p> 680afterwards.</p>
645<p>Their main purpose is to integrate other event mechanisms into libev. This 681<p>Their main purpose is to integrate other event mechanisms into libev. This
646could be used, for example, to track variable changes, implement your own 682could be used, for example, to track variable changes, implement your own
647watchers, integrate net-snmp or a coroutine library and lots more.</p> 683watchers, integrate net-snmp or a coroutine library and lots more.</p>
648<p>This is done by examining in each prepare call which file descriptors need 684<p>This is done by examining in each prepare call which file descriptors need
649to be watched by the other library, registering ev_io watchers for them 685to be watched by the other library, registering <code>ev_io</code> watchers for
650and starting an ev_timer watcher for any timeouts (many libraries provide 686them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries
651just this functionality). Then, in the check watcher you check for any 687provide just this functionality). Then, in the check watcher you check for
652events that occured (by making your callbacks set soem flags for example) 688any events that occured (by checking the pending status of all watchers
653and call back into the library.</p> 689and stopping them) and call back into the library. The I/O and timer
690callbacks will never actually be called (but must be valid neverthelles,
691because you never know, you know?).</p>
654<p>As another example, the perl Coro module uses these hooks to integrate 692<p>As another example, the Perl Coro module uses these hooks to integrate
655coroutines into libev programs, by yielding to other active coroutines 693coroutines into libev programs, by yielding to other active coroutines
656during each prepare and only letting the process block if no coroutines 694during each prepare and only letting the process block if no coroutines
657are ready to run.</p> 695are ready to run (its actually more complicated, it only runs coroutines
696with priority higher than the event loop and one lower priority once,
697using idle watchers to keep the event loop from blocking if lower-priority
698coroutines exist, thus mapping low-priority coroutines to idle/background
699tasks).</p>
658<dl> 700<dl>
659 <dt>ev_prepare_init (ev_prepare *, callback)</dt> 701 <dt>ev_prepare_init (ev_prepare *, callback)</dt>
660 <dt>ev_check_init (ev_check *, callback)</dt> 702 <dt>ev_check_init (ev_check *, callback)</dt>
661 <dd> 703 <dd>
662 <p>Initialises and configures the prepare or check watcher - they have no 704 <p>Initialises and configures the prepare or check watcher - they have no
663parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> 705parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code>
664macros, but using them is utterly, utterly pointless.</p> 706macros, but using them is utterly, utterly and completely pointless.</p>
665 </dd> 707 </dd>
666</dl> 708</dl>
667 709
668</div> 710</div>
669<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> 711<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
670<div id="OTHER_FUNCTIONS_CONTENT"> 712<div id="OTHER_FUNCTIONS_CONTENT">
671<p>There are some other fucntions of possible interest. Described. Here. Now.</p> 713<p>There are some other functions of possible interest. Described. Here. Now.</p>
672<dl> 714<dl>
673 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> 715 <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt>
674 <dd> 716 <dd>
675 <p>This function combines a simple timer and an I/O watcher, calls your 717 <p>This function combines a simple timer and an I/O watcher, calls your
676callback on whichever event happens first and automatically stop both 718callback on whichever event happens first and automatically stop both
677watchers. This is useful if you want to wait for a single event on an fd 719watchers. This is useful if you want to wait for a single event on an fd
678or timeout without havign to allocate/configure/start/stop/free one or 720or timeout without havign to allocate/configure/start/stop/free one or
679more watchers yourself.</p> 721more watchers yourself.</p>
680 <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events is 722 <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events
681ignored. Otherwise, an ev_io watcher for the given <code>fd</code> and <code>events</code> set 723is being ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and
682will be craeted and started.</p> 724<code>events</code> set will be craeted and started.</p>
683 <p>If <code>timeout</code> is less than 0, then no timeout watcher will be 725 <p>If <code>timeout</code> is less than 0, then no timeout watcher will be
684started. Otherwise an ev_timer watcher with after = <code>timeout</code> (and repeat 726started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and
685= 0) will be started.</p> 727repeat = 0) will be started. While <code>0</code> is a valid timeout, it is of
728dubious value.</p>
686 <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and 729 <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and gets
687gets passed an events set (normally a combination of EV_ERROR, EV_READ, 730passed an events set like normal event callbacks (with a combination of
688EV_WRITE or EV_TIMEOUT) and the <code>arg</code> value passed to <code>ev_once</code>:</p> 731<code>EV_ERROR</code>, <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code>
732value passed to <code>ev_once</code>:</p>
689<pre> static void stdin_ready (int revents, void *arg) 733<pre> static void stdin_ready (int revents, void *arg)
690 { 734 {
691 if (revents &amp; EV_TIMEOUT) 735 if (revents &amp; EV_TIMEOUT)
692 /* doh, nothing entered */ 736 /* doh, nothing entered */;
693 else if (revents &amp; EV_READ) 737 else if (revents &amp; EV_READ)
694 /* stdin might have data for us, joy! */ 738 /* stdin might have data for us, joy! */;
695 } 739 }
696 740
697 ev_once (STDIN_FILENO, EV_READm 10., stdin_ready, 0); 741 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
698 742
699</pre> 743</pre>
700 </dd> 744 </dd>
701 <dt>ev_feed_event (loop, watcher, int events)</dt> 745 <dt>ev_feed_event (loop, watcher, int events)</dt>
702 <dd> 746 <dd>
703 <p>Feeds the given event set into the event loop, as if the specified event 747 <p>Feeds the given event set into the event loop, as if the specified event
704has happened for the specified watcher (which must be a pointer to an 748had happened for the specified watcher (which must be a pointer to an
705initialised but not necessarily active event watcher).</p> 749initialised but not necessarily started event watcher).</p>
706 </dd> 750 </dd>
707 <dt>ev_feed_fd_event (loop, int fd, int revents)</dt> 751 <dt>ev_feed_fd_event (loop, int fd, int revents)</dt>
708 <dd> 752 <dd>
709 <p>Feed an event on the given fd, as if a file descriptor backend detected it.</p> 753 <p>Feed an event on the given fd, as if a file descriptor backend detected
754the given events it.</p>
710 </dd> 755 </dd>
711 <dt>ev_feed_signal_event (loop, int signum)</dt> 756 <dt>ev_feed_signal_event (loop, int signum)</dt>
712 <dd> 757 <dd>
713 <p>Feed an event as if the given signal occured (loop must be the default loop!).</p> 758 <p>Feed an event as if the given signal occured (loop must be the default loop!).</p>
714 </dd> 759 </dd>

Diff Legend

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