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

Comparing libev/ev.pod (file contents):
Revision 1.213 by root, Wed Nov 5 02:48:45 2008 UTC vs.
Revision 1.232 by root, Thu Apr 16 06:17:26 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);
418starting a watcher (without re-setting it) also usually doesn't cause 420starting a watcher (without re-setting it) also usually doesn't cause
419extra overhead. A fork can both result in spurious notifications as well 421extra overhead. A fork can both result in spurious notifications as well
420as 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
421take considerable time and thus should be avoided. 423take considerable time and thus should be avoided.
422 424
423All this means that, in practise, C<EVBACKEND_SELECT> is as fast or faster 425All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
424then epoll for maybe up to a hundred file descriptors. So sad. 426faster than epoll for maybe up to a hundred file descriptors, depending on
427the usage. So sad.
425 428
426While nominally embeddable in other event loops, this feature is broken in 429While nominally embeddable in other event loops, this feature is broken in
427all kernel versions tested so far. 430all kernel versions tested so far.
428 431
429This 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
457 460
458While nominally embeddable in other event loops, this doesn't work 461While nominally embeddable in other event loops, this doesn't work
459everywhere, 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
460almost 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
461(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
462(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
463using it only for sockets. 466also broken on OS X)) and, did I mention it, using it only for sockets.
464 467
465This 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
466C<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
467C<NOTE_EOF>. 470C<NOTE_EOF>.
468 471
630This function is rarely useful, but when some event callback runs for a 633This function is rarely useful, but when some event callback runs for a
631very long time without entering the event loop, updating libev's idea of 634very long time without entering the event loop, updating libev's idea of
632the current time is a good idea. 635the current time is a good idea.
633 636
634See also "The special problem of time updates" in the C<ev_timer> section. 637See also "The special problem of time updates" in the C<ev_timer> section.
638
639=item ev_suspend (loop)
640
641=item ev_resume (loop)
642
643These two functions suspend and resume a loop, for use when the loop is
644not used for a while and timeouts should not be processed.
645
646A typical use case would be an interactive program such as a game: When
647the user presses C<^Z> to suspend the game and resumes it an hour later it
648would be best to handle timeouts as if no time had actually passed while
649the program was suspended. This can be achieved by calling C<ev_suspend>
650in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
651C<ev_resume> directly afterwards to resume timer processing.
652
653Effectively, all C<ev_timer> watchers will be delayed by the time spend
654between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
655will be rescheduled (that is, they will lose any events that would have
656occured while suspended).
657
658After calling C<ev_suspend> you B<must not> call I<any> function on the
659given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
660without a previous call to C<ev_suspend>.
661
662Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
663event loop time (see C<ev_now_update>).
635 664
636=item ev_loop (loop, int flags) 665=item ev_loop (loop, int flags)
637 666
638Finally, this is it, the event handler. This function usually is called 667Finally, this is it, the event handler. This function usually is called
639after you initialised all your watchers and you want to start handling 668after you initialised all your watchers and you want to start handling
723 752
724If you have a watcher you never unregister that should not keep C<ev_loop> 753If you have a watcher you never unregister that should not keep C<ev_loop>
725from returning, call ev_unref() after starting, and ev_ref() before 754from returning, call ev_unref() after starting, and ev_ref() before
726stopping it. 755stopping it.
727 756
728As an example, libev itself uses this for its internal signal pipe: It is 757As an example, libev itself uses this for its internal signal pipe: It
729not visible to the libev user and should not keep C<ev_loop> from exiting 758is not visible to the libev user and should not keep C<ev_loop> from
730if no event watchers registered by it are active. It is also an excellent 759exiting if no event watchers registered by it are active. It is also an
731way to do this for generic recurring timers or from within third-party 760excellent way to do this for generic recurring timers or from within
732libraries. Just remember to I<unref after start> and I<ref before stop> 761third-party libraries. Just remember to I<unref after start> and I<ref
733(but only if the watcher wasn't active before, or was active before, 762before stop> (but only if the watcher wasn't active before, or was active
734respectively). 763before, respectively. Note also that libev might stop watchers itself
764(e.g. non-repeating timers) in which case you have to C<ev_ref>
765in the callback).
735 766
736Example: Create a signal watcher, but keep it from keeping C<ev_loop> 767Example: Create a signal watcher, but keep it from keeping C<ev_loop>
737running when nothing else is active. 768running when nothing else is active.
738 769
739 ev_signal exitsig; 770 ev_signal exitsig;
923 954
924=item C<EV_ASYNC> 955=item C<EV_ASYNC>
925 956
926The given async watcher has been asynchronously notified (see C<ev_async>). 957The given async watcher has been asynchronously notified (see C<ev_async>).
927 958
959=item C<EV_CUSTOM>
960
961Not ever sent (or otherwise used) by libev itself, but can be freely used
962by libev users to signal watchers (e.g. via C<ev_feed_event>).
963
928=item C<EV_ERROR> 964=item C<EV_ERROR>
929 965
930An unspecified error has occurred, the watcher has been stopped. This might 966An unspecified error has occurred, the watcher has been stopped. This might
931happen because the watcher could not be properly started because libev 967happen because the watcher could not be properly started because libev
932ran out of memory, a file descriptor was found to be closed or any other 968ran out of memory, a file descriptor was found to be closed or any other
1046Set and query the priority of the watcher. The priority is a small 1082Set and query the priority of the watcher. The priority is a small
1047integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> 1083integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1048(default: C<-2>). Pending watchers with higher priority will be invoked 1084(default: C<-2>). Pending watchers with higher priority will be invoked
1049before watchers with lower priority, but priority will not keep watchers 1085before watchers with lower priority, but priority will not keep watchers
1050from being executed (except for C<ev_idle> watchers). 1086from being executed (except for C<ev_idle> watchers).
1087
1088See L<
1051 1089
1052This means that priorities are I<only> used for ordering callback 1090This means that priorities are I<only> used for ordering callback
1053invocation after new events have been received. This is useful, for 1091invocation after new events have been received. This is useful, for
1054example, to reduce latency after idling, or more often, to bind two 1092example, to reduce latency after idling, or more often, to bind two
1055watchers on the same event and make sure one is called first. 1093watchers on the same event and make sure one is called first.
1314year, it will still time out after (roughly) one hour. "Roughly" because 1352year, it will still time out after (roughly) one hour. "Roughly" because
1315detecting time jumps is hard, and some inaccuracies are unavoidable (the 1353detecting time jumps is hard, and some inaccuracies are unavoidable (the
1316monotonic clock option helps a lot here). 1354monotonic clock option helps a lot here).
1317 1355
1318The callback is guaranteed to be invoked only I<after> its timeout has 1356The callback is guaranteed to be invoked only I<after> its timeout has
1319passed, but if multiple timers become ready during the same loop iteration 1357passed. If multiple timers become ready during the same loop iteration
1320then order of execution is undefined. 1358then the ones with earlier time-out values are invoked before ones with
1359later time-out values (but this is no longer true when a callback calls
1360C<ev_loop> recursively).
1321 1361
1322=head3 Be smart about timeouts 1362=head3 Be smart about timeouts
1323 1363
1324Many real-world problems involve some kind of timeout, usually for error 1364Many real-world problems involve some kind of timeout, usually for error
1325recovery. A typical example is an HTTP request - if the other side hangs, 1365recovery. A typical example is an HTTP request - if the other side hangs,
1418 else 1458 else
1419 { 1459 {
1420 // callback was invoked, but there was some activity, re-arm 1460 // callback was invoked, but there was some activity, re-arm
1421 // the watcher to fire in last_activity + 60, which is 1461 // the watcher to fire in last_activity + 60, which is
1422 // guaranteed to be in the future, so "again" is positive: 1462 // guaranteed to be in the future, so "again" is positive:
1423 w->again = timeout - now; 1463 w->repeat = timeout - now;
1424 ev_timer_again (EV_A_ w); 1464 ev_timer_again (EV_A_ w);
1425 } 1465 }
1426 } 1466 }
1427 1467
1428To summarise the callback: first calculate the real timeout (defined 1468To summarise the callback: first calculate the real timeout (defined
1544If the timer is started but non-repeating, stop it (as if it timed out). 1584If the timer is started but non-repeating, stop it (as if it timed out).
1545 1585
1546If the timer is repeating, either start it if necessary (with the 1586If the timer is repeating, either start it if necessary (with the
1547C<repeat> value), or reset the running timer to the C<repeat> value. 1587C<repeat> value), or reset the running timer to the C<repeat> value.
1548 1588
1549This sounds a bit complicated, see "Be smart about timeouts", above, for a 1589This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1550usage example. 1590usage example.
1551 1591
1552=item ev_tstamp repeat [read-write] 1592=item ev_tstamp repeat [read-write]
1553 1593
1554The current C<repeat> value. Will be used each time the watcher times out 1594The current C<repeat> value. Will be used each time the watcher times out
1593=head2 C<ev_periodic> - to cron or not to cron? 1633=head2 C<ev_periodic> - to cron or not to cron?
1594 1634
1595Periodic watchers are also timers of a kind, but they are very versatile 1635Periodic watchers are also timers of a kind, but they are very versatile
1596(and unfortunately a bit complex). 1636(and unfortunately a bit complex).
1597 1637
1598Unlike C<ev_timer>'s, they are not based on real time (or relative time) 1638Unlike C<ev_timer>, periodic watchers are not based on real time (or
1599but on wall clock time (absolute time). You can tell a periodic watcher 1639relative time, the physical time that passes) but on wall clock time
1600to trigger after some specific point in time. For example, if you tell a 1640(absolute time, the thing you can read on your calender or clock). The
1601periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now () 1641difference is that wall clock time can run faster or slower than real
1602+ 10.>, that is, an absolute time not a delay) and then reset your system 1642time, and time jumps are not uncommon (e.g. when you adjust your
1603clock to January of the previous year, then it will take more than year 1643wrist-watch).
1604to trigger the event (unlike an C<ev_timer>, which would still trigger
1605roughly 10 seconds later as it uses a relative timeout).
1606 1644
1645You can tell a periodic watcher to trigger after some specific point
1646in time: for example, if you tell a periodic watcher to trigger "in 10
1647seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
1648not a delay) and then reset your system clock to January of the previous
1649year, then it will take a year or more to trigger the event (unlike an
1650C<ev_timer>, which would still trigger roughly 10 seconds after starting
1651it, as it uses a relative timeout).
1652
1607C<ev_periodic>s can also be used to implement vastly more complex timers, 1653C<ev_periodic> watchers can also be used to implement vastly more complex
1608such as triggering an event on each "midnight, local time", or other 1654timers, such as triggering an event on each "midnight, local time", or
1609complicated rules. 1655other complicated rules. This cannot be done with C<ev_timer> watchers, as
1656those cannot react to time jumps.
1610 1657
1611As with timers, the callback is guaranteed to be invoked only when the 1658As with timers, the callback is guaranteed to be invoked only when the
1612time (C<at>) has passed, but if multiple periodic timers become ready 1659point in time where it is supposed to trigger has passed. If multiple
1613during the same loop iteration, then order of execution is undefined. 1660timers become ready during the same loop iteration then the ones with
1661earlier time-out values are invoked before ones with later time-out values
1662(but this is no longer true when a callback calls C<ev_loop> recursively).
1614 1663
1615=head3 Watcher-Specific Functions and Data Members 1664=head3 Watcher-Specific Functions and Data Members
1616 1665
1617=over 4 1666=over 4
1618 1667
1619=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) 1668=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1620 1669
1621=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) 1670=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1622 1671
1623Lots of arguments, lets sort it out... There are basically three modes of 1672Lots of arguments, let's sort it out... There are basically three modes of
1624operation, and we will explain them from simplest to most complex: 1673operation, and we will explain them from simplest to most complex:
1625 1674
1626=over 4 1675=over 4
1627 1676
1628=item * absolute timer (at = time, interval = reschedule_cb = 0) 1677=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1629 1678
1630In this configuration the watcher triggers an event after the wall clock 1679In this configuration the watcher triggers an event after the wall clock
1631time C<at> has passed. It will not repeat and will not adjust when a time 1680time C<offset> has passed. It will not repeat and will not adjust when a
1632jump occurs, that is, if it is to be run at January 1st 2011 then it will 1681time jump occurs, that is, if it is to be run at January 1st 2011 then it
1633only run when the system clock reaches or surpasses this time. 1682will be stopped and invoked when the system clock reaches or surpasses
1683this point in time.
1634 1684
1635=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1685=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1636 1686
1637In this mode the watcher will always be scheduled to time out at the next 1687In this mode the watcher will always be scheduled to time out at the next
1638C<at + N * interval> time (for some integer N, which can also be negative) 1688C<offset + N * interval> time (for some integer N, which can also be
1639and then repeat, regardless of any time jumps. 1689negative) and then repeat, regardless of any time jumps. The C<offset>
1690argument is merely an offset into the C<interval> periods.
1640 1691
1641This can be used to create timers that do not drift with respect to the 1692This can be used to create timers that do not drift with respect to the
1642system clock, for example, here is a C<ev_periodic> that triggers each 1693system clock, for example, here is an C<ev_periodic> that triggers each
1643hour, on the hour: 1694hour, on the hour (with respect to UTC):
1644 1695
1645 ev_periodic_set (&periodic, 0., 3600., 0); 1696 ev_periodic_set (&periodic, 0., 3600., 0);
1646 1697
1647This doesn't mean there will always be 3600 seconds in between triggers, 1698This doesn't mean there will always be 3600 seconds in between triggers,
1648but only that the callback will be called when the system time shows a 1699but only that the callback will be called when the system time shows a
1649full hour (UTC), or more correctly, when the system time is evenly divisible 1700full hour (UTC), or more correctly, when the system time is evenly divisible
1650by 3600. 1701by 3600.
1651 1702
1652Another way to think about it (for the mathematically inclined) is that 1703Another way to think about it (for the mathematically inclined) is that
1653C<ev_periodic> will try to run the callback in this mode at the next possible 1704C<ev_periodic> will try to run the callback in this mode at the next possible
1654time where C<time = at (mod interval)>, regardless of any time jumps. 1705time where C<time = offset (mod interval)>, regardless of any time jumps.
1655 1706
1656For numerical stability it is preferable that the C<at> value is near 1707For numerical stability it is preferable that the C<offset> value is near
1657C<ev_now ()> (the current time), but there is no range requirement for 1708C<ev_now ()> (the current time), but there is no range requirement for
1658this value, and in fact is often specified as zero. 1709this value, and in fact is often specified as zero.
1659 1710
1660Note also that there is an upper limit to how often a timer can fire (CPU 1711Note also that there is an upper limit to how often a timer can fire (CPU
1661speed for example), so if C<interval> is very small then timing stability 1712speed for example), so if C<interval> is very small then timing stability
1662will of course deteriorate. Libev itself tries to be exact to be about one 1713will of course deteriorate. Libev itself tries to be exact to be about one
1663millisecond (if the OS supports it and the machine is fast enough). 1714millisecond (if the OS supports it and the machine is fast enough).
1664 1715
1665=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) 1716=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1666 1717
1667In this mode the values for C<interval> and C<at> are both being 1718In this mode the values for C<interval> and C<offset> are both being
1668ignored. Instead, each time the periodic watcher gets scheduled, the 1719ignored. Instead, each time the periodic watcher gets scheduled, the
1669reschedule callback will be called with the watcher as first, and the 1720reschedule callback will be called with the watcher as first, and the
1670current time as second argument. 1721current time as second argument.
1671 1722
1672NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, 1723NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1673ever, or make ANY event loop modifications whatsoever>. 1724or make ANY other event loop modifications whatsoever, unless explicitly
1725allowed by documentation here>.
1674 1726
1675If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop 1727If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
1676it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the 1728it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1677only event loop modification you are allowed to do). 1729only event loop modification you are allowed to do).
1678 1730
1708a different time than the last time it was called (e.g. in a crond like 1760a different time than the last time it was called (e.g. in a crond like
1709program when the crontabs have changed). 1761program when the crontabs have changed).
1710 1762
1711=item ev_tstamp ev_periodic_at (ev_periodic *) 1763=item ev_tstamp ev_periodic_at (ev_periodic *)
1712 1764
1713When active, returns the absolute time that the watcher is supposed to 1765When active, returns the absolute time that the watcher is supposed
1714trigger next. 1766to trigger next. This is not the same as the C<offset> argument to
1767C<ev_periodic_set>, but indeed works even in interval and manual
1768rescheduling modes.
1715 1769
1716=item ev_tstamp offset [read-write] 1770=item ev_tstamp offset [read-write]
1717 1771
1718When repeating, this contains the offset value, otherwise this is the 1772When repeating, this contains the offset value, otherwise this is the
1719absolute point in time (the C<at> value passed to C<ev_periodic_set>). 1773absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
1774although libev might modify this value for better numerical stability).
1720 1775
1721Can be modified any time, but changes only take effect when the periodic 1776Can be modified any time, but changes only take effect when the periodic
1722timer fires or C<ev_periodic_again> is being called. 1777timer fires or C<ev_periodic_again> is being called.
1723 1778
1724=item ev_tstamp interval [read-write] 1779=item ev_tstamp interval [read-write]
2009the process. The exception are C<ev_stat> watchers - those call C<stat 2064the process. The exception are C<ev_stat> watchers - those call C<stat
2010()>, which is a synchronous operation. 2065()>, which is a synchronous operation.
2011 2066
2012For local paths, this usually doesn't matter: unless the system is very 2067For local paths, this usually doesn't matter: unless the system is very
2013busy or the intervals between stat's are large, a stat call will be fast, 2068busy or the intervals between stat's are large, a stat call will be fast,
2014as the path data is suually in memory already (except when starting the 2069as the path data is usually in memory already (except when starting the
2015watcher). 2070watcher).
2016 2071
2017For networked file systems, calling C<stat ()> can block an indefinite 2072For networked file systems, calling C<stat ()> can block an indefinite
2018time due to network issues, and even under good conditions, a stat call 2073time due to network issues, and even under good conditions, a stat call
2019often takes multiple milliseconds. 2074often takes multiple milliseconds.
2176 2231
2177=head3 Watcher-Specific Functions and Data Members 2232=head3 Watcher-Specific Functions and Data Members
2178 2233
2179=over 4 2234=over 4
2180 2235
2181=item ev_idle_init (ev_signal *, callback) 2236=item ev_idle_init (ev_idle *, callback)
2182 2237
2183Initialises and configures the idle watcher - it has no parameters of any 2238Initialises and configures the idle watcher - it has no parameters of any
2184kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 2239kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
2185believe me. 2240believe me.
2186 2241
2425some fds have to be watched and handled very quickly (with low latency), 2480some fds have to be watched and handled very quickly (with low latency),
2426and even priorities and idle watchers might have too much overhead. In 2481and even priorities and idle watchers might have too much overhead. In
2427this case you would put all the high priority stuff in one loop and all 2482this case you would put all the high priority stuff in one loop and all
2428the rest in a second one, and embed the second one in the first. 2483the rest in a second one, and embed the second one in the first.
2429 2484
2430As long as the watcher is active, the callback will be invoked every time 2485As long as the watcher is active, the callback will be invoked every
2431there might be events pending in the embedded loop. The callback must then 2486time there might be events pending in the embedded loop. The callback
2432call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke 2487must then call C<ev_embed_sweep (mainloop, watcher)> to make a single
2433their callbacks (you could also start an idle watcher to give the embedded 2488sweep and invoke their callbacks (the callback doesn't need to invoke the
2434loop strictly lower priority for example). You can also set the callback 2489C<ev_embed_sweep> function directly, it could also start an idle watcher
2435to C<0>, in which case the embed watcher will automatically execute the 2490to give the embedded loop strictly lower priority for example).
2436embedded loop sweep.
2437 2491
2438As long as the watcher is started it will automatically handle events. The 2492You can also set the callback to C<0>, in which case the embed watcher
2439callback will be invoked whenever some events have been handled. You can 2493will automatically execute the embedded loop sweep whenever necessary.
2440set the callback to C<0> to avoid having to specify one if you are not
2441interested in that.
2442 2494
2443Also, there have not currently been made special provisions for forking: 2495Fork detection will be handled transparently while the C<ev_embed> watcher
2444when you fork, you not only have to call C<ev_loop_fork> on both loops, 2496is active, i.e., the embedded loop will automatically be forked when the
2445but you will also have to stop and restart any C<ev_embed> watchers 2497embedding loop forks. In other cases, the user is responsible for calling
2446yourself - but you can use a fork watcher to handle this automatically, 2498C<ev_loop_fork> on the embedded loop.
2447and future versions of libev might do just that.
2448 2499
2449Unfortunately, not all backends are embeddable: only the ones returned by 2500Unfortunately, not all backends are embeddable: only the ones returned by
2450C<ev_embeddable_backends> are, which, unfortunately, does not include any 2501C<ev_embeddable_backends> are, which, unfortunately, does not include any
2451portable one. 2502portable one.
2452 2503
2683an C<EV_ASYNC> event on the watcher into the event loop. Unlike 2734an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2684C<ev_feed_event>, this call is safe to do from other threads, signal or 2735C<ev_feed_event>, this call is safe to do from other threads, signal or
2685similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding 2736similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2686section below on what exactly this means). 2737section below on what exactly this means).
2687 2738
2739Note that, as with other watchers in libev, multiple events might get
2740compressed into a single callback invocation (another way to look at this
2741is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
2742reset when the event loop detects that).
2743
2688This call incurs the overhead of a system call only once per loop iteration, 2744This call incurs the overhead of a system call only once per event loop
2689so while the overhead might be noticeable, it doesn't apply to repeated 2745iteration, so while the overhead might be noticeable, it doesn't apply to
2690calls to C<ev_async_send>. 2746repeated calls to C<ev_async_send> for the same event loop.
2691 2747
2692=item bool = ev_async_pending (ev_async *) 2748=item bool = ev_async_pending (ev_async *)
2693 2749
2694Returns a non-zero value when C<ev_async_send> has been called on the 2750Returns a non-zero value when C<ev_async_send> has been called on the
2695watcher but the event has not yet been processed (or even noted) by the 2751watcher but the event has not yet been processed (or even noted) by the
2698C<ev_async_send> sets a flag in the watcher and wakes up the loop. When 2754C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2699the loop iterates next and checks for the watcher to have become active, 2755the loop iterates next and checks for the watcher to have become active,
2700it will reset the flag again. C<ev_async_pending> can be used to very 2756it will reset the flag again. C<ev_async_pending> can be used to very
2701quickly check whether invoking the loop might be a good idea. 2757quickly check whether invoking the loop might be a good idea.
2702 2758
2703Not that this does I<not> check whether the watcher itself is pending, only 2759Not that this does I<not> check whether the watcher itself is pending,
2704whether it has been requested to make this watcher pending. 2760only whether it has been requested to make this watcher pending: there
2761is a time window between the event loop checking and resetting the async
2762notification, and the callback being invoked.
2705 2763
2706=back 2764=back
2707 2765
2708 2766
2709=head1 OTHER FUNCTIONS 2767=head1 OTHER FUNCTIONS
2888 2946
2889 myclass obj; 2947 myclass obj;
2890 ev::io iow; 2948 ev::io iow;
2891 iow.set <myclass, &myclass::io_cb> (&obj); 2949 iow.set <myclass, &myclass::io_cb> (&obj);
2892 2950
2951=item w->set (object *)
2952
2953This is an B<experimental> feature that might go away in a future version.
2954
2955This is a variation of a method callback - leaving out the method to call
2956will default the method to C<operator ()>, which makes it possible to use
2957functor objects without having to manually specify the C<operator ()> all
2958the time. Incidentally, you can then also leave out the template argument
2959list.
2960
2961The C<operator ()> method prototype must be C<void operator ()(watcher &w,
2962int revents)>.
2963
2964See the method-C<set> above for more details.
2965
2966Example: use a functor object as callback.
2967
2968 struct myfunctor
2969 {
2970 void operator() (ev::io &w, int revents)
2971 {
2972 ...
2973 }
2974 }
2975
2976 myfunctor f;
2977
2978 ev::io w;
2979 w.set (&f);
2980
2893=item w->set<function> (void *data = 0) 2981=item w->set<function> (void *data = 0)
2894 2982
2895Also sets a callback, but uses a static method or plain function as 2983Also sets a callback, but uses a static method or plain function as
2896callback. The optional C<data> argument will be stored in the watcher's 2984callback. The optional C<data> argument will be stored in the watcher's
2897C<data> member and is free for you to use. 2985C<data> member and is free for you to use.
2983L<http://software.schmorp.de/pkg/EV>. 3071L<http://software.schmorp.de/pkg/EV>.
2984 3072
2985=item Python 3073=item Python
2986 3074
2987Python bindings can be found at L<http://code.google.com/p/pyev/>. It 3075Python bindings can be found at L<http://code.google.com/p/pyev/>. It
2988seems to be quite complete and well-documented. Note, however, that the 3076seems to be quite complete and well-documented.
2989patch they require for libev is outright dangerous as it breaks the ABI
2990for everybody else, and therefore, should never be applied in an installed
2991libev (if python requires an incompatible ABI then it needs to embed
2992libev).
2993 3077
2994=item Ruby 3078=item Ruby
2995 3079
2996Tony Arcieri has written a ruby extension that offers access to a subset 3080Tony Arcieri has written a ruby extension that offers access to a subset
2997of the libev API and adds file handle abstractions, asynchronous DNS and 3081of the libev API and adds file handle abstractions, asynchronous DNS and
2998more on top of it. It can be found via gem servers. Its homepage is at 3082more on top of it. It can be found via gem servers. Its homepage is at
2999L<http://rev.rubyforge.org/>. 3083L<http://rev.rubyforge.org/>.
3084
3085Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
3086makes rev work even on mingw.
3087
3088=item Haskell
3089
3090A haskell binding to libev is available at
3091L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3000 3092
3001=item D 3093=item D
3002 3094
3003Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 3095Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3004be found at L<http://proj.llucax.com.ar/wiki/evd>. 3096be found at L<http://proj.llucax.com.ar/wiki/evd>.
3181keeps libev from including F<config.h>, and it also defines dummy 3273keeps libev from including F<config.h>, and it also defines dummy
3182implementations for some libevent functions (such as logging, which is not 3274implementations for some libevent functions (such as logging, which is not
3183supported). It will also not define any of the structs usually found in 3275supported). It will also not define any of the structs usually found in
3184F<event.h> that are not directly supported by the libev core alone. 3276F<event.h> that are not directly supported by the libev core alone.
3185 3277
3278In stanbdalone mode, libev will still try to automatically deduce the
3279configuration, but has to be more conservative.
3280
3186=item EV_USE_MONOTONIC 3281=item EV_USE_MONOTONIC
3187 3282
3188If defined to be C<1>, libev will try to detect the availability of the 3283If defined to be C<1>, libev will try to detect the availability of the
3189monotonic clock option at both compile time and runtime. Otherwise no use 3284monotonic clock option at both compile time and runtime. Otherwise no
3190of the monotonic clock option will be attempted. If you enable this, you 3285use of the monotonic clock option will be attempted. If you enable this,
3191usually have to link against librt or something similar. Enabling it when 3286you usually have to link against librt or something similar. Enabling it
3192the functionality isn't available is safe, though, although you have 3287when the functionality isn't available is safe, though, although you have
3193to make sure you link against any libraries where the C<clock_gettime> 3288to make sure you link against any libraries where the C<clock_gettime>
3194function is hiding in (often F<-lrt>). 3289function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
3195 3290
3196=item EV_USE_REALTIME 3291=item EV_USE_REALTIME
3197 3292
3198If defined to be C<1>, libev will try to detect the availability of the 3293If defined to be C<1>, libev will try to detect the availability of the
3199real-time clock option at compile time (and assume its availability at 3294real-time clock option at compile time (and assume its availability
3200runtime if successful). Otherwise no use of the real-time clock option will 3295at runtime if successful). Otherwise no use of the real-time clock
3201be attempted. This effectively replaces C<gettimeofday> by C<clock_get 3296option will be attempted. This effectively replaces C<gettimeofday>
3202(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the 3297by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
3203note about libraries in the description of C<EV_USE_MONOTONIC>, though. 3298correctness. See the note about libraries in the description of
3299C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
3300C<EV_USE_CLOCK_SYSCALL>.
3301
3302=item EV_USE_CLOCK_SYSCALL
3303
3304If defined to be C<1>, libev will try to use a direct syscall instead
3305of calling the system-provided C<clock_gettime> function. This option
3306exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
3307unconditionally pulls in C<libpthread>, slowing down single-threaded
3308programs needlessly. Using a direct syscall is slightly slower (in
3309theory), because no optimised vdso implementation can be used, but avoids
3310the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
3311higher, as it simplifies linking (no need for C<-lrt>).
3204 3312
3205=item EV_USE_NANOSLEEP 3313=item EV_USE_NANOSLEEP
3206 3314
3207If defined to be C<1>, libev will assume that C<nanosleep ()> is available 3315If defined to be C<1>, libev will assume that C<nanosleep ()> is available
3208and will use it for delays. Otherwise it will use C<select ()>. 3316and will use it for delays. Otherwise it will use C<select ()>.
3224 3332
3225=item EV_SELECT_USE_FD_SET 3333=item EV_SELECT_USE_FD_SET
3226 3334
3227If defined to C<1>, then the select backend will use the system C<fd_set> 3335If defined to C<1>, then the select backend will use the system C<fd_set>
3228structure. This is useful if libev doesn't compile due to a missing 3336structure. This is useful if libev doesn't compile due to a missing
3229C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on 3337C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
3230exotic systems. This usually limits the range of file descriptors to some 3338on exotic systems. This usually limits the range of file descriptors to
3231low limit such as 1024 or might have other limitations (winsocket only 3339some low limit such as 1024 or might have other limitations (winsocket
3232allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might 3340only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
3233influence the size of the C<fd_set> used. 3341configures the maximum size of the C<fd_set>.
3234 3342
3235=item EV_SELECT_IS_WINSOCKET 3343=item EV_SELECT_IS_WINSOCKET
3236 3344
3237When defined to C<1>, the select backend will assume that 3345When defined to C<1>, the select backend will assume that
3238select/socket/connect etc. don't understand file descriptors but 3346select/socket/connect etc. don't understand file descriptors but

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines