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

Comparing libev/ev.pod (file contents):
Revision 1.131 by root, Tue Feb 19 17:09:28 2008 UTC vs.
Revision 1.140 by root, Wed Apr 2 06:34:51 2008 UTC

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
53The newest version of this document is also available as a html-formatted 67The newest version of this document is also available as an html-formatted
54web page you might find easier to navigate when reading it for the first 68web page you might find easier to navigate when reading it for the first
55time: L<http://cvs.schmorp.de/libev/ev.html>. 69time: L<http://cvs.schmorp.de/libev/ev.html>.
56 70
57Libev is an event loop: you register interest in certain events (such as a 71Libev is an event loop: you register interest in certain events (such as a
58file descriptor being readable or a timeout occurring), and it will manage 72file descriptor being readable or a timeout occurring), and it will manage
84L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent 98L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
85for example). 99for example).
86 100
87=head2 CONVENTIONS 101=head2 CONVENTIONS
88 102
89Libev is very configurable. In this manual the default configuration will 103Libev is very configurable. In this manual the default (and most common)
90be described, which supports multiple event loops. For more info about 104configuration will be described, which supports multiple event loops. For
91various configuration options please have a look at B<EMBED> section in 105more info about various configuration options please have a look at
92this manual. If libev was configured without support for multiple event 106B<EMBED> section in this manual. If libev was configured without support
93loops, then all functions taking an initial argument of name C<loop> 107for 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. 108name C<loop> (which is always of type C<struct ev_loop *>) will not have
109this argument.
95 110
96=head2 TIME REPRESENTATION 111=head2 TIME REPRESENTATION
97 112
98Libev represents time as a single floating point number, representing the 113Libev 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
260flags. If that is troubling you, check C<ev_backend ()> afterwards). 275flags. If that is troubling you, check C<ev_backend ()> afterwards).
261 276
262If you don't know what event loop to use, use the one returned from this 277If you don't know what event loop to use, use the one returned from this
263function. 278function.
264 279
280Note that this function is I<not> thread-safe, so if you want to use it
281from multiple threads, you have to lock (note also that this is unlikely,
282as loops cannot bes hared easily between threads anyway).
283
265The default loop is the only loop that can handle C<ev_signal> and 284The default loop is the only loop that can handle C<ev_signal> and
266C<ev_child> watchers, and to do this, it always registers a handler 285C<ev_child> watchers, and to do this, it always registers a handler
267for C<SIGCHLD>. If this is a problem for your app you can either 286for C<SIGCHLD>. If this is a problem for your app you can either
268create a dynamic loop with C<ev_loop_new> that doesn't do that, or you 287create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
269can simply overwrite the C<SIGCHLD> signal handler I<after> calling 288can simply overwrite the C<SIGCHLD> signal handler I<after> calling
297enabling this flag. 316enabling this flag.
298 317
299This works by calling C<getpid ()> on every iteration of the loop, 318This works by calling C<getpid ()> on every iteration of the loop,
300and thus this might slow down your event loop if you do a lot of loop 319and thus this might slow down your event loop if you do a lot of loop
301iterations and little real work, but is usually not noticeable (on my 320iterations and little real work, but is usually not noticeable (on my
302Linux system for example, C<getpid> is actually a simple 5-insn sequence 321GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
303without a syscall and thus I<very> fast, but my Linux system also has 322without a syscall and thus I<very> fast, but my GNU/Linux system also has
304C<pthread_atfork> which is even faster). 323C<pthread_atfork> which is even faster).
305 324
306The big advantage of this flag is that you can forget about fork (and 325The big advantage of this flag is that you can forget about fork (and
307forget about forgetting to tell libev about forking) when you use this 326forget about forgetting to tell libev about forking) when you use this
308flag. 327flag.
450 469
451Similar to C<ev_default_loop>, but always creates a new event loop that is 470Similar to C<ev_default_loop>, but always creates a new event loop that is
452always distinct from the default loop. Unlike the default loop, it cannot 471always distinct from the default loop. Unlike the default loop, it cannot
453handle signal and child watchers, and attempts to do so will be greeted by 472handle signal and child watchers, and attempts to do so will be greeted by
454undefined behaviour (or a failed assertion if assertions are enabled). 473undefined behaviour (or a failed assertion if assertions are enabled).
474
475Note that this function I<is> thread-safe, and the recommended way to use
476libev with threads is indeed to create one loop per thread, and using the
477default loop in the "main" or "initial" thread.
455 478
456Example: Try to create a event loop that uses epoll and nothing else. 479Example: 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)
1070To support fork in your programs, you either have to call 1093To support fork in your programs, you either have to call
1071C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child, 1094C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1072enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or 1095enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1073C<EVBACKEND_POLL>. 1096C<EVBACKEND_POLL>.
1074 1097
1098=head3 The special problem of SIGPIPE
1099
1100While not really specific to libev, it is easy to forget about SIGPIPE:
1101when reading from a pipe whose other end has been closed, your program
1102gets send a SIGPIPE, which, by default, aborts your program. For most
1103programs this is sensible behaviour, for daemons, this is usually
1104undesirable.
1105
1106So when you encounter spurious, unexplained daemon exits, make sure you
1107ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1108somewhere, 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
1156configure a timer to trigger every 10 seconds, then it will trigger at 1191configure a timer to trigger every 10 seconds, then it will trigger at
1157exactly 10 second intervals. If, however, your program cannot keep up with 1192exactly 10 second intervals. If, however, your program cannot keep up with
1158the timer (because it takes longer than those 10 seconds to do stuff) the 1193the timer (because it takes longer than those 10 seconds to do stuff) the
1159timer will not fire more than once per event loop iteration. 1194timer will not fire more than once per event loop iteration.
1160 1195
1161=item ev_timer_again (loop) 1196=item ev_timer_again (loop, ev_timer *)
1162 1197
1163This will act as if the timer timed out and restart it again if it is 1198This will act as if the timer timed out and restart it again if it is
1164repeating. The exact semantics are: 1199repeating. The exact semantics are:
1165 1200
1166If the timer is pending, its pending status is cleared. 1201If the timer is pending, its pending status is cleared.
1275In this configuration the watcher triggers an event at the wallclock time 1310In this configuration the watcher triggers an event at the wallclock time
1276C<at> and doesn't repeat. It will not adjust when a time jump occurs, 1311C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1277that is, if it is to be run at January 1st 2011 then it will run when the 1312that is, if it is to be run at January 1st 2011 then it will run when the
1278system time reaches or surpasses this time. 1313system time reaches or surpasses this time.
1279 1314
1280=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1315=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1281 1316
1282In this mode the watcher will always be scheduled to time out at the next 1317In this mode the watcher will always be scheduled to time out at the next
1283C<at + N * interval> time (for some integer N, which can also be negative) 1318C<at + N * interval> time (for some integer N, which can also be negative)
1284and then repeat, regardless of any time jumps. 1319and then repeat, regardless of any time jumps.
1285 1320
1419with the kernel (thus it coexists with your own signal handlers as long 1454with the kernel (thus it coexists with your own signal handlers as long
1420as you don't register any with libev). Similarly, when the last signal 1455as you don't register any with libev). Similarly, when the last signal
1421watcher for a signal is stopped libev will reset the signal handler to 1456watcher for a signal is stopped libev will reset the signal handler to
1422SIG_DFL (regardless of what it was set to before). 1457SIG_DFL (regardless of what it was set to before).
1423 1458
1459If possible and supported, libev will install its handlers with
1460C<SA_RESTART> behaviour enabled, so syscalls should not be unduly
1461interrupted. If you have a problem with syscalls getting interrupted by
1462signals you can block all signals in an C<ev_check> watcher and unblock
1463them in an C<ev_prepare> watcher.
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
1428=item ev_signal_init (ev_signal *, callback, int signum) 1469=item ev_signal_init (ev_signal *, callback, int signum)
1436 1477
1437The signal the watcher watches out for. 1478The signal the watcher watches out for.
1438 1479
1439=back 1480=back
1440 1481
1482=head3 Examples
1483
1484Example: Try to exit cleanly on SIGINT and SIGTERM.
1485
1486 static void
1487 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1488 {
1489 ev_unloop (loop, EVUNLOOP_ALL);
1490 }
1491
1492 struct ev_signal signal_watcher;
1493 ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1494 ev_signal_start (loop, &sigint_cb);
1495
1441 1496
1442=head2 C<ev_child> - watch out for process status changes 1497=head2 C<ev_child> - watch out for process status changes
1443 1498
1444Child watchers trigger when your process receives a SIGCHLD in response to 1499Child watchers trigger when your process receives a SIGCHLD in response to
1445some child status changes (most typically when a child of yours dies). 1500some child status changes (most typically when a child of yours dies). It
1501is permissible to install a child watcher I<after> the child has been
1502forked (which implies it might have already exited), as long as the event
1503loop isn't entered (or is continued from a watcher).
1504
1505Only the default event loop is capable of handling signals, and therefore
1506you can only rgeister child watchers in the default event loop.
1507
1508=head3 Process Interaction
1509
1510Libev grabs C<SIGCHLD> as soon as the default event loop is
1511initialised. This is necessary to guarantee proper behaviour even if
1512the first child watcher is started after the child exits. The occurance
1513of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1514synchronously as part of the event loop processing. Libev always reaps all
1515children, even ones not watched.
1516
1517=head3 Overriding the Built-In Processing
1518
1519Libev offers no special support for overriding the built-in child
1520processing, but if your application collides with libev's default child
1521handler, you can override it easily by installing your own handler for
1522C<SIGCHLD> after initialising the default loop, and making sure the
1523default loop never gets destroyed. You are encouraged, however, to use an
1524event-based approach to child reaping and thus use libev's support for
1525that, so other libev users can use C<ev_child> watchers freely.
1446 1526
1447=head3 Watcher-Specific Functions and Data Members 1527=head3 Watcher-Specific Functions and Data Members
1448 1528
1449=over 4 1529=over 4
1450 1530
1476 1556
1477=back 1557=back
1478 1558
1479=head3 Examples 1559=head3 Examples
1480 1560
1481Example: Try to exit cleanly on SIGINT and SIGTERM. 1561Example: C<fork()> a new process and install a child handler to wait for
1562its completion.
1563
1564 ev_child cw;
1482 1565
1483 static void 1566 static void
1484 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1567 child_cb (EV_P_ struct ev_child *w, int revents)
1485 { 1568 {
1486 ev_unloop (loop, EVUNLOOP_ALL); 1569 ev_child_stop (EV_A_ w);
1570 printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1487 } 1571 }
1488 1572
1489 struct ev_signal signal_watcher; 1573 pid_t pid = fork ();
1490 ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 1574
1491 ev_signal_start (loop, &sigint_cb); 1575 if (pid < 0)
1576 // error
1577 else if (pid == 0)
1578 {
1579 // the forked child executes here
1580 exit (1);
1581 }
1582 else
1583 {
1584 ev_child_init (&cw, child_cb, pid, 0);
1585 ev_child_start (EV_DEFAULT_ &cw);
1586 }
1492 1587
1493 1588
1494=head2 C<ev_stat> - did the file attributes just change? 1589=head2 C<ev_stat> - did the file attributes just change?
1495 1590
1496This watches a filesystem path for attribute changes. That is, it calls 1591This watches a filesystem path for attribute changes. That is, it calls
1525semantics of C<ev_stat> watchers, which means that libev sometimes needs 1620semantics of C<ev_stat> watchers, which means that libev sometimes needs
1526to fall back to regular polling again even with inotify, but changes are 1621to fall back to regular polling again even with inotify, but changes are
1527usually detected immediately, and if the file exists there will be no 1622usually detected immediately, and if the file exists there will be no
1528polling. 1623polling.
1529 1624
1625=head3 ABI Issues (Largefile Support)
1626
1627Libev by default (unless the user overrides this) uses the default
1628compilation environment, which means that on systems with optionally
1629disabled large file support, you get the 32 bit version of the stat
1630structure. When using the library from programs that change the ABI to
1631use 64 bit file offsets the programs will fail. In that case you have to
1632compile libev with the same flags to get binary compatibility. This is
1633obviously the case with any flags that change the ABI, but the problem is
1634most noticably with ev_stat and largefile support.
1635
1530=head3 Inotify 1636=head3 Inotify
1531 1637
1532When C<inotify (7)> support has been compiled into libev (generally only 1638When C<inotify (7)> support has been compiled into libev (generally only
1533available on Linux) and present at runtime, it will be used to speed up 1639available on Linux) and present at runtime, it will be used to speed up
1534change detection where possible. The inotify descriptor will be created lazily 1640change detection where possible. The inotify descriptor will be created lazily
1576 1682
1577The callback will be receive C<EV_STAT> when a change was detected, 1683The callback will be receive C<EV_STAT> when a change was detected,
1578relative to the attributes at the time the watcher was started (or the 1684relative to the attributes at the time the watcher was started (or the
1579last change was detected). 1685last change was detected).
1580 1686
1581=item ev_stat_stat (ev_stat *) 1687=item ev_stat_stat (loop, ev_stat *)
1582 1688
1583Updates the stat buffer immediately with new values. If you change the 1689Updates the stat buffer immediately with new values. If you change the
1584watched path in your callback, you could call this fucntion to avoid 1690watched path in your callback, you could call this fucntion to avoid
1585detecting this change (while introducing a race condition). Can also be 1691detecting this change (while introducing a race condition). Can also be
1586useful simply to find out the new values. 1692useful simply to find out the new values.
2102 { 2208 {
2103 sometype data; 2209 sometype data;
2104 2210
2105 // no locking etc. 2211 // no locking etc.
2106 queue_put (data); 2212 queue_put (data);
2107 ev_async_send (DEFAULT_ &mysig); 2213 ev_async_send (EV_DEFAULT_ &mysig);
2108 } 2214 }
2109 2215
2110 static void 2216 static void
2111 mysig_cb (EV_P_ ev_async *w, int revents) 2217 mysig_cb (EV_P_ ev_async *w, int revents)
2112 { 2218 {
2143 // only need to lock the actual queueing operation 2249 // only need to lock the actual queueing operation
2144 pthread_mutex_lock (&mymutex); 2250 pthread_mutex_lock (&mymutex);
2145 queue_put (data); 2251 queue_put (data);
2146 pthread_mutex_unlock (&mymutex); 2252 pthread_mutex_unlock (&mymutex);
2147 2253
2148 ev_async_send (DEFAULT_ &mysig); 2254 ev_async_send (EV_DEFAULT_ &mysig);
2149 } 2255 }
2150 2256
2151 static void 2257 static void
2152 mysig_cb (EV_P_ ev_async *w, int revents) 2258 mysig_cb (EV_P_ ev_async *w, int revents)
2153 { 2259 {
2181section below on what exactly this means). 2287section below on what exactly this means).
2182 2288
2183This call incurs the overhead of a syscall only once per loop iteration, 2289This call incurs the overhead of a syscall only once per loop iteration,
2184so while the overhead might be noticable, it doesn't apply to repeated 2290so while the overhead might be noticable, it doesn't apply to repeated
2185calls to C<ev_async_send>. 2291calls to C<ev_async_send>.
2292
2293=item bool = ev_async_pending (ev_async *)
2294
2295Returns a non-zero value when C<ev_async_send> has been called on the
2296watcher but the event has not yet been processed (or even noted) by the
2297event loop.
2298
2299C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2300the loop iterates next and checks for the watcher to have become active,
2301it will reset the flag again. C<ev_async_pending> can be used to very
2302quickly check wether invoking the loop might be a good idea.
2303
2304Not that this does I<not> check wether the watcher itself is pending, only
2305wether it has been requested to make this watcher pending.
2186 2306
2187=back 2307=back
2188 2308
2189 2309
2190=head1 OTHER FUNCTIONS 2310=head1 OTHER FUNCTIONS
2432 idle.set <myclass, &myclass::idle_cb> (this); 2552 idle.set <myclass, &myclass::idle_cb> (this);
2433 2553
2434 io.start (fd, ev::READ); 2554 io.start (fd, ev::READ);
2435 } 2555 }
2436 }; 2556 };
2557
2558
2559=head1 OTHER LANGUAGE BINDINGS
2560
2561Libev does not offer other language bindings itself, but bindings for a
2562numbe rof languages exist in the form of third-party packages. If you know
2563any interesting language binding in addition to the ones listed here, drop
2564me a note.
2565
2566=over 4
2567
2568=item Perl
2569
2570The EV module implements the full libev API and is actually used to test
2571libev. EV is developed together with libev. Apart from the EV core module,
2572there are additional modules that implement libev-compatible interfaces
2573to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the
2574C<libglib> event core (C<Glib::EV> and C<EV::Glib>).
2575
2576It can be found and installed via CPAN, its homepage is found at
2577L<http://software.schmorp.de/pkg/EV>.
2578
2579=item Ruby
2580
2581Tony Arcieri has written a ruby extension that offers access to a subset
2582of the libev API and adds filehandle abstractions, asynchronous DNS and
2583more on top of it. It can be found via gem servers. Its homepage is at
2584L<http://rev.rubyforge.org/>.
2585
2586=item D
2587
2588Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2589be found at L<http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.
2590
2591=back
2437 2592
2438 2593
2439=head1 MACRO MAGIC 2594=head1 MACRO MAGIC
2440 2595
2441Libev can be compiled with a variety of options, the most fundamantal 2596Libev can be compiled with a variety of options, the most fundamantal

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines