1 |
root |
1.1 |
<?xml version="1.0" encoding="UTF-8"?> |
2 |
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
3 |
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
4 |
|
|
<head> |
5 |
|
|
<title>libev</title> |
6 |
|
|
<meta name="description" content="Pod documentation for libev" /> |
7 |
|
|
<meta name="inputfile" content="<standard input>" /> |
8 |
|
|
<meta name="outputfile" content="<standard output>" /> |
9 |
root |
1.24 |
<meta name="created" content="Mon Nov 12 10:07:10 2007" /> |
10 |
root |
1.1 |
<meta name="generator" content="Pod::Xhtml 1.57" /> |
11 |
|
|
<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> |
12 |
|
|
<body> |
13 |
|
|
<div class="pod"> |
14 |
|
|
<!-- INDEX START --> |
15 |
|
|
<h3 id="TOP">Index</h3> |
16 |
|
|
|
17 |
|
|
<ul><li><a href="#NAME">NAME</a></li> |
18 |
|
|
<li><a href="#SYNOPSIS">SYNOPSIS</a></li> |
19 |
|
|
<li><a href="#DESCRIPTION">DESCRIPTION</a></li> |
20 |
|
|
<li><a href="#FEATURES">FEATURES</a></li> |
21 |
|
|
<li><a href="#CONVENTIONS">CONVENTIONS</a></li> |
22 |
root |
1.18 |
<li><a href="#TIME_REPRESENTATION">TIME REPRESENTATION</a></li> |
23 |
|
|
<li><a href="#GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</a></li> |
24 |
root |
1.1 |
<li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li> |
25 |
|
|
<li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a> |
26 |
|
|
<ul><li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li> |
27 |
|
|
</ul> |
28 |
|
|
</li> |
29 |
|
|
<li><a href="#WATCHER_TYPES">WATCHER TYPES</a> |
30 |
root |
1.11 |
<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> |
31 |
root |
1.10 |
<li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</a></li> |
32 |
root |
1.14 |
<li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</a></li> |
33 |
root |
1.10 |
<li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</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> |
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> |
36 |
root |
1.17 |
<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> |
37 |
root |
1.1 |
</ul> |
38 |
|
|
</li> |
39 |
|
|
<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> |
40 |
root |
1.23 |
<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li> |
41 |
|
|
<li><a href="#C_SUPPORT">C++ SUPPORT</a></li> |
42 |
root |
1.1 |
<li><a href="#AUTHOR">AUTHOR</a> |
43 |
|
|
</li> |
44 |
|
|
</ul><hr /> |
45 |
|
|
<!-- INDEX END --> |
46 |
|
|
|
47 |
|
|
<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p> |
48 |
|
|
<div id="NAME_CONTENT"> |
49 |
|
|
<p>libev - a high performance full-featured event loop written in C</p> |
50 |
|
|
|
51 |
|
|
</div> |
52 |
|
|
<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
53 |
|
|
<div id="SYNOPSIS_CONTENT"> |
54 |
|
|
<pre> #include <ev.h> |
55 |
|
|
|
56 |
|
|
</pre> |
57 |
|
|
|
58 |
|
|
</div> |
59 |
|
|
<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
60 |
|
|
<div id="DESCRIPTION_CONTENT"> |
61 |
|
|
<p>Libev is an event loop: you register interest in certain events (such as a |
62 |
|
|
file descriptor being readable or a timeout occuring), and it will manage |
63 |
root |
1.4 |
these event sources and provide your program with events.</p> |
64 |
root |
1.1 |
<p>To do this, it must take more or less complete control over your process |
65 |
|
|
(or thread) by executing the <i>event loop</i> handler, and will then |
66 |
|
|
communicate events via a callback mechanism.</p> |
67 |
|
|
<p>You register interest in certain events by registering so-called <i>event |
68 |
|
|
watchers</i>, which are relatively small C structures you initialise with the |
69 |
|
|
details of the event, and then hand it over to libev by <i>starting</i> the |
70 |
|
|
watcher.</p> |
71 |
|
|
|
72 |
|
|
</div> |
73 |
|
|
<h1 id="FEATURES">FEATURES</h1><p><a href="#TOP" class="toplink">Top</a></p> |
74 |
|
|
<div id="FEATURES_CONTENT"> |
75 |
|
|
<p>Libev supports select, poll, the linux-specific epoll and the bsd-specific |
76 |
|
|
kqueue mechanisms for file descriptor events, relative timers, absolute |
77 |
|
|
timers with customised rescheduling, signal events, process status change |
78 |
|
|
events (related to SIGCHLD), and event watchers dealing with the event |
79 |
root |
1.5 |
loop mechanism itself (idle, prepare and check watchers). It also is quite |
80 |
root |
1.7 |
fast (see this <a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing |
81 |
|
|
it to libevent for example).</p> |
82 |
root |
1.1 |
|
83 |
|
|
</div> |
84 |
|
|
<h1 id="CONVENTIONS">CONVENTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
85 |
|
|
<div id="CONVENTIONS_CONTENT"> |
86 |
|
|
<p>Libev is very configurable. In this manual the default configuration |
87 |
|
|
will be described, which supports multiple event loops. For more info |
88 |
root |
1.7 |
about various configuration options please have a look at the file |
89 |
root |
1.1 |
<cite>README.embed</cite> in the libev distribution. If libev was configured without |
90 |
|
|
support for multiple event loops, then all functions taking an initial |
91 |
|
|
argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>) |
92 |
|
|
will not have this argument.</p> |
93 |
|
|
|
94 |
|
|
</div> |
95 |
root |
1.18 |
<h1 id="TIME_REPRESENTATION">TIME REPRESENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
96 |
|
|
<div id="TIME_REPRESENTATION_CONTENT"> |
97 |
root |
1.2 |
<p>Libev represents time as a single floating point number, representing the |
98 |
|
|
(fractional) number of seconds since the (POSIX) epoch (somewhere near |
99 |
|
|
the beginning of 1970, details are complicated, don't ask). This type is |
100 |
root |
1.1 |
called <code>ev_tstamp</code>, which is what you should use too. It usually aliases |
101 |
|
|
to the double type in C.</p> |
102 |
root |
1.18 |
|
103 |
|
|
</div> |
104 |
|
|
<h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
105 |
|
|
<div id="GLOBAL_FUNCTIONS_CONTENT"> |
106 |
root |
1.21 |
<p>These functions can be called anytime, even before initialising the |
107 |
|
|
library in any way.</p> |
108 |
root |
1.1 |
<dl> |
109 |
|
|
<dt>ev_tstamp ev_time ()</dt> |
110 |
|
|
<dd> |
111 |
|
|
<p>Returns the current time as libev would use it.</p> |
112 |
|
|
</dd> |
113 |
|
|
<dt>int ev_version_major ()</dt> |
114 |
|
|
<dt>int ev_version_minor ()</dt> |
115 |
|
|
<dd> |
116 |
|
|
<p>You can find out the major and minor version numbers of the library |
117 |
|
|
you linked against by calling the functions <code>ev_version_major</code> and |
118 |
|
|
<code>ev_version_minor</code>. If you want, you can compare against the global |
119 |
|
|
symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the |
120 |
|
|
version of the library your program was compiled against.</p> |
121 |
root |
1.9 |
<p>Usually, it's a good idea to terminate if the major versions mismatch, |
122 |
root |
1.1 |
as this indicates an incompatible change. Minor versions are usually |
123 |
|
|
compatible to older versions, so a larger minor version alone is usually |
124 |
|
|
not a problem.</p> |
125 |
|
|
</dd> |
126 |
|
|
<dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> |
127 |
|
|
<dd> |
128 |
|
|
<p>Sets the allocation function to use (the prototype is similar to the |
129 |
root |
1.7 |
realloc C function, the semantics are identical). It is used to allocate |
130 |
|
|
and free memory (no surprises here). If it returns zero when memory |
131 |
|
|
needs to be allocated, the library might abort or take some potentially |
132 |
|
|
destructive action. The default is your system realloc function.</p> |
133 |
root |
1.1 |
<p>You could override this function in high-availability programs to, say, |
134 |
|
|
free some memory if it cannot allocate memory, to use a special allocator, |
135 |
|
|
or even to sleep a while and retry until some memory is available.</p> |
136 |
|
|
</dd> |
137 |
|
|
<dt>ev_set_syserr_cb (void (*cb)(const char *msg));</dt> |
138 |
|
|
<dd> |
139 |
|
|
<p>Set the callback function to call on a retryable syscall error (such |
140 |
|
|
as failed select, poll, epoll_wait). The message is a printable string |
141 |
|
|
indicating the system call or subsystem causing the problem. If this |
142 |
|
|
callback is set, then libev will expect it to remedy the sitution, no |
143 |
root |
1.7 |
matter what, when it returns. That is, libev will generally retry the |
144 |
root |
1.1 |
requested operation, or, if the condition doesn't go away, do bad stuff |
145 |
|
|
(such as abort).</p> |
146 |
|
|
</dd> |
147 |
|
|
</dl> |
148 |
|
|
|
149 |
|
|
</div> |
150 |
|
|
<h1 id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</h1><p><a href="#TOP" class="toplink">Top</a></p> |
151 |
|
|
<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2"> |
152 |
|
|
<p>An event loop is described by a <code>struct ev_loop *</code>. The library knows two |
153 |
|
|
types of such loops, the <i>default</i> loop, which supports signals and child |
154 |
|
|
events, and dynamically created loops which do not.</p> |
155 |
|
|
<p>If you use threads, a common model is to run the default event loop |
156 |
root |
1.18 |
in your main thread (or in a separate thread) and for each thread you |
157 |
root |
1.7 |
create, you also create another event loop. Libev itself does no locking |
158 |
|
|
whatsoever, so if you mix calls to the same event loop in different |
159 |
|
|
threads, make sure you lock (this is usually a bad idea, though, even if |
160 |
root |
1.9 |
done correctly, because it's hideous and inefficient).</p> |
161 |
root |
1.1 |
<dl> |
162 |
|
|
<dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt> |
163 |
|
|
<dd> |
164 |
|
|
<p>This will initialise the default event loop if it hasn't been initialised |
165 |
|
|
yet and return it. If the default loop could not be initialised, returns |
166 |
|
|
false. If it already was initialised it simply returns it (and ignores the |
167 |
|
|
flags).</p> |
168 |
|
|
<p>If you don't know what event loop to use, use the one returned from this |
169 |
|
|
function.</p> |
170 |
|
|
<p>The flags argument can be used to specify special behaviour or specific |
171 |
root |
1.8 |
backends to use, and is usually specified as 0 (or EVFLAG_AUTO).</p> |
172 |
root |
1.1 |
<p>It supports the following flags:</p> |
173 |
|
|
<p> |
174 |
|
|
<dl> |
175 |
root |
1.10 |
<dt><code>EVFLAG_AUTO</code></dt> |
176 |
root |
1.1 |
<dd> |
177 |
root |
1.9 |
<p>The default flags value. Use this if you have no clue (it's the right |
178 |
root |
1.1 |
thing, believe me).</p> |
179 |
|
|
</dd> |
180 |
root |
1.10 |
<dt><code>EVFLAG_NOENV</code></dt> |
181 |
root |
1.1 |
<dd> |
182 |
root |
1.8 |
<p>If this flag bit is ored into the flag value (or the program runs setuid |
183 |
|
|
or setgid) then libev will <i>not</i> look at the environment variable |
184 |
|
|
<code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will |
185 |
|
|
override the flags completely if it is found in the environment. This is |
186 |
|
|
useful to try out specific backends to test their performance, or to work |
187 |
|
|
around bugs.</p> |
188 |
root |
1.1 |
</dd> |
189 |
root |
1.10 |
<dt><code>EVMETHOD_SELECT</code> (portable select backend)</dt> |
190 |
|
|
<dt><code>EVMETHOD_POLL</code> (poll backend, available everywhere except on windows)</dt> |
191 |
|
|
<dt><code>EVMETHOD_EPOLL</code> (linux only)</dt> |
192 |
|
|
<dt><code>EVMETHOD_KQUEUE</code> (some bsds only)</dt> |
193 |
|
|
<dt><code>EVMETHOD_DEVPOLL</code> (solaris 8 only)</dt> |
194 |
|
|
<dt><code>EVMETHOD_PORT</code> (solaris 10 only)</dt> |
195 |
root |
1.1 |
<dd> |
196 |
|
|
<p>If one or more of these are ored into the flags value, then only these |
197 |
|
|
backends will be tried (in the reverse order as given here). If one are |
198 |
|
|
specified, any backend will do.</p> |
199 |
|
|
</dd> |
200 |
|
|
</dl> |
201 |
|
|
</p> |
202 |
|
|
</dd> |
203 |
|
|
<dt>struct ev_loop *ev_loop_new (unsigned int flags)</dt> |
204 |
|
|
<dd> |
205 |
|
|
<p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is |
206 |
|
|
always distinct from the default loop. Unlike the default loop, it cannot |
207 |
|
|
handle signal and child watchers, and attempts to do so will be greeted by |
208 |
|
|
undefined behaviour (or a failed assertion if assertions are enabled).</p> |
209 |
|
|
</dd> |
210 |
|
|
<dt>ev_default_destroy ()</dt> |
211 |
|
|
<dd> |
212 |
|
|
<p>Destroys the default loop again (frees all memory and kernel state |
213 |
|
|
etc.). This stops all registered event watchers (by not touching them in |
214 |
root |
1.9 |
any way whatsoever, although you cannot rely on this :).</p> |
215 |
root |
1.1 |
</dd> |
216 |
|
|
<dt>ev_loop_destroy (loop)</dt> |
217 |
|
|
<dd> |
218 |
|
|
<p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an |
219 |
|
|
earlier call to <code>ev_loop_new</code>.</p> |
220 |
|
|
</dd> |
221 |
|
|
<dt>ev_default_fork ()</dt> |
222 |
|
|
<dd> |
223 |
|
|
<p>This function reinitialises the kernel state for backends that have |
224 |
|
|
one. Despite the name, you can call it anytime, but it makes most sense |
225 |
|
|
after forking, in either the parent or child process (or both, but that |
226 |
|
|
again makes little sense).</p> |
227 |
|
|
<p>You <i>must</i> call this function after forking if and only if you want to |
228 |
|
|
use the event library in both processes. If you just fork+exec, you don't |
229 |
|
|
have to call it.</p> |
230 |
root |
1.9 |
<p>The function itself is quite fast and it's usually not a problem to call |
231 |
root |
1.1 |
it just in case after a fork. To make this easy, the function will fit in |
232 |
|
|
quite nicely into a call to <code>pthread_atfork</code>:</p> |
233 |
|
|
<pre> pthread_atfork (0, 0, ev_default_fork); |
234 |
|
|
|
235 |
|
|
</pre> |
236 |
|
|
</dd> |
237 |
|
|
<dt>ev_loop_fork (loop)</dt> |
238 |
|
|
<dd> |
239 |
|
|
<p>Like <code>ev_default_fork</code>, but acts on an event loop created by |
240 |
|
|
<code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop |
241 |
|
|
after fork, and how you do this is entirely your own problem.</p> |
242 |
|
|
</dd> |
243 |
|
|
<dt>unsigned int ev_method (loop)</dt> |
244 |
|
|
<dd> |
245 |
|
|
<p>Returns one of the <code>EVMETHOD_*</code> flags indicating the event backend in |
246 |
|
|
use.</p> |
247 |
|
|
</dd> |
248 |
root |
1.9 |
<dt>ev_tstamp ev_now (loop)</dt> |
249 |
root |
1.1 |
<dd> |
250 |
|
|
<p>Returns the current "event loop time", which is the time the event loop |
251 |
|
|
got events and started processing them. This timestamp does not change |
252 |
|
|
as long as callbacks are being processed, and this is also the base time |
253 |
|
|
used for relative timers. You can treat it as the timestamp of the event |
254 |
|
|
occuring (or more correctly, the mainloop finding out about it).</p> |
255 |
|
|
</dd> |
256 |
|
|
<dt>ev_loop (loop, int flags)</dt> |
257 |
|
|
<dd> |
258 |
|
|
<p>Finally, this is it, the event handler. This function usually is called |
259 |
|
|
after you initialised all your watchers and you want to start handling |
260 |
|
|
events.</p> |
261 |
|
|
<p>If the flags argument is specified as 0, it will not return until either |
262 |
|
|
no event watchers are active anymore or <code>ev_unloop</code> was called.</p> |
263 |
|
|
<p>A flags value of <code>EVLOOP_NONBLOCK</code> will look for new events, will handle |
264 |
|
|
those events and any outstanding ones, but will not block your process in |
265 |
root |
1.9 |
case there are no events and will return after one iteration of the loop.</p> |
266 |
root |
1.1 |
<p>A flags value of <code>EVLOOP_ONESHOT</code> will look for new events (waiting if |
267 |
|
|
neccessary) and will handle those and any outstanding ones. It will block |
268 |
root |
1.9 |
your process until at least one new event arrives, and will return after |
269 |
|
|
one iteration of the loop.</p> |
270 |
root |
1.1 |
<p>This flags value could be used to implement alternative looping |
271 |
|
|
constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and |
272 |
|
|
more generic mechanism.</p> |
273 |
|
|
</dd> |
274 |
|
|
<dt>ev_unloop (loop, how)</dt> |
275 |
|
|
<dd> |
276 |
root |
1.9 |
<p>Can be used to make a call to <code>ev_loop</code> return early (but only after it |
277 |
|
|
has processed all outstanding events). The <code>how</code> argument must be either |
278 |
|
|
<code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> call return, or |
279 |
|
|
<code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p> |
280 |
root |
1.1 |
</dd> |
281 |
|
|
<dt>ev_ref (loop)</dt> |
282 |
|
|
<dt>ev_unref (loop)</dt> |
283 |
|
|
<dd> |
284 |
root |
1.9 |
<p>Ref/unref can be used to add or remove a reference count on the event |
285 |
|
|
loop: Every watcher keeps one reference, and as long as the reference |
286 |
|
|
count is nonzero, <code>ev_loop</code> will not return on its own. If you have |
287 |
|
|
a watcher you never unregister that should not keep <code>ev_loop</code> from |
288 |
|
|
returning, ev_unref() after starting, and ev_ref() before stopping it. For |
289 |
|
|
example, libev itself uses this for its internal signal pipe: It is not |
290 |
|
|
visible to the libev user and should not keep <code>ev_loop</code> from exiting if |
291 |
|
|
no event watchers registered by it are active. It is also an excellent |
292 |
|
|
way to do this for generic recurring timers or from within third-party |
293 |
|
|
libraries. Just remember to <i>unref after start</i> and <i>ref before stop</i>.</p> |
294 |
root |
1.1 |
</dd> |
295 |
|
|
</dl> |
296 |
|
|
|
297 |
|
|
</div> |
298 |
|
|
<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> |
299 |
|
|
<div id="ANATOMY_OF_A_WATCHER_CONTENT"> |
300 |
|
|
<p>A watcher is a structure that you create and register to record your |
301 |
|
|
interest in some event. For instance, if you want to wait for STDIN to |
302 |
root |
1.10 |
become readable, you would create an <code>ev_io</code> watcher for that:</p> |
303 |
root |
1.1 |
<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
304 |
|
|
{ |
305 |
|
|
ev_io_stop (w); |
306 |
|
|
ev_unloop (loop, EVUNLOOP_ALL); |
307 |
|
|
} |
308 |
|
|
|
309 |
|
|
struct ev_loop *loop = ev_default_loop (0); |
310 |
|
|
struct ev_io stdin_watcher; |
311 |
|
|
ev_init (&stdin_watcher, my_cb); |
312 |
|
|
ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); |
313 |
|
|
ev_io_start (loop, &stdin_watcher); |
314 |
|
|
ev_loop (loop, 0); |
315 |
|
|
|
316 |
|
|
</pre> |
317 |
|
|
<p>As you can see, you are responsible for allocating the memory for your |
318 |
|
|
watcher structures (and it is usually a bad idea to do this on the stack, |
319 |
|
|
although this can sometimes be quite valid).</p> |
320 |
|
|
<p>Each watcher structure must be initialised by a call to <code>ev_init |
321 |
|
|
(watcher *, callback)</code>, which expects a callback to be provided. This |
322 |
|
|
callback gets invoked each time the event occurs (or, in the case of io |
323 |
|
|
watchers, each time the event loop detects that the file descriptor given |
324 |
|
|
is readable and/or writable).</p> |
325 |
|
|
<p>Each watcher type has its own <code>ev_<type>_set (watcher *, ...)</code> macro |
326 |
|
|
with arguments specific to this watcher type. There is also a macro |
327 |
|
|
to combine initialisation and setting in one call: <code>ev_<type>_init |
328 |
|
|
(watcher *, callback, ...)</code>.</p> |
329 |
|
|
<p>To make the watcher actually watch out for events, you have to start it |
330 |
|
|
with a watcher-specific start function (<code>ev_<type>_start (loop, watcher |
331 |
|
|
*)</code>), and you can stop watching for events at any time by calling the |
332 |
|
|
corresponding stop function (<code>ev_<type>_stop (loop, watcher *)</code>.</p> |
333 |
|
|
<p>As long as your watcher is active (has been started but not stopped) you |
334 |
|
|
must not touch the values stored in it. Most specifically you must never |
335 |
|
|
reinitialise it or call its set method.</p> |
336 |
root |
1.14 |
<p>You can check whether an event is active by calling the <code>ev_is_active |
337 |
root |
1.4 |
(watcher *)</code> macro. To see whether an event is outstanding (but the |
338 |
root |
1.14 |
callback for it has not been called yet) you can use the <code>ev_is_pending |
339 |
root |
1.1 |
(watcher *)</code> macro.</p> |
340 |
|
|
<p>Each and every callback receives the event loop pointer as first, the |
341 |
|
|
registered watcher structure as second, and a bitset of received events as |
342 |
|
|
third argument.</p> |
343 |
root |
1.14 |
<p>The received events usually include a single bit per event type received |
344 |
root |
1.1 |
(you can receive multiple events at the same time). The possible bit masks |
345 |
|
|
are:</p> |
346 |
|
|
<dl> |
347 |
root |
1.10 |
<dt><code>EV_READ</code></dt> |
348 |
|
|
<dt><code>EV_WRITE</code></dt> |
349 |
root |
1.1 |
<dd> |
350 |
root |
1.10 |
<p>The file descriptor in the <code>ev_io</code> watcher has become readable and/or |
351 |
root |
1.1 |
writable.</p> |
352 |
|
|
</dd> |
353 |
root |
1.10 |
<dt><code>EV_TIMEOUT</code></dt> |
354 |
root |
1.1 |
<dd> |
355 |
root |
1.10 |
<p>The <code>ev_timer</code> watcher has timed out.</p> |
356 |
root |
1.1 |
</dd> |
357 |
root |
1.10 |
<dt><code>EV_PERIODIC</code></dt> |
358 |
root |
1.1 |
<dd> |
359 |
root |
1.10 |
<p>The <code>ev_periodic</code> watcher has timed out.</p> |
360 |
root |
1.1 |
</dd> |
361 |
root |
1.10 |
<dt><code>EV_SIGNAL</code></dt> |
362 |
root |
1.1 |
<dd> |
363 |
root |
1.10 |
<p>The signal specified in the <code>ev_signal</code> watcher has been received by a thread.</p> |
364 |
root |
1.1 |
</dd> |
365 |
root |
1.10 |
<dt><code>EV_CHILD</code></dt> |
366 |
root |
1.1 |
<dd> |
367 |
root |
1.10 |
<p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p> |
368 |
root |
1.1 |
</dd> |
369 |
root |
1.10 |
<dt><code>EV_IDLE</code></dt> |
370 |
root |
1.1 |
<dd> |
371 |
root |
1.10 |
<p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p> |
372 |
root |
1.1 |
</dd> |
373 |
root |
1.10 |
<dt><code>EV_PREPARE</code></dt> |
374 |
|
|
<dt><code>EV_CHECK</code></dt> |
375 |
root |
1.1 |
<dd> |
376 |
root |
1.10 |
<p>All <code>ev_prepare</code> watchers are invoked just <i>before</i> <code>ev_loop</code> starts |
377 |
|
|
to gather new events, and all <code>ev_check</code> watchers are invoked just after |
378 |
root |
1.1 |
<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any |
379 |
|
|
received events. Callbacks of both watcher types can start and stop as |
380 |
|
|
many watchers as they want, and all of them will be taken into account |
381 |
root |
1.10 |
(for example, a <code>ev_prepare</code> watcher might start an idle watcher to keep |
382 |
root |
1.1 |
<code>ev_loop</code> from blocking).</p> |
383 |
|
|
</dd> |
384 |
root |
1.10 |
<dt><code>EV_ERROR</code></dt> |
385 |
root |
1.1 |
<dd> |
386 |
|
|
<p>An unspecified error has occured, the watcher has been stopped. This might |
387 |
|
|
happen because the watcher could not be properly started because libev |
388 |
|
|
ran out of memory, a file descriptor was found to be closed or any other |
389 |
|
|
problem. You best act on it by reporting the problem and somehow coping |
390 |
|
|
with the watcher being stopped.</p> |
391 |
|
|
<p>Libev will usually signal a few "dummy" events together with an error, |
392 |
|
|
for example it might indicate that a fd is readable or writable, and if |
393 |
|
|
your callbacks is well-written it can just attempt the operation and cope |
394 |
|
|
with the error from read() or write(). This will not work in multithreaded |
395 |
|
|
programs, though, so beware.</p> |
396 |
|
|
</dd> |
397 |
|
|
</dl> |
398 |
|
|
|
399 |
|
|
</div> |
400 |
|
|
<h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2> |
401 |
|
|
<div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2"> |
402 |
|
|
<p>Each watcher has, by default, a member <code>void *data</code> that you can change |
403 |
root |
1.14 |
and read at any time, libev will completely ignore it. This can be used |
404 |
root |
1.1 |
to associate arbitrary data with your watcher. If you need more data and |
405 |
|
|
don't want to allocate memory and store a pointer to it in that data |
406 |
|
|
member, you can also "subclass" the watcher type and provide your own |
407 |
|
|
data:</p> |
408 |
|
|
<pre> struct my_io |
409 |
|
|
{ |
410 |
|
|
struct ev_io io; |
411 |
|
|
int otherfd; |
412 |
|
|
void *somedata; |
413 |
|
|
struct whatever *mostinteresting; |
414 |
|
|
} |
415 |
|
|
|
416 |
|
|
</pre> |
417 |
|
|
<p>And since your callback will be called with a pointer to the watcher, you |
418 |
|
|
can cast it back to your own type:</p> |
419 |
|
|
<pre> static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents) |
420 |
|
|
{ |
421 |
|
|
struct my_io *w = (struct my_io *)w_; |
422 |
|
|
... |
423 |
|
|
} |
424 |
|
|
|
425 |
|
|
</pre> |
426 |
|
|
<p>More interesting and less C-conformant ways of catsing your callback type |
427 |
|
|
have been omitted....</p> |
428 |
|
|
|
429 |
|
|
|
430 |
|
|
|
431 |
|
|
|
432 |
|
|
|
433 |
|
|
</div> |
434 |
|
|
<h1 id="WATCHER_TYPES">WATCHER TYPES</h1><p><a href="#TOP" class="toplink">Top</a></p> |
435 |
|
|
<div id="WATCHER_TYPES_CONTENT"> |
436 |
|
|
<p>This section describes each watcher in detail, but will not repeat |
437 |
|
|
information given in the last section.</p> |
438 |
|
|
|
439 |
|
|
</div> |
440 |
root |
1.11 |
<h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</h2> |
441 |
|
|
<div id="code_ev_io_code_is_this_file_descrip-2"> |
442 |
root |
1.4 |
<p>I/O watchers check whether a file descriptor is readable or writable |
443 |
root |
1.1 |
in each iteration of the event loop (This behaviour is called |
444 |
|
|
level-triggering because you keep receiving events as long as the |
445 |
root |
1.14 |
condition persists. Remember you can stop the watcher if you don't want to |
446 |
root |
1.1 |
act on the event and neither want to receive future events).</p> |
447 |
root |
1.8 |
<p>In general you can register as many read and/or write event watchers oer |
448 |
|
|
fd as you want (as long as you don't confuse yourself). Setting all file |
449 |
|
|
descriptors to non-blocking mode is also usually a good idea (but not |
450 |
|
|
required if you know what you are doing).</p> |
451 |
|
|
<p>You have to be careful with dup'ed file descriptors, though. Some backends |
452 |
|
|
(the linux epoll backend is a notable example) cannot handle dup'ed file |
453 |
|
|
descriptors correctly if you register interest in two or more fds pointing |
454 |
|
|
to the same file/socket etc. description.</p> |
455 |
|
|
<p>If you must do this, then force the use of a known-to-be-good backend |
456 |
|
|
(at the time of this writing, this includes only EVMETHOD_SELECT and |
457 |
|
|
EVMETHOD_POLL).</p> |
458 |
root |
1.1 |
<dl> |
459 |
|
|
<dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
460 |
|
|
<dt>ev_io_set (ev_io *, int fd, int events)</dt> |
461 |
|
|
<dd> |
462 |
root |
1.10 |
<p>Configures an <code>ev_io</code> watcher. The fd is the file descriptor to rceeive |
463 |
root |
1.1 |
events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ | |
464 |
|
|
EV_WRITE</code> to receive the given events.</p> |
465 |
|
|
</dd> |
466 |
|
|
</dl> |
467 |
|
|
|
468 |
|
|
</div> |
469 |
root |
1.10 |
<h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2> |
470 |
|
|
<div id="code_ev_timer_code_relative_and_opti-2"> |
471 |
root |
1.1 |
<p>Timer watchers are simple relative timers that generate an event after a |
472 |
|
|
given time, and optionally repeating in regular intervals after that.</p> |
473 |
|
|
<p>The timers are based on real time, that is, if you register an event that |
474 |
|
|
times out after an hour and youreset your system clock to last years |
475 |
|
|
time, it will still time out after (roughly) and hour. "Roughly" because |
476 |
|
|
detecting time jumps is hard, and soem inaccuracies are unavoidable (the |
477 |
|
|
monotonic clock option helps a lot here).</p> |
478 |
root |
1.9 |
<p>The relative timeouts are calculated relative to the <code>ev_now ()</code> |
479 |
|
|
time. This is usually the right thing as this timestamp refers to the time |
480 |
|
|
of the event triggering whatever timeout you are modifying/starting. If |
481 |
|
|
you suspect event processing to be delayed and you *need* to base the timeout |
482 |
|
|
ion the current time, use something like this to adjust for this:</p> |
483 |
|
|
<pre> ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
484 |
|
|
|
485 |
|
|
</pre> |
486 |
root |
1.1 |
<dl> |
487 |
|
|
<dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> |
488 |
|
|
<dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> |
489 |
|
|
<dd> |
490 |
|
|
<p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is |
491 |
|
|
<code>0.</code>, then it will automatically be stopped. If it is positive, then the |
492 |
|
|
timer will automatically be configured to trigger again <code>repeat</code> seconds |
493 |
|
|
later, again, and again, until stopped manually.</p> |
494 |
|
|
<p>The timer itself will do a best-effort at avoiding drift, that is, if you |
495 |
|
|
configure a timer to trigger every 10 seconds, then it will trigger at |
496 |
|
|
exactly 10 second intervals. If, however, your program cannot keep up with |
497 |
|
|
the timer (ecause it takes longer than those 10 seconds to do stuff) the |
498 |
|
|
timer will not fire more than once per event loop iteration.</p> |
499 |
|
|
</dd> |
500 |
|
|
<dt>ev_timer_again (loop)</dt> |
501 |
|
|
<dd> |
502 |
|
|
<p>This will act as if the timer timed out and restart it again if it is |
503 |
|
|
repeating. The exact semantics are:</p> |
504 |
|
|
<p>If the timer is started but nonrepeating, stop it.</p> |
505 |
|
|
<p>If the timer is repeating, either start it if necessary (with the repeat |
506 |
|
|
value), or reset the running timer to the repeat value.</p> |
507 |
|
|
<p>This sounds a bit complicated, but here is a useful and typical |
508 |
|
|
example: Imagine you have a tcp connection and you want a so-called idle |
509 |
|
|
timeout, that is, you want to be called when there have been, say, 60 |
510 |
|
|
seconds of inactivity on the socket. The easiest way to do this is to |
511 |
root |
1.10 |
configure an <code>ev_timer</code> with after=repeat=60 and calling ev_timer_again each |
512 |
root |
1.1 |
time you successfully read or write some data. If you go into an idle |
513 |
|
|
state where you do not expect data to travel on the socket, you can stop |
514 |
|
|
the timer, and again will automatically restart it if need be.</p> |
515 |
|
|
</dd> |
516 |
|
|
</dl> |
517 |
|
|
|
518 |
|
|
</div> |
519 |
root |
1.14 |
<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</h2> |
520 |
root |
1.10 |
<div id="code_ev_periodic_code_to_cron_or_not-2"> |
521 |
root |
1.1 |
<p>Periodic watchers are also timers of a kind, but they are very versatile |
522 |
|
|
(and unfortunately a bit complex).</p> |
523 |
root |
1.10 |
<p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time) |
524 |
root |
1.1 |
but on wallclock time (absolute time). You can tell a periodic watcher |
525 |
|
|
to trigger "at" some specific point in time. For example, if you tell a |
526 |
|
|
periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now () |
527 |
|
|
+ 10.>) and then reset your system clock to the last year, then it will |
528 |
root |
1.10 |
take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger |
529 |
root |
1.1 |
roughly 10 seconds later and of course not if you reset your system time |
530 |
|
|
again).</p> |
531 |
|
|
<p>They can also be used to implement vastly more complex timers, such as |
532 |
|
|
triggering an event on eahc midnight, local time.</p> |
533 |
|
|
<dl> |
534 |
|
|
<dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> |
535 |
|
|
<dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt> |
536 |
|
|
<dd> |
537 |
|
|
<p>Lots of arguments, lets sort it out... There are basically three modes of |
538 |
|
|
operation, and we will explain them from simplest to complex:</p> |
539 |
|
|
|
540 |
|
|
|
541 |
|
|
|
542 |
|
|
|
543 |
|
|
<p> |
544 |
|
|
<dl> |
545 |
|
|
<dt>* absolute timer (interval = reschedule_cb = 0)</dt> |
546 |
|
|
<dd> |
547 |
|
|
<p>In this configuration the watcher triggers an event at the wallclock time |
548 |
|
|
<code>at</code> and doesn't repeat. It will not adjust when a time jump occurs, |
549 |
|
|
that is, if it is to be run at January 1st 2011 then it will run when the |
550 |
|
|
system time reaches or surpasses this time.</p> |
551 |
|
|
</dd> |
552 |
|
|
<dt>* non-repeating interval timer (interval > 0, reschedule_cb = 0)</dt> |
553 |
|
|
<dd> |
554 |
|
|
<p>In this mode the watcher will always be scheduled to time out at the next |
555 |
|
|
<code>at + N * interval</code> time (for some integer N) and then repeat, regardless |
556 |
|
|
of any time jumps.</p> |
557 |
|
|
<p>This can be used to create timers that do not drift with respect to system |
558 |
|
|
time:</p> |
559 |
|
|
<pre> ev_periodic_set (&periodic, 0., 3600., 0); |
560 |
|
|
|
561 |
|
|
</pre> |
562 |
|
|
<p>This doesn't mean there will always be 3600 seconds in between triggers, |
563 |
|
|
but only that the the callback will be called when the system time shows a |
564 |
root |
1.12 |
full hour (UTC), or more correctly, when the system time is evenly divisible |
565 |
root |
1.1 |
by 3600.</p> |
566 |
|
|
<p>Another way to think about it (for the mathematically inclined) is that |
567 |
root |
1.10 |
<code>ev_periodic</code> will try to run the callback in this mode at the next possible |
568 |
root |
1.1 |
time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p> |
569 |
|
|
</dd> |
570 |
|
|
<dt>* manual reschedule mode (reschedule_cb = callback)</dt> |
571 |
|
|
<dd> |
572 |
|
|
<p>In this mode the values for <code>interval</code> and <code>at</code> are both being |
573 |
|
|
ignored. Instead, each time the periodic watcher gets scheduled, the |
574 |
|
|
reschedule callback will be called with the watcher as first, and the |
575 |
|
|
current time as second argument.</p> |
576 |
root |
1.21 |
<p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher, |
577 |
|
|
ever, or make any event loop modifications</i>. If you need to stop it, |
578 |
|
|
return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by |
579 |
|
|
starting a prepare watcher).</p> |
580 |
root |
1.13 |
<p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
581 |
|
|
ev_tstamp now)</code>, e.g.:</p> |
582 |
root |
1.1 |
<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
583 |
|
|
{ |
584 |
|
|
return now + 60.; |
585 |
|
|
} |
586 |
|
|
|
587 |
|
|
</pre> |
588 |
|
|
<p>It must return the next time to trigger, based on the passed time value |
589 |
|
|
(that is, the lowest time value larger than to the second argument). It |
590 |
|
|
will usually be called just before the callback will be triggered, but |
591 |
|
|
might be called at other times, too.</p> |
592 |
root |
1.21 |
<p>NOTE: <i>This callback must always return a time that is later than the |
593 |
root |
1.22 |
passed <code>now</code> value</i>. Not even <code>now</code> itself will do, it <i>must</i> be larger.</p> |
594 |
root |
1.1 |
<p>This can be used to create very complex timers, such as a timer that |
595 |
|
|
triggers on each midnight, local time. To do this, you would calculate the |
596 |
root |
1.22 |
next midnight after <code>now</code> and return the timestamp value for this. How |
597 |
|
|
you do this is, again, up to you (but it is not trivial, which is the main |
598 |
|
|
reason I omitted it as an example).</p> |
599 |
root |
1.1 |
</dd> |
600 |
|
|
</dl> |
601 |
|
|
</p> |
602 |
|
|
</dd> |
603 |
|
|
<dt>ev_periodic_again (loop, ev_periodic *)</dt> |
604 |
|
|
<dd> |
605 |
|
|
<p>Simply stops and restarts the periodic watcher again. This is only useful |
606 |
|
|
when you changed some parameters or the reschedule callback would return |
607 |
|
|
a different time than the last time it was called (e.g. in a crond like |
608 |
|
|
program when the crontabs have changed).</p> |
609 |
|
|
</dd> |
610 |
|
|
</dl> |
611 |
|
|
|
612 |
|
|
</div> |
613 |
root |
1.10 |
<h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</h2> |
614 |
|
|
<div id="code_ev_signal_code_signal_me_when_a-2"> |
615 |
root |
1.1 |
<p>Signal watchers will trigger an event when the process receives a specific |
616 |
|
|
signal one or more times. Even though signals are very asynchronous, libev |
617 |
root |
1.9 |
will try it's best to deliver signals synchronously, i.e. as part of the |
618 |
root |
1.1 |
normal event processing, like any other event.</p> |
619 |
root |
1.14 |
<p>You can configure as many watchers as you like per signal. Only when the |
620 |
root |
1.1 |
first watcher gets started will libev actually register a signal watcher |
621 |
|
|
with the kernel (thus it coexists with your own signal handlers as long |
622 |
|
|
as you don't register any with libev). Similarly, when the last signal |
623 |
|
|
watcher for a signal is stopped libev will reset the signal handler to |
624 |
|
|
SIG_DFL (regardless of what it was set to before).</p> |
625 |
|
|
<dl> |
626 |
|
|
<dt>ev_signal_init (ev_signal *, callback, int signum)</dt> |
627 |
|
|
<dt>ev_signal_set (ev_signal *, int signum)</dt> |
628 |
|
|
<dd> |
629 |
|
|
<p>Configures the watcher to trigger on the given signal number (usually one |
630 |
|
|
of the <code>SIGxxx</code> constants).</p> |
631 |
|
|
</dd> |
632 |
|
|
</dl> |
633 |
|
|
|
634 |
|
|
</div> |
635 |
root |
1.10 |
<h2 id="code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</h2> |
636 |
|
|
<div id="code_ev_child_code_wait_for_pid_stat-2"> |
637 |
root |
1.1 |
<p>Child watchers trigger when your process receives a SIGCHLD in response to |
638 |
|
|
some child status changes (most typically when a child of yours dies).</p> |
639 |
|
|
<dl> |
640 |
|
|
<dt>ev_child_init (ev_child *, callback, int pid)</dt> |
641 |
|
|
<dt>ev_child_set (ev_child *, int pid)</dt> |
642 |
|
|
<dd> |
643 |
|
|
<p>Configures the watcher to wait for status changes of process <code>pid</code> (or |
644 |
|
|
<i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look |
645 |
|
|
at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see |
646 |
root |
1.14 |
the status word (use the macros from <code>sys/wait.h</code> and see your systems |
647 |
|
|
<code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the |
648 |
|
|
process causing the status change.</p> |
649 |
root |
1.1 |
</dd> |
650 |
|
|
</dl> |
651 |
|
|
|
652 |
|
|
</div> |
653 |
root |
1.10 |
<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</h2> |
654 |
|
|
<div id="code_ev_idle_code_when_you_ve_got_no-2"> |
655 |
root |
1.14 |
<p>Idle watchers trigger events when there are no other events are pending |
656 |
|
|
(prepare, check and other idle watchers do not count). That is, as long |
657 |
|
|
as your process is busy handling sockets or timeouts (or even signals, |
658 |
|
|
imagine) it will not be triggered. But when your process is idle all idle |
659 |
|
|
watchers are being called again and again, once per event loop iteration - |
660 |
|
|
until stopped, that is, or your process receives more events and becomes |
661 |
|
|
busy.</p> |
662 |
root |
1.1 |
<p>The most noteworthy effect is that as long as any idle watchers are |
663 |
|
|
active, the process will not block when waiting for new events.</p> |
664 |
|
|
<p>Apart from keeping your process non-blocking (which is a useful |
665 |
|
|
effect on its own sometimes), idle watchers are a good place to do |
666 |
|
|
"pseudo-background processing", or delay processing stuff to after the |
667 |
|
|
event loop has handled all outstanding events.</p> |
668 |
|
|
<dl> |
669 |
|
|
<dt>ev_idle_init (ev_signal *, callback)</dt> |
670 |
|
|
<dd> |
671 |
|
|
<p>Initialises and configures the idle watcher - it has no parameters of any |
672 |
|
|
kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless, |
673 |
|
|
believe me.</p> |
674 |
|
|
</dd> |
675 |
|
|
</dl> |
676 |
|
|
|
677 |
|
|
</div> |
678 |
root |
1.17 |
<h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2> |
679 |
root |
1.16 |
<div id="code_ev_prepare_code_and_code_ev_che-2"> |
680 |
root |
1.14 |
<p>Prepare and check watchers are usually (but not always) used in tandem: |
681 |
root |
1.23 |
prepare watchers get invoked before the process blocks and check watchers |
682 |
root |
1.14 |
afterwards.</p> |
683 |
root |
1.1 |
<p>Their main purpose is to integrate other event mechanisms into libev. This |
684 |
|
|
could be used, for example, to track variable changes, implement your own |
685 |
|
|
watchers, integrate net-snmp or a coroutine library and lots more.</p> |
686 |
|
|
<p>This is done by examining in each prepare call which file descriptors need |
687 |
root |
1.14 |
to be watched by the other library, registering <code>ev_io</code> watchers for |
688 |
|
|
them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries |
689 |
|
|
provide just this functionality). Then, in the check watcher you check for |
690 |
|
|
any events that occured (by checking the pending status of all watchers |
691 |
|
|
and stopping them) and call back into the library. The I/O and timer |
692 |
root |
1.23 |
callbacks will never actually be called (but must be valid nevertheless, |
693 |
root |
1.14 |
because you never know, you know?).</p> |
694 |
|
|
<p>As another example, the Perl Coro module uses these hooks to integrate |
695 |
root |
1.1 |
coroutines into libev programs, by yielding to other active coroutines |
696 |
|
|
during each prepare and only letting the process block if no coroutines |
697 |
root |
1.23 |
are ready to run (it's actually more complicated: it only runs coroutines |
698 |
|
|
with priority higher than or equal to the event loop and one coroutine |
699 |
|
|
of lower priority, but only once, using idle watchers to keep the event |
700 |
|
|
loop from blocking if lower-priority coroutines are active, thus mapping |
701 |
|
|
low-priority coroutines to idle/background tasks).</p> |
702 |
root |
1.1 |
<dl> |
703 |
|
|
<dt>ev_prepare_init (ev_prepare *, callback)</dt> |
704 |
|
|
<dt>ev_check_init (ev_check *, callback)</dt> |
705 |
|
|
<dd> |
706 |
|
|
<p>Initialises and configures the prepare or check watcher - they have no |
707 |
|
|
parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> |
708 |
root |
1.14 |
macros, but using them is utterly, utterly and completely pointless.</p> |
709 |
root |
1.1 |
</dd> |
710 |
|
|
</dl> |
711 |
|
|
|
712 |
|
|
</div> |
713 |
|
|
<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
714 |
|
|
<div id="OTHER_FUNCTIONS_CONTENT"> |
715 |
root |
1.14 |
<p>There are some other functions of possible interest. Described. Here. Now.</p> |
716 |
root |
1.1 |
<dl> |
717 |
|
|
<dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> |
718 |
|
|
<dd> |
719 |
|
|
<p>This function combines a simple timer and an I/O watcher, calls your |
720 |
|
|
callback on whichever event happens first and automatically stop both |
721 |
|
|
watchers. This is useful if you want to wait for a single event on an fd |
722 |
|
|
or timeout without havign to allocate/configure/start/stop/free one or |
723 |
|
|
more watchers yourself.</p> |
724 |
root |
1.14 |
<p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events |
725 |
|
|
is being ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and |
726 |
|
|
<code>events</code> set will be craeted and started.</p> |
727 |
root |
1.1 |
<p>If <code>timeout</code> is less than 0, then no timeout watcher will be |
728 |
root |
1.14 |
started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and |
729 |
|
|
repeat = 0) will be started. While <code>0</code> is a valid timeout, it is of |
730 |
|
|
dubious value.</p> |
731 |
|
|
<p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and gets |
732 |
root |
1.24 |
passed an <code>revents</code> set like normal event callbacks (a combination of |
733 |
root |
1.14 |
<code>EV_ERROR</code>, <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code> |
734 |
|
|
value passed to <code>ev_once</code>:</p> |
735 |
root |
1.1 |
<pre> static void stdin_ready (int revents, void *arg) |
736 |
|
|
{ |
737 |
|
|
if (revents & EV_TIMEOUT) |
738 |
root |
1.14 |
/* doh, nothing entered */; |
739 |
root |
1.1 |
else if (revents & EV_READ) |
740 |
root |
1.14 |
/* stdin might have data for us, joy! */; |
741 |
root |
1.1 |
} |
742 |
|
|
|
743 |
root |
1.14 |
ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
744 |
root |
1.1 |
|
745 |
|
|
</pre> |
746 |
|
|
</dd> |
747 |
|
|
<dt>ev_feed_event (loop, watcher, int events)</dt> |
748 |
|
|
<dd> |
749 |
|
|
<p>Feeds the given event set into the event loop, as if the specified event |
750 |
root |
1.14 |
had happened for the specified watcher (which must be a pointer to an |
751 |
|
|
initialised but not necessarily started event watcher).</p> |
752 |
root |
1.1 |
</dd> |
753 |
|
|
<dt>ev_feed_fd_event (loop, int fd, int revents)</dt> |
754 |
|
|
<dd> |
755 |
root |
1.14 |
<p>Feed an event on the given fd, as if a file descriptor backend detected |
756 |
|
|
the given events it.</p> |
757 |
root |
1.1 |
</dd> |
758 |
|
|
<dt>ev_feed_signal_event (loop, int signum)</dt> |
759 |
|
|
<dd> |
760 |
|
|
<p>Feed an event as if the given signal occured (loop must be the default loop!).</p> |
761 |
|
|
</dd> |
762 |
|
|
</dl> |
763 |
|
|
|
764 |
|
|
</div> |
765 |
root |
1.23 |
<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
766 |
|
|
<div id="LIBEVENT_EMULATION_CONTENT"> |
767 |
|
|
<p>TBD.</p> |
768 |
|
|
|
769 |
|
|
</div> |
770 |
|
|
<h1 id="C_SUPPORT">C++ SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p> |
771 |
|
|
<div id="C_SUPPORT_CONTENT"> |
772 |
|
|
<p>TBD.</p> |
773 |
|
|
|
774 |
|
|
</div> |
775 |
root |
1.1 |
<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
776 |
|
|
<div id="AUTHOR_CONTENT"> |
777 |
|
|
<p>Marc Lehmann <libev@schmorp.de>.</p> |
778 |
|
|
|
779 |
|
|
</div> |
780 |
|
|
</div></body> |
781 |
|
|
</html> |