… | |
… | |
1860 | |
1860 | |
1861 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
1861 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
1862 | but remember the time of last activity, and check for a real timeout only |
1862 | but remember the time of last activity, and check for a real timeout only |
1863 | within the callback: |
1863 | within the callback: |
1864 | |
1864 | |
|
|
1865 | ev_tstamp timeout = 60.; |
1865 | ev_tstamp last_activity; // time of last activity |
1866 | ev_tstamp last_activity; // time of last activity |
|
|
1867 | ev_timer timer; |
1866 | |
1868 | |
1867 | static void |
1869 | static void |
1868 | callback (EV_P_ ev_timer *w, int revents) |
1870 | callback (EV_P_ ev_timer *w, int revents) |
1869 | { |
1871 | { |
1870 | ev_tstamp now = ev_now (EV_A); |
1872 | // calculate when the timeout would happen |
1871 | ev_tstamp timeout = last_activity + 60.; |
1873 | ev_tstamp after = last_activity - ev_now (EV_A) + timeout; |
1872 | |
1874 | |
1873 | // if last_activity + 60. is older than now, we did time out |
1875 | // if negative, it means we the timeout already occured |
1874 | if (timeout < now) |
1876 | if (after < 0.) |
1875 | { |
1877 | { |
1876 | // timeout occurred, take action |
1878 | // timeout occurred, take action |
1877 | } |
1879 | } |
1878 | else |
1880 | else |
1879 | { |
1881 | { |
1880 | // callback was invoked, but there was some activity, re-arm |
1882 | // callback was invoked, but there was some recent |
1881 | // the watcher to fire in last_activity + 60, which is |
1883 | // activity. simply restart the timer to time out |
1882 | // guaranteed to be in the future, so "again" is positive: |
1884 | // after "after" seconds, which is the earliest time |
1883 | w->repeat = timeout - now; |
1885 | // the timeout can occur. |
|
|
1886 | ev_timer_set (w, after, 0.); |
1884 | ev_timer_again (EV_A_ w); |
1887 | ev_timer_start (EV_A_ w); |
1885 | } |
1888 | } |
1886 | } |
1889 | } |
1887 | |
1890 | |
1888 | To summarise the callback: first calculate the real timeout (defined |
1891 | To summarise the callback: first calculate in how many seconds the |
1889 | as "60 seconds after the last activity"), then check if that time has |
1892 | timeout will occur (by calculating the absolute time when it would occur, |
1890 | been reached, which means something I<did>, in fact, time out. Otherwise |
1893 | C<last_activity + timeout>, and subtracting the current time, C<ev_now |
1891 | the callback was invoked too early (C<timeout> is in the future), so |
1894 | (EV_A)> from that). |
1892 | re-schedule the timer to fire at that future time, to see if maybe we have |
|
|
1893 | a timeout then. |
|
|
1894 | |
1895 | |
1895 | Note how C<ev_timer_again> is used, taking advantage of the |
1896 | If this value is negative, then we are already past the timeout, i.e. we |
1896 | C<ev_timer_again> optimisation when the timer is already running. |
1897 | timed out, and need to do whatever is needed in this case. |
|
|
1898 | |
|
|
1899 | Otherwise, we now the earliest time at which the timeout would trigger, |
|
|
1900 | and simply start the timer with this timeout value. |
|
|
1901 | |
|
|
1902 | In other words, each time the callback is invoked it will check whether |
|
|
1903 | the timeout cocured. If not, it will simply reschedule itself to check |
|
|
1904 | again at the earliest time it could time out. Rinse. Repeat. |
1897 | |
1905 | |
1898 | This scheme causes more callback invocations (about one every 60 seconds |
1906 | This scheme causes more callback invocations (about one every 60 seconds |
1899 | minus half the average time between activity), but virtually no calls to |
1907 | minus half the average time between activity), but virtually no calls to |
1900 | libev to change the timeout. |
1908 | libev to change the timeout. |
1901 | |
1909 | |
1902 | To start the timer, simply initialise the watcher and set C<last_activity> |
1910 | To start the machinery, simply initialise the watcher and set |
1903 | to the current time (meaning we just have some activity :), then call the |
1911 | C<last_activity> to the current time (meaning there was some activity just |
1904 | callback, which will "do the right thing" and start the timer: |
1912 | now), then call the callback, which will "do the right thing" and start |
|
|
1913 | the timer: |
1905 | |
1914 | |
|
|
1915 | last_activity = ev_now (EV_A); |
1906 | ev_init (timer, callback); |
1916 | ev_init (&timer, callback); |
1907 | last_activity = ev_now (loop); |
1917 | callback (EV_A_ &timer, 0); |
1908 | callback (loop, timer, EV_TIMER); |
|
|
1909 | |
1918 | |
1910 | And when there is some activity, simply store the current time in |
1919 | When there is some activity, simply store the current time in |
1911 | C<last_activity>, no libev calls at all: |
1920 | C<last_activity>, no libev calls at all: |
1912 | |
1921 | |
|
|
1922 | if (activity detected) |
1913 | last_activity = ev_now (loop); |
1923 | last_activity = ev_now (EV_A); |
|
|
1924 | |
|
|
1925 | When your timeout value changes, then the timeout can be changed by simply |
|
|
1926 | providing a new value, stopping the timer and calling the callback, which |
|
|
1927 | will agaion do the right thing (for example, time out immediately :). |
|
|
1928 | |
|
|
1929 | timeout = new_value; |
|
|
1930 | ev_timer_stop (EV_A_ &timer); |
|
|
1931 | callback (EV_A_ &timer, 0); |
1914 | |
1932 | |
1915 | This technique is slightly more complex, but in most cases where the |
1933 | This technique is slightly more complex, but in most cases where the |
1916 | time-out is unlikely to be triggered, much more efficient. |
1934 | time-out is unlikely to be triggered, much more efficient. |
1917 | |
|
|
1918 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
|
|
1919 | callback :) - just change the timeout and invoke the callback, which will |
|
|
1920 | fix things for you. |
|
|
1921 | |
1935 | |
1922 | =item 4. Wee, just use a double-linked list for your timeouts. |
1936 | =item 4. Wee, just use a double-linked list for your timeouts. |
1923 | |
1937 | |
1924 | If there is not one request, but many thousands (millions...), all |
1938 | If there is not one request, but many thousands (millions...), all |
1925 | employing some kind of timeout with the same timeout value, then one can |
1939 | employing some kind of timeout with the same timeout value, then one can |
… | |
… | |
2094 | keep up with the timer (because it takes longer than those 10 seconds to |
2108 | keep up with the timer (because it takes longer than those 10 seconds to |
2095 | do stuff) the timer will not fire more than once per event loop iteration. |
2109 | do stuff) the timer will not fire more than once per event loop iteration. |
2096 | |
2110 | |
2097 | =item ev_timer_again (loop, ev_timer *) |
2111 | =item ev_timer_again (loop, ev_timer *) |
2098 | |
2112 | |
2099 | This will act as if the timer timed out and restarts it again if it is |
2113 | This will act as if the timer timed out, and restarts it again if it is |
2100 | repeating. The exact semantics are: |
2114 | repeating. It basically works like calling C<ev_timer_stop>, updating the |
|
|
2115 | timeout to the C<repeat> value and calling C<ev_timer_start>. |
2101 | |
2116 | |
|
|
2117 | The exact semantics are as in the following rules, all of which will be |
|
|
2118 | applied to the watcher: |
|
|
2119 | |
|
|
2120 | =over 4 |
|
|
2121 | |
2102 | If the timer is pending, its pending status is cleared. |
2122 | =item If the timer is pending, the pending status is always cleared. |
2103 | |
2123 | |
2104 | If the timer is started but non-repeating, stop it (as if it timed out). |
2124 | =item If the timer is started but non-repeating, stop it (as if it timed |
|
|
2125 | out, without invoking it). |
2105 | |
2126 | |
2106 | If the timer is repeating, either start it if necessary (with the |
2127 | =item If the timer is repeating, make the C<repeat> value the new timeout |
2107 | C<repeat> value), or reset the running timer to the C<repeat> value. |
2128 | and start the timer, if necessary. |
|
|
2129 | |
|
|
2130 | =back |
2108 | |
2131 | |
2109 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
2132 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
2110 | usage example. |
2133 | usage example. |
2111 | |
2134 | |
2112 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2135 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
… | |
… | |
3557 | { |
3580 | { |
3558 | struct my_biggy big = (struct my_biggy *) |
3581 | struct my_biggy big = (struct my_biggy *) |
3559 | (((char *)w) - offsetof (struct my_biggy, t2)); |
3582 | (((char *)w) - offsetof (struct my_biggy, t2)); |
3560 | } |
3583 | } |
3561 | |
3584 | |
|
|
3585 | =head2 AVOIDING FINISHING BEFORE RETURNING |
|
|
3586 | |
|
|
3587 | Often you have structures like this in event-based programs: |
|
|
3588 | |
|
|
3589 | callback () |
|
|
3590 | { |
|
|
3591 | free (request); |
|
|
3592 | } |
|
|
3593 | |
|
|
3594 | request = start_new_request (..., callback); |
|
|
3595 | |
|
|
3596 | The intent is to start some "lengthy" operation. The C<request> could be |
|
|
3597 | used to cancel the operation, or do other things with it. |
|
|
3598 | |
|
|
3599 | It's not uncommon to have code paths in C<start_new_request> that |
|
|
3600 | immediately invoke the callback, for example, to report errors. Or you add |
|
|
3601 | some caching layer that finds that it can skip the lengthy aspects of the |
|
|
3602 | operation and simply invoke the callback with the result. |
|
|
3603 | |
|
|
3604 | The problem here is that this will happen I<before> C<start_new_request> |
|
|
3605 | has returned, so C<request> is not set. |
|
|
3606 | |
|
|
3607 | Even if you pass the request by some safer means to the callback, you |
|
|
3608 | might want to do something to the request after starting it, such as |
|
|
3609 | canceling it, which probably isn't working so well when the callback has |
|
|
3610 | already been invoked. |
|
|
3611 | |
|
|
3612 | A common way around all these issues is to make sure that |
|
|
3613 | C<start_new_request> I<always> returns before the callback is invoked. If |
|
|
3614 | C<start_new_request> immediately knows the result, it can artificially |
|
|
3615 | delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher |
|
|
3616 | for example, or more sneakily, by reusing an existing (stopped) watcher |
|
|
3617 | and pushing it into the pending queue: |
|
|
3618 | |
|
|
3619 | ev_set_cb (watcher, callback); |
|
|
3620 | ev_feed_event (EV_A_ watcher, 0); |
|
|
3621 | |
|
|
3622 | This way, C<start_new_request> can safely return before the callback is |
|
|
3623 | invoked, while not delaying callback invocation too much. |
|
|
3624 | |
3562 | =head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS |
3625 | =head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS |
3563 | |
3626 | |
3564 | Often (especially in GUI toolkits) there are places where you have |
3627 | Often (especially in GUI toolkits) there are places where you have |
3565 | I<modal> interaction, which is most easily implemented by recursively |
3628 | I<modal> interaction, which is most easily implemented by recursively |
3566 | invoking C<ev_run>. |
3629 | invoking C<ev_run>. |
… | |
… | |
3579 | int exit_main_loop = 0; |
3642 | int exit_main_loop = 0; |
3580 | |
3643 | |
3581 | while (!exit_main_loop) |
3644 | while (!exit_main_loop) |
3582 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3645 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3583 | |
3646 | |
3584 | // in a model watcher |
3647 | // in a modal watcher |
3585 | int exit_nested_loop = 0; |
3648 | int exit_nested_loop = 0; |
3586 | |
3649 | |
3587 | while (!exit_nested_loop) |
3650 | while (!exit_nested_loop) |
3588 | ev_run (EV_A_ EVRUN_ONCE); |
3651 | ev_run (EV_A_ EVRUN_ONCE); |
3589 | |
3652 | |
… | |
… | |
3769 | switch_to (libev_coro); |
3832 | switch_to (libev_coro); |
3770 | } |
3833 | } |
3771 | |
3834 | |
3772 | That basically suspends the coroutine inside C<wait_for_event> and |
3835 | That basically suspends the coroutine inside C<wait_for_event> and |
3773 | continues the libev coroutine, which, when appropriate, switches back to |
3836 | continues the libev coroutine, which, when appropriate, switches back to |
3774 | this or any other coroutine. I am sure if you sue this your own :) |
3837 | this or any other coroutine. |
3775 | |
3838 | |
3776 | You can do similar tricks if you have, say, threads with an event queue - |
3839 | You can do similar tricks if you have, say, threads with an event queue - |
3777 | instead of storing a coroutine, you store the queue object and instead of |
3840 | instead of storing a coroutine, you store the queue object and instead of |
3778 | switching to a coroutine, you push the watcher onto the queue and notify |
3841 | switching to a coroutine, you push the watcher onto the queue and notify |
3779 | any waiters. |
3842 | any waiters. |
… | |
… | |
3872 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
3935 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
3873 | |
3936 | |
3874 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
3937 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
3875 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
3938 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
3876 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
3939 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
3877 | defines by many implementations. |
3940 | defined by many implementations. |
3878 | |
3941 | |
3879 | All of those classes have these methods: |
3942 | All of those classes have these methods: |
3880 | |
3943 | |
3881 | =over 4 |
3944 | =over 4 |
3882 | |
3945 | |
… | |
… | |
4441 | If defined to be C<1>, libev will compile in support for the Linux inotify |
4504 | If defined to be C<1>, libev will compile in support for the Linux inotify |
4442 | interface to speed up C<ev_stat> watchers. Its actual availability will |
4505 | interface to speed up C<ev_stat> watchers. Its actual availability will |
4443 | be detected at runtime. If undefined, it will be enabled if the headers |
4506 | be detected at runtime. If undefined, it will be enabled if the headers |
4444 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4507 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4445 | |
4508 | |
|
|
4509 | =item EV_NO_SMP |
|
|
4510 | |
|
|
4511 | If defined to be C<1>, libev will assume that memory is always coherent |
|
|
4512 | between threads, that is, threads can be used, but threads never run on |
|
|
4513 | different cpus (or different cpu cores). This reduces dependencies |
|
|
4514 | and makes libev faster. |
|
|
4515 | |
|
|
4516 | =item EV_NO_THREADS |
|
|
4517 | |
|
|
4518 | If defined to be C<1>, libev will assume that it will never be called |
|
|
4519 | from different threads, which is a stronger assumption than C<EV_NO_SMP>, |
|
|
4520 | above. This reduces dependencies and makes libev faster. |
|
|
4521 | |
4446 | =item EV_ATOMIC_T |
4522 | =item EV_ATOMIC_T |
4447 | |
4523 | |
4448 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4524 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4449 | access is atomic and serialised with respect to other threads or signal |
4525 | access is atomic and serialised with respect to other threads or signal |
4450 | contexts. No such type is easily found in the C language, so you can |
4526 | contexts. No such type is easily found in the C language, so you can |
… | |
… | |
4597 | |
4673 | |
4598 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
4674 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
4599 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
4675 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
4600 | your program might be left out as well - a binary starting a timer and an |
4676 | your program might be left out as well - a binary starting a timer and an |
4601 | I/O watcher then might come out at only 5Kb. |
4677 | I/O watcher then might come out at only 5Kb. |
|
|
4678 | |
|
|
4679 | =item EV_API_STATIC |
|
|
4680 | |
|
|
4681 | If this symbol is defined (by default it is not), then all identifiers |
|
|
4682 | will have static linkage. This means that libev will not export any |
|
|
4683 | identifiers, and you cannot link against libev anymore. This can be useful |
|
|
4684 | when you embed libev, only want to use libev functions in a single file, |
|
|
4685 | and do not want its identifiers to be visible. |
|
|
4686 | |
|
|
4687 | To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that |
|
|
4688 | wants to use libev. |
|
|
4689 | |
|
|
4690 | This option only works when libev is compiled with a C compiler, as C++ |
|
|
4691 | doesn't support the required declaration syntax. |
4602 | |
4692 | |
4603 | =item EV_AVOID_STDIO |
4693 | =item EV_AVOID_STDIO |
4604 | |
4694 | |
4605 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
4695 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
4606 | functions (printf, scanf, perror etc.). This will increase the code size |
4696 | functions (printf, scanf, perror etc.). This will increase the code size |