… | |
… | |
726 | |
726 | |
727 | If you have a watcher you never unregister that should not keep C<ev_loop> |
727 | If you have a watcher you never unregister that should not keep C<ev_loop> |
728 | from returning, call ev_unref() after starting, and ev_ref() before |
728 | from returning, call ev_unref() after starting, and ev_ref() before |
729 | stopping it. |
729 | stopping it. |
730 | |
730 | |
731 | As an example, libev itself uses this for its internal signal pipe: It is |
731 | As an example, libev itself uses this for its internal signal pipe: It |
732 | not visible to the libev user and should not keep C<ev_loop> from exiting |
732 | is not visible to the libev user and should not keep C<ev_loop> from |
733 | if no event watchers registered by it are active. It is also an excellent |
733 | exiting if no event watchers registered by it are active. It is also an |
734 | way to do this for generic recurring timers or from within third-party |
734 | excellent way to do this for generic recurring timers or from within |
735 | libraries. Just remember to I<unref after start> and I<ref before stop> |
735 | third-party libraries. Just remember to I<unref after start> and I<ref |
736 | (but only if the watcher wasn't active before, or was active before, |
736 | before stop> (but only if the watcher wasn't active before, or was active |
737 | respectively). |
737 | before, respectively. Note also that libev might stop watchers itself |
|
|
738 | (e.g. non-repeating timers) in which case you have to C<ev_ref> |
|
|
739 | in the callback). |
738 | |
740 | |
739 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
741 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
740 | running when nothing else is active. |
742 | running when nothing else is active. |
741 | |
743 | |
742 | ev_signal exitsig; |
744 | ev_signal exitsig; |
… | |
… | |
925 | C<ev_fork>). |
927 | C<ev_fork>). |
926 | |
928 | |
927 | =item C<EV_ASYNC> |
929 | =item C<EV_ASYNC> |
928 | |
930 | |
929 | The given async watcher has been asynchronously notified (see C<ev_async>). |
931 | The given async watcher has been asynchronously notified (see C<ev_async>). |
|
|
932 | |
|
|
933 | =item C<EV_CUSTOM> |
|
|
934 | |
|
|
935 | Not ever sent (or otherwise used) by libev itself, but can be freely used |
|
|
936 | by libev users to signal watchers (e.g. via C<ev_feed_event>). |
930 | |
937 | |
931 | =item C<EV_ERROR> |
938 | =item C<EV_ERROR> |
932 | |
939 | |
933 | An unspecified error has occurred, the watcher has been stopped. This might |
940 | An unspecified error has occurred, the watcher has been stopped. This might |
934 | happen because the watcher could not be properly started because libev |
941 | happen because the watcher could not be properly started because libev |
… | |
… | |
1596 | =head2 C<ev_periodic> - to cron or not to cron? |
1603 | =head2 C<ev_periodic> - to cron or not to cron? |
1597 | |
1604 | |
1598 | Periodic watchers are also timers of a kind, but they are very versatile |
1605 | Periodic watchers are also timers of a kind, but they are very versatile |
1599 | (and unfortunately a bit complex). |
1606 | (and unfortunately a bit complex). |
1600 | |
1607 | |
1601 | Unlike C<ev_timer>'s, they are not based on real time (or relative time) |
1608 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
1602 | but on wall clock time (absolute time). You can tell a periodic watcher |
1609 | relative time, the physical time that passes) but on wall clock time |
1603 | to trigger after some specific point in time. For example, if you tell a |
1610 | (absolute time, the thing you can read on your calender or clock). The |
1604 | periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now () |
1611 | difference is that wall clock time can run faster or slower than real |
1605 | + 10.>, that is, an absolute time not a delay) and then reset your system |
1612 | time, and time jumps are not uncommon (e.g. when you adjust your |
1606 | clock to January of the previous year, then it will take more than year |
1613 | wrist-watch). |
1607 | to trigger the event (unlike an C<ev_timer>, which would still trigger |
|
|
1608 | roughly 10 seconds later as it uses a relative timeout). |
|
|
1609 | |
1614 | |
|
|
1615 | You can tell a periodic watcher to trigger after some specific point |
|
|
1616 | in time: for example, if you tell a periodic watcher to trigger "in 10 |
|
|
1617 | seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time |
|
|
1618 | not a delay) and then reset your system clock to January of the previous |
|
|
1619 | year, then it will take a year or more to trigger the event (unlike an |
|
|
1620 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
|
|
1621 | it, as it uses a relative timeout). |
|
|
1622 | |
1610 | C<ev_periodic>s can also be used to implement vastly more complex timers, |
1623 | C<ev_periodic> watchers can also be used to implement vastly more complex |
1611 | such as triggering an event on each "midnight, local time", or other |
1624 | timers, such as triggering an event on each "midnight, local time", or |
1612 | complicated rules. |
1625 | other complicated rules. This cannot be done with C<ev_timer> watchers, as |
|
|
1626 | those cannot react to time jumps. |
1613 | |
1627 | |
1614 | As with timers, the callback is guaranteed to be invoked only when the |
1628 | As with timers, the callback is guaranteed to be invoked only when the |
1615 | time (C<at>) has passed, but if multiple periodic timers become ready |
1629 | point in time where it is supposed to trigger has passed, but if multiple |
1616 | during the same loop iteration, then order of execution is undefined. |
1630 | periodic timers become ready during the same loop iteration, then order of |
|
|
1631 | execution is undefined. |
1617 | |
1632 | |
1618 | =head3 Watcher-Specific Functions and Data Members |
1633 | =head3 Watcher-Specific Functions and Data Members |
1619 | |
1634 | |
1620 | =over 4 |
1635 | =over 4 |
1621 | |
1636 | |
1622 | =item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) |
1637 | =item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb) |
1623 | |
1638 | |
1624 | =item ev_periodic_set (ev_periodic *, ev_tstamp at, ev_tstamp interval, reschedule_cb) |
1639 | =item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb) |
1625 | |
1640 | |
1626 | Lots of arguments, lets sort it out... There are basically three modes of |
1641 | Lots of arguments, let's sort it out... There are basically three modes of |
1627 | operation, and we will explain them from simplest to most complex: |
1642 | operation, and we will explain them from simplest to most complex: |
1628 | |
1643 | |
1629 | =over 4 |
1644 | =over 4 |
1630 | |
1645 | |
1631 | =item * absolute timer (at = time, interval = reschedule_cb = 0) |
1646 | =item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0) |
1632 | |
1647 | |
1633 | In this configuration the watcher triggers an event after the wall clock |
1648 | In this configuration the watcher triggers an event after the wall clock |
1634 | time C<at> has passed. It will not repeat and will not adjust when a time |
1649 | time C<offset> has passed. It will not repeat and will not adjust when a |
1635 | jump occurs, that is, if it is to be run at January 1st 2011 then it will |
1650 | time jump occurs, that is, if it is to be run at January 1st 2011 then it |
1636 | only run when the system clock reaches or surpasses this time. |
1651 | will be stopped and invoked when the system clock reaches or surpasses |
|
|
1652 | this point in time. |
1637 | |
1653 | |
1638 | =item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
1654 | =item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0) |
1639 | |
1655 | |
1640 | In this mode the watcher will always be scheduled to time out at the next |
1656 | In this mode the watcher will always be scheduled to time out at the next |
1641 | C<at + N * interval> time (for some integer N, which can also be negative) |
1657 | C<offset + N * interval> time (for some integer N, which can also be |
1642 | and then repeat, regardless of any time jumps. |
1658 | negative) and then repeat, regardless of any time jumps. The C<offset> |
|
|
1659 | argument is merely an offset into the C<interval> periods. |
1643 | |
1660 | |
1644 | This can be used to create timers that do not drift with respect to the |
1661 | This can be used to create timers that do not drift with respect to the |
1645 | system clock, for example, here is a C<ev_periodic> that triggers each |
1662 | system clock, for example, here is an C<ev_periodic> that triggers each |
1646 | hour, on the hour: |
1663 | hour, on the hour (with respect to UTC): |
1647 | |
1664 | |
1648 | ev_periodic_set (&periodic, 0., 3600., 0); |
1665 | ev_periodic_set (&periodic, 0., 3600., 0); |
1649 | |
1666 | |
1650 | This doesn't mean there will always be 3600 seconds in between triggers, |
1667 | This doesn't mean there will always be 3600 seconds in between triggers, |
1651 | but only that the callback will be called when the system time shows a |
1668 | but only that the callback will be called when the system time shows a |
1652 | full hour (UTC), or more correctly, when the system time is evenly divisible |
1669 | full hour (UTC), or more correctly, when the system time is evenly divisible |
1653 | by 3600. |
1670 | by 3600. |
1654 | |
1671 | |
1655 | Another way to think about it (for the mathematically inclined) is that |
1672 | Another way to think about it (for the mathematically inclined) is that |
1656 | C<ev_periodic> will try to run the callback in this mode at the next possible |
1673 | C<ev_periodic> will try to run the callback in this mode at the next possible |
1657 | time where C<time = at (mod interval)>, regardless of any time jumps. |
1674 | time where C<time = offset (mod interval)>, regardless of any time jumps. |
1658 | |
1675 | |
1659 | For numerical stability it is preferable that the C<at> value is near |
1676 | For numerical stability it is preferable that the C<offset> value is near |
1660 | C<ev_now ()> (the current time), but there is no range requirement for |
1677 | C<ev_now ()> (the current time), but there is no range requirement for |
1661 | this value, and in fact is often specified as zero. |
1678 | this value, and in fact is often specified as zero. |
1662 | |
1679 | |
1663 | Note also that there is an upper limit to how often a timer can fire (CPU |
1680 | Note also that there is an upper limit to how often a timer can fire (CPU |
1664 | speed for example), so if C<interval> is very small then timing stability |
1681 | speed for example), so if C<interval> is very small then timing stability |
1665 | will of course deteriorate. Libev itself tries to be exact to be about one |
1682 | will of course deteriorate. Libev itself tries to be exact to be about one |
1666 | millisecond (if the OS supports it and the machine is fast enough). |
1683 | millisecond (if the OS supports it and the machine is fast enough). |
1667 | |
1684 | |
1668 | =item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) |
1685 | =item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback) |
1669 | |
1686 | |
1670 | In this mode the values for C<interval> and C<at> are both being |
1687 | In this mode the values for C<interval> and C<offset> are both being |
1671 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1688 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1672 | reschedule callback will be called with the watcher as first, and the |
1689 | reschedule callback will be called with the watcher as first, and the |
1673 | current time as second argument. |
1690 | current time as second argument. |
1674 | |
1691 | |
1675 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, |
1692 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever, |
1676 | ever, or make ANY other event loop modifications whatsoever>. |
1693 | or make ANY other event loop modifications whatsoever, unless explicitly |
|
|
1694 | allowed by documentation here>. |
1677 | |
1695 | |
1678 | If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop |
1696 | If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop |
1679 | it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the |
1697 | it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the |
1680 | only event loop modification you are allowed to do). |
1698 | only event loop modification you are allowed to do). |
1681 | |
1699 | |
… | |
… | |
1711 | a different time than the last time it was called (e.g. in a crond like |
1729 | a different time than the last time it was called (e.g. in a crond like |
1712 | program when the crontabs have changed). |
1730 | program when the crontabs have changed). |
1713 | |
1731 | |
1714 | =item ev_tstamp ev_periodic_at (ev_periodic *) |
1732 | =item ev_tstamp ev_periodic_at (ev_periodic *) |
1715 | |
1733 | |
1716 | When active, returns the absolute time that the watcher is supposed to |
1734 | When active, returns the absolute time that the watcher is supposed |
1717 | trigger next. |
1735 | to trigger next. This is not the same as the C<offset> argument to |
|
|
1736 | C<ev_periodic_set>, but indeed works even in interval and manual |
|
|
1737 | rescheduling modes. |
1718 | |
1738 | |
1719 | =item ev_tstamp offset [read-write] |
1739 | =item ev_tstamp offset [read-write] |
1720 | |
1740 | |
1721 | When repeating, this contains the offset value, otherwise this is the |
1741 | When repeating, this contains the offset value, otherwise this is the |
1722 | absolute point in time (the C<at> value passed to C<ev_periodic_set>). |
1742 | absolute point in time (the C<offset> value passed to C<ev_periodic_set>, |
|
|
1743 | although libev might modify this value for better numerical stability). |
1723 | |
1744 | |
1724 | Can be modified any time, but changes only take effect when the periodic |
1745 | Can be modified any time, but changes only take effect when the periodic |
1725 | timer fires or C<ev_periodic_again> is being called. |
1746 | timer fires or C<ev_periodic_again> is being called. |
1726 | |
1747 | |
1727 | =item ev_tstamp interval [read-write] |
1748 | =item ev_tstamp interval [read-write] |
… | |
… | |
2179 | |
2200 | |
2180 | =head3 Watcher-Specific Functions and Data Members |
2201 | =head3 Watcher-Specific Functions and Data Members |
2181 | |
2202 | |
2182 | =over 4 |
2203 | =over 4 |
2183 | |
2204 | |
2184 | =item ev_idle_init (ev_signal *, callback) |
2205 | =item ev_idle_init (ev_idle *, callback) |
2185 | |
2206 | |
2186 | Initialises and configures the idle watcher - it has no parameters of any |
2207 | Initialises and configures the idle watcher - it has no parameters of any |
2187 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
2208 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
2188 | believe me. |
2209 | believe me. |
2189 | |
2210 | |
… | |
… | |
2682 | an C<EV_ASYNC> event on the watcher into the event loop. Unlike |
2703 | an C<EV_ASYNC> event on the watcher into the event loop. Unlike |
2683 | C<ev_feed_event>, this call is safe to do from other threads, signal or |
2704 | C<ev_feed_event>, this call is safe to do from other threads, signal or |
2684 | similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding |
2705 | similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding |
2685 | section below on what exactly this means). |
2706 | section below on what exactly this means). |
2686 | |
2707 | |
|
|
2708 | Note that, as with other watchers in libev, multiple events might get |
|
|
2709 | compressed into a single callback invocation (another way to look at this |
|
|
2710 | is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, |
|
|
2711 | reset when the event loop detects that). |
|
|
2712 | |
2687 | This call incurs the overhead of a system call only once per loop iteration, |
2713 | This call incurs the overhead of a system call only once per event loop |
2688 | so while the overhead might be noticeable, it doesn't apply to repeated |
2714 | iteration, so while the overhead might be noticeable, it doesn't apply to |
2689 | calls to C<ev_async_send>. |
2715 | repeated calls to C<ev_async_send> for the same event loop. |
2690 | |
2716 | |
2691 | =item bool = ev_async_pending (ev_async *) |
2717 | =item bool = ev_async_pending (ev_async *) |
2692 | |
2718 | |
2693 | Returns a non-zero value when C<ev_async_send> has been called on the |
2719 | Returns a non-zero value when C<ev_async_send> has been called on the |
2694 | watcher but the event has not yet been processed (or even noted) by the |
2720 | watcher but the event has not yet been processed (or even noted) by the |
… | |
… | |
2697 | C<ev_async_send> sets a flag in the watcher and wakes up the loop. When |
2723 | C<ev_async_send> sets a flag in the watcher and wakes up the loop. When |
2698 | the loop iterates next and checks for the watcher to have become active, |
2724 | the loop iterates next and checks for the watcher to have become active, |
2699 | it will reset the flag again. C<ev_async_pending> can be used to very |
2725 | it will reset the flag again. C<ev_async_pending> can be used to very |
2700 | quickly check whether invoking the loop might be a good idea. |
2726 | quickly check whether invoking the loop might be a good idea. |
2701 | |
2727 | |
2702 | Not that this does I<not> check whether the watcher itself is pending, only |
2728 | Not that this does I<not> check whether the watcher itself is pending, |
2703 | whether it has been requested to make this watcher pending. |
2729 | only whether it has been requested to make this watcher pending: there |
|
|
2730 | is a time window between the event loop checking and resetting the async |
|
|
2731 | notification, and the callback being invoked. |
2704 | |
2732 | |
2705 | =back |
2733 | =back |
2706 | |
2734 | |
2707 | |
2735 | |
2708 | =head1 OTHER FUNCTIONS |
2736 | =head1 OTHER FUNCTIONS |
… | |
… | |
3012 | L<http://software.schmorp.de/pkg/EV>. |
3040 | L<http://software.schmorp.de/pkg/EV>. |
3013 | |
3041 | |
3014 | =item Python |
3042 | =item Python |
3015 | |
3043 | |
3016 | Python bindings can be found at L<http://code.google.com/p/pyev/>. It |
3044 | Python bindings can be found at L<http://code.google.com/p/pyev/>. It |
3017 | seems to be quite complete and well-documented. Note, however, that the |
3045 | seems to be quite complete and well-documented. |
3018 | patch they require for libev is outright dangerous as it breaks the ABI |
|
|
3019 | for everybody else, and therefore, should never be applied in an installed |
|
|
3020 | libev (if python requires an incompatible ABI then it needs to embed |
|
|
3021 | libev). |
|
|
3022 | |
3046 | |
3023 | =item Ruby |
3047 | =item Ruby |
3024 | |
3048 | |
3025 | Tony Arcieri has written a ruby extension that offers access to a subset |
3049 | Tony Arcieri has written a ruby extension that offers access to a subset |
3026 | of the libev API and adds file handle abstractions, asynchronous DNS and |
3050 | of the libev API and adds file handle abstractions, asynchronous DNS and |
3027 | more on top of it. It can be found via gem servers. Its homepage is at |
3051 | more on top of it. It can be found via gem servers. Its homepage is at |
3028 | L<http://rev.rubyforge.org/>. |
3052 | L<http://rev.rubyforge.org/>. |
3029 | |
3053 | |
3030 | Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190> |
3054 | Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190> |
3031 | makes rev work even on mingw. |
3055 | makes rev work even on mingw. |
|
|
3056 | |
|
|
3057 | =item Haskell |
|
|
3058 | |
|
|
3059 | A haskell binding to libev is available at |
|
|
3060 | L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. |
3032 | |
3061 | |
3033 | =item D |
3062 | =item D |
3034 | |
3063 | |
3035 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
3064 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
3036 | be found at L<http://proj.llucax.com.ar/wiki/evd>. |
3065 | be found at L<http://proj.llucax.com.ar/wiki/evd>. |