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

Comparing libev/ev.pod (file contents):
Revision 1.209 by root, Wed Oct 29 14:12:34 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);
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). 391epoll scales either O(1) or O(active_fds).
390 392
391The epoll syscalls are the most misdesigned of the more advanced event 393The epoll mechanism deserves honorable mention as the most misdesigned
392mechanisms: problems include silently dropping fds, requiring a system 394of the more advanced event mechanisms: mere annoyances include silently
393call per change per fd (and unnecessary guessing of parameters), problems 395dropping file descriptors, requiring a system call per change per file
396descriptor (and unnecessary guessing of parameters), problems with dup and
394with dup and so on. The biggest issue is fork races, however - if a 397so on. The biggest issue is fork races, however - if a program forks then
395program forks then I<both> parent and child process have to recreate the 398I<both> parent and child process have to recreate the epoll set, which can
396epoll set, which can take considerable time (one syscall per fd) and is of 399take considerable time (one syscall per file descriptor) and is of course
397course hard to detect. 400hard to detect.
398 401
399Epoll is also notoriously buggy - embedding epoll fds should work, but 402Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
400of course doesn't, and epoll just loves to report events for totally 403of course I<doesn't>, and epoll just loves to report events for totally
401I<different> file descriptors (even already closed ones, so one cannot 404I<different> file descriptors (even already closed ones, so one cannot
402even remove them from the set) than registered in the set (especially 405even remove them from the set) than registered in the set (especially
403on SMP systems). Libev tries to counter these spurious notifications by 406on SMP systems). Libev tries to counter these spurious notifications by
404employing an additional generation counter and comparing that against the 407employing an additional generation counter and comparing that against the
405events to filter out spurious ones. 408events to filter out spurious ones, recreating the set when required.
406 409
407While 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
408will 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
409(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
410best 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
411very well if you register events for both fds. 414file descriptors might not work very well if you register events for both
415file descriptors.
412 416
413Best performance from this backend is achieved by not unregistering all 417Best performance from this backend is achieved by not unregistering all
414watchers for a file descriptor until it has been closed, if possible, 418watchers for a file descriptor until it has been closed, if possible,
415i.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
416starting a watcher (without re-setting it) also usually doesn't cause 420starting a watcher (without re-setting it) also usually doesn't cause
417extra overhead. A fork can both result in spurious notifications as well 421extra overhead. A fork can both result in spurious notifications as well
418as in libev having to destroy and recreate the epoll object, which can 422as in libev having to destroy and recreate the epoll object, which can
419take considerable time and thus should be avoided. 423take considerable time and thus should be avoided.
420 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.
428
421While nominally embeddable in other event loops, this feature is broken in 429While nominally embeddable in other event loops, this feature is broken in
422all kernel versions tested so far. 430all kernel versions tested so far.
423 431
424This 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
425C<EVBACKEND_POLL>. 433C<EVBACKEND_POLL>.
426 434
427=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 435=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
428 436
429Kqueue deserves special mention, as at the time of this writing, it was 437Kqueue deserves special mention, as at the time of this writing, it
430broken 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
431anything but sockets and pipes, except on Darwin, where of course it's 439with anything but sockets and pipes, except on Darwin, where of course
432completely useless). For this reason it's not being "auto-detected" unless 440it's completely useless). Unlike epoll, however, whose brokenness
433you 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
434libev 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.
435 446
436You 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
437only 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
438the target platform). See C<ev_embed> watchers for more info. 449the target platform). See C<ev_embed> watchers for more info.
439 450
449 460
450While nominally embeddable in other event loops, this doesn't work 461While nominally embeddable in other event loops, this doesn't work
451everywhere, 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
452almost 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
453(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
454(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
455using it only for sockets. 466also broken on OS X)) and, did I mention it, using it only for sockets.
456 467
457This 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
458C<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
459C<NOTE_EOF>. 470C<NOTE_EOF>.
460 471
1410 else 1421 else
1411 { 1422 {
1412 // callback was invoked, but there was some activity, re-arm 1423 // callback was invoked, but there was some activity, re-arm
1413 // the watcher to fire in last_activity + 60, which is 1424 // the watcher to fire in last_activity + 60, which is
1414 // guaranteed to be in the future, so "again" is positive: 1425 // guaranteed to be in the future, so "again" is positive:
1415 w->again = timeout - now; 1426 w->repeat = timeout - now;
1416 ev_timer_again (EV_A_ w); 1427 ev_timer_again (EV_A_ w);
1417 } 1428 }
1418 } 1429 }
1419 1430
1420To summarise the callback: first calculate the real timeout (defined 1431To summarise the callback: first calculate the real timeout (defined
1585=head2 C<ev_periodic> - to cron or not to cron? 1596=head2 C<ev_periodic> - to cron or not to cron?
1586 1597
1587Periodic 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
1588(and unfortunately a bit complex). 1599(and unfortunately a bit complex).
1589 1600
1590Unlike 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
1591but on wall clock time (absolute time). You can tell a periodic watcher 1602relative time, the physical time that passes) but on wall clock time
1592to 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
1593periodic 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
1594+ 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
1595clock to January of the previous year, then it will take more than year 1606wrist-watch).
1596to trigger the event (unlike an C<ev_timer>, which would still trigger
1597roughly 10 seconds later as it uses a relative timeout).
1598 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
1599C<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
1600such as triggering an event on each "midnight, local time", or other 1617timers, such as triggering an event on each "midnight, local time", or
1601complicated rules. 1618other complicated rules. This cannot be done with C<ev_timer> watchers, as
1619those cannot react to time jumps.
1602 1620
1603As 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
1604time (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
1605during 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.
1606 1625
1607=head3 Watcher-Specific Functions and Data Members 1626=head3 Watcher-Specific Functions and Data Members
1608 1627
1609=over 4 1628=over 4
1610 1629
1611=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)
1612 1631
1613=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)
1614 1633
1615Lots 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
1616operation, and we will explain them from simplest to most complex: 1635operation, and we will explain them from simplest to most complex:
1617 1636
1618=over 4 1637=over 4
1619 1638
1620=item * absolute timer (at = time, interval = reschedule_cb = 0) 1639=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1621 1640
1622In this configuration the watcher triggers an event after the wall clock 1641In this configuration the watcher triggers an event after the wall clock
1623time 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
1624jump 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
1625only 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.
1626 1646
1627=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)
1628 1648
1629In 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
1630C<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
1631and 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.
1632 1653
1633This 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
1634system 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
1635hour, on the hour: 1656hour, on the hour (with respect to UTC):
1636 1657
1637 ev_periodic_set (&periodic, 0., 3600., 0); 1658 ev_periodic_set (&periodic, 0., 3600., 0);
1638 1659
1639This 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,
1640but 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
1641full 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
1642by 3600. 1663by 3600.
1643 1664
1644Another way to think about it (for the mathematically inclined) is that 1665Another way to think about it (for the mathematically inclined) is that
1645C<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
1646time where C<time = at (mod interval)>, regardless of any time jumps. 1667time where C<time = offset (mod interval)>, regardless of any time jumps.
1647 1668
1648For 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
1649C<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
1650this value, and in fact is often specified as zero. 1671this value, and in fact is often specified as zero.
1651 1672
1652Note 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
1653speed 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
1654will 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
1655millisecond (if the OS supports it and the machine is fast enough). 1676millisecond (if the OS supports it and the machine is fast enough).
1656 1677
1657=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) 1678=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1658 1679
1659In 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
1660ignored. Instead, each time the periodic watcher gets scheduled, the 1681ignored. Instead, each time the periodic watcher gets scheduled, the
1661reschedule callback will be called with the watcher as first, and the 1682reschedule callback will be called with the watcher as first, and the
1662current time as second argument. 1683current time as second argument.
1663 1684
1664NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, 1685NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1665ever, or make ANY event loop modifications whatsoever>. 1686or make ANY other event loop modifications whatsoever, unless explicitly
1687allowed by documentation here>.
1666 1688
1667If 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
1668it 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
1669only event loop modification you are allowed to do). 1691only event loop modification you are allowed to do).
1670 1692
1700a 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
1701program when the crontabs have changed). 1723program when the crontabs have changed).
1702 1724
1703=item ev_tstamp ev_periodic_at (ev_periodic *) 1725=item ev_tstamp ev_periodic_at (ev_periodic *)
1704 1726
1705When active, returns the absolute time that the watcher is supposed to 1727When active, returns the absolute time that the watcher is supposed
1706trigger 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.
1707 1731
1708=item ev_tstamp offset [read-write] 1732=item ev_tstamp offset [read-write]
1709 1733
1710When repeating, this contains the offset value, otherwise this is the 1734When repeating, this contains the offset value, otherwise this is the
1711absolute 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).
1712 1737
1713Can 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
1714timer fires or C<ev_periodic_again> is being called. 1739timer fires or C<ev_periodic_again> is being called.
1715 1740
1716=item ev_tstamp interval [read-write] 1741=item ev_tstamp interval [read-write]
1927C<stat> on that path in regular intervals (or when the OS says it changed) 1952C<stat> on that path in regular intervals (or when the OS says it changed)
1928and sees if it changed compared to the last time, invoking the callback if 1953and sees if it changed compared to the last time, invoking the callback if
1929it did. 1954it did.
1930 1955
1931The 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
1932not 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
1933not 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
1934otherwise 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
1935the stat buffer having unspecified contents. 1960least one) and all the other fields of the stat buffer having unspecified
1961contents.
1936 1962
1937The path I<must not> end in a slash or contain special components such as 1963The path I<must not> end in a slash or contain special components such as
1938C<.> or C<..>. The path I<should> be absolute: If it is relative and 1964C<.> or C<..>. The path I<should> be absolute: If it is relative and
1939your working directory changes, then the behaviour is undefined. 1965your working directory changes, then the behaviour is undefined.
1940 1966
1950This watcher type is not meant for massive numbers of stat watchers, 1976This watcher type is not meant for massive numbers of stat watchers,
1951as even with OS-supported change notifications, this can be 1977as even with OS-supported change notifications, this can be
1952resource-intensive. 1978resource-intensive.
1953 1979
1954At the time of this writing, the only OS-specific interface implemented 1980At the time of this writing, the only OS-specific interface implemented
1955is the Linux inotify interface (implementing kqueue support is left as 1981is the Linux inotify interface (implementing kqueue support is left as an
1956an 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
1957of implementing C<ev_stat> semantics with kqueue). 1983implementing C<ev_stat> semantics with kqueue, except as a hint).
1958 1984
1959=head3 ABI Issues (Largefile Support) 1985=head3 ABI Issues (Largefile Support)
1960 1986
1961Libev by default (unless the user overrides this) uses the default 1987Libev by default (unless the user overrides this) uses the default
1962compilation environment, which means that on systems with large file 1988compilation environment, which means that on systems with large file
1973to exchange stat structures with application programs compiled using the 1999to exchange stat structures with application programs compiled using the
1974default compilation environment. 2000default compilation environment.
1975 2001
1976=head3 Inotify and Kqueue 2002=head3 Inotify and Kqueue
1977 2003
1978When C<inotify (7)> support has been compiled into libev (generally 2004When C<inotify (7)> support has been compiled into libev and present at
1979only 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
1980implementations) and present at runtime, it will be used to speed up 2006inotify descriptor will be created lazily when the first C<ev_stat>
1981change detection where possible. The inotify descriptor will be created 2007watcher is being started.
1982lazily when the first C<ev_stat> watcher is being started.
1983 2008
1984Inotify presence does not change the semantics of C<ev_stat> watchers 2009Inotify presence does not change the semantics of C<ev_stat> watchers
1985except 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
1986making regular C<stat> calls. Even in the presence of inotify support 2011making regular C<stat> calls. Even in the presence of inotify support
1987there 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,
1988but 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.
1989 2017
1990There 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
1991implement this functionality, due to the requirement of having a file 2019implement this functionality, due to the requirement of having a file
1992descriptor open on the object at all times, and detecting renames, unlinks 2020descriptor open on the object at all times, and detecting renames, unlinks
1993etc. is difficult. 2021etc. is difficult.
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.
1994 2040
1995=head3 The special problem of stat time resolution 2041=head3 The special problem of stat time resolution
1996 2042
1997The C<stat ()> system call only supports full-second resolution portably, 2043The C<stat ()> system call only supports full-second resolution portably,
1998and even on systems where the resolution is higher, most file systems 2044and even on systems where the resolution is higher, most file systems
2147 2193
2148=head3 Watcher-Specific Functions and Data Members 2194=head3 Watcher-Specific Functions and Data Members
2149 2195
2150=over 4 2196=over 4
2151 2197
2152=item ev_idle_init (ev_signal *, callback) 2198=item ev_idle_init (ev_idle *, callback)
2153 2199
2154Initialises and configures the idle watcher - it has no parameters of any 2200Initialises and configures the idle watcher - it has no parameters of any
2155kind. 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,
2156believe me. 2202believe me.
2157 2203
2396some 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),
2397and even priorities and idle watchers might have too much overhead. In 2443and even priorities and idle watchers might have too much overhead. In
2398this 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
2399the 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.
2400 2446
2401As 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
2402there might be events pending in the embedded loop. The callback must then 2448time there might be events pending in the embedded loop. The callback
2403call 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
2404their 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
2405loop strictly lower priority for example). You can also set the callback 2451C<ev_embed_sweep> function directly, it could also start an idle watcher
2406to C<0>, in which case the embed watcher will automatically execute the 2452to give the embedded loop strictly lower priority for example).
2407embedded loop sweep.
2408 2453
2409As 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
2410callback will be invoked whenever some events have been handled. You can 2455will automatically execute the embedded loop sweep whenever necessary.
2411set the callback to C<0> to avoid having to specify one if you are not
2412interested in that.
2413 2456
2414Also, there have not currently been made special provisions for forking: 2457Fork detection will be handled transparently while the C<ev_embed> watcher
2415when 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
2416but 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
2417yourself - but you can use a fork watcher to handle this automatically, 2460C<ev_loop_fork> on the embedded loop.
2418and future versions of libev might do just that.
2419 2461
2420Unfortunately, not all backends are embeddable: only the ones returned by 2462Unfortunately, not all backends are embeddable: only the ones returned by
2421C<ev_embeddable_backends> are, which, unfortunately, does not include any 2463C<ev_embeddable_backends> are, which, unfortunately, does not include any
2422portable one. 2464portable one.
2423 2465
2654an 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
2655C<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
2656similar 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
2657section below on what exactly this means). 2699section below on what exactly this means).
2658 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
2659This 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
2660so 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
2661calls to C<ev_async_send>. 2708repeated calls to C<ev_async_send> for the same event loop.
2662 2709
2663=item bool = ev_async_pending (ev_async *) 2710=item bool = ev_async_pending (ev_async *)
2664 2711
2665Returns 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
2666watcher 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
2669C<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
2670the 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,
2671it 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
2672quickly check whether invoking the loop might be a good idea. 2719quickly check whether invoking the loop might be a good idea.
2673 2720
2674Not 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,
2675whether 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.
2676 2725
2677=back 2726=back
2678 2727
2679 2728
2680=head1 OTHER FUNCTIONS 2729=head1 OTHER FUNCTIONS
2859 2908
2860 myclass obj; 2909 myclass obj;
2861 ev::io iow; 2910 ev::io iow;
2862 iow.set <myclass, &myclass::io_cb> (&obj); 2911 iow.set <myclass, &myclass::io_cb> (&obj);
2863 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
2864=item w->set<function> (void *data = 0) 2943=item w->set<function> (void *data = 0)
2865 2944
2866Also 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
2867callback. 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
2868C<data> member and is free for you to use. 2947C<data> member and is free for you to use.
2954L<http://software.schmorp.de/pkg/EV>. 3033L<http://software.schmorp.de/pkg/EV>.
2955 3034
2956=item Python 3035=item Python
2957 3036
2958Python 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
2959seems to be quite complete and well-documented. Note, however, that the 3038seems to be quite complete and well-documented.
2960patch they require for libev is outright dangerous as it breaks the ABI
2961for everybody else, and therefore, should never be applied in an installed
2962libev (if python requires an incompatible ABI then it needs to embed
2963libev).
2964 3039
2965=item Ruby 3040=item Ruby
2966 3041
2967Tony 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
2968of the libev API and adds file handle abstractions, asynchronous DNS and 3043of the libev API and adds file handle abstractions, asynchronous DNS and
2969more 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
2970L<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>.
2971 3054
2972=item D 3055=item D
2973 3056
2974Leandro 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
2975be found at L<http://proj.llucax.com.ar/wiki/evd>. 3058be found at L<http://proj.llucax.com.ar/wiki/evd>.
3152keeps libev from including F<config.h>, and it also defines dummy 3235keeps libev from including F<config.h>, and it also defines dummy
3153implementations for some libevent functions (such as logging, which is not 3236implementations for some libevent functions (such as logging, which is not
3154supported). 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
3155F<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.
3156 3239
3240In stanbdalone mode, libev will still try to automatically deduce the
3241configuration, but has to be more conservative.
3242
3157=item EV_USE_MONOTONIC 3243=item EV_USE_MONOTONIC
3158 3244
3159If 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
3160monotonic clock option at both compile time and runtime. Otherwise no use 3246monotonic clock option at both compile time and runtime. Otherwise no
3161of 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,
3162usually have to link against librt or something similar. Enabling it when 3248you usually have to link against librt or something similar. Enabling it
3163the functionality isn't available is safe, though, although you have 3249when the functionality isn't available is safe, though, although you have
3164to 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>
3165function is hiding in (often F<-lrt>). 3251function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
3166 3252
3167=item EV_USE_REALTIME 3253=item EV_USE_REALTIME
3168 3254
3169If 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
3170real-time clock option at compile time (and assume its availability at 3256real-time clock option at compile time (and assume its availability
3171runtime if successful). Otherwise no use of the real-time clock option will 3257at runtime if successful). Otherwise no use of the real-time clock
3172be attempted. This effectively replaces C<gettimeofday> by C<clock_get 3258option will be attempted. This effectively replaces C<gettimeofday>
3173(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the 3259by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
3174note 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>).
3175 3274
3176=item EV_USE_NANOSLEEP 3275=item EV_USE_NANOSLEEP
3177 3276
3178If 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
3179and will use it for delays. Otherwise it will use C<select ()>. 3278and will use it for delays. Otherwise it will use C<select ()>.
3195 3294
3196=item EV_SELECT_USE_FD_SET 3295=item EV_SELECT_USE_FD_SET
3197 3296
3198If 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>
3199structure. 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
3200C<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
3201exotic systems. This usually limits the range of file descriptors to some 3300on exotic systems. This usually limits the range of file descriptors to
3202low limit such as 1024 or might have other limitations (winsocket only 3301some low limit such as 1024 or might have other limitations (winsocket
3203allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might 3302only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
3204influence the size of the C<fd_set> used. 3303configures the maximum size of the C<fd_set>.
3205 3304
3206=item EV_SELECT_IS_WINSOCKET 3305=item EV_SELECT_IS_WINSOCKET
3207 3306
3208When defined to C<1>, the select backend will assume that 3307When defined to C<1>, the select backend will assume that
3209select/socket/connect etc. don't understand file descriptors but 3308select/socket/connect etc. don't understand file descriptors but

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines