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

Comparing libev/ev.pod (file contents):
Revision 1.202 by root, Fri Oct 24 08:30:01 2008 UTC vs.
Revision 1.228 by root, Sat Mar 28 08:22:30 2009 UTC

8 8
9=head2 EXAMPLE PROGRAM 9=head2 EXAMPLE PROGRAM
10 10
11 // a single header file is required 11 // a single header file is required
12 #include <ev.h> 12 #include <ev.h>
13
14 #include <stdio.h> // for puts
13 15
14 // every watcher type has its own typedef'd struct 16 // every watcher type has its own typedef'd struct
15 // with the name ev_TYPE 17 // with the name ev_TYPE
16 ev_io stdin_watcher; 18 ev_io stdin_watcher;
17 ev_timer timeout_watcher; 19 ev_timer timeout_watcher;
41 43
42 int 44 int
43 main (void) 45 main (void)
44 { 46 {
45 // use the default event loop unless you have special needs 47 // use the default event loop unless you have special needs
46 ev_loop *loop = ev_default_loop (0); 48 struct ev_loop *loop = ev_default_loop (0);
47 49
48 // initialise an io watcher, then start it 50 // initialise an io watcher, then start it
49 // this one will watch for stdin to become readable 51 // this one will watch for stdin to become readable
50 ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); 52 ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
51 ev_io_start (loop, &stdin_watcher); 53 ev_io_start (loop, &stdin_watcher);
298If you don't know what event loop to use, use the one returned from this 300If you don't know what event loop to use, use the one returned from this
299function. 301function.
300 302
301Note that this function is I<not> thread-safe, so if you want to use it 303Note that this function is I<not> thread-safe, so if you want to use it
302from multiple threads, you have to lock (note also that this is unlikely, 304from multiple threads, you have to lock (note also that this is unlikely,
303as loops cannot bes hared easily between threads anyway). 305as loops cannot be shared easily between threads anyway).
304 306
305The default loop is the only loop that can handle C<ev_signal> and 307The default loop is the only loop that can handle C<ev_signal> and
306C<ev_child> watchers, and to do this, it always registers a handler 308C<ev_child> watchers, and to do this, it always registers a handler
307for C<SIGCHLD>. If this is a problem for your application you can either 309for C<SIGCHLD>. If this is a problem for your application you can either
308create a dynamic loop with C<ev_loop_new> that doesn't do that, or you 310create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
384=item C<EVBACKEND_EPOLL> (value 4, Linux) 386=item C<EVBACKEND_EPOLL> (value 4, Linux)
385 387
386For few fds, this backend is a bit little slower than poll and select, 388For few fds, this backend is a bit little slower than poll and select,
387but it scales phenomenally better. While poll and select usually scale 389but it scales phenomenally better. While poll and select usually scale
388like O(total_fds) where n is the total number of fds (or the highest fd), 390like O(total_fds) where n is the total number of fds (or the highest fd),
389epoll scales either O(1) or O(active_fds). The epoll design has a number 391epoll scales either O(1) or O(active_fds).
390of shortcomings, such as silently dropping events in some hard-to-detect 392
391cases and requiring a system call per fd change, no fork support and bad 393The epoll mechanism deserves honorable mention as the most misdesigned
392support for dup. 394of the more advanced event mechanisms: mere annoyances include silently
395dropping file descriptors, requiring a system call per change per file
396descriptor (and unnecessary guessing of parameters), problems with dup and
397so on. The biggest issue is fork races, however - if a program forks then
398I<both> parent and child process have to recreate the epoll set, which can
399take considerable time (one syscall per file descriptor) and is of course
400hard to detect.
401
402Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
403of course I<doesn't>, and epoll just loves to report events for totally
404I<different> file descriptors (even already closed ones, so one cannot
405even remove them from the set) than registered in the set (especially
406on SMP systems). Libev tries to counter these spurious notifications by
407employing an additional generation counter and comparing that against the
408events to filter out spurious ones, recreating the set when required.
393 409
394While stopping, setting and starting an I/O watcher in the same iteration 410While stopping, setting and starting an I/O watcher in the same iteration
395will result in some caching, there is still a system call per such incident 411will result in some caching, there is still a system call per such
396(because the fd could point to a different file description now), so its 412incident (because the same I<file descriptor> could point to a different
397best to avoid that. Also, C<dup ()>'ed file descriptors might not work 413I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
398very well if you register events for both fds. 414file descriptors might not work very well if you register events for both
399 415file descriptors.
400Please note that epoll sometimes generates spurious notifications, so you
401need to use non-blocking I/O or other means to avoid blocking when no data
402(or space) is available.
403 416
404Best performance from this backend is achieved by not unregistering all 417Best performance from this backend is achieved by not unregistering all
405watchers for a file descriptor until it has been closed, if possible, 418watchers for a file descriptor until it has been closed, if possible,
406i.e. keep at least one watcher active per fd at all times. Stopping and 419i.e. keep at least one watcher active per fd at all times. Stopping and
407starting a watcher (without re-setting it) also usually doesn't cause 420starting a watcher (without re-setting it) also usually doesn't cause
408extra overhead. 421extra overhead. A fork can both result in spurious notifications as well
422as in libev having to destroy and recreate the epoll object, which can
423take considerable time and thus should be avoided.
424
425All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
426faster than epoll for maybe up to a hundred file descriptors, depending on
427the usage. So sad.
409 428
410While nominally embeddable in other event loops, this feature is broken in 429While nominally embeddable in other event loops, this feature is broken in
411all kernel versions tested so far. 430all kernel versions tested so far.
412 431
413This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 432This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
414C<EVBACKEND_POLL>. 433C<EVBACKEND_POLL>.
415 434
416=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 435=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
417 436
418Kqueue deserves special mention, as at the time of this writing, it was 437Kqueue deserves special mention, as at the time of this writing, it
419broken on all BSDs except NetBSD (usually it doesn't work reliably with 438was broken on all BSDs except NetBSD (usually it doesn't work reliably
420anything but sockets and pipes, except on Darwin, where of course it's 439with anything but sockets and pipes, except on Darwin, where of course
421completely useless). For this reason it's not being "auto-detected" unless 440it's completely useless). Unlike epoll, however, whose brokenness
422you explicitly specify it in the flags (i.e. using C<EVBACKEND_KQUEUE>) or 441is by design, these kqueue bugs can (and eventually will) be fixed
423libev was compiled on a known-to-be-good (-enough) system like NetBSD. 442without API changes to existing programs. For this reason it's not being
443"auto-detected" unless you explicitly specify it in the flags (i.e. using
444C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
445system like NetBSD.
424 446
425You still can embed kqueue into a normal poll or select backend and use it 447You still can embed kqueue into a normal poll or select backend and use it
426only for sockets (after having made sure that sockets work with kqueue on 448only for sockets (after having made sure that sockets work with kqueue on
427the target platform). See C<ev_embed> watchers for more info. 449the target platform). See C<ev_embed> watchers for more info.
428 450
429It scales in the same way as the epoll backend, but the interface to the 451It scales in the same way as the epoll backend, but the interface to the
430kernel is more efficient (which says nothing about its actual speed, of 452kernel is more efficient (which says nothing about its actual speed, of
431course). While stopping, setting and starting an I/O watcher does never 453course). While stopping, setting and starting an I/O watcher does never
432cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to 454cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
433two event changes per incident. Support for C<fork ()> is very bad and it 455two event changes per incident. Support for C<fork ()> is very bad (but
434drops fds silently in similarly hard-to-detect cases. 456sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
457cases
435 458
436This backend usually performs well under most conditions. 459This backend usually performs well under most conditions.
437 460
438While nominally embeddable in other event loops, this doesn't work 461While nominally embeddable in other event loops, this doesn't work
439everywhere, so you might need to test for this. And since it is broken 462everywhere, so you might need to test for this. And since it is broken
440almost everywhere, you should only use it when you have a lot of sockets 463almost everywhere, you should only use it when you have a lot of sockets
441(for which it usually works), by embedding it into another event loop 464(for which it usually works), by embedding it into another event loop
442(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and, did I mention it, 465(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course
443using it only for sockets. 466also broken on OS X)) and, did I mention it, using it only for sockets.
444 467
445This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with 468This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with
446C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with 469C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
447C<NOTE_EOF>. 470C<NOTE_EOF>.
448 471
468might perform better. 491might perform better.
469 492
470On the positive side, with the exception of the spurious readiness 493On the positive side, with the exception of the spurious readiness
471notifications, this backend actually performed fully to specification 494notifications, this backend actually performed fully to specification
472in all tests and is fully embeddable, which is a rare feat among the 495in all tests and is fully embeddable, which is a rare feat among the
473OS-specific backends. 496OS-specific backends (I vastly prefer correctness over speed hacks).
474 497
475This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 498This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
476C<EVBACKEND_POLL>. 499C<EVBACKEND_POLL>.
477 500
478=item C<EVBACKEND_ALL> 501=item C<EVBACKEND_ALL>
531responsibility to either stop all watchers cleanly yourself I<before> 554responsibility to either stop all watchers cleanly yourself I<before>
532calling this function, or cope with the fact afterwards (which is usually 555calling this function, or cope with the fact afterwards (which is usually
533the easiest thing, you can just ignore the watchers and/or C<free ()> them 556the easiest thing, you can just ignore the watchers and/or C<free ()> them
534for example). 557for example).
535 558
536Note that certain global state, such as signal state, will not be freed by 559Note that certain global state, such as signal state (and installed signal
537this function, and related watchers (such as signal and child watchers) 560handlers), will not be freed by this function, and related watchers (such
538would need to be stopped manually. 561as signal and child watchers) would need to be stopped manually.
539 562
540In general it is not advisable to call this function except in the 563In general it is not advisable to call this function except in the
541rare occasion where you really need to free e.g. the signal handling 564rare occasion where you really need to free e.g. the signal handling
542pipe fds. If you need dynamically allocated loops it is better to use 565pipe fds. If you need dynamically allocated loops it is better to use
543C<ev_loop_new> and C<ev_loop_destroy>). 566C<ev_loop_new> and C<ev_loop_destroy>).
635the loop. 658the loop.
636 659
637A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if 660A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
638necessary) and will handle those and any already outstanding ones. It 661necessary) and will handle those and any already outstanding ones. It
639will block your process until at least one new event arrives (which could 662will block your process until at least one new event arrives (which could
640be an event internal to libev itself, so there is no guarentee that a 663be an event internal to libev itself, so there is no guarantee that a
641user-registered callback will be called), and will return after one 664user-registered callback will be called), and will return after one
642iteration of the loop. 665iteration of the loop.
643 666
644This is useful if you are waiting for some external event in conjunction 667This is useful if you are waiting for some external event in conjunction
645with something not expressible using other libev watchers (i.e. "roll your 668with something not expressible using other libev watchers (i.e. "roll your
1398 else 1421 else
1399 { 1422 {
1400 // callback was invoked, but there was some activity, re-arm 1423 // callback was invoked, but there was some activity, re-arm
1401 // the watcher to fire in last_activity + 60, which is 1424 // the watcher to fire in last_activity + 60, which is
1402 // guaranteed to be in the future, so "again" is positive: 1425 // guaranteed to be in the future, so "again" is positive:
1403 w->again = timeout - now; 1426 w->repeat = timeout - now;
1404 ev_timer_again (EV_A_ w); 1427 ev_timer_again (EV_A_ w);
1405 } 1428 }
1406 } 1429 }
1407 1430
1408To summarise the callback: first calculate the real timeout (defined 1431To summarise the callback: first calculate the real timeout (defined
1573=head2 C<ev_periodic> - to cron or not to cron? 1596=head2 C<ev_periodic> - to cron or not to cron?
1574 1597
1575Periodic watchers are also timers of a kind, but they are very versatile 1598Periodic watchers are also timers of a kind, but they are very versatile
1576(and unfortunately a bit complex). 1599(and unfortunately a bit complex).
1577 1600
1578Unlike C<ev_timer>'s, they are not based on real time (or relative time) 1601Unlike C<ev_timer>, periodic watchers are not based on real time (or
1579but on wall clock time (absolute time). You can tell a periodic watcher 1602relative time, the physical time that passes) but on wall clock time
1580to trigger after some specific point in time. For example, if you tell a 1603(absolute time, the thing you can read on your calender or clock). The
1581periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now () 1604difference is that wall clock time can run faster or slower than real
1582+ 10.>, that is, an absolute time not a delay) and then reset your system 1605time, and time jumps are not uncommon (e.g. when you adjust your
1583clock to January of the previous year, then it will take more than year 1606wrist-watch).
1584to trigger the event (unlike an C<ev_timer>, which would still trigger
1585roughly 10 seconds later as it uses a relative timeout).
1586 1607
1608You can tell a periodic watcher to trigger after some specific point
1609in time: for example, if you tell a periodic watcher to trigger "in 10
1610seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
1611not a delay) and then reset your system clock to January of the previous
1612year, then it will take a year or more to trigger the event (unlike an
1613C<ev_timer>, which would still trigger roughly 10 seconds after starting
1614it, as it uses a relative timeout).
1615
1587C<ev_periodic>s can also be used to implement vastly more complex timers, 1616C<ev_periodic> watchers can also be used to implement vastly more complex
1588such as triggering an event on each "midnight, local time", or other 1617timers, such as triggering an event on each "midnight, local time", or
1589complicated rules. 1618other complicated rules. This cannot be done with C<ev_timer> watchers, as
1619those cannot react to time jumps.
1590 1620
1591As with timers, the callback is guaranteed to be invoked only when the 1621As with timers, the callback is guaranteed to be invoked only when the
1592time (C<at>) has passed, but if multiple periodic timers become ready 1622point in time where it is supposed to trigger has passed, but if multiple
1593during the same loop iteration, then order of execution is undefined. 1623periodic timers become ready during the same loop iteration, then order of
1624execution is undefined.
1594 1625
1595=head3 Watcher-Specific Functions and Data Members 1626=head3 Watcher-Specific Functions and Data Members
1596 1627
1597=over 4 1628=over 4
1598 1629
1599=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) 1630=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1600 1631
1601=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) 1632=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1602 1633
1603Lots of arguments, lets sort it out... There are basically three modes of 1634Lots of arguments, let's sort it out... There are basically three modes of
1604operation, and we will explain them from simplest to most complex: 1635operation, and we will explain them from simplest to most complex:
1605 1636
1606=over 4 1637=over 4
1607 1638
1608=item * absolute timer (at = time, interval = reschedule_cb = 0) 1639=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1609 1640
1610In this configuration the watcher triggers an event after the wall clock 1641In this configuration the watcher triggers an event after the wall clock
1611time C<at> has passed. It will not repeat and will not adjust when a time 1642time C<offset> has passed. It will not repeat and will not adjust when a
1612jump occurs, that is, if it is to be run at January 1st 2011 then it will 1643time jump occurs, that is, if it is to be run at January 1st 2011 then it
1613only run when the system clock reaches or surpasses this time. 1644will be stopped and invoked when the system clock reaches or surpasses
1645this point in time.
1614 1646
1615=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1647=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1616 1648
1617In this mode the watcher will always be scheduled to time out at the next 1649In this mode the watcher will always be scheduled to time out at the next
1618C<at + N * interval> time (for some integer N, which can also be negative) 1650C<offset + N * interval> time (for some integer N, which can also be
1619and then repeat, regardless of any time jumps. 1651negative) and then repeat, regardless of any time jumps. The C<offset>
1652argument is merely an offset into the C<interval> periods.
1620 1653
1621This can be used to create timers that do not drift with respect to the 1654This can be used to create timers that do not drift with respect to the
1622system clock, for example, here is a C<ev_periodic> that triggers each 1655system clock, for example, here is an C<ev_periodic> that triggers each
1623hour, on the hour: 1656hour, on the hour (with respect to UTC):
1624 1657
1625 ev_periodic_set (&periodic, 0., 3600., 0); 1658 ev_periodic_set (&periodic, 0., 3600., 0);
1626 1659
1627This doesn't mean there will always be 3600 seconds in between triggers, 1660This doesn't mean there will always be 3600 seconds in between triggers,
1628but only that the callback will be called when the system time shows a 1661but only that the callback will be called when the system time shows a
1629full hour (UTC), or more correctly, when the system time is evenly divisible 1662full hour (UTC), or more correctly, when the system time is evenly divisible
1630by 3600. 1663by 3600.
1631 1664
1632Another way to think about it (for the mathematically inclined) is that 1665Another way to think about it (for the mathematically inclined) is that
1633C<ev_periodic> will try to run the callback in this mode at the next possible 1666C<ev_periodic> will try to run the callback in this mode at the next possible
1634time where C<time = at (mod interval)>, regardless of any time jumps. 1667time where C<time = offset (mod interval)>, regardless of any time jumps.
1635 1668
1636For numerical stability it is preferable that the C<at> value is near 1669For numerical stability it is preferable that the C<offset> value is near
1637C<ev_now ()> (the current time), but there is no range requirement for 1670C<ev_now ()> (the current time), but there is no range requirement for
1638this value, and in fact is often specified as zero. 1671this value, and in fact is often specified as zero.
1639 1672
1640Note also that there is an upper limit to how often a timer can fire (CPU 1673Note also that there is an upper limit to how often a timer can fire (CPU
1641speed for example), so if C<interval> is very small then timing stability 1674speed for example), so if C<interval> is very small then timing stability
1642will of course deteriorate. Libev itself tries to be exact to be about one 1675will of course deteriorate. Libev itself tries to be exact to be about one
1643millisecond (if the OS supports it and the machine is fast enough). 1676millisecond (if the OS supports it and the machine is fast enough).
1644 1677
1645=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) 1678=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1646 1679
1647In this mode the values for C<interval> and C<at> are both being 1680In this mode the values for C<interval> and C<offset> are both being
1648ignored. Instead, each time the periodic watcher gets scheduled, the 1681ignored. Instead, each time the periodic watcher gets scheduled, the
1649reschedule callback will be called with the watcher as first, and the 1682reschedule callback will be called with the watcher as first, and the
1650current time as second argument. 1683current time as second argument.
1651 1684
1652NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, 1685NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1653ever, or make ANY event loop modifications whatsoever>. 1686or make ANY other event loop modifications whatsoever, unless explicitly
1687allowed by documentation here>.
1654 1688
1655If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop 1689If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
1656it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the 1690it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1657only event loop modification you are allowed to do). 1691only event loop modification you are allowed to do).
1658 1692
1688a different time than the last time it was called (e.g. in a crond like 1722a different time than the last time it was called (e.g. in a crond like
1689program when the crontabs have changed). 1723program when the crontabs have changed).
1690 1724
1691=item ev_tstamp ev_periodic_at (ev_periodic *) 1725=item ev_tstamp ev_periodic_at (ev_periodic *)
1692 1726
1693When active, returns the absolute time that the watcher is supposed to 1727When active, returns the absolute time that the watcher is supposed
1694trigger next. 1728to trigger next. This is not the same as the C<offset> argument to
1729C<ev_periodic_set>, but indeed works even in interval and manual
1730rescheduling modes.
1695 1731
1696=item ev_tstamp offset [read-write] 1732=item ev_tstamp offset [read-write]
1697 1733
1698When repeating, this contains the offset value, otherwise this is the 1734When repeating, this contains the offset value, otherwise this is the
1699absolute point in time (the C<at> value passed to C<ev_periodic_set>). 1735absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
1736although libev might modify this value for better numerical stability).
1700 1737
1701Can be modified any time, but changes only take effect when the periodic 1738Can be modified any time, but changes only take effect when the periodic
1702timer fires or C<ev_periodic_again> is being called. 1739timer fires or C<ev_periodic_again> is being called.
1703 1740
1704=item ev_tstamp interval [read-write] 1741=item ev_tstamp interval [read-write]
1910 1947
1911 1948
1912=head2 C<ev_stat> - did the file attributes just change? 1949=head2 C<ev_stat> - did the file attributes just change?
1913 1950
1914This watches a file system path for attribute changes. That is, it calls 1951This watches a file system path for attribute changes. That is, it calls
1915C<stat> regularly (or when the OS says it changed) and sees if it changed 1952C<stat> on that path in regular intervals (or when the OS says it changed)
1916compared to the last time, invoking the callback if it did. 1953and sees if it changed compared to the last time, invoking the callback if
1954it did.
1917 1955
1918The path does not need to exist: changing from "path exists" to "path does 1956The path does not need to exist: changing from "path exists" to "path does
1919not exist" is a status change like any other. The condition "path does 1957not exist" is a status change like any other. The condition "path does not
1920not exist" is signified by the C<st_nlink> field being zero (which is 1958exist" (or more correctly "path cannot be stat'ed") is signified by the
1921otherwise always forced to be at least one) and all the other fields of 1959C<st_nlink> field being zero (which is otherwise always forced to be at
1922the stat buffer having unspecified contents. 1960least one) and all the other fields of the stat buffer having unspecified
1961contents.
1923 1962
1924The path I<should> be absolute and I<must not> end in a slash. If it is 1963The path I<must not> end in a slash or contain special components such as
1964C<.> or C<..>. The path I<should> be absolute: If it is relative and
1925relative and your working directory changes, the behaviour is undefined. 1965your working directory changes, then the behaviour is undefined.
1926 1966
1927Since there is no standard kernel interface to do this, the portable 1967Since there is no portable change notification interface available, the
1928implementation simply calls C<stat (2)> regularly on the path to see if 1968portable implementation simply calls C<stat(2)> regularly on the path
1929it changed somehow. You can specify a recommended polling interval for 1969to see if it changed somehow. You can specify a recommended polling
1930this case. If you specify a polling interval of C<0> (highly recommended!) 1970interval for this case. If you specify a polling interval of C<0> (highly
1931then a I<suitable, unspecified default> value will be used (which 1971recommended!) then a I<suitable, unspecified default> value will be used
1932you can expect to be around five seconds, although this might change 1972(which you can expect to be around five seconds, although this might
1933dynamically). Libev will also impose a minimum interval which is currently 1973change dynamically). Libev will also impose a minimum interval which is
1934around C<0.1>, but thats usually overkill. 1974currently around C<0.1>, but that's usually overkill.
1935 1975
1936This watcher type is not meant for massive numbers of stat watchers, 1976This watcher type is not meant for massive numbers of stat watchers,
1937as even with OS-supported change notifications, this can be 1977as even with OS-supported change notifications, this can be
1938resource-intensive. 1978resource-intensive.
1939 1979
1940At the time of this writing, the only OS-specific interface implemented 1980At the time of this writing, the only OS-specific interface implemented
1941is the Linux inotify interface (implementing kqueue support is left as 1981is the Linux inotify interface (implementing kqueue support is left as an
1942an exercise for the reader. Note, however, that the author sees no way 1982exercise for the reader. Note, however, that the author sees no way of
1943of implementing C<ev_stat> semantics with kqueue). 1983implementing C<ev_stat> semantics with kqueue, except as a hint).
1944 1984
1945=head3 ABI Issues (Largefile Support) 1985=head3 ABI Issues (Largefile Support)
1946 1986
1947Libev by default (unless the user overrides this) uses the default 1987Libev by default (unless the user overrides this) uses the default
1948compilation environment, which means that on systems with large file 1988compilation environment, which means that on systems with large file
1949support disabled by default, you get the 32 bit version of the stat 1989support disabled by default, you get the 32 bit version of the stat
1950structure. When using the library from programs that change the ABI to 1990structure. When using the library from programs that change the ABI to
1951use 64 bit file offsets the programs will fail. In that case you have to 1991use 64 bit file offsets the programs will fail. In that case you have to
1952compile libev with the same flags to get binary compatibility. This is 1992compile libev with the same flags to get binary compatibility. This is
1953obviously the case with any flags that change the ABI, but the problem is 1993obviously the case with any flags that change the ABI, but the problem is
1954most noticeably disabled with ev_stat and large file support. 1994most noticeably displayed with ev_stat and large file support.
1955 1995
1956The solution for this is to lobby your distribution maker to make large 1996The solution for this is to lobby your distribution maker to make large
1957file interfaces available by default (as e.g. FreeBSD does) and not 1997file interfaces available by default (as e.g. FreeBSD does) and not
1958optional. Libev cannot simply switch on large file support because it has 1998optional. Libev cannot simply switch on large file support because it has
1959to exchange stat structures with application programs compiled using the 1999to exchange stat structures with application programs compiled using the
1960default compilation environment. 2000default compilation environment.
1961 2001
1962=head3 Inotify and Kqueue 2002=head3 Inotify and Kqueue
1963 2003
1964When C<inotify (7)> support has been compiled into libev (generally 2004When C<inotify (7)> support has been compiled into libev and present at
1965only available with Linux 2.6.25 or above due to bugs in earlier 2005runtime, it will be used to speed up change detection where possible. The
1966implementations) and present at runtime, it will be used to speed up 2006inotify descriptor will be created lazily when the first C<ev_stat>
1967change detection where possible. The inotify descriptor will be created 2007watcher is being started.
1968lazily when the first C<ev_stat> watcher is being started.
1969 2008
1970Inotify presence does not change the semantics of C<ev_stat> watchers 2009Inotify presence does not change the semantics of C<ev_stat> watchers
1971except that changes might be detected earlier, and in some cases, to avoid 2010except that changes might be detected earlier, and in some cases, to avoid
1972making regular C<stat> calls. Even in the presence of inotify support 2011making regular C<stat> calls. Even in the presence of inotify support
1973there are many cases where libev has to resort to regular C<stat> polling, 2012there are many cases where libev has to resort to regular C<stat> polling,
1974but as long as the path exists, libev usually gets away without polling. 2013but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
2014many bugs), the path exists (i.e. stat succeeds), and the path resides on
2015a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
2016xfs are fully working) libev usually gets away without polling.
1975 2017
1976There is no support for kqueue, as apparently it cannot be used to 2018There is no support for kqueue, as apparently it cannot be used to
1977implement this functionality, due to the requirement of having a file 2019implement this functionality, due to the requirement of having a file
1978descriptor open on the object at all times, and detecting renames, unlinks 2020descriptor open on the object at all times, and detecting renames, unlinks
1979etc. is difficult. 2021etc. is difficult.
1980 2022
2023=head3 C<stat ()> is a synchronous operation
2024
2025Libev doesn't normally do any kind of I/O itself, and so is not blocking
2026the process. The exception are C<ev_stat> watchers - those call C<stat
2027()>, which is a synchronous operation.
2028
2029For local paths, this usually doesn't matter: unless the system is very
2030busy or the intervals between stat's are large, a stat call will be fast,
2031as the path data is usually in memory already (except when starting the
2032watcher).
2033
2034For networked file systems, calling C<stat ()> can block an indefinite
2035time due to network issues, and even under good conditions, a stat call
2036often takes multiple milliseconds.
2037
2038Therefore, it is best to avoid using C<ev_stat> watchers on networked
2039paths, although this is fully supported by libev.
2040
1981=head3 The special problem of stat time resolution 2041=head3 The special problem of stat time resolution
1982 2042
1983The C<stat ()> system call only supports full-second resolution portably, and 2043The C<stat ()> system call only supports full-second resolution portably,
1984even on systems where the resolution is higher, most file systems still 2044and even on systems where the resolution is higher, most file systems
1985only support whole seconds. 2045still only support whole seconds.
1986 2046
1987That means that, if the time is the only thing that changes, you can 2047That means that, if the time is the only thing that changes, you can
1988easily miss updates: on the first update, C<ev_stat> detects a change and 2048easily miss updates: on the first update, C<ev_stat> detects a change and
1989calls your callback, which does something. When there is another update 2049calls your callback, which does something. When there is another update
1990within the same second, C<ev_stat> will be unable to detect unless the 2050within the same second, C<ev_stat> will be unable to detect unless the
2133 2193
2134=head3 Watcher-Specific Functions and Data Members 2194=head3 Watcher-Specific Functions and Data Members
2135 2195
2136=over 4 2196=over 4
2137 2197
2138=item ev_idle_init (ev_signal *, callback) 2198=item ev_idle_init (ev_idle *, callback)
2139 2199
2140Initialises and configures the idle watcher - it has no parameters of any 2200Initialises and configures the idle watcher - it has no parameters of any
2141kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 2201kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
2142believe me. 2202believe me.
2143 2203
2382some fds have to be watched and handled very quickly (with low latency), 2442some fds have to be watched and handled very quickly (with low latency),
2383and even priorities and idle watchers might have too much overhead. In 2443and even priorities and idle watchers might have too much overhead. In
2384this case you would put all the high priority stuff in one loop and all 2444this case you would put all the high priority stuff in one loop and all
2385the rest in a second one, and embed the second one in the first. 2445the rest in a second one, and embed the second one in the first.
2386 2446
2387As long as the watcher is active, the callback will be invoked every time 2447As long as the watcher is active, the callback will be invoked every
2388there might be events pending in the embedded loop. The callback must then 2448time there might be events pending in the embedded loop. The callback
2389call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke 2449must then call C<ev_embed_sweep (mainloop, watcher)> to make a single
2390their callbacks (you could also start an idle watcher to give the embedded 2450sweep and invoke their callbacks (the callback doesn't need to invoke the
2391loop strictly lower priority for example). You can also set the callback 2451C<ev_embed_sweep> function directly, it could also start an idle watcher
2392to C<0>, in which case the embed watcher will automatically execute the 2452to give the embedded loop strictly lower priority for example).
2393embedded loop sweep.
2394 2453
2395As long as the watcher is started it will automatically handle events. The 2454You can also set the callback to C<0>, in which case the embed watcher
2396callback will be invoked whenever some events have been handled. You can 2455will automatically execute the embedded loop sweep whenever necessary.
2397set the callback to C<0> to avoid having to specify one if you are not
2398interested in that.
2399 2456
2400Also, there have not currently been made special provisions for forking: 2457Fork detection will be handled transparently while the C<ev_embed> watcher
2401when you fork, you not only have to call C<ev_loop_fork> on both loops, 2458is active, i.e., the embedded loop will automatically be forked when the
2402but you will also have to stop and restart any C<ev_embed> watchers 2459embedding loop forks. In other cases, the user is responsible for calling
2403yourself - but you can use a fork watcher to handle this automatically, 2460C<ev_loop_fork> on the embedded loop.
2404and future versions of libev might do just that.
2405 2461
2406Unfortunately, not all backends are embeddable: only the ones returned by 2462Unfortunately, not all backends are embeddable: only the ones returned by
2407C<ev_embeddable_backends> are, which, unfortunately, does not include any 2463C<ev_embeddable_backends> are, which, unfortunately, does not include any
2408portable one. 2464portable one.
2409 2465
2629=over 4 2685=over 4
2630 2686
2631=item ev_async_init (ev_async *, callback) 2687=item ev_async_init (ev_async *, callback)
2632 2688
2633Initialises and configures the async watcher - it has no parameters of any 2689Initialises and configures the async watcher - it has no parameters of any
2634kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless, 2690kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
2635trust me. 2691trust me.
2636 2692
2637=item ev_async_send (loop, ev_async *) 2693=item ev_async_send (loop, ev_async *)
2638 2694
2639Sends/signals/activates the given C<ev_async> watcher, that is, feeds 2695Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2640an C<EV_ASYNC> event on the watcher into the event loop. Unlike 2696an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2641C<ev_feed_event>, this call is safe to do from other threads, signal or 2697C<ev_feed_event>, this call is safe to do from other threads, signal or
2642similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding 2698similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2643section below on what exactly this means). 2699section below on what exactly this means).
2644 2700
2701Note that, as with other watchers in libev, multiple events might get
2702compressed into a single callback invocation (another way to look at this
2703is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
2704reset when the event loop detects that).
2705
2645This call incurs the overhead of a system call only once per loop iteration, 2706This call incurs the overhead of a system call only once per event loop
2646so while the overhead might be noticeable, it doesn't apply to repeated 2707iteration, so while the overhead might be noticeable, it doesn't apply to
2647calls to C<ev_async_send>. 2708repeated calls to C<ev_async_send> for the same event loop.
2648 2709
2649=item bool = ev_async_pending (ev_async *) 2710=item bool = ev_async_pending (ev_async *)
2650 2711
2651Returns a non-zero value when C<ev_async_send> has been called on the 2712Returns a non-zero value when C<ev_async_send> has been called on the
2652watcher but the event has not yet been processed (or even noted) by the 2713watcher but the event has not yet been processed (or even noted) by the
2655C<ev_async_send> sets a flag in the watcher and wakes up the loop. When 2716C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2656the loop iterates next and checks for the watcher to have become active, 2717the loop iterates next and checks for the watcher to have become active,
2657it will reset the flag again. C<ev_async_pending> can be used to very 2718it will reset the flag again. C<ev_async_pending> can be used to very
2658quickly check whether invoking the loop might be a good idea. 2719quickly check whether invoking the loop might be a good idea.
2659 2720
2660Not that this does I<not> check whether the watcher itself is pending, only 2721Not that this does I<not> check whether the watcher itself is pending,
2661whether it has been requested to make this watcher pending. 2722only whether it has been requested to make this watcher pending: there
2723is a time window between the event loop checking and resetting the async
2724notification, and the callback being invoked.
2662 2725
2663=back 2726=back
2664 2727
2665 2728
2666=head1 OTHER FUNCTIONS 2729=head1 OTHER FUNCTIONS
2845 2908
2846 myclass obj; 2909 myclass obj;
2847 ev::io iow; 2910 ev::io iow;
2848 iow.set <myclass, &myclass::io_cb> (&obj); 2911 iow.set <myclass, &myclass::io_cb> (&obj);
2849 2912
2913=item w->set (object *)
2914
2915This is an B<experimental> feature that might go away in a future version.
2916
2917This is a variation of a method callback - leaving out the method to call
2918will default the method to C<operator ()>, which makes it possible to use
2919functor objects without having to manually specify the C<operator ()> all
2920the time. Incidentally, you can then also leave out the template argument
2921list.
2922
2923The C<operator ()> method prototype must be C<void operator ()(watcher &w,
2924int revents)>.
2925
2926See the method-C<set> above for more details.
2927
2928Example: use a functor object as callback.
2929
2930 struct myfunctor
2931 {
2932 void operator() (ev::io &w, int revents)
2933 {
2934 ...
2935 }
2936 }
2937
2938 myfunctor f;
2939
2940 ev::io w;
2941 w.set (&f);
2942
2850=item w->set<function> (void *data = 0) 2943=item w->set<function> (void *data = 0)
2851 2944
2852Also sets a callback, but uses a static method or plain function as 2945Also sets a callback, but uses a static method or plain function as
2853callback. The optional C<data> argument will be stored in the watcher's 2946callback. The optional C<data> argument will be stored in the watcher's
2854C<data> member and is free for you to use. 2947C<data> member and is free for you to use.
2940L<http://software.schmorp.de/pkg/EV>. 3033L<http://software.schmorp.de/pkg/EV>.
2941 3034
2942=item Python 3035=item Python
2943 3036
2944Python bindings can be found at L<http://code.google.com/p/pyev/>. It 3037Python bindings can be found at L<http://code.google.com/p/pyev/>. It
2945seems to be quite complete and well-documented. Note, however, that the 3038seems to be quite complete and well-documented.
2946patch they require for libev is outright dangerous as it breaks the ABI
2947for everybody else, and therefore, should never be applied in an installed
2948libev (if python requires an incompatible ABI then it needs to embed
2949libev).
2950 3039
2951=item Ruby 3040=item Ruby
2952 3041
2953Tony Arcieri has written a ruby extension that offers access to a subset 3042Tony Arcieri has written a ruby extension that offers access to a subset
2954of the libev API and adds file handle abstractions, asynchronous DNS and 3043of the libev API and adds file handle abstractions, asynchronous DNS and
2955more on top of it. It can be found via gem servers. Its homepage is at 3044more on top of it. It can be found via gem servers. Its homepage is at
2956L<http://rev.rubyforge.org/>. 3045L<http://rev.rubyforge.org/>.
3046
3047Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
3048makes rev work even on mingw.
3049
3050=item Haskell
3051
3052A haskell binding to libev is available at
3053L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
2957 3054
2958=item D 3055=item D
2959 3056
2960Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 3057Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2961be found at L<http://proj.llucax.com.ar/wiki/evd>. 3058be found at L<http://proj.llucax.com.ar/wiki/evd>.
3072 3169
3073 #define EV_STANDALONE 1 3170 #define EV_STANDALONE 1
3074 #include "ev.h" 3171 #include "ev.h"
3075 3172
3076Both header files and implementation files can be compiled with a C++ 3173Both header files and implementation files can be compiled with a C++
3077compiler (at least, thats a stated goal, and breakage will be treated 3174compiler (at least, that's a stated goal, and breakage will be treated
3078as a bug). 3175as a bug).
3079 3176
3080You need the following files in your source tree, or in a directory 3177You need the following files in your source tree, or in a directory
3081in your include path (e.g. in libev/ when using -Ilibev): 3178in your include path (e.g. in libev/ when using -Ilibev):
3082 3179
3138keeps libev from including F<config.h>, and it also defines dummy 3235keeps libev from including F<config.h>, and it also defines dummy
3139implementations for some libevent functions (such as logging, which is not 3236implementations for some libevent functions (such as logging, which is not
3140supported). It will also not define any of the structs usually found in 3237supported). It will also not define any of the structs usually found in
3141F<event.h> that are not directly supported by the libev core alone. 3238F<event.h> that are not directly supported by the libev core alone.
3142 3239
3240In stanbdalone mode, libev will still try to automatically deduce the
3241configuration, but has to be more conservative.
3242
3143=item EV_USE_MONOTONIC 3243=item EV_USE_MONOTONIC
3144 3244
3145If defined to be C<1>, libev will try to detect the availability of the 3245If defined to be C<1>, libev will try to detect the availability of the
3146monotonic clock option at both compile time and runtime. Otherwise no use 3246monotonic clock option at both compile time and runtime. Otherwise no
3147of the monotonic clock option will be attempted. If you enable this, you 3247use of the monotonic clock option will be attempted. If you enable this,
3148usually have to link against librt or something similar. Enabling it when 3248you usually have to link against librt or something similar. Enabling it
3149the functionality isn't available is safe, though, although you have 3249when the functionality isn't available is safe, though, although you have
3150to make sure you link against any libraries where the C<clock_gettime> 3250to make sure you link against any libraries where the C<clock_gettime>
3151function is hiding in (often F<-lrt>). 3251function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
3152 3252
3153=item EV_USE_REALTIME 3253=item EV_USE_REALTIME
3154 3254
3155If defined to be C<1>, libev will try to detect the availability of the 3255If defined to be C<1>, libev will try to detect the availability of the
3156real-time clock option at compile time (and assume its availability at 3256real-time clock option at compile time (and assume its availability
3157runtime if successful). Otherwise no use of the real-time clock option will 3257at runtime if successful). Otherwise no use of the real-time clock
3158be attempted. This effectively replaces C<gettimeofday> by C<clock_get 3258option will be attempted. This effectively replaces C<gettimeofday>
3159(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the 3259by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
3160note about libraries in the description of C<EV_USE_MONOTONIC>, though. 3260correctness. See the note about libraries in the description of
3261C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
3262C<EV_USE_CLOCK_SYSCALL>.
3263
3264=item EV_USE_CLOCK_SYSCALL
3265
3266If defined to be C<1>, libev will try to use a direct syscall instead
3267of calling the system-provided C<clock_gettime> function. This option
3268exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
3269unconditionally pulls in C<libpthread>, slowing down single-threaded
3270programs needlessly. Using a direct syscall is slightly slower (in
3271theory), because no optimised vdso implementation can be used, but avoids
3272the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
3273higher, as it simplifies linking (no need for C<-lrt>).
3161 3274
3162=item EV_USE_NANOSLEEP 3275=item EV_USE_NANOSLEEP
3163 3276
3164If defined to be C<1>, libev will assume that C<nanosleep ()> is available 3277If defined to be C<1>, libev will assume that C<nanosleep ()> is available
3165and will use it for delays. Otherwise it will use C<select ()>. 3278and will use it for delays. Otherwise it will use C<select ()>.
3181 3294
3182=item EV_SELECT_USE_FD_SET 3295=item EV_SELECT_USE_FD_SET
3183 3296
3184If defined to C<1>, then the select backend will use the system C<fd_set> 3297If defined to C<1>, then the select backend will use the system C<fd_set>
3185structure. This is useful if libev doesn't compile due to a missing 3298structure. This is useful if libev doesn't compile due to a missing
3186C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on 3299C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
3187exotic systems. This usually limits the range of file descriptors to some 3300on exotic systems. This usually limits the range of file descriptors to
3188low limit such as 1024 or might have other limitations (winsocket only 3301some low limit such as 1024 or might have other limitations (winsocket
3189allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might 3302only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
3190influence the size of the C<fd_set> used. 3303configures the maximum size of the C<fd_set>.
3191 3304
3192=item EV_SELECT_IS_WINSOCKET 3305=item EV_SELECT_IS_WINSOCKET
3193 3306
3194When defined to C<1>, the select backend will assume that 3307When defined to C<1>, the select backend will assume that
3195select/socket/connect etc. don't understand file descriptors but 3308select/socket/connect etc. don't understand file descriptors but
3554loop, as long as you don't confuse yourself). The only exception is that 3667loop, as long as you don't confuse yourself). The only exception is that
3555you must not do this from C<ev_periodic> reschedule callbacks. 3668you must not do this from C<ev_periodic> reschedule callbacks.
3556 3669
3557Care has been taken to ensure that libev does not keep local state inside 3670Care has been taken to ensure that libev does not keep local state inside
3558C<ev_loop>, and other calls do not usually allow for coroutine switches as 3671C<ev_loop>, and other calls do not usually allow for coroutine switches as
3559they do not clal any callbacks. 3672they do not call any callbacks.
3560 3673
3561=head2 COMPILER WARNINGS 3674=head2 COMPILER WARNINGS
3562 3675
3563Depending on your compiler and compiler settings, you might get no or a 3676Depending on your compiler and compiler settings, you might get no or a
3564lot of warnings when compiling libev code. Some people are apparently 3677lot of warnings when compiling libev code. Some people are apparently
3598 ==2274== definitely lost: 0 bytes in 0 blocks. 3711 ==2274== definitely lost: 0 bytes in 0 blocks.
3599 ==2274== possibly lost: 0 bytes in 0 blocks. 3712 ==2274== possibly lost: 0 bytes in 0 blocks.
3600 ==2274== still reachable: 256 bytes in 1 blocks. 3713 ==2274== still reachable: 256 bytes in 1 blocks.
3601 3714
3602Then there is no memory leak, just as memory accounted to global variables 3715Then there is no memory leak, just as memory accounted to global variables
3603is not a memleak - the memory is still being refernced, and didn't leak. 3716is not a memleak - the memory is still being referenced, and didn't leak.
3604 3717
3605Similarly, under some circumstances, valgrind might report kernel bugs 3718Similarly, under some circumstances, valgrind might report kernel bugs
3606as if it were a bug in libev (e.g. in realloc or in the poll backend, 3719as if it were a bug in libev (e.g. in realloc or in the poll backend,
3607although an acceptable workaround has been found here), or it might be 3720although an acceptable workaround has been found here), or it might be
3608confused. 3721confused.
3846=back 3959=back
3847 3960
3848 3961
3849=head1 AUTHOR 3962=head1 AUTHOR
3850 3963
3851Marc Lehmann <libev@schmorp.de>. 3964Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3852 3965

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines