… | |
… | |
6 | |
6 | |
7 | #include <ev.h> |
7 | #include <ev.h> |
8 | |
8 | |
9 | =head2 EXAMPLE PROGRAM |
9 | =head2 EXAMPLE PROGRAM |
10 | |
10 | |
|
|
11 | // a single header file is required |
11 | #include <ev.h> |
12 | #include <ev.h> |
12 | |
13 | |
|
|
14 | // every watcher type has its own typedef'd struct |
|
|
15 | // with the name ev_<type> |
13 | ev_io stdin_watcher; |
16 | ev_io stdin_watcher; |
14 | ev_timer timeout_watcher; |
17 | ev_timer timeout_watcher; |
15 | |
18 | |
|
|
19 | // all watcher callbacks have a similar signature |
16 | /* called when data readable on stdin */ |
20 | // this callback is called when data is readable on stdin |
17 | static void |
21 | static void |
18 | stdin_cb (EV_P_ struct ev_io *w, int revents) |
22 | stdin_cb (EV_P_ struct ev_io *w, int revents) |
19 | { |
23 | { |
20 | /* puts ("stdin ready"); */ |
24 | puts ("stdin ready"); |
21 | ev_io_stop (EV_A_ w); /* just a syntax example */ |
25 | // for one-shot events, one must manually stop the watcher |
22 | ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */ |
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); |
23 | } |
31 | } |
24 | |
32 | |
|
|
33 | // another callback, this time for a time-out |
25 | static void |
34 | static void |
26 | timeout_cb (EV_P_ struct ev_timer *w, int revents) |
35 | timeout_cb (EV_P_ struct ev_timer *w, int revents) |
27 | { |
36 | { |
28 | /* puts ("timeout"); */ |
37 | puts ("timeout"); |
29 | ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */ |
38 | // this causes the innermost ev_loop to stop iterating |
|
|
39 | ev_unloop (EV_A_ EVUNLOOP_ONE); |
30 | } |
40 | } |
31 | |
41 | |
32 | int |
42 | int |
33 | main (void) |
43 | main (void) |
34 | { |
44 | { |
|
|
45 | // use the default event loop unless you have special needs |
35 | struct ev_loop *loop = ev_default_loop (0); |
46 | struct ev_loop *loop = ev_default_loop (0); |
36 | |
47 | |
37 | /* initialise an io watcher, then start it */ |
48 | // initialise an io watcher, then start it |
|
|
49 | // this one will watch for stdin to become readable |
38 | ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
50 | ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
39 | ev_io_start (loop, &stdin_watcher); |
51 | ev_io_start (loop, &stdin_watcher); |
40 | |
52 | |
|
|
53 | // initialise a timer watcher, then start it |
41 | /* simple non-repeating 5.5 second timeout */ |
54 | // simple non-repeating 5.5 second timeout |
42 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
55 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
43 | ev_timer_start (loop, &timeout_watcher); |
56 | ev_timer_start (loop, &timeout_watcher); |
44 | |
57 | |
45 | /* loop till timeout or data ready */ |
58 | // now wait for events to arrive |
46 | ev_loop (loop, 0); |
59 | ev_loop (loop, 0); |
47 | |
60 | |
|
|
61 | // unloop was called, so exit |
48 | return 0; |
62 | return 0; |
49 | } |
63 | } |
50 | |
64 | |
51 | =head1 DESCRIPTION |
65 | =head1 DESCRIPTION |
52 | |
66 | |
53 | The newest version of this document is also available as a html-formatted |
67 | The newest version of this document is also available as an html-formatted |
54 | web page you might find easier to navigate when reading it for the first |
68 | web page you might find easier to navigate when reading it for the first |
55 | time: L<http://cvs.schmorp.de/libev/ev.html>. |
69 | time: L<http://cvs.schmorp.de/libev/ev.html>. |
56 | |
70 | |
57 | 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 |
58 | file descriptor being readable or a timeout occurring), and it will manage |
72 | file descriptor being readable or a timeout occurring), and it will manage |
… | |
… | |
84 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
98 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
85 | for example). |
99 | for example). |
86 | |
100 | |
87 | =head2 CONVENTIONS |
101 | =head2 CONVENTIONS |
88 | |
102 | |
89 | Libev is very configurable. In this manual the default configuration will |
103 | Libev is very configurable. In this manual the default (and most common) |
90 | be described, which supports multiple event loops. For more info about |
104 | configuration will be described, which supports multiple event loops. For |
91 | various configuration options please have a look at B<EMBED> section in |
105 | more info about various configuration options please have a look at |
92 | this manual. If libev was configured without support for multiple event |
106 | B<EMBED> section in this manual. If libev was configured without support |
93 | loops, then all functions taking an initial argument of name C<loop> |
107 | for multiple event loops, then all functions taking an initial argument of |
94 | (which is always of type C<struct ev_loop *>) will not have this argument. |
108 | name C<loop> (which is always of type C<struct ev_loop *>) will not have |
|
|
109 | this argument. |
95 | |
110 | |
96 | =head2 TIME REPRESENTATION |
111 | =head2 TIME REPRESENTATION |
97 | |
112 | |
98 | Libev represents time as a single floating point number, representing the |
113 | Libev represents time as a single floating point number, representing the |
99 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
114 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
… | |
… | |
181 | See the description of C<ev_embed> watchers for more info. |
196 | See the description of C<ev_embed> watchers for more info. |
182 | |
197 | |
183 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) |
198 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) |
184 | |
199 | |
185 | Sets the allocation function to use (the prototype is similar - the |
200 | Sets the allocation function to use (the prototype is similar - the |
186 | semantics is identical - to the realloc C function). It is used to |
201 | semantics are identical to the C<realloc> C89/SuS/POSIX function). It is |
187 | allocate and free memory (no surprises here). If it returns zero when |
202 | used to allocate and free memory (no surprises here). If it returns zero |
188 | memory needs to be allocated, the library might abort or take some |
203 | when memory needs to be allocated (C<size != 0>), the library might abort |
189 | potentially destructive action. The default is your system realloc |
204 | or take some potentially destructive action. |
190 | function. |
205 | |
|
|
206 | Since some systems (at least OpenBSD and Darwin) fail to implement |
|
|
207 | correct C<realloc> semantics, libev will use a wrapper around the system |
|
|
208 | C<realloc> and C<free> functions by default. |
191 | |
209 | |
192 | You could override this function in high-availability programs to, say, |
210 | You could override this function in high-availability programs to, say, |
193 | free some memory if it cannot allocate memory, to use a special allocator, |
211 | free some memory if it cannot allocate memory, to use a special allocator, |
194 | or even to sleep a while and retry until some memory is available. |
212 | or even to sleep a while and retry until some memory is available. |
195 | |
213 | |
196 | Example: Replace the libev allocator with one that waits a bit and then |
214 | Example: Replace the libev allocator with one that waits a bit and then |
197 | retries). |
215 | retries (example requires a standards-compliant C<realloc>). |
198 | |
216 | |
199 | static void * |
217 | static void * |
200 | persistent_realloc (void *ptr, size_t size) |
218 | persistent_realloc (void *ptr, size_t size) |
201 | { |
219 | { |
202 | for (;;) |
220 | for (;;) |
… | |
… | |
241 | |
259 | |
242 | An event loop is described by a C<struct ev_loop *>. The library knows two |
260 | An event loop is described by a C<struct ev_loop *>. The library knows two |
243 | types of such loops, the I<default> loop, which supports signals and child |
261 | types of such loops, the I<default> loop, which supports signals and child |
244 | events, and dynamically created loops which do not. |
262 | events, and dynamically created loops which do not. |
245 | |
263 | |
246 | If you use threads, a common model is to run the default event loop |
|
|
247 | in your main thread (or in a separate thread) and for each thread you |
|
|
248 | create, you also create another event loop. Libev itself does no locking |
|
|
249 | whatsoever, so if you mix calls to the same event loop in different |
|
|
250 | threads, make sure you lock (this is usually a bad idea, though, even if |
|
|
251 | done correctly, because it's hideous and inefficient). |
|
|
252 | |
|
|
253 | =over 4 |
264 | =over 4 |
254 | |
265 | |
255 | =item struct ev_loop *ev_default_loop (unsigned int flags) |
266 | =item struct ev_loop *ev_default_loop (unsigned int flags) |
256 | |
267 | |
257 | This will initialise the default event loop if it hasn't been initialised |
268 | This will initialise the default event loop if it hasn't been initialised |
… | |
… | |
259 | false. If it already was initialised it simply returns it (and ignores the |
270 | false. If it already was initialised it simply returns it (and ignores the |
260 | flags. If that is troubling you, check C<ev_backend ()> afterwards). |
271 | flags. If that is troubling you, check C<ev_backend ()> afterwards). |
261 | |
272 | |
262 | If you don't know what event loop to use, use the one returned from this |
273 | If you don't know what event loop to use, use the one returned from this |
263 | function. |
274 | function. |
|
|
275 | |
|
|
276 | Note that this function is I<not> thread-safe, so if you want to use it |
|
|
277 | from multiple threads, you have to lock (note also that this is unlikely, |
|
|
278 | as loops cannot bes hared easily between threads anyway). |
264 | |
279 | |
265 | The default loop is the only loop that can handle C<ev_signal> and |
280 | The default loop is the only loop that can handle C<ev_signal> and |
266 | C<ev_child> watchers, and to do this, it always registers a handler |
281 | C<ev_child> watchers, and to do this, it always registers a handler |
267 | for C<SIGCHLD>. If this is a problem for your app you can either |
282 | for C<SIGCHLD>. If this is a problem for your app you can either |
268 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
283 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
… | |
… | |
297 | enabling this flag. |
312 | enabling this flag. |
298 | |
313 | |
299 | This works by calling C<getpid ()> on every iteration of the loop, |
314 | This works by calling C<getpid ()> on every iteration of the loop, |
300 | and thus this might slow down your event loop if you do a lot of loop |
315 | and thus this might slow down your event loop if you do a lot of loop |
301 | iterations and little real work, but is usually not noticeable (on my |
316 | iterations and little real work, but is usually not noticeable (on my |
302 | Linux system for example, C<getpid> is actually a simple 5-insn sequence |
317 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence |
303 | without a syscall and thus I<very> fast, but my Linux system also has |
318 | without a syscall and thus I<very> fast, but my GNU/Linux system also has |
304 | C<pthread_atfork> which is even faster). |
319 | C<pthread_atfork> which is even faster). |
305 | |
320 | |
306 | The big advantage of this flag is that you can forget about fork (and |
321 | The big advantage of this flag is that you can forget about fork (and |
307 | forget about forgetting to tell libev about forking) when you use this |
322 | forget about forgetting to tell libev about forking) when you use this |
308 | flag. |
323 | flag. |
… | |
… | |
339 | 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, |
340 | but it scales phenomenally better. While poll and select usually scale |
355 | but it scales phenomenally better. While poll and select usually scale |
341 | like O(total_fds) where n is the total number of fds (or the highest fd), |
356 | like O(total_fds) where n is the total number of fds (or the highest fd), |
342 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
357 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
343 | of shortcomings, such as silently dropping events in some hard-to-detect |
358 | of shortcomings, such as silently dropping events in some hard-to-detect |
344 | cases and rewiring a syscall per fd change, no fork support and bad |
359 | cases and requiring a syscall per fd change, no fork support and bad |
345 | support for dup. |
360 | support for dup. |
346 | |
361 | |
347 | While stopping, setting and starting an I/O watcher in the same iteration |
362 | While stopping, setting and starting an I/O watcher in the same iteration |
348 | will 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 |
349 | (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 |
… | |
… | |
450 | |
465 | |
451 | 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 |
452 | 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 |
453 | 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 |
454 | undefined behaviour (or a failed assertion if assertions are enabled). |
469 | undefined behaviour (or a failed assertion if assertions are enabled). |
|
|
470 | |
|
|
471 | Note that this function I<is> thread-safe, and the recommended way to use |
|
|
472 | libev with threads is indeed to create one loop per thread, and using the |
|
|
473 | default loop in the "main" or "initial" thread. |
455 | |
474 | |
456 | Example: Try to create a event loop that uses epoll and nothing else. |
475 | Example: Try to create a event loop that uses epoll and nothing else. |
457 | |
476 | |
458 | struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
477 | struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
459 | if (!epoller) |
478 | if (!epoller) |
… | |
… | |
1070 | To support fork in your programs, you either have to call |
1089 | To support fork in your programs, you either have to call |
1071 | C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child, |
1090 | C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child, |
1072 | enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or |
1091 | enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or |
1073 | C<EVBACKEND_POLL>. |
1092 | C<EVBACKEND_POLL>. |
1074 | |
1093 | |
|
|
1094 | =head3 The special problem of SIGPIPE |
|
|
1095 | |
|
|
1096 | While not really specific to libev, it is easy to forget about SIGPIPE: |
|
|
1097 | when reading from a pipe whose other end has been closed, your program |
|
|
1098 | gets send a SIGPIPE, which, by default, aborts your program. For most |
|
|
1099 | programs this is sensible behaviour, for daemons, this is usually |
|
|
1100 | undesirable. |
|
|
1101 | |
|
|
1102 | So when you encounter spurious, unexplained daemon exits, make sure you |
|
|
1103 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
|
|
1104 | somewhere, as that would have given you a big clue). |
|
|
1105 | |
1075 | |
1106 | |
1076 | =head3 Watcher-Specific Functions |
1107 | =head3 Watcher-Specific Functions |
1077 | |
1108 | |
1078 | =over 4 |
1109 | =over 4 |
1079 | |
1110 | |
… | |
… | |
1419 | with the kernel (thus it coexists with your own signal handlers as long |
1450 | with the kernel (thus it coexists with your own signal handlers as long |
1420 | as you don't register any with libev). Similarly, when the last signal |
1451 | as you don't register any with libev). Similarly, when the last signal |
1421 | watcher for a signal is stopped libev will reset the signal handler to |
1452 | watcher for a signal is stopped libev will reset the signal handler to |
1422 | SIG_DFL (regardless of what it was set to before). |
1453 | SIG_DFL (regardless of what it was set to before). |
1423 | |
1454 | |
|
|
1455 | If possible and supported, libev will install its handlers with |
|
|
1456 | C<SA_RESTART> behaviour enabled, so syscalls should not be unduly |
|
|
1457 | interrupted. If you have a problem with syscalls getting interrupted by |
|
|
1458 | signals you can block all signals in an C<ev_check> watcher and unblock |
|
|
1459 | them in an C<ev_prepare> watcher. |
|
|
1460 | |
1424 | =head3 Watcher-Specific Functions and Data Members |
1461 | =head3 Watcher-Specific Functions and Data Members |
1425 | |
1462 | |
1426 | =over 4 |
1463 | =over 4 |
1427 | |
1464 | |
1428 | =item ev_signal_init (ev_signal *, callback, int signum) |
1465 | =item ev_signal_init (ev_signal *, callback, int signum) |
… | |
… | |
1454 | |
1491 | |
1455 | |
1492 | |
1456 | =head2 C<ev_child> - watch out for process status changes |
1493 | =head2 C<ev_child> - watch out for process status changes |
1457 | |
1494 | |
1458 | Child watchers trigger when your process receives a SIGCHLD in response to |
1495 | Child watchers trigger when your process receives a SIGCHLD in response to |
1459 | some child status changes (most typically when a child of yours dies). |
1496 | some child status changes (most typically when a child of yours dies). It |
|
|
1497 | is permissible to install a child watcher I<after> the child has been |
|
|
1498 | forked (which implies it might have already exited), as long as the event |
|
|
1499 | loop isn't entered (or is continued from a watcher). |
|
|
1500 | |
|
|
1501 | Only the default event loop is capable of handling signals, and therefore |
|
|
1502 | you can only rgeister child watchers in the default event loop. |
|
|
1503 | |
|
|
1504 | =head3 Process Interaction |
|
|
1505 | |
|
|
1506 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
|
|
1507 | initialised. This is necessary to guarantee proper behaviour even if |
|
|
1508 | the first child watcher is started after the child exits. The occurance |
|
|
1509 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
|
|
1510 | synchronously as part of the event loop processing. Libev always reaps all |
|
|
1511 | children, even ones not watched. |
|
|
1512 | |
|
|
1513 | =head3 Overriding the Built-In Processing |
|
|
1514 | |
|
|
1515 | Libev offers no special support for overriding the built-in child |
|
|
1516 | processing, but if your application collides with libev's default child |
|
|
1517 | handler, you can override it easily by installing your own handler for |
|
|
1518 | C<SIGCHLD> after initialising the default loop, and making sure the |
|
|
1519 | default loop never gets destroyed. You are encouraged, however, to use an |
|
|
1520 | event-based approach to child reaping and thus use libev's support for |
|
|
1521 | that, so other libev users can use C<ev_child> watchers freely. |
1460 | |
1522 | |
1461 | =head3 Watcher-Specific Functions and Data Members |
1523 | =head3 Watcher-Specific Functions and Data Members |
1462 | |
1524 | |
1463 | =over 4 |
1525 | =over 4 |
1464 | |
1526 | |
… | |
… | |
1488 | The process exit/trace status caused by C<rpid> (see your systems |
1550 | The process exit/trace status caused by C<rpid> (see your systems |
1489 | C<waitpid> and C<sys/wait.h> documentation for details). |
1551 | C<waitpid> and C<sys/wait.h> documentation for details). |
1490 | |
1552 | |
1491 | =back |
1553 | =back |
1492 | |
1554 | |
|
|
1555 | =head3 Examples |
|
|
1556 | |
|
|
1557 | Example: C<fork()> a new process and install a child handler to wait for |
|
|
1558 | its completion. |
|
|
1559 | |
|
|
1560 | ev_child cw; |
|
|
1561 | |
|
|
1562 | static void |
|
|
1563 | child_cb (EV_P_ struct ev_child *w, int revents) |
|
|
1564 | { |
|
|
1565 | ev_child_stop (EV_A_ w); |
|
|
1566 | printf ("process %d exited with status %x\n", w->rpid, w->rstatus); |
|
|
1567 | } |
|
|
1568 | |
|
|
1569 | pid_t pid = fork (); |
|
|
1570 | |
|
|
1571 | if (pid < 0) |
|
|
1572 | // error |
|
|
1573 | else if (pid == 0) |
|
|
1574 | { |
|
|
1575 | // the forked child executes here |
|
|
1576 | exit (1); |
|
|
1577 | } |
|
|
1578 | else |
|
|
1579 | { |
|
|
1580 | ev_child_init (&cw, child_cb, pid, 0); |
|
|
1581 | ev_child_start (EV_DEFAULT_ &cw); |
|
|
1582 | } |
|
|
1583 | |
1493 | |
1584 | |
1494 | =head2 C<ev_stat> - did the file attributes just change? |
1585 | =head2 C<ev_stat> - did the file attributes just change? |
1495 | |
1586 | |
1496 | This watches a filesystem path for attribute changes. That is, it calls |
1587 | This watches a filesystem path for attribute changes. That is, it calls |
1497 | C<stat> regularly (or when the OS says it changed) and sees if it changed |
1588 | C<stat> regularly (or when the OS says it changed) and sees if it changed |
… | |
… | |
1524 | reader). Inotify will be used to give hints only and should not change the |
1615 | reader). Inotify will be used to give hints only and should not change the |
1525 | semantics of C<ev_stat> watchers, which means that libev sometimes needs |
1616 | semantics of C<ev_stat> watchers, which means that libev sometimes needs |
1526 | to fall back to regular polling again even with inotify, but changes are |
1617 | to fall back to regular polling again even with inotify, but changes are |
1527 | usually detected immediately, and if the file exists there will be no |
1618 | usually detected immediately, and if the file exists there will be no |
1528 | polling. |
1619 | polling. |
|
|
1620 | |
|
|
1621 | =head3 ABI Issues (Largefile Support) |
|
|
1622 | |
|
|
1623 | Libev by default (unless the user overrides this) uses the default |
|
|
1624 | compilation environment, which means that on systems with optionally |
|
|
1625 | disabled large file support, you get the 32 bit version of the stat |
|
|
1626 | structure. When using the library from programs that change the ABI to |
|
|
1627 | use 64 bit file offsets the programs will fail. In that case you have to |
|
|
1628 | compile libev with the same flags to get binary compatibility. This is |
|
|
1629 | obviously the case with any flags that change the ABI, but the problem is |
|
|
1630 | most noticably with ev_stat and largefile support. |
1529 | |
1631 | |
1530 | =head3 Inotify |
1632 | =head3 Inotify |
1531 | |
1633 | |
1532 | When C<inotify (7)> support has been compiled into libev (generally only |
1634 | When C<inotify (7)> support has been compiled into libev (generally only |
1533 | available on Linux) and present at runtime, it will be used to speed up |
1635 | available on Linux) and present at runtime, it will be used to speed up |
… | |
… | |
2182 | |
2284 | |
2183 | This call incurs the overhead of a syscall only once per loop iteration, |
2285 | This call incurs the overhead of a syscall only once per loop iteration, |
2184 | so while the overhead might be noticable, it doesn't apply to repeated |
2286 | so while the overhead might be noticable, it doesn't apply to repeated |
2185 | calls to C<ev_async_send>. |
2287 | calls to C<ev_async_send>. |
2186 | |
2288 | |
|
|
2289 | =item bool = ev_async_pending (ev_async *) |
|
|
2290 | |
|
|
2291 | Returns a non-zero value when C<ev_async_send> has been called on the |
|
|
2292 | watcher but the event has not yet been processed (or even noted) by the |
|
|
2293 | event loop. |
|
|
2294 | |
|
|
2295 | C<ev_async_send> sets a flag in the watcher and wakes up the loop. When |
|
|
2296 | the loop iterates next and checks for the watcher to have become active, |
|
|
2297 | it will reset the flag again. C<ev_async_pending> can be used to very |
|
|
2298 | quickly check wether invoking the loop might be a good idea. |
|
|
2299 | |
|
|
2300 | Not that this does I<not> check wether the watcher itself is pending, only |
|
|
2301 | wether it has been requested to make this watcher pending. |
|
|
2302 | |
2187 | =back |
2303 | =back |
2188 | |
2304 | |
2189 | |
2305 | |
2190 | =head1 OTHER FUNCTIONS |
2306 | =head1 OTHER FUNCTIONS |
2191 | |
2307 | |
… | |
… | |
2262 | |
2378 | |
2263 | =item * Priorities are not currently supported. Initialising priorities |
2379 | =item * Priorities are not currently supported. Initialising priorities |
2264 | will fail and all watchers will have the same priority, even though there |
2380 | will fail and all watchers will have the same priority, even though there |
2265 | is an ev_pri field. |
2381 | is an ev_pri field. |
2266 | |
2382 | |
|
|
2383 | =item * In libevent, the last base created gets the signals, in libev, the |
|
|
2384 | first base created (== the default loop) gets the signals. |
|
|
2385 | |
2267 | =item * Other members are not supported. |
2386 | =item * Other members are not supported. |
2268 | |
2387 | |
2269 | =item * The libev emulation is I<not> ABI compatible to libevent, you need |
2388 | =item * The libev emulation is I<not> ABI compatible to libevent, you need |
2270 | to use the libev header file and library. |
2389 | to use the libev header file and library. |
2271 | |
2390 | |
… | |
… | |
2434 | io.start (fd, ev::READ); |
2553 | io.start (fd, ev::READ); |
2435 | } |
2554 | } |
2436 | }; |
2555 | }; |
2437 | |
2556 | |
2438 | |
2557 | |
|
|
2558 | =head1 OTHER LANGUAGE BINDINGS |
|
|
2559 | |
|
|
2560 | Libev does not offer other language bindings itself, but bindings for a |
|
|
2561 | numbe rof languages exist in the form of third-party packages. If you know |
|
|
2562 | any interesting language binding in addition to the ones listed here, drop |
|
|
2563 | me a note. |
|
|
2564 | |
|
|
2565 | =over 4 |
|
|
2566 | |
|
|
2567 | =item Perl |
|
|
2568 | |
|
|
2569 | The EV module implements the full libev API and is actually used to test |
|
|
2570 | libev. EV is developed together with libev. Apart from the EV core module, |
|
|
2571 | there are additional modules that implement libev-compatible interfaces |
|
|
2572 | to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the |
|
|
2573 | C<libglib> event core (C<Glib::EV> and C<EV::Glib>). |
|
|
2574 | |
|
|
2575 | It can be found and installed via CPAN, its homepage is found at |
|
|
2576 | L<http://software.schmorp.de/pkg/EV>. |
|
|
2577 | |
|
|
2578 | =item Ruby |
|
|
2579 | |
|
|
2580 | Tony Arcieri has written a ruby extension that offers access to a subset |
|
|
2581 | of the libev API and adds filehandle abstractions, asynchronous DNS and |
|
|
2582 | more on top of it. It can be found via gem servers. Its homepage is at |
|
|
2583 | L<http://rev.rubyforge.org/>. |
|
|
2584 | |
|
|
2585 | =item D |
|
|
2586 | |
|
|
2587 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
|
|
2588 | be found at L<http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>. |
|
|
2589 | |
|
|
2590 | =back |
|
|
2591 | |
|
|
2592 | |
2439 | =head1 MACRO MAGIC |
2593 | =head1 MACRO MAGIC |
2440 | |
2594 | |
2441 | Libev can be compiled with a variety of options, the most fundamantal |
2595 | Libev can be compiled with a variety of options, the most fundamantal |
2442 | of which is C<EV_MULTIPLICITY>. This option determines whether (most) |
2596 | of which is C<EV_MULTIPLICITY>. This option determines whether (most) |
2443 | functions and callbacks have an initial C<struct ev_loop *> argument. |
2597 | functions and callbacks have an initial C<struct ev_loop *> argument. |
… | |
… | |
2477 | |
2631 | |
2478 | =item C<EV_DEFAULT>, C<EV_DEFAULT_> |
2632 | =item C<EV_DEFAULT>, C<EV_DEFAULT_> |
2479 | |
2633 | |
2480 | Similar to the other two macros, this gives you the value of the default |
2634 | Similar to the other two macros, this gives you the value of the default |
2481 | loop, if multiple loops are supported ("ev loop default"). |
2635 | loop, if multiple loops are supported ("ev loop default"). |
|
|
2636 | |
|
|
2637 | =item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> |
|
|
2638 | |
|
|
2639 | Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the |
|
|
2640 | default loop has been initialised (C<UC> == unchecked). Their behaviour |
|
|
2641 | is undefined when the default loop has not been initialised by a previous |
|
|
2642 | execution of C<EV_DEFAULT>, C<EV_DEFAULT_> or C<ev_default_init (...)>. |
|
|
2643 | |
|
|
2644 | It is often prudent to use C<EV_DEFAULT> when initialising the first |
|
|
2645 | watcher in a function but use C<EV_DEFAULT_UC> afterwards. |
2482 | |
2646 | |
2483 | =back |
2647 | =back |
2484 | |
2648 | |
2485 | Example: Declare and initialise a check watcher, utilising the above |
2649 | Example: Declare and initialise a check watcher, utilising the above |
2486 | macros so it will work regardless of whether multiple loops are supported |
2650 | macros so it will work regardless of whether multiple loops are supported |
… | |
… | |
2582 | |
2746 | |
2583 | libev.m4 |
2747 | libev.m4 |
2584 | |
2748 | |
2585 | =head2 PREPROCESSOR SYMBOLS/MACROS |
2749 | =head2 PREPROCESSOR SYMBOLS/MACROS |
2586 | |
2750 | |
2587 | Libev can be configured via a variety of preprocessor symbols you have to define |
2751 | Libev can be configured via a variety of preprocessor symbols you have to |
2588 | before including any of its files. The default is not to build for multiplicity |
2752 | define before including any of its files. The default in the absense of |
2589 | and only include the select backend. |
2753 | autoconf is noted for every option. |
2590 | |
2754 | |
2591 | =over 4 |
2755 | =over 4 |
2592 | |
2756 | |
2593 | =item EV_STANDALONE |
2757 | =item EV_STANDALONE |
2594 | |
2758 | |
… | |
… | |
2620 | =item EV_USE_NANOSLEEP |
2784 | =item EV_USE_NANOSLEEP |
2621 | |
2785 | |
2622 | If defined to be C<1>, libev will assume that C<nanosleep ()> is available |
2786 | If defined to be C<1>, libev will assume that C<nanosleep ()> is available |
2623 | and will use it for delays. Otherwise it will use C<select ()>. |
2787 | and will use it for delays. Otherwise it will use C<select ()>. |
2624 | |
2788 | |
|
|
2789 | =item EV_USE_EVENTFD |
|
|
2790 | |
|
|
2791 | If defined to be C<1>, then libev will assume that C<eventfd ()> is |
|
|
2792 | available and will probe for kernel support at runtime. This will improve |
|
|
2793 | C<ev_signal> and C<ev_async> performance and reduce resource consumption. |
|
|
2794 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
|
|
2795 | 2.7 or newer, otherwise disabled. |
|
|
2796 | |
2625 | =item EV_USE_SELECT |
2797 | =item EV_USE_SELECT |
2626 | |
2798 | |
2627 | If undefined or defined to be C<1>, libev will compile in support for the |
2799 | If undefined or defined to be C<1>, libev will compile in support for the |
2628 | C<select>(2) backend. No attempt at autodetection will be done: if no |
2800 | C<select>(2) backend. No attempt at autodetection will be done: if no |
2629 | other method takes over, select will be it. Otherwise the select backend |
2801 | other method takes over, select will be it. Otherwise the select backend |
… | |
… | |
2665 | |
2837 | |
2666 | =item EV_USE_EPOLL |
2838 | =item EV_USE_EPOLL |
2667 | |
2839 | |
2668 | If defined to be C<1>, libev will compile in support for the Linux |
2840 | If defined to be C<1>, libev will compile in support for the Linux |
2669 | C<epoll>(7) backend. Its availability will be detected at runtime, |
2841 | C<epoll>(7) backend. Its availability will be detected at runtime, |
2670 | otherwise another method will be used as fallback. This is the |
2842 | otherwise another method will be used as fallback. This is the preferred |
2671 | preferred backend for GNU/Linux systems. |
2843 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
|
|
2844 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
2672 | |
2845 | |
2673 | =item EV_USE_KQUEUE |
2846 | =item EV_USE_KQUEUE |
2674 | |
2847 | |
2675 | If defined to be C<1>, libev will compile in support for the BSD style |
2848 | If defined to be C<1>, libev will compile in support for the BSD style |
2676 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
2849 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
… | |
… | |
2695 | |
2868 | |
2696 | =item EV_USE_INOTIFY |
2869 | =item EV_USE_INOTIFY |
2697 | |
2870 | |
2698 | If defined to be C<1>, libev will compile in support for the Linux inotify |
2871 | If defined to be C<1>, libev will compile in support for the Linux inotify |
2699 | interface to speed up C<ev_stat> watchers. Its actual availability will |
2872 | interface to speed up C<ev_stat> watchers. Its actual availability will |
2700 | be detected at runtime. |
2873 | be detected at runtime. If undefined, it will be enabled if the headers |
|
|
2874 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
2701 | |
2875 | |
2702 | =item EV_ATOMIC_T |
2876 | =item EV_ATOMIC_T |
2703 | |
2877 | |
2704 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
2878 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
2705 | access is atomic with respect to other threads or signal contexts. No such |
2879 | access is atomic with respect to other threads or signal contexts. No such |
… | |
… | |
2892 | |
3066 | |
2893 | #include "ev_cpp.h" |
3067 | #include "ev_cpp.h" |
2894 | #include "ev.c" |
3068 | #include "ev.c" |
2895 | |
3069 | |
2896 | |
3070 | |
|
|
3071 | =head1 THREADS AND COROUTINES |
|
|
3072 | |
|
|
3073 | =head2 THREADS |
|
|
3074 | |
|
|
3075 | Libev itself is completely threadsafe, but it uses no locking. This |
|
|
3076 | means that you can use as many loops as you want in parallel, as long as |
|
|
3077 | only one thread ever calls into one libev function with the same loop |
|
|
3078 | parameter. |
|
|
3079 | |
|
|
3080 | Or put differently: calls with different loop parameters can be done in |
|
|
3081 | parallel from multiple threads, calls with the same loop parameter must be |
|
|
3082 | done serially (but can be done from different threads, as long as only one |
|
|
3083 | thread ever is inside a call at any point in time, e.g. by using a mutex |
|
|
3084 | per loop). |
|
|
3085 | |
|
|
3086 | If you want to know which design is best for your problem, then I cannot |
|
|
3087 | help you but by giving some generic advice: |
|
|
3088 | |
|
|
3089 | =over 4 |
|
|
3090 | |
|
|
3091 | =item * most applications have a main thread: use the default libev loop |
|
|
3092 | in that thread, or create a seperate thread running only the default loop. |
|
|
3093 | |
|
|
3094 | This helps integrating other libraries or software modules that use libev |
|
|
3095 | themselves and don't care/know about threading. |
|
|
3096 | |
|
|
3097 | =item * one loop per thread is usually a good model. |
|
|
3098 | |
|
|
3099 | Doing this is almost never wrong, sometimes a better-performance model |
|
|
3100 | exists, but it is always a good start. |
|
|
3101 | |
|
|
3102 | =item * other models exist, such as the leader/follower pattern, where one |
|
|
3103 | loop is handed through multiple threads in a kind of round-robbin fashion. |
|
|
3104 | |
|
|
3105 | Chosing a model is hard - look around, learn, know that usually you cna do |
|
|
3106 | better than you currently do :-) |
|
|
3107 | |
|
|
3108 | =item * often you need to talk to some other thread which blocks in the |
|
|
3109 | event loop - C<ev_async> watchers can be used to wake them up from other |
|
|
3110 | threads safely (or from signal contexts...). |
|
|
3111 | |
|
|
3112 | =back |
|
|
3113 | |
|
|
3114 | =head2 COROUTINES |
|
|
3115 | |
|
|
3116 | Libev is much more accomodating to coroutines ("cooperative threads"): |
|
|
3117 | libev fully supports nesting calls to it's functions from different |
|
|
3118 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
|
|
3119 | different coroutines and switch freely between both coroutines running the |
|
|
3120 | loop, as long as you don't confuse yourself). The only exception is that |
|
|
3121 | you must not do this from C<ev_periodic> reschedule callbacks. |
|
|
3122 | |
|
|
3123 | Care has been invested into making sure that libev does not keep local |
|
|
3124 | state inside C<ev_loop>, and other calls do not usually allow coroutine |
|
|
3125 | switches. |
|
|
3126 | |
|
|
3127 | |
2897 | =head1 COMPLEXITIES |
3128 | =head1 COMPLEXITIES |
2898 | |
3129 | |
2899 | In this section the complexities of (many of) the algorithms used inside |
3130 | In this section the complexities of (many of) the algorithms used inside |
2900 | libev will be explained. For complexity discussions about backends see the |
3131 | libev will be explained. For complexity discussions about backends see the |
2901 | documentation for C<ev_default_init>. |
3132 | documentation for C<ev_default_init>. |