… | |
… | |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | #include <ev.h> |
7 | #include <ev.h> |
8 | |
8 | |
|
|
9 | =head2 EXAMPLE PROGRAM |
|
|
10 | |
|
|
11 | // a single header file is required |
|
|
12 | #include <ev.h> |
|
|
13 | |
|
|
14 | // every watcher type has its own typedef'd struct |
|
|
15 | // with the name ev_<type> |
|
|
16 | ev_io stdin_watcher; |
|
|
17 | ev_timer timeout_watcher; |
|
|
18 | |
|
|
19 | // all watcher callbacks have a similar signature |
|
|
20 | // this callback is called when data is readable on stdin |
|
|
21 | static void |
|
|
22 | stdin_cb (EV_P_ struct ev_io *w, int revents) |
|
|
23 | { |
|
|
24 | puts ("stdin ready"); |
|
|
25 | // for one-shot events, one must manually stop the watcher |
|
|
26 | // with its corresponding stop function. |
|
|
27 | ev_io_stop (EV_A_ w); |
|
|
28 | |
|
|
29 | // this causes all nested ev_loop's to stop iterating |
|
|
30 | ev_unloop (EV_A_ EVUNLOOP_ALL); |
|
|
31 | } |
|
|
32 | |
|
|
33 | // another callback, this time for a time-out |
|
|
34 | static void |
|
|
35 | timeout_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
36 | { |
|
|
37 | puts ("timeout"); |
|
|
38 | // this causes the innermost ev_loop to stop iterating |
|
|
39 | ev_unloop (EV_A_ EVUNLOOP_ONE); |
|
|
40 | } |
|
|
41 | |
|
|
42 | int |
|
|
43 | main (void) |
|
|
44 | { |
|
|
45 | // use the default event loop unless you have special needs |
|
|
46 | struct ev_loop *loop = ev_default_loop (0); |
|
|
47 | |
|
|
48 | // initialise an io watcher, then start it |
|
|
49 | // this one will watch for stdin to become readable |
|
|
50 | ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
|
|
51 | ev_io_start (loop, &stdin_watcher); |
|
|
52 | |
|
|
53 | // initialise a timer watcher, then start it |
|
|
54 | // simple non-repeating 5.5 second timeout |
|
|
55 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
|
|
56 | ev_timer_start (loop, &timeout_watcher); |
|
|
57 | |
|
|
58 | // now wait for events to arrive |
|
|
59 | ev_loop (loop, 0); |
|
|
60 | |
|
|
61 | // unloop was called, so exit |
|
|
62 | return 0; |
|
|
63 | } |
|
|
64 | |
9 | =head1 DESCRIPTION |
65 | =head1 DESCRIPTION |
10 | |
66 | |
|
|
67 | The newest version of this document is also available as an html-formatted |
|
|
68 | web page you might find easier to navigate when reading it for the first |
|
|
69 | time: L<http://cvs.schmorp.de/libev/ev.html>. |
|
|
70 | |
11 | Libev is an event loop: you register interest in certain events (such as a |
71 | Libev is an event loop: you register interest in certain events (such as a |
12 | file descriptor being readable or a timeout occuring), and it will manage |
72 | file descriptor being readable or a timeout occurring), and it will manage |
13 | these event sources and provide your program with events. |
73 | these event sources and provide your program with events. |
14 | |
74 | |
15 | To do this, it must take more or less complete control over your process |
75 | To do this, it must take more or less complete control over your process |
16 | (or thread) by executing the I<event loop> handler, and will then |
76 | (or thread) by executing the I<event loop> handler, and will then |
17 | communicate events via a callback mechanism. |
77 | communicate events via a callback mechanism. |
… | |
… | |
19 | You register interest in certain events by registering so-called I<event |
79 | You register interest in certain events by registering so-called I<event |
20 | watchers>, which are relatively small C structures you initialise with the |
80 | watchers>, which are relatively small C structures you initialise with the |
21 | details of the event, and then hand it over to libev by I<starting> the |
81 | details of the event, and then hand it over to libev by I<starting> the |
22 | watcher. |
82 | watcher. |
23 | |
83 | |
24 | =head1 FEATURES |
84 | =head2 FEATURES |
25 | |
85 | |
26 | Libev supports select, poll, the linux-specific epoll and the bsd-specific |
86 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
27 | kqueue mechanisms for file descriptor events, relative timers, absolute |
87 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
28 | timers with customised rescheduling, signal events, process status change |
88 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
29 | events (related to SIGCHLD), and event watchers dealing with the event |
89 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
30 | loop mechanism itself (idle, prepare and check watchers). It also is quite |
90 | with customised rescheduling (C<ev_periodic>), synchronous signals |
|
|
91 | (C<ev_signal>), process status change events (C<ev_child>), and event |
|
|
92 | watchers dealing with the event loop mechanism itself (C<ev_idle>, |
|
|
93 | C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as |
|
|
94 | file watchers (C<ev_stat>) and even limited support for fork events |
|
|
95 | (C<ev_fork>). |
|
|
96 | |
|
|
97 | It also is quite fast (see this |
31 | fast (see this L<benchmark|http://libev.schmorp.de/bench.html> comparing |
98 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
32 | it to libevent for example). |
99 | for example). |
33 | |
100 | |
34 | =head1 CONVENTIONS |
101 | =head2 CONVENTIONS |
35 | |
102 | |
36 | Libev is very configurable. In this manual the default configuration |
103 | Libev is very configurable. In this manual the default (and most common) |
37 | will be described, which supports multiple event loops. For more info |
104 | configuration will be described, which supports multiple event loops. For |
38 | about various configuration options please have a look at the file |
105 | more info about various configuration options please have a look at |
39 | F<README.embed> in the libev distribution. If libev was configured without |
106 | B<EMBED> section in this manual. If libev was configured without support |
40 | support for multiple event loops, then all functions taking an initial |
107 | for multiple event loops, then all functions taking an initial argument of |
41 | argument of name C<loop> (which is always of type C<struct ev_loop *>) |
108 | name C<loop> (which is always of type C<struct ev_loop *>) will not have |
42 | will not have this argument. |
109 | this argument. |
43 | |
110 | |
44 | =head1 TIME REPRESENTATION |
111 | =head2 TIME REPRESENTATION |
45 | |
112 | |
46 | Libev represents time as a single floating point number, representing the |
113 | Libev represents time as a single floating point number, representing the |
47 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
114 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
48 | the beginning of 1970, details are complicated, don't ask). This type is |
115 | the beginning of 1970, details are complicated, don't ask). This type is |
49 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
116 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
50 | to the C<double> type in C, and when you need to do any calculations on |
117 | to the C<double> type in C, and when you need to do any calculations on |
51 | it, you should treat it as such. |
118 | it, you should treat it as some floatingpoint value. Unlike the name |
|
|
119 | component C<stamp> might indicate, it is also used for time differences |
|
|
120 | throughout libev. |
52 | |
121 | |
53 | =head1 GLOBAL FUNCTIONS |
122 | =head1 GLOBAL FUNCTIONS |
54 | |
123 | |
55 | These functions can be called anytime, even before initialising the |
124 | These functions can be called anytime, even before initialising the |
56 | library in any way. |
125 | library in any way. |
… | |
… | |
61 | |
130 | |
62 | Returns the current time as libev would use it. Please note that the |
131 | Returns the current time as libev would use it. Please note that the |
63 | C<ev_now> function is usually faster and also often returns the timestamp |
132 | C<ev_now> function is usually faster and also often returns the timestamp |
64 | you actually want to know. |
133 | you actually want to know. |
65 | |
134 | |
|
|
135 | =item ev_sleep (ev_tstamp interval) |
|
|
136 | |
|
|
137 | Sleep for the given interval: The current thread will be blocked until |
|
|
138 | either it is interrupted or the given time interval has passed. Basically |
|
|
139 | this is a subsecond-resolution C<sleep ()>. |
|
|
140 | |
66 | =item int ev_version_major () |
141 | =item int ev_version_major () |
67 | |
142 | |
68 | =item int ev_version_minor () |
143 | =item int ev_version_minor () |
69 | |
144 | |
70 | You can find out the major and minor version numbers of the library |
145 | You can find out the major and minor ABI version numbers of the library |
71 | you linked against by calling the functions C<ev_version_major> and |
146 | you linked against by calling the functions C<ev_version_major> and |
72 | C<ev_version_minor>. If you want, you can compare against the global |
147 | C<ev_version_minor>. If you want, you can compare against the global |
73 | symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the |
148 | symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the |
74 | version of the library your program was compiled against. |
149 | version of the library your program was compiled against. |
75 | |
150 | |
|
|
151 | These version numbers refer to the ABI version of the library, not the |
|
|
152 | release version. |
|
|
153 | |
76 | Usually, it's a good idea to terminate if the major versions mismatch, |
154 | Usually, it's a good idea to terminate if the major versions mismatch, |
77 | as this indicates an incompatible change. Minor versions are usually |
155 | as this indicates an incompatible change. Minor versions are usually |
78 | compatible to older versions, so a larger minor version alone is usually |
156 | compatible to older versions, so a larger minor version alone is usually |
79 | not a problem. |
157 | not a problem. |
80 | |
158 | |
81 | Example: make sure we haven't accidentally been linked against the wrong |
159 | Example: Make sure we haven't accidentally been linked against the wrong |
82 | version: |
160 | version. |
83 | |
161 | |
84 | assert (("libev version mismatch", |
162 | assert (("libev version mismatch", |
85 | ev_version_major () == EV_VERSION_MAJOR |
163 | ev_version_major () == EV_VERSION_MAJOR |
86 | && ev_version_minor () >= EV_VERSION_MINOR)); |
164 | && ev_version_minor () >= EV_VERSION_MINOR)); |
87 | |
165 | |
… | |
… | |
117 | |
195 | |
118 | See the description of C<ev_embed> watchers for more info. |
196 | See the description of C<ev_embed> watchers for more info. |
119 | |
197 | |
120 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) |
198 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) |
121 | |
199 | |
122 | Sets the allocation function to use (the prototype is similar to the |
200 | Sets the allocation function to use (the prototype is similar - the |
123 | realloc C function, the semantics are identical). It is used to allocate |
201 | semantics is identical - to the realloc C function). It is used to |
124 | and free memory (no surprises here). If it returns zero when memory |
202 | allocate and free memory (no surprises here). If it returns zero when |
125 | needs to be allocated, the library might abort or take some potentially |
203 | memory needs to be allocated, the library might abort or take some |
126 | destructive action. The default is your system realloc function. |
204 | potentially destructive action. The default is your system realloc |
|
|
205 | function. |
127 | |
206 | |
128 | You could override this function in high-availability programs to, say, |
207 | You could override this function in high-availability programs to, say, |
129 | free some memory if it cannot allocate memory, to use a special allocator, |
208 | free some memory if it cannot allocate memory, to use a special allocator, |
130 | or even to sleep a while and retry until some memory is available. |
209 | or even to sleep a while and retry until some memory is available. |
131 | |
210 | |
132 | Example: replace the libev allocator with one that waits a bit and then |
211 | Example: Replace the libev allocator with one that waits a bit and then |
133 | retries: better than mine). |
212 | retries). |
134 | |
213 | |
135 | static void * |
214 | static void * |
136 | persistent_realloc (void *ptr, long size) |
215 | persistent_realloc (void *ptr, size_t size) |
137 | { |
216 | { |
138 | for (;;) |
217 | for (;;) |
139 | { |
218 | { |
140 | void *newptr = realloc (ptr, size); |
219 | void *newptr = realloc (ptr, size); |
141 | |
220 | |
… | |
… | |
157 | callback is set, then libev will expect it to remedy the sitution, no |
236 | callback is set, then libev will expect it to remedy the sitution, no |
158 | matter what, when it returns. That is, libev will generally retry the |
237 | matter what, when it returns. That is, libev will generally retry the |
159 | requested operation, or, if the condition doesn't go away, do bad stuff |
238 | requested operation, or, if the condition doesn't go away, do bad stuff |
160 | (such as abort). |
239 | (such as abort). |
161 | |
240 | |
162 | Example: do the same thing as libev does internally: |
241 | Example: This is basically the same thing that libev does internally, too. |
163 | |
242 | |
164 | static void |
243 | static void |
165 | fatal_error (const char *msg) |
244 | fatal_error (const char *msg) |
166 | { |
245 | { |
167 | perror (msg); |
246 | perror (msg); |
… | |
… | |
196 | flags. If that is troubling you, check C<ev_backend ()> afterwards). |
275 | flags. If that is troubling you, check C<ev_backend ()> afterwards). |
197 | |
276 | |
198 | If you don't know what event loop to use, use the one returned from this |
277 | If you don't know what event loop to use, use the one returned from this |
199 | function. |
278 | function. |
200 | |
279 | |
|
|
280 | The default loop is the only loop that can handle C<ev_signal> and |
|
|
281 | C<ev_child> watchers, and to do this, it always registers a handler |
|
|
282 | for C<SIGCHLD>. If this is a problem for your app you can either |
|
|
283 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
|
|
284 | can simply overwrite the C<SIGCHLD> signal handler I<after> calling |
|
|
285 | C<ev_default_init>. |
|
|
286 | |
201 | The flags argument can be used to specify special behaviour or specific |
287 | The flags argument can be used to specify special behaviour or specific |
202 | backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). |
288 | backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). |
203 | |
289 | |
204 | The following flags are supported: |
290 | The following flags are supported: |
205 | |
291 | |
… | |
… | |
217 | C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will |
303 | C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will |
218 | override the flags completely if it is found in the environment. This is |
304 | override the flags completely if it is found in the environment. This is |
219 | useful to try out specific backends to test their performance, or to work |
305 | useful to try out specific backends to test their performance, or to work |
220 | around bugs. |
306 | around bugs. |
221 | |
307 | |
|
|
308 | =item C<EVFLAG_FORKCHECK> |
|
|
309 | |
|
|
310 | Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after |
|
|
311 | a fork, you can also make libev check for a fork in each iteration by |
|
|
312 | enabling this flag. |
|
|
313 | |
|
|
314 | This works by calling C<getpid ()> on every iteration of the loop, |
|
|
315 | and thus this might slow down your event loop if you do a lot of loop |
|
|
316 | iterations and little real work, but is usually not noticeable (on my |
|
|
317 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence |
|
|
318 | without a syscall and thus I<very> fast, but my GNU/Linux system also has |
|
|
319 | C<pthread_atfork> which is even faster). |
|
|
320 | |
|
|
321 | The big advantage of this flag is that you can forget about fork (and |
|
|
322 | forget about forgetting to tell libev about forking) when you use this |
|
|
323 | flag. |
|
|
324 | |
|
|
325 | This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS> |
|
|
326 | environment variable. |
|
|
327 | |
222 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
328 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
223 | |
329 | |
224 | This is your standard select(2) backend. Not I<completely> standard, as |
330 | This is your standard select(2) backend. Not I<completely> standard, as |
225 | libev tries to roll its own fd_set with no limits on the number of fds, |
331 | libev tries to roll its own fd_set with no limits on the number of fds, |
226 | but if that fails, expect a fairly low limit on the number of fds when |
332 | but if that fails, expect a fairly low limit on the number of fds when |
227 | using this backend. It doesn't scale too well (O(highest_fd)), but its usually |
333 | using this backend. It doesn't scale too well (O(highest_fd)), but its |
228 | the fastest backend for a low number of fds. |
334 | usually the fastest backend for a low number of (low-numbered :) fds. |
|
|
335 | |
|
|
336 | To get good performance out of this backend you need a high amount of |
|
|
337 | parallelity (most of the file descriptors should be busy). If you are |
|
|
338 | writing a server, you should C<accept ()> in a loop to accept as many |
|
|
339 | connections as possible during one iteration. You might also want to have |
|
|
340 | a look at C<ev_set_io_collect_interval ()> to increase the amount of |
|
|
341 | readyness notifications you get per iteration. |
229 | |
342 | |
230 | =item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) |
343 | =item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) |
231 | |
344 | |
232 | And this is your standard poll(2) backend. It's more complicated than |
345 | And this is your standard poll(2) backend. It's more complicated |
233 | select, but handles sparse fds better and has no artificial limit on the |
346 | than select, but handles sparse fds better and has no artificial |
234 | number of fds you can use (except it will slow down considerably with a |
347 | limit on the number of fds you can use (except it will slow down |
235 | lot of inactive fds). It scales similarly to select, i.e. O(total_fds). |
348 | considerably with a lot of inactive fds). It scales similarly to select, |
|
|
349 | i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for |
|
|
350 | performance tips. |
236 | |
351 | |
237 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
352 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
238 | |
353 | |
239 | For few fds, this backend is a bit little slower than poll and select, |
354 | For few fds, this backend is a bit little slower than poll and select, |
240 | but it scales phenomenally better. While poll and select usually scale like |
355 | but it scales phenomenally better. While poll and select usually scale |
241 | O(total_fds) where n is the total number of fds (or the highest fd), epoll scales |
356 | like O(total_fds) where n is the total number of fds (or the highest fd), |
242 | either O(1) or O(active_fds). |
357 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
|
|
358 | of shortcomings, such as silently dropping events in some hard-to-detect |
|
|
359 | cases and rewiring a syscall per fd change, no fork support and bad |
|
|
360 | support for dup. |
243 | |
361 | |
244 | While stopping and starting an I/O watcher in the same iteration will |
362 | While stopping, setting and starting an I/O watcher in the same iteration |
245 | result in some caching, there is still a syscall per such incident |
363 | will result in some caching, there is still a syscall per such incident |
246 | (because the fd could point to a different file description now), so its |
364 | (because the fd could point to a different file description now), so its |
247 | best to avoid that. Also, dup()ed file descriptors might not work very |
365 | best to avoid that. Also, C<dup ()>'ed file descriptors might not work |
248 | well if you register events for both fds. |
366 | very well if you register events for both fds. |
249 | |
367 | |
250 | Please note that epoll sometimes generates spurious notifications, so you |
368 | Please note that epoll sometimes generates spurious notifications, so you |
251 | need to use non-blocking I/O or other means to avoid blocking when no data |
369 | need to use non-blocking I/O or other means to avoid blocking when no data |
252 | (or space) is available. |
370 | (or space) is available. |
253 | |
371 | |
|
|
372 | Best performance from this backend is achieved by not unregistering all |
|
|
373 | watchers for a file descriptor until it has been closed, if possible, i.e. |
|
|
374 | keep at least one watcher active per fd at all times. |
|
|
375 | |
|
|
376 | While nominally embeddeble in other event loops, this feature is broken in |
|
|
377 | all kernel versions tested so far. |
|
|
378 | |
254 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
379 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
255 | |
380 | |
256 | Kqueue deserves special mention, as at the time of this writing, it |
381 | Kqueue deserves special mention, as at the time of this writing, it |
257 | was broken on all BSDs except NetBSD (usually it doesn't work with |
382 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
258 | anything but sockets and pipes, except on Darwin, where of course its |
383 | with anything but sockets and pipes, except on Darwin, where of course |
259 | completely useless). For this reason its not being "autodetected" |
384 | it's completely useless). For this reason it's not being "autodetected" |
260 | unless you explicitly specify it explicitly in the flags (i.e. using |
385 | unless you explicitly specify it explicitly in the flags (i.e. using |
261 | C<EVBACKEND_KQUEUE>). |
386 | C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) |
|
|
387 | system like NetBSD. |
|
|
388 | |
|
|
389 | You still can embed kqueue into a normal poll or select backend and use it |
|
|
390 | only for sockets (after having made sure that sockets work with kqueue on |
|
|
391 | the target platform). See C<ev_embed> watchers for more info. |
262 | |
392 | |
263 | It scales in the same way as the epoll backend, but the interface to the |
393 | It scales in the same way as the epoll backend, but the interface to the |
264 | kernel is more efficient (which says nothing about its actual speed, of |
394 | kernel is more efficient (which says nothing about its actual speed, of |
265 | course). While starting and stopping an I/O watcher does not cause an |
395 | course). While stopping, setting and starting an I/O watcher does never |
266 | extra syscall as with epoll, it still adds up to four event changes per |
396 | cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to |
267 | incident, so its best to avoid that. |
397 | two event changes per incident, support for C<fork ()> is very bad and it |
|
|
398 | drops fds silently in similarly hard-to-detect cases. |
|
|
399 | |
|
|
400 | This backend usually performs well under most conditions. |
|
|
401 | |
|
|
402 | While nominally embeddable in other event loops, this doesn't work |
|
|
403 | everywhere, so you might need to test for this. And since it is broken |
|
|
404 | almost everywhere, you should only use it when you have a lot of sockets |
|
|
405 | (for which it usually works), by embedding it into another event loop |
|
|
406 | (e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for |
|
|
407 | sockets. |
268 | |
408 | |
269 | =item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) |
409 | =item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) |
270 | |
410 | |
271 | This is not implemented yet (and might never be). |
411 | This is not implemented yet (and might never be, unless you send me an |
|
|
412 | implementation). According to reports, C</dev/poll> only supports sockets |
|
|
413 | and is not embeddable, which would limit the usefulness of this backend |
|
|
414 | immensely. |
272 | |
415 | |
273 | =item C<EVBACKEND_PORT> (value 32, Solaris 10) |
416 | =item C<EVBACKEND_PORT> (value 32, Solaris 10) |
274 | |
417 | |
275 | This uses the Solaris 10 port mechanism. As with everything on Solaris, |
418 | This uses the Solaris 10 event port mechanism. As with everything on Solaris, |
276 | it's really slow, but it still scales very well (O(active_fds)). |
419 | it's really slow, but it still scales very well (O(active_fds)). |
277 | |
420 | |
278 | Please note that solaris ports can result in a lot of spurious |
421 | Please note that solaris event ports can deliver a lot of spurious |
279 | notifications, so you need to use non-blocking I/O or other means to avoid |
422 | notifications, so you need to use non-blocking I/O or other means to avoid |
280 | blocking when no data (or space) is available. |
423 | blocking when no data (or space) is available. |
|
|
424 | |
|
|
425 | While this backend scales well, it requires one system call per active |
|
|
426 | file descriptor per loop iteration. For small and medium numbers of file |
|
|
427 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
|
|
428 | might perform better. |
|
|
429 | |
|
|
430 | On the positive side, ignoring the spurious readyness notifications, this |
|
|
431 | backend actually performed to specification in all tests and is fully |
|
|
432 | embeddable, which is a rare feat among the OS-specific backends. |
281 | |
433 | |
282 | =item C<EVBACKEND_ALL> |
434 | =item C<EVBACKEND_ALL> |
283 | |
435 | |
284 | Try all backends (even potentially broken ones that wouldn't be tried |
436 | Try all backends (even potentially broken ones that wouldn't be tried |
285 | with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as |
437 | with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as |
286 | C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. |
438 | C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. |
287 | |
439 | |
|
|
440 | It is definitely not recommended to use this flag. |
|
|
441 | |
288 | =back |
442 | =back |
289 | |
443 | |
290 | If one or more of these are ored into the flags value, then only these |
444 | If one or more of these are ored into the flags value, then only these |
291 | backends will be tried (in the reverse order as given here). If none are |
445 | backends will be tried (in the reverse order as listed here). If none are |
292 | specified, most compiled-in backend will be tried, usually in reverse |
446 | specified, all backends in C<ev_recommended_backends ()> will be tried. |
293 | order of their flag values :) |
|
|
294 | |
447 | |
295 | The most typical usage is like this: |
448 | The most typical usage is like this: |
296 | |
449 | |
297 | if (!ev_default_loop (0)) |
450 | if (!ev_default_loop (0)) |
298 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
451 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
… | |
… | |
313 | Similar to C<ev_default_loop>, but always creates a new event loop that is |
466 | Similar to C<ev_default_loop>, but always creates a new event loop that is |
314 | always distinct from the default loop. Unlike the default loop, it cannot |
467 | always distinct from the default loop. Unlike the default loop, it cannot |
315 | handle signal and child watchers, and attempts to do so will be greeted by |
468 | handle signal and child watchers, and attempts to do so will be greeted by |
316 | undefined behaviour (or a failed assertion if assertions are enabled). |
469 | undefined behaviour (or a failed assertion if assertions are enabled). |
317 | |
470 | |
318 | Example: try to create a event loop that uses epoll and nothing else. |
471 | Example: Try to create a event loop that uses epoll and nothing else. |
319 | |
472 | |
320 | struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
473 | struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
321 | if (!epoller) |
474 | if (!epoller) |
322 | fatal ("no epoll found here, maybe it hides under your chair"); |
475 | fatal ("no epoll found here, maybe it hides under your chair"); |
323 | |
476 | |
… | |
… | |
326 | Destroys the default loop again (frees all memory and kernel state |
479 | Destroys the default loop again (frees all memory and kernel state |
327 | etc.). None of the active event watchers will be stopped in the normal |
480 | etc.). None of the active event watchers will be stopped in the normal |
328 | sense, so e.g. C<ev_is_active> might still return true. It is your |
481 | sense, so e.g. C<ev_is_active> might still return true. It is your |
329 | responsibility to either stop all watchers cleanly yoursef I<before> |
482 | responsibility to either stop all watchers cleanly yoursef I<before> |
330 | calling this function, or cope with the fact afterwards (which is usually |
483 | calling this function, or cope with the fact afterwards (which is usually |
331 | the easiest thing, youc na just ignore the watchers and/or C<free ()> them |
484 | the easiest thing, you can just ignore the watchers and/or C<free ()> them |
332 | for example). |
485 | for example). |
|
|
486 | |
|
|
487 | Note that certain global state, such as signal state, will not be freed by |
|
|
488 | this function, and related watchers (such as signal and child watchers) |
|
|
489 | would need to be stopped manually. |
|
|
490 | |
|
|
491 | In general it is not advisable to call this function except in the |
|
|
492 | rare occasion where you really need to free e.g. the signal handling |
|
|
493 | pipe fds. If you need dynamically allocated loops it is better to use |
|
|
494 | C<ev_loop_new> and C<ev_loop_destroy>). |
333 | |
495 | |
334 | =item ev_loop_destroy (loop) |
496 | =item ev_loop_destroy (loop) |
335 | |
497 | |
336 | Like C<ev_default_destroy>, but destroys an event loop created by an |
498 | Like C<ev_default_destroy>, but destroys an event loop created by an |
337 | earlier call to C<ev_loop_new>. |
499 | earlier call to C<ev_loop_new>. |
338 | |
500 | |
339 | =item ev_default_fork () |
501 | =item ev_default_fork () |
340 | |
502 | |
|
|
503 | This function sets a flag that causes subsequent C<ev_loop> iterations |
341 | This function reinitialises the kernel state for backends that have |
504 | to reinitialise the kernel state for backends that have one. Despite the |
342 | one. Despite the name, you can call it anytime, but it makes most sense |
505 | name, you can call it anytime, but it makes most sense after forking, in |
343 | after forking, in either the parent or child process (or both, but that |
506 | the child process (or both child and parent, but that again makes little |
344 | again makes little sense). |
507 | sense). You I<must> call it in the child before using any of the libev |
|
|
508 | functions, and it will only take effect at the next C<ev_loop> iteration. |
345 | |
509 | |
346 | You I<must> call this function in the child process after forking if and |
510 | On the other hand, you only need to call this function in the child |
347 | only if you want to use the event library in both processes. If you just |
511 | process if and only if you want to use the event library in the child. If |
348 | fork+exec, you don't have to call it. |
512 | you just fork+exec, you don't have to call it at all. |
349 | |
513 | |
350 | The function itself is quite fast and it's usually not a problem to call |
514 | The function itself is quite fast and it's usually not a problem to call |
351 | it just in case after a fork. To make this easy, the function will fit in |
515 | it just in case after a fork. To make this easy, the function will fit in |
352 | quite nicely into a call to C<pthread_atfork>: |
516 | quite nicely into a call to C<pthread_atfork>: |
353 | |
517 | |
354 | pthread_atfork (0, 0, ev_default_fork); |
518 | pthread_atfork (0, 0, ev_default_fork); |
355 | |
519 | |
356 | At the moment, C<EVBACKEND_SELECT> and C<EVBACKEND_POLL> are safe to use |
|
|
357 | without calling this function, so if you force one of those backends you |
|
|
358 | do not need to care. |
|
|
359 | |
|
|
360 | =item ev_loop_fork (loop) |
520 | =item ev_loop_fork (loop) |
361 | |
521 | |
362 | Like C<ev_default_fork>, but acts on an event loop created by |
522 | Like C<ev_default_fork>, but acts on an event loop created by |
363 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
523 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
364 | after fork, and how you do this is entirely your own problem. |
524 | after fork, and how you do this is entirely your own problem. |
|
|
525 | |
|
|
526 | =item int ev_is_default_loop (loop) |
|
|
527 | |
|
|
528 | Returns true when the given loop actually is the default loop, false otherwise. |
|
|
529 | |
|
|
530 | =item unsigned int ev_loop_count (loop) |
|
|
531 | |
|
|
532 | Returns the count of loop iterations for the loop, which is identical to |
|
|
533 | the number of times libev did poll for new events. It starts at C<0> and |
|
|
534 | happily wraps around with enough iterations. |
|
|
535 | |
|
|
536 | This value can sometimes be useful as a generation counter of sorts (it |
|
|
537 | "ticks" the number of loop iterations), as it roughly corresponds with |
|
|
538 | C<ev_prepare> and C<ev_check> calls. |
365 | |
539 | |
366 | =item unsigned int ev_backend (loop) |
540 | =item unsigned int ev_backend (loop) |
367 | |
541 | |
368 | Returns one of the C<EVBACKEND_*> flags indicating the event backend in |
542 | Returns one of the C<EVBACKEND_*> flags indicating the event backend in |
369 | use. |
543 | use. |
… | |
… | |
372 | |
546 | |
373 | Returns the current "event loop time", which is the time the event loop |
547 | Returns the current "event loop time", which is the time the event loop |
374 | received events and started processing them. This timestamp does not |
548 | received events and started processing them. This timestamp does not |
375 | change as long as callbacks are being processed, and this is also the base |
549 | change as long as callbacks are being processed, and this is also the base |
376 | time used for relative timers. You can treat it as the timestamp of the |
550 | time used for relative timers. You can treat it as the timestamp of the |
377 | event occuring (or more correctly, libev finding out about it). |
551 | event occurring (or more correctly, libev finding out about it). |
378 | |
552 | |
379 | =item ev_loop (loop, int flags) |
553 | =item ev_loop (loop, int flags) |
380 | |
554 | |
381 | Finally, this is it, the event handler. This function usually is called |
555 | Finally, this is it, the event handler. This function usually is called |
382 | after you initialised all your watchers and you want to start handling |
556 | after you initialised all your watchers and you want to start handling |
… | |
… | |
403 | libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is |
577 | libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is |
404 | usually a better approach for this kind of thing. |
578 | usually a better approach for this kind of thing. |
405 | |
579 | |
406 | Here are the gory details of what C<ev_loop> does: |
580 | Here are the gory details of what C<ev_loop> does: |
407 | |
581 | |
408 | * If there are no active watchers (reference count is zero), return. |
582 | - Before the first iteration, call any pending watchers. |
409 | - Queue prepare watchers and then call all outstanding watchers. |
583 | * If EVFLAG_FORKCHECK was used, check for a fork. |
|
|
584 | - If a fork was detected, queue and call all fork watchers. |
|
|
585 | - Queue and call all prepare watchers. |
410 | - If we have been forked, recreate the kernel state. |
586 | - If we have been forked, recreate the kernel state. |
411 | - Update the kernel state with all outstanding changes. |
587 | - Update the kernel state with all outstanding changes. |
412 | - Update the "event loop time". |
588 | - Update the "event loop time". |
413 | - Calculate for how long to block. |
589 | - Calculate for how long to sleep or block, if at all |
|
|
590 | (active idle watchers, EVLOOP_NONBLOCK or not having |
|
|
591 | any active watchers at all will result in not sleeping). |
|
|
592 | - Sleep if the I/O and timer collect interval say so. |
414 | - Block the process, waiting for any events. |
593 | - Block the process, waiting for any events. |
415 | - Queue all outstanding I/O (fd) events. |
594 | - Queue all outstanding I/O (fd) events. |
416 | - Update the "event loop time" and do time jump handling. |
595 | - Update the "event loop time" and do time jump handling. |
417 | - Queue all outstanding timers. |
596 | - Queue all outstanding timers. |
418 | - Queue all outstanding periodics. |
597 | - Queue all outstanding periodics. |
419 | - If no events are pending now, queue all idle watchers. |
598 | - If no events are pending now, queue all idle watchers. |
420 | - Queue all check watchers. |
599 | - Queue all check watchers. |
421 | - Call all queued watchers in reverse order (i.e. check watchers first). |
600 | - Call all queued watchers in reverse order (i.e. check watchers first). |
422 | Signals and child watchers are implemented as I/O watchers, and will |
601 | Signals and child watchers are implemented as I/O watchers, and will |
423 | be handled here by queueing them when their watcher gets executed. |
602 | be handled here by queueing them when their watcher gets executed. |
424 | - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
603 | - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
425 | were used, return, otherwise continue with step *. |
604 | were used, or there are no active watchers, return, otherwise |
|
|
605 | continue with step *. |
426 | |
606 | |
427 | Example: queue some jobs and then loop until no events are outsanding |
607 | Example: Queue some jobs and then loop until no events are outstanding |
428 | anymore. |
608 | anymore. |
429 | |
609 | |
430 | ... queue jobs here, make sure they register event watchers as long |
610 | ... queue jobs here, make sure they register event watchers as long |
431 | ... as they still have work to do (even an idle watcher will do..) |
611 | ... as they still have work to do (even an idle watcher will do..) |
432 | ev_loop (my_loop, 0); |
612 | ev_loop (my_loop, 0); |
… | |
… | |
436 | |
616 | |
437 | Can be used to make a call to C<ev_loop> return early (but only after it |
617 | Can be used to make a call to C<ev_loop> return early (but only after it |
438 | has processed all outstanding events). The C<how> argument must be either |
618 | has processed all outstanding events). The C<how> argument must be either |
439 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
619 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
440 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
620 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
|
|
621 | |
|
|
622 | This "unloop state" will be cleared when entering C<ev_loop> again. |
441 | |
623 | |
442 | =item ev_ref (loop) |
624 | =item ev_ref (loop) |
443 | |
625 | |
444 | =item ev_unref (loop) |
626 | =item ev_unref (loop) |
445 | |
627 | |
… | |
… | |
450 | returning, ev_unref() after starting, and ev_ref() before stopping it. For |
632 | returning, ev_unref() after starting, and ev_ref() before stopping it. For |
451 | example, libev itself uses this for its internal signal pipe: It is not |
633 | example, libev itself uses this for its internal signal pipe: It is not |
452 | visible to the libev user and should not keep C<ev_loop> from exiting if |
634 | visible to the libev user and should not keep C<ev_loop> from exiting if |
453 | no event watchers registered by it are active. It is also an excellent |
635 | no event watchers registered by it are active. It is also an excellent |
454 | way to do this for generic recurring timers or from within third-party |
636 | way to do this for generic recurring timers or from within third-party |
455 | libraries. Just remember to I<unref after start> and I<ref before stop>. |
637 | libraries. Just remember to I<unref after start> and I<ref before stop> |
|
|
638 | (but only if the watcher wasn't active before, or was active before, |
|
|
639 | respectively). |
456 | |
640 | |
457 | Example: create a signal watcher, but keep it from keeping C<ev_loop> |
641 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
458 | running when nothing else is active. |
642 | running when nothing else is active. |
459 | |
643 | |
460 | struct dv_signal exitsig; |
644 | struct ev_signal exitsig; |
461 | ev_signal_init (&exitsig, sig_cb, SIGINT); |
645 | ev_signal_init (&exitsig, sig_cb, SIGINT); |
462 | ev_signal_start (myloop, &exitsig); |
646 | ev_signal_start (loop, &exitsig); |
463 | evf_unref (myloop); |
647 | evf_unref (loop); |
464 | |
648 | |
465 | Example: for some weird reason, unregister the above signal handler again. |
649 | Example: For some weird reason, unregister the above signal handler again. |
466 | |
650 | |
467 | ev_ref (myloop); |
651 | ev_ref (loop); |
468 | ev_signal_stop (myloop, &exitsig); |
652 | ev_signal_stop (loop, &exitsig); |
|
|
653 | |
|
|
654 | =item ev_set_io_collect_interval (loop, ev_tstamp interval) |
|
|
655 | |
|
|
656 | =item ev_set_timeout_collect_interval (loop, ev_tstamp interval) |
|
|
657 | |
|
|
658 | These advanced functions influence the time that libev will spend waiting |
|
|
659 | for events. Both are by default C<0>, meaning that libev will try to |
|
|
660 | invoke timer/periodic callbacks and I/O callbacks with minimum latency. |
|
|
661 | |
|
|
662 | Setting these to a higher value (the C<interval> I<must> be >= C<0>) |
|
|
663 | allows libev to delay invocation of I/O and timer/periodic callbacks to |
|
|
664 | increase efficiency of loop iterations. |
|
|
665 | |
|
|
666 | The background is that sometimes your program runs just fast enough to |
|
|
667 | handle one (or very few) event(s) per loop iteration. While this makes |
|
|
668 | the program responsive, it also wastes a lot of CPU time to poll for new |
|
|
669 | events, especially with backends like C<select ()> which have a high |
|
|
670 | overhead for the actual polling but can deliver many events at once. |
|
|
671 | |
|
|
672 | By setting a higher I<io collect interval> you allow libev to spend more |
|
|
673 | time collecting I/O events, so you can handle more events per iteration, |
|
|
674 | at the cost of increasing latency. Timeouts (both C<ev_periodic> and |
|
|
675 | C<ev_timer>) will be not affected. Setting this to a non-null value will |
|
|
676 | introduce an additional C<ev_sleep ()> call into most loop iterations. |
|
|
677 | |
|
|
678 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
|
|
679 | to spend more time collecting timeouts, at the expense of increased |
|
|
680 | latency (the watcher callback will be called later). C<ev_io> watchers |
|
|
681 | will not be affected. Setting this to a non-null value will not introduce |
|
|
682 | any overhead in libev. |
|
|
683 | |
|
|
684 | Many (busy) programs can usually benefit by setting the io collect |
|
|
685 | interval to a value near C<0.1> or so, which is often enough for |
|
|
686 | interactive servers (of course not for games), likewise for timeouts. It |
|
|
687 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
|
|
688 | as this approsaches the timing granularity of most systems. |
469 | |
689 | |
470 | =back |
690 | =back |
471 | |
691 | |
472 | |
692 | |
473 | =head1 ANATOMY OF A WATCHER |
693 | =head1 ANATOMY OF A WATCHER |
… | |
… | |
573 | =item C<EV_FORK> |
793 | =item C<EV_FORK> |
574 | |
794 | |
575 | The event loop has been resumed in the child process after fork (see |
795 | The event loop has been resumed in the child process after fork (see |
576 | C<ev_fork>). |
796 | C<ev_fork>). |
577 | |
797 | |
|
|
798 | =item C<EV_ASYNC> |
|
|
799 | |
|
|
800 | The given async watcher has been asynchronously notified (see C<ev_async>). |
|
|
801 | |
578 | =item C<EV_ERROR> |
802 | =item C<EV_ERROR> |
579 | |
803 | |
580 | An unspecified error has occured, the watcher has been stopped. This might |
804 | An unspecified error has occured, the watcher has been stopped. This might |
581 | happen because the watcher could not be properly started because libev |
805 | happen because the watcher could not be properly started because libev |
582 | ran out of memory, a file descriptor was found to be closed or any other |
806 | ran out of memory, a file descriptor was found to be closed or any other |
… | |
… | |
653 | =item bool ev_is_pending (ev_TYPE *watcher) |
877 | =item bool ev_is_pending (ev_TYPE *watcher) |
654 | |
878 | |
655 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
879 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
656 | events but its callback has not yet been invoked). As long as a watcher |
880 | events but its callback has not yet been invoked). As long as a watcher |
657 | is pending (but not active) you must not call an init function on it (but |
881 | is pending (but not active) you must not call an init function on it (but |
658 | C<ev_TYPE_set> is safe) and you must make sure the watcher is available to |
882 | C<ev_TYPE_set> is safe), you must not change its priority, and you must |
659 | libev (e.g. you cnanot C<free ()> it). |
883 | make sure the watcher is available to libev (e.g. you cannot C<free ()> |
|
|
884 | it). |
660 | |
885 | |
661 | =item callback = ev_cb (ev_TYPE *watcher) |
886 | =item callback ev_cb (ev_TYPE *watcher) |
662 | |
887 | |
663 | Returns the callback currently set on the watcher. |
888 | Returns the callback currently set on the watcher. |
664 | |
889 | |
665 | =item ev_cb_set (ev_TYPE *watcher, callback) |
890 | =item ev_cb_set (ev_TYPE *watcher, callback) |
666 | |
891 | |
667 | Change the callback. You can change the callback at virtually any time |
892 | Change the callback. You can change the callback at virtually any time |
668 | (modulo threads). |
893 | (modulo threads). |
|
|
894 | |
|
|
895 | =item ev_set_priority (ev_TYPE *watcher, priority) |
|
|
896 | |
|
|
897 | =item int ev_priority (ev_TYPE *watcher) |
|
|
898 | |
|
|
899 | Set and query the priority of the watcher. The priority is a small |
|
|
900 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
|
|
901 | (default: C<-2>). Pending watchers with higher priority will be invoked |
|
|
902 | before watchers with lower priority, but priority will not keep watchers |
|
|
903 | from being executed (except for C<ev_idle> watchers). |
|
|
904 | |
|
|
905 | This means that priorities are I<only> used for ordering callback |
|
|
906 | invocation after new events have been received. This is useful, for |
|
|
907 | example, to reduce latency after idling, or more often, to bind two |
|
|
908 | watchers on the same event and make sure one is called first. |
|
|
909 | |
|
|
910 | If you need to suppress invocation when higher priority events are pending |
|
|
911 | you need to look at C<ev_idle> watchers, which provide this functionality. |
|
|
912 | |
|
|
913 | You I<must not> change the priority of a watcher as long as it is active or |
|
|
914 | pending. |
|
|
915 | |
|
|
916 | The default priority used by watchers when no priority has been set is |
|
|
917 | always C<0>, which is supposed to not be too high and not be too low :). |
|
|
918 | |
|
|
919 | Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is |
|
|
920 | fine, as long as you do not mind that the priority value you query might |
|
|
921 | or might not have been adjusted to be within valid range. |
|
|
922 | |
|
|
923 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
|
|
924 | |
|
|
925 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
|
|
926 | C<loop> nor C<revents> need to be valid as long as the watcher callback |
|
|
927 | can deal with that fact. |
|
|
928 | |
|
|
929 | =item int ev_clear_pending (loop, ev_TYPE *watcher) |
|
|
930 | |
|
|
931 | If the watcher is pending, this function returns clears its pending status |
|
|
932 | and returns its C<revents> bitset (as if its callback was invoked). If the |
|
|
933 | watcher isn't pending it does nothing and returns C<0>. |
669 | |
934 | |
670 | =back |
935 | =back |
671 | |
936 | |
672 | |
937 | |
673 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
938 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
… | |
… | |
694 | { |
959 | { |
695 | struct my_io *w = (struct my_io *)w_; |
960 | struct my_io *w = (struct my_io *)w_; |
696 | ... |
961 | ... |
697 | } |
962 | } |
698 | |
963 | |
699 | More interesting and less C-conformant ways of catsing your callback type |
964 | More interesting and less C-conformant ways of casting your callback type |
700 | have been omitted.... |
965 | instead have been omitted. |
|
|
966 | |
|
|
967 | Another common scenario is having some data structure with multiple |
|
|
968 | watchers: |
|
|
969 | |
|
|
970 | struct my_biggy |
|
|
971 | { |
|
|
972 | int some_data; |
|
|
973 | ev_timer t1; |
|
|
974 | ev_timer t2; |
|
|
975 | } |
|
|
976 | |
|
|
977 | In this case getting the pointer to C<my_biggy> is a bit more complicated, |
|
|
978 | you need to use C<offsetof>: |
|
|
979 | |
|
|
980 | #include <stddef.h> |
|
|
981 | |
|
|
982 | static void |
|
|
983 | t1_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
984 | { |
|
|
985 | struct my_biggy big = (struct my_biggy * |
|
|
986 | (((char *)w) - offsetof (struct my_biggy, t1)); |
|
|
987 | } |
|
|
988 | |
|
|
989 | static void |
|
|
990 | t2_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
991 | { |
|
|
992 | struct my_biggy big = (struct my_biggy * |
|
|
993 | (((char *)w) - offsetof (struct my_biggy, t2)); |
|
|
994 | } |
701 | |
995 | |
702 | |
996 | |
703 | =head1 WATCHER TYPES |
997 | =head1 WATCHER TYPES |
704 | |
998 | |
705 | This section describes each watcher in detail, but will not repeat |
999 | This section describes each watcher in detail, but will not repeat |
… | |
… | |
729 | In general you can register as many read and/or write event watchers per |
1023 | In general you can register as many read and/or write event watchers per |
730 | fd as you want (as long as you don't confuse yourself). Setting all file |
1024 | fd as you want (as long as you don't confuse yourself). Setting all file |
731 | descriptors to non-blocking mode is also usually a good idea (but not |
1025 | descriptors to non-blocking mode is also usually a good idea (but not |
732 | required if you know what you are doing). |
1026 | required if you know what you are doing). |
733 | |
1027 | |
734 | You have to be careful with dup'ed file descriptors, though. Some backends |
|
|
735 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
|
|
736 | descriptors correctly if you register interest in two or more fds pointing |
|
|
737 | to the same underlying file/socket/etc. description (that is, they share |
|
|
738 | the same underlying "file open"). |
|
|
739 | |
|
|
740 | If you must do this, then force the use of a known-to-be-good backend |
1028 | If you must do this, then force the use of a known-to-be-good backend |
741 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
1029 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
742 | C<EVBACKEND_POLL>). |
1030 | C<EVBACKEND_POLL>). |
743 | |
1031 | |
744 | Another thing you have to watch out for is that it is quite easy to |
1032 | Another thing you have to watch out for is that it is quite easy to |
… | |
… | |
750 | it is best to always use non-blocking I/O: An extra C<read>(2) returning |
1038 | it is best to always use non-blocking I/O: An extra C<read>(2) returning |
751 | C<EAGAIN> is far preferable to a program hanging until some data arrives. |
1039 | C<EAGAIN> is far preferable to a program hanging until some data arrives. |
752 | |
1040 | |
753 | If you cannot run the fd in non-blocking mode (for example you should not |
1041 | If you cannot run the fd in non-blocking mode (for example you should not |
754 | play around with an Xlib connection), then you have to seperately re-test |
1042 | play around with an Xlib connection), then you have to seperately re-test |
755 | wether a file descriptor is really ready with a known-to-be good interface |
1043 | whether a file descriptor is really ready with a known-to-be good interface |
756 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1044 | such as poll (fortunately in our Xlib example, Xlib already does this on |
757 | its own, so its quite safe to use). |
1045 | its own, so its quite safe to use). |
|
|
1046 | |
|
|
1047 | =head3 The special problem of disappearing file descriptors |
|
|
1048 | |
|
|
1049 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
|
|
1050 | descriptor (either by calling C<close> explicitly or by any other means, |
|
|
1051 | such as C<dup>). The reason is that you register interest in some file |
|
|
1052 | descriptor, but when it goes away, the operating system will silently drop |
|
|
1053 | this interest. If another file descriptor with the same number then is |
|
|
1054 | registered with libev, there is no efficient way to see that this is, in |
|
|
1055 | fact, a different file descriptor. |
|
|
1056 | |
|
|
1057 | To avoid having to explicitly tell libev about such cases, libev follows |
|
|
1058 | the following policy: Each time C<ev_io_set> is being called, libev |
|
|
1059 | will assume that this is potentially a new file descriptor, otherwise |
|
|
1060 | it is assumed that the file descriptor stays the same. That means that |
|
|
1061 | you I<have> to call C<ev_io_set> (or C<ev_io_init>) when you change the |
|
|
1062 | descriptor even if the file descriptor number itself did not change. |
|
|
1063 | |
|
|
1064 | This is how one would do it normally anyway, the important point is that |
|
|
1065 | the libev application should not optimise around libev but should leave |
|
|
1066 | optimisations to libev. |
|
|
1067 | |
|
|
1068 | =head3 The special problem of dup'ed file descriptors |
|
|
1069 | |
|
|
1070 | Some backends (e.g. epoll), cannot register events for file descriptors, |
|
|
1071 | but only events for the underlying file descriptions. That means when you |
|
|
1072 | have C<dup ()>'ed file descriptors or weirder constellations, and register |
|
|
1073 | events for them, only one file descriptor might actually receive events. |
|
|
1074 | |
|
|
1075 | There is no workaround possible except not registering events |
|
|
1076 | for potentially C<dup ()>'ed file descriptors, or to resort to |
|
|
1077 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
|
|
1078 | |
|
|
1079 | =head3 The special problem of fork |
|
|
1080 | |
|
|
1081 | Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit |
|
|
1082 | useless behaviour. Libev fully supports fork, but needs to be told about |
|
|
1083 | it in the child. |
|
|
1084 | |
|
|
1085 | To support fork in your programs, you either have to call |
|
|
1086 | C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child, |
|
|
1087 | enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or |
|
|
1088 | C<EVBACKEND_POLL>. |
|
|
1089 | |
|
|
1090 | |
|
|
1091 | =head3 Watcher-Specific Functions |
758 | |
1092 | |
759 | =over 4 |
1093 | =over 4 |
760 | |
1094 | |
761 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1095 | =item ev_io_init (ev_io *, callback, int fd, int events) |
762 | |
1096 | |
… | |
… | |
774 | |
1108 | |
775 | The events being watched. |
1109 | The events being watched. |
776 | |
1110 | |
777 | =back |
1111 | =back |
778 | |
1112 | |
|
|
1113 | =head3 Examples |
|
|
1114 | |
779 | Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well |
1115 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
780 | readable, but only once. Since it is likely line-buffered, you could |
1116 | readable, but only once. Since it is likely line-buffered, you could |
781 | attempt to read a whole line in the callback: |
1117 | attempt to read a whole line in the callback. |
782 | |
1118 | |
783 | static void |
1119 | static void |
784 | stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1120 | stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
785 | { |
1121 | { |
786 | ev_io_stop (loop, w); |
1122 | ev_io_stop (loop, w); |
… | |
… | |
816 | |
1152 | |
817 | The callback is guarenteed to be invoked only when its timeout has passed, |
1153 | The callback is guarenteed to be invoked only when its timeout has passed, |
818 | but if multiple timers become ready during the same loop iteration then |
1154 | but if multiple timers become ready during the same loop iteration then |
819 | order of execution is undefined. |
1155 | order of execution is undefined. |
820 | |
1156 | |
|
|
1157 | =head3 Watcher-Specific Functions and Data Members |
|
|
1158 | |
821 | =over 4 |
1159 | =over 4 |
822 | |
1160 | |
823 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
1161 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
824 | |
1162 | |
825 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
1163 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
… | |
… | |
833 | configure a timer to trigger every 10 seconds, then it will trigger at |
1171 | configure a timer to trigger every 10 seconds, then it will trigger at |
834 | exactly 10 second intervals. If, however, your program cannot keep up with |
1172 | exactly 10 second intervals. If, however, your program cannot keep up with |
835 | the timer (because it takes longer than those 10 seconds to do stuff) the |
1173 | the timer (because it takes longer than those 10 seconds to do stuff) the |
836 | timer will not fire more than once per event loop iteration. |
1174 | timer will not fire more than once per event loop iteration. |
837 | |
1175 | |
838 | =item ev_timer_again (loop) |
1176 | =item ev_timer_again (loop, ev_timer *) |
839 | |
1177 | |
840 | This will act as if the timer timed out and restart it again if it is |
1178 | This will act as if the timer timed out and restart it again if it is |
841 | repeating. The exact semantics are: |
1179 | repeating. The exact semantics are: |
842 | |
1180 | |
|
|
1181 | If the timer is pending, its pending status is cleared. |
|
|
1182 | |
843 | If the timer is started but nonrepeating, stop it. |
1183 | If the timer is started but nonrepeating, stop it (as if it timed out). |
844 | |
1184 | |
845 | If the timer is repeating, either start it if necessary (with the repeat |
1185 | If the timer is repeating, either start it if necessary (with the |
846 | value), or reset the running timer to the repeat value. |
1186 | C<repeat> value), or reset the running timer to the C<repeat> value. |
847 | |
1187 | |
848 | This sounds a bit complicated, but here is a useful and typical |
1188 | This sounds a bit complicated, but here is a useful and typical |
849 | example: Imagine you have a tcp connection and you want a so-called |
1189 | example: Imagine you have a tcp connection and you want a so-called idle |
850 | idle timeout, that is, you want to be called when there have been, |
1190 | timeout, that is, you want to be called when there have been, say, 60 |
851 | say, 60 seconds of inactivity on the socket. The easiest way to do |
1191 | seconds of inactivity on the socket. The easiest way to do this is to |
852 | this is to configure an C<ev_timer> with C<after>=C<repeat>=C<60> and calling |
1192 | configure an C<ev_timer> with a C<repeat> value of C<60> and then call |
853 | C<ev_timer_again> each time you successfully read or write some data. If |
1193 | C<ev_timer_again> each time you successfully read or write some data. If |
854 | you go into an idle state where you do not expect data to travel on the |
1194 | you go into an idle state where you do not expect data to travel on the |
855 | socket, you can stop the timer, and again will automatically restart it if |
1195 | socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will |
856 | need be. |
1196 | automatically restart it if need be. |
857 | |
1197 | |
858 | You can also ignore the C<after> value and C<ev_timer_start> altogether |
1198 | That means you can ignore the C<after> value and C<ev_timer_start> |
859 | and only ever use the C<repeat> value: |
1199 | altogether and only ever use the C<repeat> value and C<ev_timer_again>: |
860 | |
1200 | |
861 | ev_timer_init (timer, callback, 0., 5.); |
1201 | ev_timer_init (timer, callback, 0., 5.); |
862 | ev_timer_again (loop, timer); |
1202 | ev_timer_again (loop, timer); |
863 | ... |
1203 | ... |
864 | timer->again = 17.; |
1204 | timer->again = 17.; |
865 | ev_timer_again (loop, timer); |
1205 | ev_timer_again (loop, timer); |
866 | ... |
1206 | ... |
867 | timer->again = 10.; |
1207 | timer->again = 10.; |
868 | ev_timer_again (loop, timer); |
1208 | ev_timer_again (loop, timer); |
869 | |
1209 | |
870 | This is more efficient then stopping/starting the timer eahc time you want |
1210 | This is more slightly efficient then stopping/starting the timer each time |
871 | to modify its timeout value. |
1211 | you want to modify its timeout value. |
872 | |
1212 | |
873 | =item ev_tstamp repeat [read-write] |
1213 | =item ev_tstamp repeat [read-write] |
874 | |
1214 | |
875 | The current C<repeat> value. Will be used each time the watcher times out |
1215 | The current C<repeat> value. Will be used each time the watcher times out |
876 | or C<ev_timer_again> is called and determines the next timeout (if any), |
1216 | or C<ev_timer_again> is called and determines the next timeout (if any), |
877 | which is also when any modifications are taken into account. |
1217 | which is also when any modifications are taken into account. |
878 | |
1218 | |
879 | =back |
1219 | =back |
880 | |
1220 | |
|
|
1221 | =head3 Examples |
|
|
1222 | |
881 | Example: create a timer that fires after 60 seconds. |
1223 | Example: Create a timer that fires after 60 seconds. |
882 | |
1224 | |
883 | static void |
1225 | static void |
884 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1226 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
885 | { |
1227 | { |
886 | .. one minute over, w is actually stopped right here |
1228 | .. one minute over, w is actually stopped right here |
… | |
… | |
888 | |
1230 | |
889 | struct ev_timer mytimer; |
1231 | struct ev_timer mytimer; |
890 | ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1232 | ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
891 | ev_timer_start (loop, &mytimer); |
1233 | ev_timer_start (loop, &mytimer); |
892 | |
1234 | |
893 | Example: create a timeout timer that times out after 10 seconds of |
1235 | Example: Create a timeout timer that times out after 10 seconds of |
894 | inactivity. |
1236 | inactivity. |
895 | |
1237 | |
896 | static void |
1238 | static void |
897 | timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1239 | timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
898 | { |
1240 | { |
… | |
… | |
918 | but on wallclock time (absolute time). You can tell a periodic watcher |
1260 | but on wallclock time (absolute time). You can tell a periodic watcher |
919 | to trigger "at" some specific point in time. For example, if you tell a |
1261 | to trigger "at" some specific point in time. For example, if you tell a |
920 | periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now () |
1262 | periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now () |
921 | + 10.>) and then reset your system clock to the last year, then it will |
1263 | + 10.>) and then reset your system clock to the last year, then it will |
922 | take a year to trigger the event (unlike an C<ev_timer>, which would trigger |
1264 | take a year to trigger the event (unlike an C<ev_timer>, which would trigger |
923 | roughly 10 seconds later and of course not if you reset your system time |
1265 | roughly 10 seconds later). |
924 | again). |
|
|
925 | |
1266 | |
926 | They can also be used to implement vastly more complex timers, such as |
1267 | They can also be used to implement vastly more complex timers, such as |
927 | triggering an event on eahc midnight, local time. |
1268 | triggering an event on each midnight, local time or other, complicated, |
|
|
1269 | rules. |
928 | |
1270 | |
929 | As with timers, the callback is guarenteed to be invoked only when the |
1271 | As with timers, the callback is guarenteed to be invoked only when the |
930 | time (C<at>) has been passed, but if multiple periodic timers become ready |
1272 | time (C<at>) has been passed, but if multiple periodic timers become ready |
931 | during the same loop iteration then order of execution is undefined. |
1273 | during the same loop iteration then order of execution is undefined. |
932 | |
1274 | |
|
|
1275 | =head3 Watcher-Specific Functions and Data Members |
|
|
1276 | |
933 | =over 4 |
1277 | =over 4 |
934 | |
1278 | |
935 | =item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) |
1279 | =item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) |
936 | |
1280 | |
937 | =item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) |
1281 | =item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) |
… | |
… | |
939 | Lots of arguments, lets sort it out... There are basically three modes of |
1283 | Lots of arguments, lets sort it out... There are basically three modes of |
940 | operation, and we will explain them from simplest to complex: |
1284 | operation, and we will explain them from simplest to complex: |
941 | |
1285 | |
942 | =over 4 |
1286 | =over 4 |
943 | |
1287 | |
944 | =item * absolute timer (interval = reschedule_cb = 0) |
1288 | =item * absolute timer (at = time, interval = reschedule_cb = 0) |
945 | |
1289 | |
946 | In this configuration the watcher triggers an event at the wallclock time |
1290 | In this configuration the watcher triggers an event at the wallclock time |
947 | C<at> and doesn't repeat. It will not adjust when a time jump occurs, |
1291 | C<at> and doesn't repeat. It will not adjust when a time jump occurs, |
948 | that is, if it is to be run at January 1st 2011 then it will run when the |
1292 | that is, if it is to be run at January 1st 2011 then it will run when the |
949 | system time reaches or surpasses this time. |
1293 | system time reaches or surpasses this time. |
950 | |
1294 | |
951 | =item * non-repeating interval timer (interval > 0, reschedule_cb = 0) |
1295 | =item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
952 | |
1296 | |
953 | In this mode the watcher will always be scheduled to time out at the next |
1297 | In this mode the watcher will always be scheduled to time out at the next |
954 | C<at + N * interval> time (for some integer N) and then repeat, regardless |
1298 | C<at + N * interval> time (for some integer N, which can also be negative) |
955 | of any time jumps. |
1299 | and then repeat, regardless of any time jumps. |
956 | |
1300 | |
957 | This can be used to create timers that do not drift with respect to system |
1301 | This can be used to create timers that do not drift with respect to system |
958 | time: |
1302 | time: |
959 | |
1303 | |
960 | ev_periodic_set (&periodic, 0., 3600., 0); |
1304 | ev_periodic_set (&periodic, 0., 3600., 0); |
… | |
… | |
966 | |
1310 | |
967 | Another way to think about it (for the mathematically inclined) is that |
1311 | Another way to think about it (for the mathematically inclined) is that |
968 | C<ev_periodic> will try to run the callback in this mode at the next possible |
1312 | C<ev_periodic> will try to run the callback in this mode at the next possible |
969 | time where C<time = at (mod interval)>, regardless of any time jumps. |
1313 | time where C<time = at (mod interval)>, regardless of any time jumps. |
970 | |
1314 | |
|
|
1315 | For numerical stability it is preferable that the C<at> value is near |
|
|
1316 | C<ev_now ()> (the current time), but there is no range requirement for |
|
|
1317 | this value. |
|
|
1318 | |
971 | =item * manual reschedule mode (reschedule_cb = callback) |
1319 | =item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) |
972 | |
1320 | |
973 | In this mode the values for C<interval> and C<at> are both being |
1321 | In this mode the values for C<interval> and C<at> are both being |
974 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1322 | ignored. Instead, each time the periodic watcher gets scheduled, the |
975 | reschedule callback will be called with the watcher as first, and the |
1323 | reschedule callback will be called with the watcher as first, and the |
976 | current time as second argument. |
1324 | current time as second argument. |
977 | |
1325 | |
978 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, |
1326 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, |
979 | ever, or make any event loop modifications>. If you need to stop it, |
1327 | ever, or make any event loop modifications>. If you need to stop it, |
980 | return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by |
1328 | return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by |
981 | starting a prepare watcher). |
1329 | starting an C<ev_prepare> watcher, which is legal). |
982 | |
1330 | |
983 | Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1331 | Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
984 | ev_tstamp now)>, e.g.: |
1332 | ev_tstamp now)>, e.g.: |
985 | |
1333 | |
986 | static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
1334 | static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
… | |
… | |
1009 | Simply stops and restarts the periodic watcher again. This is only useful |
1357 | Simply stops and restarts the periodic watcher again. This is only useful |
1010 | when you changed some parameters or the reschedule callback would return |
1358 | when you changed some parameters or the reschedule callback would return |
1011 | a different time than the last time it was called (e.g. in a crond like |
1359 | a different time than the last time it was called (e.g. in a crond like |
1012 | program when the crontabs have changed). |
1360 | program when the crontabs have changed). |
1013 | |
1361 | |
|
|
1362 | =item ev_tstamp offset [read-write] |
|
|
1363 | |
|
|
1364 | When repeating, this contains the offset value, otherwise this is the |
|
|
1365 | absolute point in time (the C<at> value passed to C<ev_periodic_set>). |
|
|
1366 | |
|
|
1367 | Can be modified any time, but changes only take effect when the periodic |
|
|
1368 | timer fires or C<ev_periodic_again> is being called. |
|
|
1369 | |
1014 | =item ev_tstamp interval [read-write] |
1370 | =item ev_tstamp interval [read-write] |
1015 | |
1371 | |
1016 | The current interval value. Can be modified any time, but changes only |
1372 | The current interval value. Can be modified any time, but changes only |
1017 | take effect when the periodic timer fires or C<ev_periodic_again> is being |
1373 | take effect when the periodic timer fires or C<ev_periodic_again> is being |
1018 | called. |
1374 | called. |
… | |
… | |
1021 | |
1377 | |
1022 | The current reschedule callback, or C<0>, if this functionality is |
1378 | The current reschedule callback, or C<0>, if this functionality is |
1023 | switched off. Can be changed any time, but changes only take effect when |
1379 | switched off. Can be changed any time, but changes only take effect when |
1024 | the periodic timer fires or C<ev_periodic_again> is being called. |
1380 | the periodic timer fires or C<ev_periodic_again> is being called. |
1025 | |
1381 | |
|
|
1382 | =item ev_tstamp at [read-only] |
|
|
1383 | |
|
|
1384 | When active, contains the absolute time that the watcher is supposed to |
|
|
1385 | trigger next. |
|
|
1386 | |
1026 | =back |
1387 | =back |
1027 | |
1388 | |
|
|
1389 | =head3 Examples |
|
|
1390 | |
1028 | Example: call a callback every hour, or, more precisely, whenever the |
1391 | Example: Call a callback every hour, or, more precisely, whenever the |
1029 | system clock is divisible by 3600. The callback invocation times have |
1392 | system clock is divisible by 3600. The callback invocation times have |
1030 | potentially a lot of jittering, but good long-term stability. |
1393 | potentially a lot of jittering, but good long-term stability. |
1031 | |
1394 | |
1032 | static void |
1395 | static void |
1033 | clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1396 | clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
… | |
… | |
1037 | |
1400 | |
1038 | struct ev_periodic hourly_tick; |
1401 | struct ev_periodic hourly_tick; |
1039 | ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1402 | ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1040 | ev_periodic_start (loop, &hourly_tick); |
1403 | ev_periodic_start (loop, &hourly_tick); |
1041 | |
1404 | |
1042 | Example: the same as above, but use a reschedule callback to do it: |
1405 | Example: The same as above, but use a reschedule callback to do it: |
1043 | |
1406 | |
1044 | #include <math.h> |
1407 | #include <math.h> |
1045 | |
1408 | |
1046 | static ev_tstamp |
1409 | static ev_tstamp |
1047 | my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) |
1410 | my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) |
… | |
… | |
1049 | return fmod (now, 3600.) + 3600.; |
1412 | return fmod (now, 3600.) + 3600.; |
1050 | } |
1413 | } |
1051 | |
1414 | |
1052 | ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1415 | ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1053 | |
1416 | |
1054 | Example: call a callback every hour, starting now: |
1417 | Example: Call a callback every hour, starting now: |
1055 | |
1418 | |
1056 | struct ev_periodic hourly_tick; |
1419 | struct ev_periodic hourly_tick; |
1057 | ev_periodic_init (&hourly_tick, clock_cb, |
1420 | ev_periodic_init (&hourly_tick, clock_cb, |
1058 | fmod (ev_now (loop), 3600.), 3600., 0); |
1421 | fmod (ev_now (loop), 3600.), 3600., 0); |
1059 | ev_periodic_start (loop, &hourly_tick); |
1422 | ev_periodic_start (loop, &hourly_tick); |
… | |
… | |
1071 | with the kernel (thus it coexists with your own signal handlers as long |
1434 | with the kernel (thus it coexists with your own signal handlers as long |
1072 | as you don't register any with libev). Similarly, when the last signal |
1435 | as you don't register any with libev). Similarly, when the last signal |
1073 | watcher for a signal is stopped libev will reset the signal handler to |
1436 | watcher for a signal is stopped libev will reset the signal handler to |
1074 | SIG_DFL (regardless of what it was set to before). |
1437 | SIG_DFL (regardless of what it was set to before). |
1075 | |
1438 | |
|
|
1439 | If possible and supported, libev will install its handlers with |
|
|
1440 | C<SA_RESTART> behaviour enabled, so syscalls should not be unduly |
|
|
1441 | interrupted. If you have a problem with syscalls getting interrupted by |
|
|
1442 | signals you can block all signals in an C<ev_check> watcher and unblock |
|
|
1443 | them in an C<ev_prepare> watcher. |
|
|
1444 | |
|
|
1445 | =head3 Watcher-Specific Functions and Data Members |
|
|
1446 | |
1076 | =over 4 |
1447 | =over 4 |
1077 | |
1448 | |
1078 | =item ev_signal_init (ev_signal *, callback, int signum) |
1449 | =item ev_signal_init (ev_signal *, callback, int signum) |
1079 | |
1450 | |
1080 | =item ev_signal_set (ev_signal *, int signum) |
1451 | =item ev_signal_set (ev_signal *, int signum) |
… | |
… | |
1086 | |
1457 | |
1087 | The signal the watcher watches out for. |
1458 | The signal the watcher watches out for. |
1088 | |
1459 | |
1089 | =back |
1460 | =back |
1090 | |
1461 | |
|
|
1462 | =head3 Examples |
|
|
1463 | |
|
|
1464 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
|
|
1465 | |
|
|
1466 | static void |
|
|
1467 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
|
|
1468 | { |
|
|
1469 | ev_unloop (loop, EVUNLOOP_ALL); |
|
|
1470 | } |
|
|
1471 | |
|
|
1472 | struct ev_signal signal_watcher; |
|
|
1473 | ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
|
|
1474 | ev_signal_start (loop, &sigint_cb); |
|
|
1475 | |
1091 | |
1476 | |
1092 | =head2 C<ev_child> - watch out for process status changes |
1477 | =head2 C<ev_child> - watch out for process status changes |
1093 | |
1478 | |
1094 | Child watchers trigger when your process receives a SIGCHLD in response to |
1479 | Child watchers trigger when your process receives a SIGCHLD in response to |
1095 | some child status changes (most typically when a child of yours dies). |
1480 | some child status changes (most typically when a child of yours dies). It |
|
|
1481 | is permissible to install a child watcher I<after> the child has been |
|
|
1482 | forked (which implies it might have already exited), as long as the event |
|
|
1483 | loop isn't entered (or is continued from a watcher). |
|
|
1484 | |
|
|
1485 | Only the default event loop is capable of handling signals, and therefore |
|
|
1486 | you can only rgeister child watchers in the default event loop. |
|
|
1487 | |
|
|
1488 | =head3 Process Interaction |
|
|
1489 | |
|
|
1490 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
|
|
1491 | initialised. This is necessary to guarantee proper behaviour even if |
|
|
1492 | the first child watcher is started after the child exits. The occurance |
|
|
1493 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
|
|
1494 | synchronously as part of the event loop processing. Libev always reaps all |
|
|
1495 | children, even ones not watched. |
|
|
1496 | |
|
|
1497 | =head3 Overriding the Built-In Processing |
|
|
1498 | |
|
|
1499 | Libev offers no special support for overriding the built-in child |
|
|
1500 | processing, but if your application collides with libev's default child |
|
|
1501 | handler, you can override it easily by installing your own handler for |
|
|
1502 | C<SIGCHLD> after initialising the default loop, and making sure the |
|
|
1503 | default loop never gets destroyed. You are encouraged, however, to use an |
|
|
1504 | event-based approach to child reaping and thus use libev's support for |
|
|
1505 | that, so other libev users can use C<ev_child> watchers freely. |
|
|
1506 | |
|
|
1507 | =head3 Watcher-Specific Functions and Data Members |
1096 | |
1508 | |
1097 | =over 4 |
1509 | =over 4 |
1098 | |
1510 | |
1099 | =item ev_child_init (ev_child *, callback, int pid) |
1511 | =item ev_child_init (ev_child *, callback, int pid, int trace) |
1100 | |
1512 | |
1101 | =item ev_child_set (ev_child *, int pid) |
1513 | =item ev_child_set (ev_child *, int pid, int trace) |
1102 | |
1514 | |
1103 | Configures the watcher to wait for status changes of process C<pid> (or |
1515 | Configures the watcher to wait for status changes of process C<pid> (or |
1104 | I<any> process if C<pid> is specified as C<0>). The callback can look |
1516 | I<any> process if C<pid> is specified as C<0>). The callback can look |
1105 | at the C<rstatus> member of the C<ev_child> watcher structure to see |
1517 | at the C<rstatus> member of the C<ev_child> watcher structure to see |
1106 | the status word (use the macros from C<sys/wait.h> and see your systems |
1518 | the status word (use the macros from C<sys/wait.h> and see your systems |
1107 | C<waitpid> documentation). The C<rpid> member contains the pid of the |
1519 | C<waitpid> documentation). The C<rpid> member contains the pid of the |
1108 | process causing the status change. |
1520 | process causing the status change. C<trace> must be either C<0> (only |
|
|
1521 | activate the watcher when the process terminates) or C<1> (additionally |
|
|
1522 | activate the watcher when the process is stopped or continued). |
1109 | |
1523 | |
1110 | =item int pid [read-only] |
1524 | =item int pid [read-only] |
1111 | |
1525 | |
1112 | The process id this watcher watches out for, or C<0>, meaning any process id. |
1526 | The process id this watcher watches out for, or C<0>, meaning any process id. |
1113 | |
1527 | |
… | |
… | |
1120 | The process exit/trace status caused by C<rpid> (see your systems |
1534 | The process exit/trace status caused by C<rpid> (see your systems |
1121 | C<waitpid> and C<sys/wait.h> documentation for details). |
1535 | C<waitpid> and C<sys/wait.h> documentation for details). |
1122 | |
1536 | |
1123 | =back |
1537 | =back |
1124 | |
1538 | |
1125 | Example: try to exit cleanly on SIGINT and SIGTERM. |
1539 | =head3 Examples |
|
|
1540 | |
|
|
1541 | Example: C<fork()> a new process and install a child handler to wait for |
|
|
1542 | its completion. |
|
|
1543 | |
|
|
1544 | ev_child cw; |
1126 | |
1545 | |
1127 | static void |
1546 | static void |
1128 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1547 | child_cb (EV_P_ struct ev_child *w, int revents) |
1129 | { |
1548 | { |
1130 | ev_unloop (loop, EVUNLOOP_ALL); |
1549 | ev_child_stop (EV_A_ w); |
|
|
1550 | printf ("process %d exited with status %x\n", w->rpid, w->rstatus); |
1131 | } |
1551 | } |
1132 | |
1552 | |
1133 | struct ev_signal signal_watcher; |
1553 | pid_t pid = fork (); |
1134 | ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1554 | |
1135 | ev_signal_start (loop, &sigint_cb); |
1555 | if (pid < 0) |
|
|
1556 | // error |
|
|
1557 | else if (pid == 0) |
|
|
1558 | { |
|
|
1559 | // the forked child executes here |
|
|
1560 | exit (1); |
|
|
1561 | } |
|
|
1562 | else |
|
|
1563 | { |
|
|
1564 | ev_child_init (&cw, child_cb, pid, 0); |
|
|
1565 | ev_child_start (EV_DEFAULT_ &cw); |
|
|
1566 | } |
1136 | |
1567 | |
1137 | |
1568 | |
1138 | =head2 C<ev_stat> - did the file attributes just change? |
1569 | =head2 C<ev_stat> - did the file attributes just change? |
1139 | |
1570 | |
1140 | This watches a filesystem path for attribute changes. That is, it calls |
1571 | This watches a filesystem path for attribute changes. That is, it calls |
… | |
… | |
1145 | not exist" is a status change like any other. The condition "path does |
1576 | not exist" is a status change like any other. The condition "path does |
1146 | not exist" is signified by the C<st_nlink> field being zero (which is |
1577 | not exist" is signified by the C<st_nlink> field being zero (which is |
1147 | otherwise always forced to be at least one) and all the other fields of |
1578 | otherwise always forced to be at least one) and all the other fields of |
1148 | the stat buffer having unspecified contents. |
1579 | the stat buffer having unspecified contents. |
1149 | |
1580 | |
|
|
1581 | The path I<should> be absolute and I<must not> end in a slash. If it is |
|
|
1582 | relative and your working directory changes, the behaviour is undefined. |
|
|
1583 | |
1150 | Since there is no standard to do this, the portable implementation simply |
1584 | Since there is no standard to do this, the portable implementation simply |
1151 | calls C<stat (2)> regulalry on the path to see if it changed somehow. You |
1585 | calls C<stat (2)> regularly on the path to see if it changed somehow. You |
1152 | can specify a recommended polling interval for this case. If you specify |
1586 | can specify a recommended polling interval for this case. If you specify |
1153 | a polling interval of C<0> (highly recommended!) then a I<suitable, |
1587 | a polling interval of C<0> (highly recommended!) then a I<suitable, |
1154 | unspecified default> value will be used (which you can expect to be around |
1588 | unspecified default> value will be used (which you can expect to be around |
1155 | five seconds, although this might change dynamically). Libev will also |
1589 | five seconds, although this might change dynamically). Libev will also |
1156 | impose a minimum interval which is currently around C<0.1>, but thats |
1590 | impose a minimum interval which is currently around C<0.1>, but thats |
… | |
… | |
1158 | |
1592 | |
1159 | This watcher type is not meant for massive numbers of stat watchers, |
1593 | This watcher type is not meant for massive numbers of stat watchers, |
1160 | as even with OS-supported change notifications, this can be |
1594 | as even with OS-supported change notifications, this can be |
1161 | resource-intensive. |
1595 | resource-intensive. |
1162 | |
1596 | |
1163 | At the time of this writing, no specific OS backends are implemented, but |
1597 | At the time of this writing, only the Linux inotify interface is |
1164 | if demand increases, at least a kqueue and inotify backend will be added. |
1598 | implemented (implementing kqueue support is left as an exercise for the |
|
|
1599 | reader). Inotify will be used to give hints only and should not change the |
|
|
1600 | semantics of C<ev_stat> watchers, which means that libev sometimes needs |
|
|
1601 | to fall back to regular polling again even with inotify, but changes are |
|
|
1602 | usually detected immediately, and if the file exists there will be no |
|
|
1603 | polling. |
|
|
1604 | |
|
|
1605 | =head3 Inotify |
|
|
1606 | |
|
|
1607 | When C<inotify (7)> support has been compiled into libev (generally only |
|
|
1608 | available on Linux) and present at runtime, it will be used to speed up |
|
|
1609 | change detection where possible. The inotify descriptor will be created lazily |
|
|
1610 | when the first C<ev_stat> watcher is being started. |
|
|
1611 | |
|
|
1612 | Inotify presense does not change the semantics of C<ev_stat> watchers |
|
|
1613 | except that changes might be detected earlier, and in some cases, to avoid |
|
|
1614 | making regular C<stat> calls. Even in the presense of inotify support |
|
|
1615 | there are many cases where libev has to resort to regular C<stat> polling. |
|
|
1616 | |
|
|
1617 | (There is no support for kqueue, as apparently it cannot be used to |
|
|
1618 | implement this functionality, due to the requirement of having a file |
|
|
1619 | descriptor open on the object at all times). |
|
|
1620 | |
|
|
1621 | =head3 The special problem of stat time resolution |
|
|
1622 | |
|
|
1623 | The C<stat ()> syscall only supports full-second resolution portably, and |
|
|
1624 | even on systems where the resolution is higher, many filesystems still |
|
|
1625 | only support whole seconds. |
|
|
1626 | |
|
|
1627 | That means that, if the time is the only thing that changes, you might |
|
|
1628 | miss updates: on the first update, C<ev_stat> detects a change and calls |
|
|
1629 | your callback, which does something. When there is another update within |
|
|
1630 | the same second, C<ev_stat> will be unable to detect it. |
|
|
1631 | |
|
|
1632 | The solution to this is to delay acting on a change for a second (or till |
|
|
1633 | the next second boundary), using a roughly one-second delay C<ev_timer> |
|
|
1634 | (C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01> |
|
|
1635 | is added to work around small timing inconsistencies of some operating |
|
|
1636 | systems. |
|
|
1637 | |
|
|
1638 | =head3 Watcher-Specific Functions and Data Members |
1165 | |
1639 | |
1166 | =over 4 |
1640 | =over 4 |
1167 | |
1641 | |
1168 | =item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) |
1642 | =item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) |
1169 | |
1643 | |
… | |
… | |
1177 | |
1651 | |
1178 | The callback will be receive C<EV_STAT> when a change was detected, |
1652 | The callback will be receive C<EV_STAT> when a change was detected, |
1179 | relative to the attributes at the time the watcher was started (or the |
1653 | relative to the attributes at the time the watcher was started (or the |
1180 | last change was detected). |
1654 | last change was detected). |
1181 | |
1655 | |
1182 | =item ev_stat_stat (ev_stat *) |
1656 | =item ev_stat_stat (loop, ev_stat *) |
1183 | |
1657 | |
1184 | Updates the stat buffer immediately with new values. If you change the |
1658 | Updates the stat buffer immediately with new values. If you change the |
1185 | watched path in your callback, you could call this fucntion to avoid |
1659 | watched path in your callback, you could call this fucntion to avoid |
1186 | detecting this change (while introducing a race condition). Can also be |
1660 | detecting this change (while introducing a race condition). Can also be |
1187 | useful simply to find out the new values. |
1661 | useful simply to find out the new values. |
… | |
… | |
1205 | =item const char *path [read-only] |
1679 | =item const char *path [read-only] |
1206 | |
1680 | |
1207 | The filesystem path that is being watched. |
1681 | The filesystem path that is being watched. |
1208 | |
1682 | |
1209 | =back |
1683 | =back |
|
|
1684 | |
|
|
1685 | =head3 Examples |
1210 | |
1686 | |
1211 | Example: Watch C</etc/passwd> for attribute changes. |
1687 | Example: Watch C</etc/passwd> for attribute changes. |
1212 | |
1688 | |
1213 | static void |
1689 | static void |
1214 | passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
1690 | passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
… | |
… | |
1227 | } |
1703 | } |
1228 | |
1704 | |
1229 | ... |
1705 | ... |
1230 | ev_stat passwd; |
1706 | ev_stat passwd; |
1231 | |
1707 | |
1232 | ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); |
1708 | ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.); |
1233 | ev_stat_start (loop, &passwd); |
1709 | ev_stat_start (loop, &passwd); |
1234 | |
1710 | |
|
|
1711 | Example: Like above, but additionally use a one-second delay so we do not |
|
|
1712 | miss updates (however, frequent updates will delay processing, too, so |
|
|
1713 | one might do the work both on C<ev_stat> callback invocation I<and> on |
|
|
1714 | C<ev_timer> callback invocation). |
|
|
1715 | |
|
|
1716 | static ev_stat passwd; |
|
|
1717 | static ev_timer timer; |
|
|
1718 | |
|
|
1719 | static void |
|
|
1720 | timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
1721 | { |
|
|
1722 | ev_timer_stop (EV_A_ w); |
|
|
1723 | |
|
|
1724 | /* now it's one second after the most recent passwd change */ |
|
|
1725 | } |
|
|
1726 | |
|
|
1727 | static void |
|
|
1728 | stat_cb (EV_P_ ev_stat *w, int revents) |
|
|
1729 | { |
|
|
1730 | /* reset the one-second timer */ |
|
|
1731 | ev_timer_again (EV_A_ &timer); |
|
|
1732 | } |
|
|
1733 | |
|
|
1734 | ... |
|
|
1735 | ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); |
|
|
1736 | ev_stat_start (loop, &passwd); |
|
|
1737 | ev_timer_init (&timer, timer_cb, 0., 1.01); |
|
|
1738 | |
1235 | |
1739 | |
1236 | =head2 C<ev_idle> - when you've got nothing better to do... |
1740 | =head2 C<ev_idle> - when you've got nothing better to do... |
1237 | |
1741 | |
1238 | Idle watchers trigger events when there are no other events are pending |
1742 | Idle watchers trigger events when no other events of the same or higher |
1239 | (prepare, check and other idle watchers do not count). That is, as long |
1743 | priority are pending (prepare, check and other idle watchers do not |
1240 | as your process is busy handling sockets or timeouts (or even signals, |
1744 | count). |
1241 | imagine) it will not be triggered. But when your process is idle all idle |
1745 | |
1242 | watchers are being called again and again, once per event loop iteration - |
1746 | That is, as long as your process is busy handling sockets or timeouts |
|
|
1747 | (or even signals, imagine) of the same or higher priority it will not be |
|
|
1748 | triggered. But when your process is idle (or only lower-priority watchers |
|
|
1749 | are pending), the idle watchers are being called once per event loop |
1243 | until stopped, that is, or your process receives more events and becomes |
1750 | iteration - until stopped, that is, or your process receives more events |
1244 | busy. |
1751 | and becomes busy again with higher priority stuff. |
1245 | |
1752 | |
1246 | The most noteworthy effect is that as long as any idle watchers are |
1753 | The most noteworthy effect is that as long as any idle watchers are |
1247 | active, the process will not block when waiting for new events. |
1754 | active, the process will not block when waiting for new events. |
1248 | |
1755 | |
1249 | Apart from keeping your process non-blocking (which is a useful |
1756 | Apart from keeping your process non-blocking (which is a useful |
1250 | effect on its own sometimes), idle watchers are a good place to do |
1757 | effect on its own sometimes), idle watchers are a good place to do |
1251 | "pseudo-background processing", or delay processing stuff to after the |
1758 | "pseudo-background processing", or delay processing stuff to after the |
1252 | event loop has handled all outstanding events. |
1759 | event loop has handled all outstanding events. |
1253 | |
1760 | |
|
|
1761 | =head3 Watcher-Specific Functions and Data Members |
|
|
1762 | |
1254 | =over 4 |
1763 | =over 4 |
1255 | |
1764 | |
1256 | =item ev_idle_init (ev_signal *, callback) |
1765 | =item ev_idle_init (ev_signal *, callback) |
1257 | |
1766 | |
1258 | Initialises and configures the idle watcher - it has no parameters of any |
1767 | Initialises and configures the idle watcher - it has no parameters of any |
1259 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
1768 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
1260 | believe me. |
1769 | believe me. |
1261 | |
1770 | |
1262 | =back |
1771 | =back |
1263 | |
1772 | |
|
|
1773 | =head3 Examples |
|
|
1774 | |
1264 | Example: dynamically allocate an C<ev_idle>, start it, and in the |
1775 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
1265 | callback, free it. Alos, use no error checking, as usual. |
1776 | callback, free it. Also, use no error checking, as usual. |
1266 | |
1777 | |
1267 | static void |
1778 | static void |
1268 | idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1779 | idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1269 | { |
1780 | { |
1270 | free (w); |
1781 | free (w); |
1271 | // now do something you wanted to do when the program has |
1782 | // now do something you wanted to do when the program has |
1272 | // no longer asnything immediate to do. |
1783 | // no longer anything immediate to do. |
1273 | } |
1784 | } |
1274 | |
1785 | |
1275 | struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
1786 | struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
1276 | ev_idle_init (idle_watcher, idle_cb); |
1787 | ev_idle_init (idle_watcher, idle_cb); |
1277 | ev_idle_start (loop, idle_cb); |
1788 | ev_idle_start (loop, idle_cb); |
… | |
… | |
1315 | with priority higher than or equal to the event loop and one coroutine |
1826 | with priority higher than or equal to the event loop and one coroutine |
1316 | of lower priority, but only once, using idle watchers to keep the event |
1827 | of lower priority, but only once, using idle watchers to keep the event |
1317 | loop from blocking if lower-priority coroutines are active, thus mapping |
1828 | loop from blocking if lower-priority coroutines are active, thus mapping |
1318 | low-priority coroutines to idle/background tasks). |
1829 | low-priority coroutines to idle/background tasks). |
1319 | |
1830 | |
|
|
1831 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
|
|
1832 | priority, to ensure that they are being run before any other watchers |
|
|
1833 | after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, |
|
|
1834 | too) should not activate ("feed") events into libev. While libev fully |
|
|
1835 | supports this, they will be called before other C<ev_check> watchers |
|
|
1836 | did their job. As C<ev_check> watchers are often used to embed other |
|
|
1837 | (non-libev) event loops those other event loops might be in an unusable |
|
|
1838 | state until their C<ev_check> watcher ran (always remind yourself to |
|
|
1839 | coexist peacefully with others). |
|
|
1840 | |
|
|
1841 | =head3 Watcher-Specific Functions and Data Members |
|
|
1842 | |
1320 | =over 4 |
1843 | =over 4 |
1321 | |
1844 | |
1322 | =item ev_prepare_init (ev_prepare *, callback) |
1845 | =item ev_prepare_init (ev_prepare *, callback) |
1323 | |
1846 | |
1324 | =item ev_check_init (ev_check *, callback) |
1847 | =item ev_check_init (ev_check *, callback) |
… | |
… | |
1327 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1850 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1328 | macros, but using them is utterly, utterly and completely pointless. |
1851 | macros, but using them is utterly, utterly and completely pointless. |
1329 | |
1852 | |
1330 | =back |
1853 | =back |
1331 | |
1854 | |
1332 | Example: To include a library such as adns, you would add IO watchers |
1855 | =head3 Examples |
1333 | and a timeout watcher in a prepare handler, as required by libadns, and |
1856 | |
|
|
1857 | There are a number of principal ways to embed other event loops or modules |
|
|
1858 | into libev. Here are some ideas on how to include libadns into libev |
|
|
1859 | (there is a Perl module named C<EV::ADNS> that does this, which you could |
|
|
1860 | use for an actually working example. Another Perl module named C<EV::Glib> |
|
|
1861 | embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV |
|
|
1862 | into the Glib event loop). |
|
|
1863 | |
|
|
1864 | Method 1: Add IO watchers and a timeout watcher in a prepare handler, |
1334 | in a check watcher, destroy them and call into libadns. What follows is |
1865 | and in a check watcher, destroy them and call into libadns. What follows |
1335 | pseudo-code only of course: |
1866 | is pseudo-code only of course. This requires you to either use a low |
|
|
1867 | priority for the check watcher or use C<ev_clear_pending> explicitly, as |
|
|
1868 | the callbacks for the IO/timeout watchers might not have been called yet. |
1336 | |
1869 | |
1337 | static ev_io iow [nfd]; |
1870 | static ev_io iow [nfd]; |
1338 | static ev_timer tw; |
1871 | static ev_timer tw; |
1339 | |
1872 | |
1340 | static void |
1873 | static void |
1341 | io_cb (ev_loop *loop, ev_io *w, int revents) |
1874 | io_cb (ev_loop *loop, ev_io *w, int revents) |
1342 | { |
1875 | { |
1343 | // set the relevant poll flags |
|
|
1344 | // could also call adns_processreadable etc. here |
|
|
1345 | struct pollfd *fd = (struct pollfd *)w->data; |
|
|
1346 | if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1347 | if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1348 | } |
1876 | } |
1349 | |
1877 | |
1350 | // create io watchers for each fd and a timer before blocking |
1878 | // create io watchers for each fd and a timer before blocking |
1351 | static void |
1879 | static void |
1352 | adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1880 | adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1353 | { |
1881 | { |
1354 | int timeout = 3600000;truct pollfd fds [nfd]; |
1882 | int timeout = 3600000; |
|
|
1883 | struct pollfd fds [nfd]; |
1355 | // actual code will need to loop here and realloc etc. |
1884 | // actual code will need to loop here and realloc etc. |
1356 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1885 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1357 | |
1886 | |
1358 | /* the callback is illegal, but won't be called as we stop during check */ |
1887 | /* the callback is illegal, but won't be called as we stop during check */ |
1359 | ev_timer_init (&tw, 0, timeout * 1e-3); |
1888 | ev_timer_init (&tw, 0, timeout * 1e-3); |
1360 | ev_timer_start (loop, &tw); |
1889 | ev_timer_start (loop, &tw); |
1361 | |
1890 | |
1362 | // create on ev_io per pollfd |
1891 | // create one ev_io per pollfd |
1363 | for (int i = 0; i < nfd; ++i) |
1892 | for (int i = 0; i < nfd; ++i) |
1364 | { |
1893 | { |
1365 | ev_io_init (iow + i, io_cb, fds [i].fd, |
1894 | ev_io_init (iow + i, io_cb, fds [i].fd, |
1366 | ((fds [i].events & POLLIN ? EV_READ : 0) |
1895 | ((fds [i].events & POLLIN ? EV_READ : 0) |
1367 | | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1896 | | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1368 | |
1897 | |
1369 | fds [i].revents = 0; |
1898 | fds [i].revents = 0; |
1370 | iow [i].data = fds + i; |
|
|
1371 | ev_io_start (loop, iow + i); |
1899 | ev_io_start (loop, iow + i); |
1372 | } |
1900 | } |
1373 | } |
1901 | } |
1374 | |
1902 | |
1375 | // stop all watchers after blocking |
1903 | // stop all watchers after blocking |
… | |
… | |
1377 | adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1905 | adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1378 | { |
1906 | { |
1379 | ev_timer_stop (loop, &tw); |
1907 | ev_timer_stop (loop, &tw); |
1380 | |
1908 | |
1381 | for (int i = 0; i < nfd; ++i) |
1909 | for (int i = 0; i < nfd; ++i) |
|
|
1910 | { |
|
|
1911 | // set the relevant poll flags |
|
|
1912 | // could also call adns_processreadable etc. here |
|
|
1913 | struct pollfd *fd = fds + i; |
|
|
1914 | int revents = ev_clear_pending (iow + i); |
|
|
1915 | if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1916 | if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1917 | |
|
|
1918 | // now stop the watcher |
1382 | ev_io_stop (loop, iow + i); |
1919 | ev_io_stop (loop, iow + i); |
|
|
1920 | } |
1383 | |
1921 | |
1384 | adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
1922 | adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
1923 | } |
|
|
1924 | |
|
|
1925 | Method 2: This would be just like method 1, but you run C<adns_afterpoll> |
|
|
1926 | in the prepare watcher and would dispose of the check watcher. |
|
|
1927 | |
|
|
1928 | Method 3: If the module to be embedded supports explicit event |
|
|
1929 | notification (adns does), you can also make use of the actual watcher |
|
|
1930 | callbacks, and only destroy/create the watchers in the prepare watcher. |
|
|
1931 | |
|
|
1932 | static void |
|
|
1933 | timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
1934 | { |
|
|
1935 | adns_state ads = (adns_state)w->data; |
|
|
1936 | update_now (EV_A); |
|
|
1937 | |
|
|
1938 | adns_processtimeouts (ads, &tv_now); |
|
|
1939 | } |
|
|
1940 | |
|
|
1941 | static void |
|
|
1942 | io_cb (EV_P_ ev_io *w, int revents) |
|
|
1943 | { |
|
|
1944 | adns_state ads = (adns_state)w->data; |
|
|
1945 | update_now (EV_A); |
|
|
1946 | |
|
|
1947 | if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now); |
|
|
1948 | if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now); |
|
|
1949 | } |
|
|
1950 | |
|
|
1951 | // do not ever call adns_afterpoll |
|
|
1952 | |
|
|
1953 | Method 4: Do not use a prepare or check watcher because the module you |
|
|
1954 | want to embed is too inflexible to support it. Instead, youc na override |
|
|
1955 | their poll function. The drawback with this solution is that the main |
|
|
1956 | loop is now no longer controllable by EV. The C<Glib::EV> module does |
|
|
1957 | this. |
|
|
1958 | |
|
|
1959 | static gint |
|
|
1960 | event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
|
|
1961 | { |
|
|
1962 | int got_events = 0; |
|
|
1963 | |
|
|
1964 | for (n = 0; n < nfds; ++n) |
|
|
1965 | // create/start io watcher that sets the relevant bits in fds[n] and increment got_events |
|
|
1966 | |
|
|
1967 | if (timeout >= 0) |
|
|
1968 | // create/start timer |
|
|
1969 | |
|
|
1970 | // poll |
|
|
1971 | ev_loop (EV_A_ 0); |
|
|
1972 | |
|
|
1973 | // stop timer again |
|
|
1974 | if (timeout >= 0) |
|
|
1975 | ev_timer_stop (EV_A_ &to); |
|
|
1976 | |
|
|
1977 | // stop io watchers again - their callbacks should have set |
|
|
1978 | for (n = 0; n < nfds; ++n) |
|
|
1979 | ev_io_stop (EV_A_ iow [n]); |
|
|
1980 | |
|
|
1981 | return got_events; |
1385 | } |
1982 | } |
1386 | |
1983 | |
1387 | |
1984 | |
1388 | =head2 C<ev_embed> - when one backend isn't enough... |
1985 | =head2 C<ev_embed> - when one backend isn't enough... |
1389 | |
1986 | |
… | |
… | |
1432 | portable one. |
2029 | portable one. |
1433 | |
2030 | |
1434 | So when you want to use this feature you will always have to be prepared |
2031 | So when you want to use this feature you will always have to be prepared |
1435 | that you cannot get an embeddable loop. The recommended way to get around |
2032 | that you cannot get an embeddable loop. The recommended way to get around |
1436 | this is to have a separate variables for your embeddable loop, try to |
2033 | this is to have a separate variables for your embeddable loop, try to |
1437 | create it, and if that fails, use the normal loop for everything: |
2034 | create it, and if that fails, use the normal loop for everything. |
|
|
2035 | |
|
|
2036 | =head3 Watcher-Specific Functions and Data Members |
|
|
2037 | |
|
|
2038 | =over 4 |
|
|
2039 | |
|
|
2040 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
|
|
2041 | |
|
|
2042 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
|
|
2043 | |
|
|
2044 | Configures the watcher to embed the given loop, which must be |
|
|
2045 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
|
|
2046 | invoked automatically, otherwise it is the responsibility of the callback |
|
|
2047 | to invoke it (it will continue to be called until the sweep has been done, |
|
|
2048 | if you do not want thta, you need to temporarily stop the embed watcher). |
|
|
2049 | |
|
|
2050 | =item ev_embed_sweep (loop, ev_embed *) |
|
|
2051 | |
|
|
2052 | Make a single, non-blocking sweep over the embedded loop. This works |
|
|
2053 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
|
|
2054 | apropriate way for embedded loops. |
|
|
2055 | |
|
|
2056 | =item struct ev_loop *other [read-only] |
|
|
2057 | |
|
|
2058 | The embedded event loop. |
|
|
2059 | |
|
|
2060 | =back |
|
|
2061 | |
|
|
2062 | =head3 Examples |
|
|
2063 | |
|
|
2064 | Example: Try to get an embeddable event loop and embed it into the default |
|
|
2065 | event loop. If that is not possible, use the default loop. The default |
|
|
2066 | loop is stored in C<loop_hi>, while the mebeddable loop is stored in |
|
|
2067 | C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be |
|
|
2068 | used). |
1438 | |
2069 | |
1439 | struct ev_loop *loop_hi = ev_default_init (0); |
2070 | struct ev_loop *loop_hi = ev_default_init (0); |
1440 | struct ev_loop *loop_lo = 0; |
2071 | struct ev_loop *loop_lo = 0; |
1441 | struct ev_embed embed; |
2072 | struct ev_embed embed; |
1442 | |
2073 | |
… | |
… | |
1453 | ev_embed_start (loop_hi, &embed); |
2084 | ev_embed_start (loop_hi, &embed); |
1454 | } |
2085 | } |
1455 | else |
2086 | else |
1456 | loop_lo = loop_hi; |
2087 | loop_lo = loop_hi; |
1457 | |
2088 | |
1458 | =over 4 |
2089 | Example: Check if kqueue is available but not recommended and create |
|
|
2090 | a kqueue backend for use with sockets (which usually work with any |
|
|
2091 | kqueue implementation). Store the kqueue/socket-only event loop in |
|
|
2092 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
1459 | |
2093 | |
1460 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
2094 | struct ev_loop *loop = ev_default_init (0); |
|
|
2095 | struct ev_loop *loop_socket = 0; |
|
|
2096 | struct ev_embed embed; |
|
|
2097 | |
|
|
2098 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
|
|
2099 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
|
|
2100 | { |
|
|
2101 | ev_embed_init (&embed, 0, loop_socket); |
|
|
2102 | ev_embed_start (loop, &embed); |
|
|
2103 | } |
1461 | |
2104 | |
1462 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
2105 | if (!loop_socket) |
|
|
2106 | loop_socket = loop; |
1463 | |
2107 | |
1464 | Configures the watcher to embed the given loop, which must be |
2108 | // now use loop_socket for all sockets, and loop for everything else |
1465 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
|
|
1466 | invoked automatically, otherwise it is the responsibility of the callback |
|
|
1467 | to invoke it (it will continue to be called until the sweep has been done, |
|
|
1468 | if you do not want thta, you need to temporarily stop the embed watcher). |
|
|
1469 | |
|
|
1470 | =item ev_embed_sweep (loop, ev_embed *) |
|
|
1471 | |
|
|
1472 | Make a single, non-blocking sweep over the embedded loop. This works |
|
|
1473 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
|
|
1474 | apropriate way for embedded loops. |
|
|
1475 | |
|
|
1476 | =item struct ev_loop *loop [read-only] |
|
|
1477 | |
|
|
1478 | The embedded event loop. |
|
|
1479 | |
|
|
1480 | =back |
|
|
1481 | |
2109 | |
1482 | |
2110 | |
1483 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
2111 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
1484 | |
2112 | |
1485 | Fork watchers are called when a C<fork ()> was detected (usually because |
2113 | Fork watchers are called when a C<fork ()> was detected (usually because |
… | |
… | |
1488 | event loop blocks next and before C<ev_check> watchers are being called, |
2116 | event loop blocks next and before C<ev_check> watchers are being called, |
1489 | and only in the child after the fork. If whoever good citizen calling |
2117 | and only in the child after the fork. If whoever good citizen calling |
1490 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
2118 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
1491 | handlers will be invoked, too, of course. |
2119 | handlers will be invoked, too, of course. |
1492 | |
2120 | |
|
|
2121 | =head3 Watcher-Specific Functions and Data Members |
|
|
2122 | |
1493 | =over 4 |
2123 | =over 4 |
1494 | |
2124 | |
1495 | =item ev_fork_init (ev_signal *, callback) |
2125 | =item ev_fork_init (ev_signal *, callback) |
1496 | |
2126 | |
1497 | Initialises and configures the fork watcher - it has no parameters of any |
2127 | Initialises and configures the fork watcher - it has no parameters of any |
1498 | kind. There is a C<ev_fork_set> macro, but using it is utterly pointless, |
2128 | kind. There is a C<ev_fork_set> macro, but using it is utterly pointless, |
1499 | believe me. |
2129 | believe me. |
|
|
2130 | |
|
|
2131 | =back |
|
|
2132 | |
|
|
2133 | |
|
|
2134 | =head2 C<ev_async> - how to wake up another event loop |
|
|
2135 | |
|
|
2136 | In general, you cannot use an C<ev_loop> from multiple threads or other |
|
|
2137 | asynchronous sources such as signal handlers (as opposed to multiple event |
|
|
2138 | loops - those are of course safe to use in different threads). |
|
|
2139 | |
|
|
2140 | Sometimes, however, you need to wake up another event loop you do not |
|
|
2141 | control, for example because it belongs to another thread. This is what |
|
|
2142 | C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you |
|
|
2143 | can signal it by calling C<ev_async_send>, which is thread- and signal |
|
|
2144 | safe. |
|
|
2145 | |
|
|
2146 | This functionality is very similar to C<ev_signal> watchers, as signals, |
|
|
2147 | too, are asynchronous in nature, and signals, too, will be compressed |
|
|
2148 | (i.e. the number of callback invocations may be less than the number of |
|
|
2149 | C<ev_async_sent> calls). |
|
|
2150 | |
|
|
2151 | Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not |
|
|
2152 | just the default loop. |
|
|
2153 | |
|
|
2154 | =head3 Queueing |
|
|
2155 | |
|
|
2156 | C<ev_async> does not support queueing of data in any way. The reason |
|
|
2157 | is that the author does not know of a simple (or any) algorithm for a |
|
|
2158 | multiple-writer-single-reader queue that works in all cases and doesn't |
|
|
2159 | need elaborate support such as pthreads. |
|
|
2160 | |
|
|
2161 | That means that if you want to queue data, you have to provide your own |
|
|
2162 | queue. But at least I can tell you would implement locking around your |
|
|
2163 | queue: |
|
|
2164 | |
|
|
2165 | =over 4 |
|
|
2166 | |
|
|
2167 | =item queueing from a signal handler context |
|
|
2168 | |
|
|
2169 | To implement race-free queueing, you simply add to the queue in the signal |
|
|
2170 | handler but you block the signal handler in the watcher callback. Here is an example that does that for |
|
|
2171 | some fictitiuous SIGUSR1 handler: |
|
|
2172 | |
|
|
2173 | static ev_async mysig; |
|
|
2174 | |
|
|
2175 | static void |
|
|
2176 | sigusr1_handler (void) |
|
|
2177 | { |
|
|
2178 | sometype data; |
|
|
2179 | |
|
|
2180 | // no locking etc. |
|
|
2181 | queue_put (data); |
|
|
2182 | ev_async_send (EV_DEFAULT_ &mysig); |
|
|
2183 | } |
|
|
2184 | |
|
|
2185 | static void |
|
|
2186 | mysig_cb (EV_P_ ev_async *w, int revents) |
|
|
2187 | { |
|
|
2188 | sometype data; |
|
|
2189 | sigset_t block, prev; |
|
|
2190 | |
|
|
2191 | sigemptyset (&block); |
|
|
2192 | sigaddset (&block, SIGUSR1); |
|
|
2193 | sigprocmask (SIG_BLOCK, &block, &prev); |
|
|
2194 | |
|
|
2195 | while (queue_get (&data)) |
|
|
2196 | process (data); |
|
|
2197 | |
|
|
2198 | if (sigismember (&prev, SIGUSR1) |
|
|
2199 | sigprocmask (SIG_UNBLOCK, &block, 0); |
|
|
2200 | } |
|
|
2201 | |
|
|
2202 | (Note: pthreads in theory requires you to use C<pthread_setmask> |
|
|
2203 | instead of C<sigprocmask> when you use threads, but libev doesn't do it |
|
|
2204 | either...). |
|
|
2205 | |
|
|
2206 | =item queueing from a thread context |
|
|
2207 | |
|
|
2208 | The strategy for threads is different, as you cannot (easily) block |
|
|
2209 | threads but you can easily preempt them, so to queue safely you need to |
|
|
2210 | employ a traditional mutex lock, such as in this pthread example: |
|
|
2211 | |
|
|
2212 | static ev_async mysig; |
|
|
2213 | static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER; |
|
|
2214 | |
|
|
2215 | static void |
|
|
2216 | otherthread (void) |
|
|
2217 | { |
|
|
2218 | // only need to lock the actual queueing operation |
|
|
2219 | pthread_mutex_lock (&mymutex); |
|
|
2220 | queue_put (data); |
|
|
2221 | pthread_mutex_unlock (&mymutex); |
|
|
2222 | |
|
|
2223 | ev_async_send (EV_DEFAULT_ &mysig); |
|
|
2224 | } |
|
|
2225 | |
|
|
2226 | static void |
|
|
2227 | mysig_cb (EV_P_ ev_async *w, int revents) |
|
|
2228 | { |
|
|
2229 | pthread_mutex_lock (&mymutex); |
|
|
2230 | |
|
|
2231 | while (queue_get (&data)) |
|
|
2232 | process (data); |
|
|
2233 | |
|
|
2234 | pthread_mutex_unlock (&mymutex); |
|
|
2235 | } |
|
|
2236 | |
|
|
2237 | =back |
|
|
2238 | |
|
|
2239 | |
|
|
2240 | =head3 Watcher-Specific Functions and Data Members |
|
|
2241 | |
|
|
2242 | =over 4 |
|
|
2243 | |
|
|
2244 | =item ev_async_init (ev_async *, callback) |
|
|
2245 | |
|
|
2246 | Initialises and configures the async watcher - it has no parameters of any |
|
|
2247 | kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless, |
|
|
2248 | believe me. |
|
|
2249 | |
|
|
2250 | =item ev_async_send (loop, ev_async *) |
|
|
2251 | |
|
|
2252 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
|
|
2253 | an C<EV_ASYNC> event on the watcher into the event loop. Unlike |
|
|
2254 | C<ev_feed_event>, this call is safe to do in other threads, signal or |
|
|
2255 | similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding |
|
|
2256 | section below on what exactly this means). |
|
|
2257 | |
|
|
2258 | This call incurs the overhead of a syscall only once per loop iteration, |
|
|
2259 | so while the overhead might be noticable, it doesn't apply to repeated |
|
|
2260 | calls to C<ev_async_send>. |
1500 | |
2261 | |
1501 | =back |
2262 | =back |
1502 | |
2263 | |
1503 | |
2264 | |
1504 | =head1 OTHER FUNCTIONS |
2265 | =head1 OTHER FUNCTIONS |
… | |
… | |
1593 | |
2354 | |
1594 | To use it, |
2355 | To use it, |
1595 | |
2356 | |
1596 | #include <ev++.h> |
2357 | #include <ev++.h> |
1597 | |
2358 | |
1598 | (it is not installed by default). This automatically includes F<ev.h> |
2359 | This automatically includes F<ev.h> and puts all of its definitions (many |
1599 | and puts all of its definitions (many of them macros) into the global |
2360 | of them macros) into the global namespace. All C++ specific things are |
1600 | namespace. All C++ specific things are put into the C<ev> namespace. |
2361 | put into the C<ev> namespace. It should support all the same embedding |
|
|
2362 | options as F<ev.h>, most notably C<EV_MULTIPLICITY>. |
1601 | |
2363 | |
1602 | It should support all the same embedding options as F<ev.h>, most notably |
2364 | Care has been taken to keep the overhead low. The only data member the C++ |
1603 | C<EV_MULTIPLICITY>. |
2365 | classes add (compared to plain C-style watchers) is the event loop pointer |
|
|
2366 | that the watcher is associated with (or no additional members at all if |
|
|
2367 | you disable C<EV_MULTIPLICITY> when embedding libev). |
|
|
2368 | |
|
|
2369 | Currently, functions, and static and non-static member functions can be |
|
|
2370 | used as callbacks. Other types should be easy to add as long as they only |
|
|
2371 | need one additional pointer for context. If you need support for other |
|
|
2372 | types of functors please contact the author (preferably after implementing |
|
|
2373 | it). |
1604 | |
2374 | |
1605 | Here is a list of things available in the C<ev> namespace: |
2375 | Here is a list of things available in the C<ev> namespace: |
1606 | |
2376 | |
1607 | =over 4 |
2377 | =over 4 |
1608 | |
2378 | |
… | |
… | |
1624 | |
2394 | |
1625 | All of those classes have these methods: |
2395 | All of those classes have these methods: |
1626 | |
2396 | |
1627 | =over 4 |
2397 | =over 4 |
1628 | |
2398 | |
1629 | =item ev::TYPE::TYPE (object *, object::method *) |
2399 | =item ev::TYPE::TYPE () |
1630 | |
2400 | |
1631 | =item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *) |
2401 | =item ev::TYPE::TYPE (struct ev_loop *) |
1632 | |
2402 | |
1633 | =item ev::TYPE::~TYPE |
2403 | =item ev::TYPE::~TYPE |
1634 | |
2404 | |
1635 | The constructor takes a pointer to an object and a method pointer to |
2405 | The constructor (optionally) takes an event loop to associate the watcher |
1636 | the event handler callback to call in this class. The constructor calls |
2406 | with. If it is omitted, it will use C<EV_DEFAULT>. |
1637 | C<ev_init> for you, which means you have to call the C<set> method |
2407 | |
1638 | before starting it. If you do not specify a loop then the constructor |
2408 | The constructor calls C<ev_init> for you, which means you have to call the |
1639 | automatically associates the default loop with this watcher. |
2409 | C<set> method before starting it. |
|
|
2410 | |
|
|
2411 | It will not set a callback, however: You have to call the templated C<set> |
|
|
2412 | method to set a callback before you can start the watcher. |
|
|
2413 | |
|
|
2414 | (The reason why you have to use a method is a limitation in C++ which does |
|
|
2415 | not allow explicit template arguments for constructors). |
1640 | |
2416 | |
1641 | The destructor automatically stops the watcher if it is active. |
2417 | The destructor automatically stops the watcher if it is active. |
|
|
2418 | |
|
|
2419 | =item w->set<class, &class::method> (object *) |
|
|
2420 | |
|
|
2421 | This method sets the callback method to call. The method has to have a |
|
|
2422 | signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as |
|
|
2423 | first argument and the C<revents> as second. The object must be given as |
|
|
2424 | parameter and is stored in the C<data> member of the watcher. |
|
|
2425 | |
|
|
2426 | This method synthesizes efficient thunking code to call your method from |
|
|
2427 | the C callback that libev requires. If your compiler can inline your |
|
|
2428 | callback (i.e. it is visible to it at the place of the C<set> call and |
|
|
2429 | your compiler is good :), then the method will be fully inlined into the |
|
|
2430 | thunking function, making it as fast as a direct C callback. |
|
|
2431 | |
|
|
2432 | Example: simple class declaration and watcher initialisation |
|
|
2433 | |
|
|
2434 | struct myclass |
|
|
2435 | { |
|
|
2436 | void io_cb (ev::io &w, int revents) { } |
|
|
2437 | } |
|
|
2438 | |
|
|
2439 | myclass obj; |
|
|
2440 | ev::io iow; |
|
|
2441 | iow.set <myclass, &myclass::io_cb> (&obj); |
|
|
2442 | |
|
|
2443 | =item w->set<function> (void *data = 0) |
|
|
2444 | |
|
|
2445 | Also sets a callback, but uses a static method or plain function as |
|
|
2446 | callback. The optional C<data> argument will be stored in the watcher's |
|
|
2447 | C<data> member and is free for you to use. |
|
|
2448 | |
|
|
2449 | The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>. |
|
|
2450 | |
|
|
2451 | See the method-C<set> above for more details. |
|
|
2452 | |
|
|
2453 | Example: |
|
|
2454 | |
|
|
2455 | static void io_cb (ev::io &w, int revents) { } |
|
|
2456 | iow.set <io_cb> (); |
1642 | |
2457 | |
1643 | =item w->set (struct ev_loop *) |
2458 | =item w->set (struct ev_loop *) |
1644 | |
2459 | |
1645 | Associates a different C<struct ev_loop> with this watcher. You can only |
2460 | Associates a different C<struct ev_loop> with this watcher. You can only |
1646 | do this when the watcher is inactive (and not pending either). |
2461 | do this when the watcher is inactive (and not pending either). |
1647 | |
2462 | |
1648 | =item w->set ([args]) |
2463 | =item w->set ([args]) |
1649 | |
2464 | |
1650 | Basically the same as C<ev_TYPE_set>, with the same args. Must be |
2465 | Basically the same as C<ev_TYPE_set>, with the same args. Must be |
1651 | called at least once. Unlike the C counterpart, an active watcher gets |
2466 | called at least once. Unlike the C counterpart, an active watcher gets |
1652 | automatically stopped and restarted. |
2467 | automatically stopped and restarted when reconfiguring it with this |
|
|
2468 | method. |
1653 | |
2469 | |
1654 | =item w->start () |
2470 | =item w->start () |
1655 | |
2471 | |
1656 | Starts the watcher. Note that there is no C<loop> argument as the |
2472 | Starts the watcher. Note that there is no C<loop> argument, as the |
1657 | constructor already takes the loop. |
2473 | constructor already stores the event loop. |
1658 | |
2474 | |
1659 | =item w->stop () |
2475 | =item w->stop () |
1660 | |
2476 | |
1661 | Stops the watcher if it is active. Again, no C<loop> argument. |
2477 | Stops the watcher if it is active. Again, no C<loop> argument. |
1662 | |
2478 | |
1663 | =item w->again () C<ev::timer>, C<ev::periodic> only |
2479 | =item w->again () (C<ev::timer>, C<ev::periodic> only) |
1664 | |
2480 | |
1665 | For C<ev::timer> and C<ev::periodic>, this invokes the corresponding |
2481 | For C<ev::timer> and C<ev::periodic>, this invokes the corresponding |
1666 | C<ev_TYPE_again> function. |
2482 | C<ev_TYPE_again> function. |
1667 | |
2483 | |
1668 | =item w->sweep () C<ev::embed> only |
2484 | =item w->sweep () (C<ev::embed> only) |
1669 | |
2485 | |
1670 | Invokes C<ev_embed_sweep>. |
2486 | Invokes C<ev_embed_sweep>. |
1671 | |
2487 | |
1672 | =item w->update () C<ev::stat> only |
2488 | =item w->update () (C<ev::stat> only) |
1673 | |
2489 | |
1674 | Invokes C<ev_stat_stat>. |
2490 | Invokes C<ev_stat_stat>. |
1675 | |
2491 | |
1676 | =back |
2492 | =back |
1677 | |
2493 | |
… | |
… | |
1680 | Example: Define a class with an IO and idle watcher, start one of them in |
2496 | Example: Define a class with an IO and idle watcher, start one of them in |
1681 | the constructor. |
2497 | the constructor. |
1682 | |
2498 | |
1683 | class myclass |
2499 | class myclass |
1684 | { |
2500 | { |
1685 | ev_io io; void io_cb (ev::io &w, int revents); |
2501 | ev::io io; void io_cb (ev::io &w, int revents); |
1686 | ev_idle idle void idle_cb (ev::idle &w, int revents); |
2502 | ev:idle idle void idle_cb (ev::idle &w, int revents); |
1687 | |
2503 | |
1688 | myclass (); |
2504 | myclass (int fd) |
1689 | } |
|
|
1690 | |
|
|
1691 | myclass::myclass (int fd) |
|
|
1692 | : io (this, &myclass::io_cb), |
|
|
1693 | idle (this, &myclass::idle_cb) |
|
|
1694 | { |
2505 | { |
|
|
2506 | io .set <myclass, &myclass::io_cb > (this); |
|
|
2507 | idle.set <myclass, &myclass::idle_cb> (this); |
|
|
2508 | |
1695 | io.start (fd, ev::READ); |
2509 | io.start (fd, ev::READ); |
|
|
2510 | } |
1696 | } |
2511 | }; |
1697 | |
2512 | |
1698 | |
2513 | |
1699 | =head1 MACRO MAGIC |
2514 | =head1 MACRO MAGIC |
1700 | |
2515 | |
1701 | Libev can be compiled with a variety of options, the most fundemantal is |
2516 | Libev can be compiled with a variety of options, the most fundamantal |
1702 | C<EV_MULTIPLICITY>. This option determines wether (most) functions and |
2517 | of which is C<EV_MULTIPLICITY>. This option determines whether (most) |
1703 | callbacks have an initial C<struct ev_loop *> argument. |
2518 | functions and callbacks have an initial C<struct ev_loop *> argument. |
1704 | |
2519 | |
1705 | To make it easier to write programs that cope with either variant, the |
2520 | To make it easier to write programs that cope with either variant, the |
1706 | following macros are defined: |
2521 | following macros are defined: |
1707 | |
2522 | |
1708 | =over 4 |
2523 | =over 4 |
… | |
… | |
1740 | Similar to the other two macros, this gives you the value of the default |
2555 | Similar to the other two macros, this gives you the value of the default |
1741 | loop, if multiple loops are supported ("ev loop default"). |
2556 | loop, if multiple loops are supported ("ev loop default"). |
1742 | |
2557 | |
1743 | =back |
2558 | =back |
1744 | |
2559 | |
1745 | Example: Declare and initialise a check watcher, working regardless of |
2560 | Example: Declare and initialise a check watcher, utilising the above |
1746 | wether multiple loops are supported or not. |
2561 | macros so it will work regardless of whether multiple loops are supported |
|
|
2562 | or not. |
1747 | |
2563 | |
1748 | static void |
2564 | static void |
1749 | check_cb (EV_P_ ev_timer *w, int revents) |
2565 | check_cb (EV_P_ ev_timer *w, int revents) |
1750 | { |
2566 | { |
1751 | ev_check_stop (EV_A_ w); |
2567 | ev_check_stop (EV_A_ w); |
… | |
… | |
1754 | ev_check check; |
2570 | ev_check check; |
1755 | ev_check_init (&check, check_cb); |
2571 | ev_check_init (&check, check_cb); |
1756 | ev_check_start (EV_DEFAULT_ &check); |
2572 | ev_check_start (EV_DEFAULT_ &check); |
1757 | ev_loop (EV_DEFAULT_ 0); |
2573 | ev_loop (EV_DEFAULT_ 0); |
1758 | |
2574 | |
1759 | |
|
|
1760 | =head1 EMBEDDING |
2575 | =head1 EMBEDDING |
1761 | |
2576 | |
1762 | Libev can (and often is) directly embedded into host |
2577 | Libev can (and often is) directly embedded into host |
1763 | applications. Examples of applications that embed it include the Deliantra |
2578 | applications. Examples of applications that embed it include the Deliantra |
1764 | Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) |
2579 | Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) |
1765 | and rxvt-unicode. |
2580 | and rxvt-unicode. |
1766 | |
2581 | |
1767 | The goal is to enable you to just copy the neecssary files into your |
2582 | The goal is to enable you to just copy the necessary files into your |
1768 | source directory without having to change even a single line in them, so |
2583 | source directory without having to change even a single line in them, so |
1769 | you can easily upgrade by simply copying (or having a checked-out copy of |
2584 | you can easily upgrade by simply copying (or having a checked-out copy of |
1770 | libev somewhere in your source tree). |
2585 | libev somewhere in your source tree). |
1771 | |
2586 | |
1772 | =head2 FILESETS |
2587 | =head2 FILESETS |
… | |
… | |
1803 | ev_vars.h |
2618 | ev_vars.h |
1804 | ev_wrap.h |
2619 | ev_wrap.h |
1805 | |
2620 | |
1806 | ev_win32.c required on win32 platforms only |
2621 | ev_win32.c required on win32 platforms only |
1807 | |
2622 | |
1808 | ev_select.c only when select backend is enabled (which is by default) |
2623 | ev_select.c only when select backend is enabled (which is enabled by default) |
1809 | ev_poll.c only when poll backend is enabled (disabled by default) |
2624 | ev_poll.c only when poll backend is enabled (disabled by default) |
1810 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2625 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
1811 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2626 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
1812 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
2627 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
1813 | |
2628 | |
… | |
… | |
1862 | |
2677 | |
1863 | If defined to be C<1>, libev will try to detect the availability of the |
2678 | If defined to be C<1>, libev will try to detect the availability of the |
1864 | monotonic clock option at both compiletime and runtime. Otherwise no use |
2679 | monotonic clock option at both compiletime and runtime. Otherwise no use |
1865 | of the monotonic clock option will be attempted. If you enable this, you |
2680 | of the monotonic clock option will be attempted. If you enable this, you |
1866 | usually have to link against librt or something similar. Enabling it when |
2681 | usually have to link against librt or something similar. Enabling it when |
1867 | the functionality isn't available is safe, though, althoguh you have |
2682 | the functionality isn't available is safe, though, although you have |
1868 | to make sure you link against any libraries where the C<clock_gettime> |
2683 | to make sure you link against any libraries where the C<clock_gettime> |
1869 | function is hiding in (often F<-lrt>). |
2684 | function is hiding in (often F<-lrt>). |
1870 | |
2685 | |
1871 | =item EV_USE_REALTIME |
2686 | =item EV_USE_REALTIME |
1872 | |
2687 | |
1873 | If defined to be C<1>, libev will try to detect the availability of the |
2688 | If defined to be C<1>, libev will try to detect the availability of the |
1874 | realtime clock option at compiletime (and assume its availability at |
2689 | realtime clock option at compiletime (and assume its availability at |
1875 | runtime if successful). Otherwise no use of the realtime clock option will |
2690 | runtime if successful). Otherwise no use of the realtime clock option will |
1876 | be attempted. This effectively replaces C<gettimeofday> by C<clock_get |
2691 | be attempted. This effectively replaces C<gettimeofday> by C<clock_get |
1877 | (CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries |
2692 | (CLOCK_REALTIME, ...)> and will not normally affect correctness. See the |
1878 | in the description of C<EV_USE_MONOTONIC>, though. |
2693 | note about libraries in the description of C<EV_USE_MONOTONIC>, though. |
|
|
2694 | |
|
|
2695 | =item EV_USE_NANOSLEEP |
|
|
2696 | |
|
|
2697 | If defined to be C<1>, libev will assume that C<nanosleep ()> is available |
|
|
2698 | and will use it for delays. Otherwise it will use C<select ()>. |
1879 | |
2699 | |
1880 | =item EV_USE_SELECT |
2700 | =item EV_USE_SELECT |
1881 | |
2701 | |
1882 | If undefined or defined to be C<1>, libev will compile in support for the |
2702 | If undefined or defined to be C<1>, libev will compile in support for the |
1883 | C<select>(2) backend. No attempt at autodetection will be done: if no |
2703 | C<select>(2) backend. No attempt at autodetection will be done: if no |
… | |
… | |
1901 | wants osf handles on win32 (this is the case when the select to |
2721 | wants osf handles on win32 (this is the case when the select to |
1902 | be used is the winsock select). This means that it will call |
2722 | be used is the winsock select). This means that it will call |
1903 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
2723 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
1904 | it is assumed that all these functions actually work on fds, even |
2724 | it is assumed that all these functions actually work on fds, even |
1905 | on win32. Should not be defined on non-win32 platforms. |
2725 | on win32. Should not be defined on non-win32 platforms. |
|
|
2726 | |
|
|
2727 | =item EV_FD_TO_WIN32_HANDLE |
|
|
2728 | |
|
|
2729 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
|
|
2730 | file descriptors to socket handles. When not defining this symbol (the |
|
|
2731 | default), then libev will call C<_get_osfhandle>, which is usually |
|
|
2732 | correct. In some cases, programs use their own file descriptor management, |
|
|
2733 | in which case they can provide this function to map fds to socket handles. |
1906 | |
2734 | |
1907 | =item EV_USE_POLL |
2735 | =item EV_USE_POLL |
1908 | |
2736 | |
1909 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
2737 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
1910 | backend. Otherwise it will be enabled on non-win32 platforms. It |
2738 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
1938 | |
2766 | |
1939 | =item EV_USE_DEVPOLL |
2767 | =item EV_USE_DEVPOLL |
1940 | |
2768 | |
1941 | reserved for future expansion, works like the USE symbols above. |
2769 | reserved for future expansion, works like the USE symbols above. |
1942 | |
2770 | |
|
|
2771 | =item EV_USE_INOTIFY |
|
|
2772 | |
|
|
2773 | If defined to be C<1>, libev will compile in support for the Linux inotify |
|
|
2774 | interface to speed up C<ev_stat> watchers. Its actual availability will |
|
|
2775 | be detected at runtime. |
|
|
2776 | |
|
|
2777 | =item EV_ATOMIC_T |
|
|
2778 | |
|
|
2779 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
|
|
2780 | access is atomic with respect to other threads or signal contexts. No such |
|
|
2781 | type is easily found in the C language, so you can provide your own type |
|
|
2782 | that you know is safe for your purposes. It is used both for signal handler "locking" |
|
|
2783 | as well as for signal and thread safety in C<ev_async> watchers. |
|
|
2784 | |
|
|
2785 | In the absense of this define, libev will use C<sig_atomic_t volatile> |
|
|
2786 | (from F<signal.h>), which is usually good enough on most platforms. |
|
|
2787 | |
1943 | =item EV_H |
2788 | =item EV_H |
1944 | |
2789 | |
1945 | The name of the F<ev.h> header file used to include it. The default if |
2790 | The name of the F<ev.h> header file used to include it. The default if |
1946 | undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This |
2791 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
1947 | can be used to virtually rename the F<ev.h> header file in case of conflicts. |
2792 | used to virtually rename the F<ev.h> header file in case of conflicts. |
1948 | |
2793 | |
1949 | =item EV_CONFIG_H |
2794 | =item EV_CONFIG_H |
1950 | |
2795 | |
1951 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
2796 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
1952 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
2797 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
1953 | C<EV_H>, above. |
2798 | C<EV_H>, above. |
1954 | |
2799 | |
1955 | =item EV_EVENT_H |
2800 | =item EV_EVENT_H |
1956 | |
2801 | |
1957 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
2802 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
1958 | of how the F<event.h> header can be found. |
2803 | of how the F<event.h> header can be found, the default is C<"event.h">. |
1959 | |
2804 | |
1960 | =item EV_PROTOTYPES |
2805 | =item EV_PROTOTYPES |
1961 | |
2806 | |
1962 | If defined to be C<0>, then F<ev.h> will not define any function |
2807 | If defined to be C<0>, then F<ev.h> will not define any function |
1963 | prototypes, but still define all the structs and other symbols. This is |
2808 | prototypes, but still define all the structs and other symbols. This is |
… | |
… | |
1970 | will have the C<struct ev_loop *> as first argument, and you can create |
2815 | will have the C<struct ev_loop *> as first argument, and you can create |
1971 | additional independent event loops. Otherwise there will be no support |
2816 | additional independent event loops. Otherwise there will be no support |
1972 | for multiple event loops and there is no first event loop pointer |
2817 | for multiple event loops and there is no first event loop pointer |
1973 | argument. Instead, all functions act on the single default loop. |
2818 | argument. Instead, all functions act on the single default loop. |
1974 | |
2819 | |
|
|
2820 | =item EV_MINPRI |
|
|
2821 | |
|
|
2822 | =item EV_MAXPRI |
|
|
2823 | |
|
|
2824 | The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to |
|
|
2825 | C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can |
|
|
2826 | provide for more priorities by overriding those symbols (usually defined |
|
|
2827 | to be C<-2> and C<2>, respectively). |
|
|
2828 | |
|
|
2829 | When doing priority-based operations, libev usually has to linearly search |
|
|
2830 | all the priorities, so having many of them (hundreds) uses a lot of space |
|
|
2831 | and time, so using the defaults of five priorities (-2 .. +2) is usually |
|
|
2832 | fine. |
|
|
2833 | |
|
|
2834 | If your embedding app does not need any priorities, defining these both to |
|
|
2835 | C<0> will save some memory and cpu. |
|
|
2836 | |
1975 | =item EV_PERIODIC_ENABLE |
2837 | =item EV_PERIODIC_ENABLE |
1976 | |
2838 | |
1977 | If undefined or defined to be C<1>, then periodic timers are supported. If |
2839 | If undefined or defined to be C<1>, then periodic timers are supported. If |
1978 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
2840 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
1979 | code. |
2841 | code. |
1980 | |
2842 | |
|
|
2843 | =item EV_IDLE_ENABLE |
|
|
2844 | |
|
|
2845 | If undefined or defined to be C<1>, then idle watchers are supported. If |
|
|
2846 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
|
|
2847 | code. |
|
|
2848 | |
1981 | =item EV_EMBED_ENABLE |
2849 | =item EV_EMBED_ENABLE |
1982 | |
2850 | |
1983 | If undefined or defined to be C<1>, then embed watchers are supported. If |
2851 | If undefined or defined to be C<1>, then embed watchers are supported. If |
1984 | defined to be C<0>, then they are not. |
2852 | defined to be C<0>, then they are not. |
1985 | |
2853 | |
… | |
… | |
1989 | defined to be C<0>, then they are not. |
2857 | defined to be C<0>, then they are not. |
1990 | |
2858 | |
1991 | =item EV_FORK_ENABLE |
2859 | =item EV_FORK_ENABLE |
1992 | |
2860 | |
1993 | If undefined or defined to be C<1>, then fork watchers are supported. If |
2861 | If undefined or defined to be C<1>, then fork watchers are supported. If |
|
|
2862 | defined to be C<0>, then they are not. |
|
|
2863 | |
|
|
2864 | =item EV_ASYNC_ENABLE |
|
|
2865 | |
|
|
2866 | If undefined or defined to be C<1>, then async watchers are supported. If |
1994 | defined to be C<0>, then they are not. |
2867 | defined to be C<0>, then they are not. |
1995 | |
2868 | |
1996 | =item EV_MINIMAL |
2869 | =item EV_MINIMAL |
1997 | |
2870 | |
1998 | If you need to shave off some kilobytes of code at the expense of some |
2871 | If you need to shave off some kilobytes of code at the expense of some |
… | |
… | |
2002 | =item EV_PID_HASHSIZE |
2875 | =item EV_PID_HASHSIZE |
2003 | |
2876 | |
2004 | C<ev_child> watchers use a small hash table to distribute workload by |
2877 | C<ev_child> watchers use a small hash table to distribute workload by |
2005 | pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more |
2878 | pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more |
2006 | than enough. If you need to manage thousands of children you might want to |
2879 | than enough. If you need to manage thousands of children you might want to |
2007 | increase this value. |
2880 | increase this value (I<must> be a power of two). |
|
|
2881 | |
|
|
2882 | =item EV_INOTIFY_HASHSIZE |
|
|
2883 | |
|
|
2884 | C<ev_stat> watchers use a small hash table to distribute workload by |
|
|
2885 | inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), |
|
|
2886 | usually more than enough. If you need to manage thousands of C<ev_stat> |
|
|
2887 | watchers you might want to increase this value (I<must> be a power of |
|
|
2888 | two). |
2008 | |
2889 | |
2009 | =item EV_COMMON |
2890 | =item EV_COMMON |
2010 | |
2891 | |
2011 | By default, all watchers have a C<void *data> member. By redefining |
2892 | By default, all watchers have a C<void *data> member. By redefining |
2012 | this macro to a something else you can include more and other types of |
2893 | this macro to a something else you can include more and other types of |
… | |
… | |
2025 | |
2906 | |
2026 | =item ev_set_cb (ev, cb) |
2907 | =item ev_set_cb (ev, cb) |
2027 | |
2908 | |
2028 | Can be used to change the callback member declaration in each watcher, |
2909 | Can be used to change the callback member declaration in each watcher, |
2029 | and the way callbacks are invoked and set. Must expand to a struct member |
2910 | and the way callbacks are invoked and set. Must expand to a struct member |
2030 | definition and a statement, respectively. See the F<ev.v> header file for |
2911 | definition and a statement, respectively. See the F<ev.h> header file for |
2031 | their default definitions. One possible use for overriding these is to |
2912 | their default definitions. One possible use for overriding these is to |
2032 | avoid the C<struct ev_loop *> as first argument in all cases, or to use |
2913 | avoid the C<struct ev_loop *> as first argument in all cases, or to use |
2033 | method calls instead of plain function calls in C++. |
2914 | method calls instead of plain function calls in C++. |
|
|
2915 | |
|
|
2916 | =head2 EXPORTED API SYMBOLS |
|
|
2917 | |
|
|
2918 | If you need to re-export the API (e.g. via a dll) and you need a list of |
|
|
2919 | exported symbols, you can use the provided F<Symbol.*> files which list |
|
|
2920 | all public symbols, one per line: |
|
|
2921 | |
|
|
2922 | Symbols.ev for libev proper |
|
|
2923 | Symbols.event for the libevent emulation |
|
|
2924 | |
|
|
2925 | This can also be used to rename all public symbols to avoid clashes with |
|
|
2926 | multiple versions of libev linked together (which is obviously bad in |
|
|
2927 | itself, but sometimes it is inconvinient to avoid this). |
|
|
2928 | |
|
|
2929 | A sed command like this will create wrapper C<#define>'s that you need to |
|
|
2930 | include before including F<ev.h>: |
|
|
2931 | |
|
|
2932 | <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h |
|
|
2933 | |
|
|
2934 | This would create a file F<wrap.h> which essentially looks like this: |
|
|
2935 | |
|
|
2936 | #define ev_backend myprefix_ev_backend |
|
|
2937 | #define ev_check_start myprefix_ev_check_start |
|
|
2938 | #define ev_check_stop myprefix_ev_check_stop |
|
|
2939 | ... |
2034 | |
2940 | |
2035 | =head2 EXAMPLES |
2941 | =head2 EXAMPLES |
2036 | |
2942 | |
2037 | For a real-world example of a program the includes libev |
2943 | For a real-world example of a program the includes libev |
2038 | verbatim, you can have a look at the EV perl module |
2944 | verbatim, you can have a look at the EV perl module |
… | |
… | |
2041 | interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file |
2947 | interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file |
2042 | will be compiled. It is pretty complex because it provides its own header |
2948 | will be compiled. It is pretty complex because it provides its own header |
2043 | file. |
2949 | file. |
2044 | |
2950 | |
2045 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
2951 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
2046 | that everybody includes and which overrides some autoconf choices: |
2952 | that everybody includes and which overrides some configure choices: |
2047 | |
2953 | |
|
|
2954 | #define EV_MINIMAL 1 |
2048 | #define EV_USE_POLL 0 |
2955 | #define EV_USE_POLL 0 |
2049 | #define EV_MULTIPLICITY 0 |
2956 | #define EV_MULTIPLICITY 0 |
2050 | #define EV_PERIODICS 0 |
2957 | #define EV_PERIODIC_ENABLE 0 |
|
|
2958 | #define EV_STAT_ENABLE 0 |
|
|
2959 | #define EV_FORK_ENABLE 0 |
2051 | #define EV_CONFIG_H <config.h> |
2960 | #define EV_CONFIG_H <config.h> |
|
|
2961 | #define EV_MINPRI 0 |
|
|
2962 | #define EV_MAXPRI 0 |
2052 | |
2963 | |
2053 | #include "ev++.h" |
2964 | #include "ev++.h" |
2054 | |
2965 | |
2055 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
2966 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
2056 | |
2967 | |
… | |
… | |
2062 | |
2973 | |
2063 | In this section the complexities of (many of) the algorithms used inside |
2974 | In this section the complexities of (many of) the algorithms used inside |
2064 | libev will be explained. For complexity discussions about backends see the |
2975 | libev will be explained. For complexity discussions about backends see the |
2065 | documentation for C<ev_default_init>. |
2976 | documentation for C<ev_default_init>. |
2066 | |
2977 | |
|
|
2978 | All of the following are about amortised time: If an array needs to be |
|
|
2979 | extended, libev needs to realloc and move the whole array, but this |
|
|
2980 | happens asymptotically never with higher number of elements, so O(1) might |
|
|
2981 | mean it might do a lengthy realloc operation in rare cases, but on average |
|
|
2982 | it is much faster and asymptotically approaches constant time. |
|
|
2983 | |
2067 | =over 4 |
2984 | =over 4 |
2068 | |
2985 | |
2069 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
2986 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
2070 | |
2987 | |
|
|
2988 | This means that, when you have a watcher that triggers in one hour and |
|
|
2989 | there are 100 watchers that would trigger before that then inserting will |
|
|
2990 | have to skip roughly seven (C<ld 100>) of these watchers. |
|
|
2991 | |
2071 | =item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) |
2992 | =item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers) |
2072 | |
2993 | |
|
|
2994 | That means that changing a timer costs less than removing/adding them |
|
|
2995 | as only the relative motion in the event queue has to be paid for. |
|
|
2996 | |
2073 | =item Starting io/check/prepare/idle/signal/child watchers: O(1) |
2997 | =item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1) |
2074 | |
2998 | |
|
|
2999 | These just add the watcher into an array or at the head of a list. |
|
|
3000 | |
2075 | =item Stopping check/prepare/idle watchers: O(1) |
3001 | =item Stopping check/prepare/idle/fork/async watchers: O(1) |
2076 | |
3002 | |
2077 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16)) |
3003 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
2078 | |
3004 | |
|
|
3005 | These watchers are stored in lists then need to be walked to find the |
|
|
3006 | correct watcher to remove. The lists are usually short (you don't usually |
|
|
3007 | have many watchers waiting for the same fd or signal). |
|
|
3008 | |
2079 | =item Finding the next timer per loop iteration: O(1) |
3009 | =item Finding the next timer in each loop iteration: O(1) |
|
|
3010 | |
|
|
3011 | By virtue of using a binary heap, the next timer is always found at the |
|
|
3012 | beginning of the storage array. |
2080 | |
3013 | |
2081 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
3014 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
2082 | |
3015 | |
2083 | =item Activating one watcher: O(1) |
3016 | A change means an I/O watcher gets started or stopped, which requires |
|
|
3017 | libev to recalculate its status (and possibly tell the kernel, depending |
|
|
3018 | on backend and wether C<ev_io_set> was used). |
|
|
3019 | |
|
|
3020 | =item Activating one watcher (putting it into the pending state): O(1) |
|
|
3021 | |
|
|
3022 | =item Priority handling: O(number_of_priorities) |
|
|
3023 | |
|
|
3024 | Priorities are implemented by allocating some space for each |
|
|
3025 | priority. When doing priority-based operations, libev usually has to |
|
|
3026 | linearly search all the priorities, but starting/stopping and activating |
|
|
3027 | watchers becomes O(1) w.r.t. priority handling. |
|
|
3028 | |
|
|
3029 | =item Sending an ev_async: O(1) |
|
|
3030 | |
|
|
3031 | =item Processing ev_async_send: O(number_of_async_watchers) |
|
|
3032 | |
|
|
3033 | =item Processing signals: O(max_signal_number) |
|
|
3034 | |
|
|
3035 | Sending involves a syscall I<iff> there were no other C<ev_async_send> |
|
|
3036 | calls in the current loop iteration. Checking for async and signal events |
|
|
3037 | involves iterating over all running async watchers or all signal numbers. |
2084 | |
3038 | |
2085 | =back |
3039 | =back |
2086 | |
3040 | |
2087 | |
3041 | |
|
|
3042 | =head1 Win32 platform limitations and workarounds |
|
|
3043 | |
|
|
3044 | Win32 doesn't support any of the standards (e.g. POSIX) that libev |
|
|
3045 | requires, and its I/O model is fundamentally incompatible with the POSIX |
|
|
3046 | model. Libev still offers limited functionality on this platform in |
|
|
3047 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
|
|
3048 | descriptors. This only applies when using Win32 natively, not when using |
|
|
3049 | e.g. cygwin. |
|
|
3050 | |
|
|
3051 | There is no supported compilation method available on windows except |
|
|
3052 | embedding it into other applications. |
|
|
3053 | |
|
|
3054 | Due to the many, low, and arbitrary limits on the win32 platform and the |
|
|
3055 | abysmal performance of winsockets, using a large number of sockets is not |
|
|
3056 | recommended (and not reasonable). If your program needs to use more than |
|
|
3057 | a hundred or so sockets, then likely it needs to use a totally different |
|
|
3058 | implementation for windows, as libev offers the POSIX model, which cannot |
|
|
3059 | be implemented efficiently on windows (microsoft monopoly games). |
|
|
3060 | |
|
|
3061 | =over 4 |
|
|
3062 | |
|
|
3063 | =item The winsocket select function |
|
|
3064 | |
|
|
3065 | The winsocket C<select> function doesn't follow POSIX in that it requires |
|
|
3066 | socket I<handles> and not socket I<file descriptors>. This makes select |
|
|
3067 | very inefficient, and also requires a mapping from file descriptors |
|
|
3068 | to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>, |
|
|
3069 | C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor |
|
|
3070 | symbols for more info. |
|
|
3071 | |
|
|
3072 | The configuration for a "naked" win32 using the microsoft runtime |
|
|
3073 | libraries and raw winsocket select is: |
|
|
3074 | |
|
|
3075 | #define EV_USE_SELECT 1 |
|
|
3076 | #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ |
|
|
3077 | |
|
|
3078 | Note that winsockets handling of fd sets is O(n), so you can easily get a |
|
|
3079 | complexity in the O(n²) range when using win32. |
|
|
3080 | |
|
|
3081 | =item Limited number of file descriptors |
|
|
3082 | |
|
|
3083 | Windows has numerous arbitrary (and low) limits on things. Early versions |
|
|
3084 | of winsocket's select only supported waiting for a max. of C<64> handles |
|
|
3085 | (probably owning to the fact that all windows kernels can only wait for |
|
|
3086 | C<64> things at the same time internally; microsoft recommends spawning a |
|
|
3087 | chain of threads and wait for 63 handles and the previous thread in each). |
|
|
3088 | |
|
|
3089 | Newer versions support more handles, but you need to define C<FD_SETSIZE> |
|
|
3090 | to some high number (e.g. C<2048>) before compiling the winsocket select |
|
|
3091 | call (which might be in libev or elsewhere, for example, perl does its own |
|
|
3092 | select emulation on windows). |
|
|
3093 | |
|
|
3094 | Another limit is the number of file descriptors in the microsoft runtime |
|
|
3095 | libraries, which by default is C<64> (there must be a hidden I<64> fetish |
|
|
3096 | or something like this inside microsoft). You can increase this by calling |
|
|
3097 | C<_setmaxstdio>, which can increase this limit to C<2048> (another |
|
|
3098 | arbitrary limit), but is broken in many versions of the microsoft runtime |
|
|
3099 | libraries. |
|
|
3100 | |
|
|
3101 | This might get you to about C<512> or C<2048> sockets (depending on |
|
|
3102 | windows version and/or the phase of the moon). To get more, you need to |
|
|
3103 | wrap all I/O functions and provide your own fd management, but the cost of |
|
|
3104 | calling select (O(n²)) will likely make this unworkable. |
|
|
3105 | |
|
|
3106 | =back |
|
|
3107 | |
|
|
3108 | |
2088 | =head1 AUTHOR |
3109 | =head1 AUTHOR |
2089 | |
3110 | |
2090 | Marc Lehmann <libev@schmorp.de>. |
3111 | Marc Lehmann <libev@schmorp.de>. |
2091 | |
3112 | |