… | |
… | |
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 |
… | |
… | |
260 | flags. If that is troubling you, check C<ev_backend ()> afterwards). |
275 | flags. If that is troubling you, check C<ev_backend ()> afterwards). |
261 | |
276 | |
262 | 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 |
263 | function. |
278 | function. |
264 | |
279 | |
|
|
280 | Note that this function is I<not> thread-safe, so if you want to use it |
|
|
281 | from multiple threads, you have to lock (note also that this is unlikely, |
|
|
282 | as loops cannot bes hared easily between threads anyway). |
|
|
283 | |
265 | The default loop is the only loop that can handle C<ev_signal> and |
284 | 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 |
285 | 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 |
286 | 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 |
287 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
269 | can simply overwrite the C<SIGCHLD> signal handler I<after> calling |
288 | can simply overwrite the C<SIGCHLD> signal handler I<after> calling |
… | |
… | |
297 | enabling this flag. |
316 | enabling this flag. |
298 | |
317 | |
299 | This works by calling C<getpid ()> on every iteration of the loop, |
318 | 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 |
319 | 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 |
320 | 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 |
321 | 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 |
322 | without a syscall and thus I<very> fast, but my GNU/Linux system also has |
304 | C<pthread_atfork> which is even faster). |
323 | C<pthread_atfork> which is even faster). |
305 | |
324 | |
306 | The big advantage of this flag is that you can forget about fork (and |
325 | 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 |
326 | forget about forgetting to tell libev about forking) when you use this |
308 | flag. |
327 | flag. |
… | |
… | |
450 | |
469 | |
451 | Similar to C<ev_default_loop>, but always creates a new event loop that is |
470 | 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 |
471 | 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 |
472 | 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). |
473 | undefined behaviour (or a failed assertion if assertions are enabled). |
|
|
474 | |
|
|
475 | Note that this function I<is> thread-safe, and the recommended way to use |
|
|
476 | libev with threads is indeed to create one loop per thread, and using the |
|
|
477 | default loop in the "main" or "initial" thread. |
455 | |
478 | |
456 | Example: Try to create a event loop that uses epoll and nothing else. |
479 | Example: Try to create a event loop that uses epoll and nothing else. |
457 | |
480 | |
458 | struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
481 | struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
459 | if (!epoller) |
482 | if (!epoller) |
… | |
… | |
1070 | To support fork in your programs, you either have to call |
1093 | 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, |
1094 | 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 |
1095 | enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or |
1073 | C<EVBACKEND_POLL>. |
1096 | C<EVBACKEND_POLL>. |
1074 | |
1097 | |
|
|
1098 | =head3 The special problem of SIGPIPE |
|
|
1099 | |
|
|
1100 | While not really specific to libev, it is easy to forget about SIGPIPE: |
|
|
1101 | when reading from a pipe whose other end has been closed, your program |
|
|
1102 | gets send a SIGPIPE, which, by default, aborts your program. For most |
|
|
1103 | programs this is sensible behaviour, for daemons, this is usually |
|
|
1104 | undesirable. |
|
|
1105 | |
|
|
1106 | So when you encounter spurious, unexplained daemon exits, make sure you |
|
|
1107 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
|
|
1108 | somewhere, as that would have given you a big clue). |
|
|
1109 | |
1075 | |
1110 | |
1076 | =head3 Watcher-Specific Functions |
1111 | =head3 Watcher-Specific Functions |
1077 | |
1112 | |
1078 | =over 4 |
1113 | =over 4 |
1079 | |
1114 | |
… | |
… | |
1418 | first watcher gets started will libev actually register a signal watcher |
1453 | first watcher gets started will libev actually register a signal watcher |
1419 | with the kernel (thus it coexists with your own signal handlers as long |
1454 | 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 |
1455 | 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 |
1456 | watcher for a signal is stopped libev will reset the signal handler to |
1422 | SIG_DFL (regardless of what it was set to before). |
1457 | SIG_DFL (regardless of what it was set to before). |
|
|
1458 | |
|
|
1459 | If possible and supported, libev will install its handlers with |
|
|
1460 | C<SA_RESTART> behaviour enabled, so syscalls should not be unduly |
|
|
1461 | interrupted. If you have a problem with syscalls getting interrupted by |
|
|
1462 | signals you can block all signals in an C<ev_check> watcher and unblock |
|
|
1463 | them in an C<ev_prepare> watcher. |
1423 | |
1464 | |
1424 | =head3 Watcher-Specific Functions and Data Members |
1465 | =head3 Watcher-Specific Functions and Data Members |
1425 | |
1466 | |
1426 | =over 4 |
1467 | =over 4 |
1427 | |
1468 | |
… | |
… | |
1578 | reader). Inotify will be used to give hints only and should not change the |
1619 | reader). Inotify will be used to give hints only and should not change the |
1579 | semantics of C<ev_stat> watchers, which means that libev sometimes needs |
1620 | semantics of C<ev_stat> watchers, which means that libev sometimes needs |
1580 | to fall back to regular polling again even with inotify, but changes are |
1621 | to fall back to regular polling again even with inotify, but changes are |
1581 | usually detected immediately, and if the file exists there will be no |
1622 | usually detected immediately, and if the file exists there will be no |
1582 | polling. |
1623 | polling. |
|
|
1624 | |
|
|
1625 | =head3 ABI Issues (Largefile Support) |
|
|
1626 | |
|
|
1627 | Libev by default (unless the user overrides this) uses the default |
|
|
1628 | compilation environment, which means that on systems with optionally |
|
|
1629 | disabled large file support, you get the 32 bit version of the stat |
|
|
1630 | structure. When using the library from programs that change the ABI to |
|
|
1631 | use 64 bit file offsets the programs will fail. In that case you have to |
|
|
1632 | compile libev with the same flags to get binary compatibility. This is |
|
|
1633 | obviously the case with any flags that change the ABI, but the problem is |
|
|
1634 | most noticably with ev_stat and largefile support. |
1583 | |
1635 | |
1584 | =head3 Inotify |
1636 | =head3 Inotify |
1585 | |
1637 | |
1586 | When C<inotify (7)> support has been compiled into libev (generally only |
1638 | When C<inotify (7)> support has been compiled into libev (generally only |
1587 | available on Linux) and present at runtime, it will be used to speed up |
1639 | available on Linux) and present at runtime, it will be used to speed up |
… | |
… | |
2488 | io.start (fd, ev::READ); |
2540 | io.start (fd, ev::READ); |
2489 | } |
2541 | } |
2490 | }; |
2542 | }; |
2491 | |
2543 | |
2492 | |
2544 | |
|
|
2545 | =head1 OTHER LANGUAGE BINDINGS |
|
|
2546 | |
|
|
2547 | Libev does not offer other language bindings itself, but bindings for a |
|
|
2548 | numbe rof languages exist in the form of third-party packages. If you know |
|
|
2549 | any interesting language binding in addition to the ones listed here, drop |
|
|
2550 | me a note. |
|
|
2551 | |
|
|
2552 | =over 4 |
|
|
2553 | |
|
|
2554 | =item Perl |
|
|
2555 | |
|
|
2556 | The EV module implements the full libev API and is actually used to test |
|
|
2557 | libev. EV is developed together with libev. Apart from the EV core module, |
|
|
2558 | there are additional modules that implement libev-compatible interfaces |
|
|
2559 | to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the |
|
|
2560 | C<libglib> event core (C<Glib::EV> and C<EV::Glib>). |
|
|
2561 | |
|
|
2562 | It can be found and installed via CPAN, its homepage is found at |
|
|
2563 | L<http://software.schmorp.de/pkg/EV>. |
|
|
2564 | |
|
|
2565 | =item Ruby |
|
|
2566 | |
|
|
2567 | Tony Arcieri has written a ruby extension that offers access to a subset |
|
|
2568 | of the libev API and adds filehandle abstractions, asynchronous DNS and |
|
|
2569 | more on top of it. It can be found via gem servers. Its homepage is at |
|
|
2570 | L<http://rev.rubyforge.org/>. |
|
|
2571 | |
|
|
2572 | =item D |
|
|
2573 | |
|
|
2574 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
|
|
2575 | be found at L<http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>. |
|
|
2576 | |
|
|
2577 | =back |
|
|
2578 | |
|
|
2579 | |
2493 | =head1 MACRO MAGIC |
2580 | =head1 MACRO MAGIC |
2494 | |
2581 | |
2495 | Libev can be compiled with a variety of options, the most fundamantal |
2582 | Libev can be compiled with a variety of options, the most fundamantal |
2496 | of which is C<EV_MULTIPLICITY>. This option determines whether (most) |
2583 | of which is C<EV_MULTIPLICITY>. This option determines whether (most) |
2497 | functions and callbacks have an initial C<struct ev_loop *> argument. |
2584 | functions and callbacks have an initial C<struct ev_loop *> argument. |