… | |
… | |
82 | |
82 | |
83 | =head1 WHAT TO READ WHEN IN A HURRY |
83 | =head1 WHAT TO READ WHEN IN A HURRY |
84 | |
84 | |
85 | This manual tries to be very detailed, but unfortunately, this also makes |
85 | This manual tries to be very detailed, but unfortunately, this also makes |
86 | it very long. If you just want to know the basics of libev, I suggest |
86 | it very long. If you just want to know the basics of libev, I suggest |
87 | reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and |
87 | reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and |
88 | look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and |
88 | look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and |
89 | C<ev_timer> sections in L<WATCHER TYPES>. |
89 | C<ev_timer> sections in L</WATCHER TYPES>. |
90 | |
90 | |
91 | =head1 ABOUT LIBEV |
91 | =head1 ABOUT LIBEV |
92 | |
92 | |
93 | Libev is an event loop: you register interest in certain events (such as a |
93 | Libev is an event loop: you register interest in certain events (such as a |
94 | file descriptor being readable or a timeout occurring), and it will manage |
94 | file descriptor being readable or a timeout occurring), and it will manage |
… | |
… | |
569 | kernel is more efficient (which says nothing about its actual speed, of |
569 | kernel is more efficient (which says nothing about its actual speed, of |
570 | course). While stopping, setting and starting an I/O watcher does never |
570 | course). While stopping, setting and starting an I/O watcher does never |
571 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
571 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
572 | two event changes per incident. Support for C<fork ()> is very bad (you |
572 | two event changes per incident. Support for C<fork ()> is very bad (you |
573 | might have to leak fd's on fork, but it's more sane than epoll) and it |
573 | might have to leak fd's on fork, but it's more sane than epoll) and it |
574 | drops fds silently in similarly hard-to-detect cases |
574 | drops fds silently in similarly hard-to-detect cases. |
575 | |
575 | |
576 | This backend usually performs well under most conditions. |
576 | This backend usually performs well under most conditions. |
577 | |
577 | |
578 | While nominally embeddable in other event loops, this doesn't work |
578 | While nominally embeddable in other event loops, this doesn't work |
579 | everywhere, so you might need to test for this. And since it is broken |
579 | everywhere, so you might need to test for this. And since it is broken |
… | |
… | |
764 | |
764 | |
765 | This function is rarely useful, but when some event callback runs for a |
765 | This function is rarely useful, but when some event callback runs for a |
766 | very long time without entering the event loop, updating libev's idea of |
766 | very long time without entering the event loop, updating libev's idea of |
767 | the current time is a good idea. |
767 | the current time is a good idea. |
768 | |
768 | |
769 | See also L<The special problem of time updates> in the C<ev_timer> section. |
769 | See also L</The special problem of time updates> in the C<ev_timer> section. |
770 | |
770 | |
771 | =item ev_suspend (loop) |
771 | =item ev_suspend (loop) |
772 | |
772 | |
773 | =item ev_resume (loop) |
773 | =item ev_resume (loop) |
774 | |
774 | |
… | |
… | |
1174 | |
1174 | |
1175 | =item C<EV_PREPARE> |
1175 | =item C<EV_PREPARE> |
1176 | |
1176 | |
1177 | =item C<EV_CHECK> |
1177 | =item C<EV_CHECK> |
1178 | |
1178 | |
1179 | All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts |
1179 | All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to |
1180 | to gather new events, and all C<ev_check> watchers are invoked just after |
1180 | gather new events, and all C<ev_check> watchers are queued (not invoked) |
1181 | C<ev_run> has gathered them, but before it invokes any callbacks for any |
1181 | just after C<ev_run> has gathered them, but before it queues any callbacks |
|
|
1182 | for any received events. That means C<ev_prepare> watchers are the last |
|
|
1183 | watchers invoked before the event loop sleeps or polls for new events, and |
|
|
1184 | C<ev_check> watchers will be invoked before any other watchers of the same |
|
|
1185 | or lower priority within an event loop iteration. |
|
|
1186 | |
1182 | received events. Callbacks of both watcher types can start and stop as |
1187 | Callbacks of both watcher types can start and stop as many watchers as |
1183 | many watchers as they want, and all of them will be taken into account |
1188 | they want, and all of them will be taken into account (for example, a |
1184 | (for example, a C<ev_prepare> watcher might start an idle watcher to keep |
1189 | C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from |
1185 | C<ev_run> from blocking). |
1190 | blocking). |
1186 | |
1191 | |
1187 | =item C<EV_EMBED> |
1192 | =item C<EV_EMBED> |
1188 | |
1193 | |
1189 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1194 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1190 | |
1195 | |
… | |
… | |
1313 | |
1318 | |
1314 | =item callback ev_cb (ev_TYPE *watcher) |
1319 | =item callback ev_cb (ev_TYPE *watcher) |
1315 | |
1320 | |
1316 | Returns the callback currently set on the watcher. |
1321 | Returns the callback currently set on the watcher. |
1317 | |
1322 | |
1318 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1323 | =item ev_set_cb (ev_TYPE *watcher, callback) |
1319 | |
1324 | |
1320 | Change the callback. You can change the callback at virtually any time |
1325 | Change the callback. You can change the callback at virtually any time |
1321 | (modulo threads). |
1326 | (modulo threads). |
1322 | |
1327 | |
1323 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
1328 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
… | |
… | |
1341 | or might not have been clamped to the valid range. |
1346 | or might not have been clamped to the valid range. |
1342 | |
1347 | |
1343 | The default priority used by watchers when no priority has been set is |
1348 | The default priority used by watchers when no priority has been set is |
1344 | always C<0>, which is supposed to not be too high and not be too low :). |
1349 | always C<0>, which is supposed to not be too high and not be too low :). |
1345 | |
1350 | |
1346 | See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1351 | See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1347 | priorities. |
1352 | priorities. |
1348 | |
1353 | |
1349 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1354 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1350 | |
1355 | |
1351 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
1356 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
… | |
… | |
1376 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
1381 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
1377 | functions that do not need a watcher. |
1382 | functions that do not need a watcher. |
1378 | |
1383 | |
1379 | =back |
1384 | =back |
1380 | |
1385 | |
1381 | See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR |
1386 | See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR |
1382 | OWN COMPOSITE WATCHERS> idioms. |
1387 | OWN COMPOSITE WATCHERS> idioms. |
1383 | |
1388 | |
1384 | =head2 WATCHER STATES |
1389 | =head2 WATCHER STATES |
1385 | |
1390 | |
1386 | There are various watcher states mentioned throughout this manual - |
1391 | There are various watcher states mentioned throughout this manual - |
… | |
… | |
1388 | transition between them will be described in more detail - and while these |
1393 | transition between them will be described in more detail - and while these |
1389 | rules might look complicated, they usually do "the right thing". |
1394 | rules might look complicated, they usually do "the right thing". |
1390 | |
1395 | |
1391 | =over 4 |
1396 | =over 4 |
1392 | |
1397 | |
1393 | =item initialiased |
1398 | =item initialised |
1394 | |
1399 | |
1395 | Before a watcher can be registered with the event loop it has to be |
1400 | Before a watcher can be registered with the event loop it has to be |
1396 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
1401 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
1397 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1402 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1398 | |
1403 | |
… | |
… | |
1874 | callback (EV_P_ ev_timer *w, int revents) |
1879 | callback (EV_P_ ev_timer *w, int revents) |
1875 | { |
1880 | { |
1876 | // calculate when the timeout would happen |
1881 | // calculate when the timeout would happen |
1877 | ev_tstamp after = last_activity - ev_now (EV_A) + timeout; |
1882 | ev_tstamp after = last_activity - ev_now (EV_A) + timeout; |
1878 | |
1883 | |
1879 | // if negative, it means we the timeout already occured |
1884 | // if negative, it means we the timeout already occurred |
1880 | if (after < 0.) |
1885 | if (after < 0.) |
1881 | { |
1886 | { |
1882 | // timeout occurred, take action |
1887 | // timeout occurred, take action |
1883 | } |
1888 | } |
1884 | else |
1889 | else |
… | |
… | |
1902 | |
1907 | |
1903 | Otherwise, we now the earliest time at which the timeout would trigger, |
1908 | Otherwise, we now the earliest time at which the timeout would trigger, |
1904 | and simply start the timer with this timeout value. |
1909 | and simply start the timer with this timeout value. |
1905 | |
1910 | |
1906 | In other words, each time the callback is invoked it will check whether |
1911 | In other words, each time the callback is invoked it will check whether |
1907 | the timeout cocured. If not, it will simply reschedule itself to check |
1912 | the timeout occurred. If not, it will simply reschedule itself to check |
1908 | again at the earliest time it could time out. Rinse. Repeat. |
1913 | again at the earliest time it could time out. Rinse. Repeat. |
1909 | |
1914 | |
1910 | This scheme causes more callback invocations (about one every 60 seconds |
1915 | This scheme causes more callback invocations (about one every 60 seconds |
1911 | minus half the average time between activity), but virtually no calls to |
1916 | minus half the average time between activity), but virtually no calls to |
1912 | libev to change the timeout. |
1917 | libev to change the timeout. |
… | |
… | |
1926 | if (activity detected) |
1931 | if (activity detected) |
1927 | last_activity = ev_now (EV_A); |
1932 | last_activity = ev_now (EV_A); |
1928 | |
1933 | |
1929 | When your timeout value changes, then the timeout can be changed by simply |
1934 | When your timeout value changes, then the timeout can be changed by simply |
1930 | providing a new value, stopping the timer and calling the callback, which |
1935 | providing a new value, stopping the timer and calling the callback, which |
1931 | will agaion do the right thing (for example, time out immediately :). |
1936 | will again do the right thing (for example, time out immediately :). |
1932 | |
1937 | |
1933 | timeout = new_value; |
1938 | timeout = new_value; |
1934 | ev_timer_stop (EV_A_ &timer); |
1939 | ev_timer_stop (EV_A_ &timer); |
1935 | callback (EV_A_ &timer, 0); |
1940 | callback (EV_A_ &timer, 0); |
1936 | |
1941 | |
… | |
… | |
2131 | =item If the timer is repeating, make the C<repeat> value the new timeout |
2136 | =item If the timer is repeating, make the C<repeat> value the new timeout |
2132 | and start the timer, if necessary. |
2137 | and start the timer, if necessary. |
2133 | |
2138 | |
2134 | =back |
2139 | =back |
2135 | |
2140 | |
2136 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
2141 | This sounds a bit complicated, see L</Be smart about timeouts>, above, for a |
2137 | usage example. |
2142 | usage example. |
2138 | |
2143 | |
2139 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2144 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2140 | |
2145 | |
2141 | Returns the remaining time until a timer fires. If the timer is active, |
2146 | Returns the remaining time until a timer fires. If the timer is active, |
… | |
… | |
2601 | |
2606 | |
2602 | =head2 C<ev_stat> - did the file attributes just change? |
2607 | =head2 C<ev_stat> - did the file attributes just change? |
2603 | |
2608 | |
2604 | This watches a file system path for attribute changes. That is, it calls |
2609 | This watches a file system path for attribute changes. That is, it calls |
2605 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2610 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2606 | and sees if it changed compared to the last time, invoking the callback if |
2611 | and sees if it changed compared to the last time, invoking the callback |
2607 | it did. |
2612 | if it did. Starting the watcher C<stat>'s the file, so only changes that |
|
|
2613 | happen after the watcher has been started will be reported. |
2608 | |
2614 | |
2609 | The path does not need to exist: changing from "path exists" to "path does |
2615 | The path does not need to exist: changing from "path exists" to "path does |
2610 | not exist" is a status change like any other. The condition "path does not |
2616 | not exist" is a status change like any other. The condition "path does not |
2611 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2617 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2612 | C<st_nlink> field being zero (which is otherwise always forced to be at |
2618 | C<st_nlink> field being zero (which is otherwise always forced to be at |
… | |
… | |
2842 | Apart from keeping your process non-blocking (which is a useful |
2848 | Apart from keeping your process non-blocking (which is a useful |
2843 | effect on its own sometimes), idle watchers are a good place to do |
2849 | effect on its own sometimes), idle watchers are a good place to do |
2844 | "pseudo-background processing", or delay processing stuff to after the |
2850 | "pseudo-background processing", or delay processing stuff to after the |
2845 | event loop has handled all outstanding events. |
2851 | event loop has handled all outstanding events. |
2846 | |
2852 | |
|
|
2853 | =head3 Abusing an C<ev_idle> watcher for its side-effect |
|
|
2854 | |
|
|
2855 | As long as there is at least one active idle watcher, libev will never |
|
|
2856 | sleep unnecessarily. Or in other words, it will loop as fast as possible. |
|
|
2857 | For this to work, the idle watcher doesn't need to be invoked at all - the |
|
|
2858 | lowest priority will do. |
|
|
2859 | |
|
|
2860 | This mode of operation can be useful together with an C<ev_check> watcher, |
|
|
2861 | to do something on each event loop iteration - for example to balance load |
|
|
2862 | between different connections. |
|
|
2863 | |
|
|
2864 | See L</Abusing an ev_check watcher for its side-effect> for a longer |
|
|
2865 | example. |
|
|
2866 | |
2847 | =head3 Watcher-Specific Functions and Data Members |
2867 | =head3 Watcher-Specific Functions and Data Members |
2848 | |
2868 | |
2849 | =over 4 |
2869 | =over 4 |
2850 | |
2870 | |
2851 | =item ev_idle_init (ev_idle *, callback) |
2871 | =item ev_idle_init (ev_idle *, callback) |
… | |
… | |
2862 | callback, free it. Also, use no error checking, as usual. |
2882 | callback, free it. Also, use no error checking, as usual. |
2863 | |
2883 | |
2864 | static void |
2884 | static void |
2865 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2885 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2866 | { |
2886 | { |
|
|
2887 | // stop the watcher |
|
|
2888 | ev_idle_stop (loop, w); |
|
|
2889 | |
|
|
2890 | // now we can free it |
2867 | free (w); |
2891 | free (w); |
|
|
2892 | |
2868 | // now do something you wanted to do when the program has |
2893 | // now do something you wanted to do when the program has |
2869 | // no longer anything immediate to do. |
2894 | // no longer anything immediate to do. |
2870 | } |
2895 | } |
2871 | |
2896 | |
2872 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
2897 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
… | |
… | |
2874 | ev_idle_start (loop, idle_watcher); |
2899 | ev_idle_start (loop, idle_watcher); |
2875 | |
2900 | |
2876 | |
2901 | |
2877 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2902 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2878 | |
2903 | |
2879 | Prepare and check watchers are usually (but not always) used in pairs: |
2904 | Prepare and check watchers are often (but not always) used in pairs: |
2880 | prepare watchers get invoked before the process blocks and check watchers |
2905 | prepare watchers get invoked before the process blocks and check watchers |
2881 | afterwards. |
2906 | afterwards. |
2882 | |
2907 | |
2883 | You I<must not> call C<ev_run> or similar functions that enter |
2908 | You I<must not> call C<ev_run> or similar functions that enter |
2884 | the current event loop from either C<ev_prepare> or C<ev_check> |
2909 | the current event loop from either C<ev_prepare> or C<ev_check> |
… | |
… | |
2912 | with priority higher than or equal to the event loop and one coroutine |
2937 | with priority higher than or equal to the event loop and one coroutine |
2913 | of lower priority, but only once, using idle watchers to keep the event |
2938 | of lower priority, but only once, using idle watchers to keep the event |
2914 | loop from blocking if lower-priority coroutines are active, thus mapping |
2939 | loop from blocking if lower-priority coroutines are active, thus mapping |
2915 | low-priority coroutines to idle/background tasks). |
2940 | low-priority coroutines to idle/background tasks). |
2916 | |
2941 | |
2917 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
2942 | When used for this purpose, it is recommended to give C<ev_check> watchers |
2918 | priority, to ensure that they are being run before any other watchers |
2943 | highest (C<EV_MAXPRI>) priority, to ensure that they are being run before |
2919 | after the poll (this doesn't matter for C<ev_prepare> watchers). |
2944 | any other watchers after the poll (this doesn't matter for C<ev_prepare> |
|
|
2945 | watchers). |
2920 | |
2946 | |
2921 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
2947 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
2922 | activate ("feed") events into libev. While libev fully supports this, they |
2948 | activate ("feed") events into libev. While libev fully supports this, they |
2923 | might get executed before other C<ev_check> watchers did their job. As |
2949 | might get executed before other C<ev_check> watchers did their job. As |
2924 | C<ev_check> watchers are often used to embed other (non-libev) event |
2950 | C<ev_check> watchers are often used to embed other (non-libev) event |
2925 | loops those other event loops might be in an unusable state until their |
2951 | loops those other event loops might be in an unusable state until their |
2926 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
2952 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
2927 | others). |
2953 | others). |
|
|
2954 | |
|
|
2955 | =head3 Abusing an C<ev_check> watcher for its side-effect |
|
|
2956 | |
|
|
2957 | C<ev_check> (and less often also C<ev_prepare>) watchers can also be |
|
|
2958 | useful because they are called once per event loop iteration. For |
|
|
2959 | example, if you want to handle a large number of connections fairly, you |
|
|
2960 | normally only do a bit of work for each active connection, and if there |
|
|
2961 | is more work to do, you wait for the next event loop iteration, so other |
|
|
2962 | connections have a chance of making progress. |
|
|
2963 | |
|
|
2964 | Using an C<ev_check> watcher is almost enough: it will be called on the |
|
|
2965 | next event loop iteration. However, that isn't as soon as possible - |
|
|
2966 | without external events, your C<ev_check> watcher will not be invoked. |
|
|
2967 | |
|
|
2968 | This is where C<ev_idle> watchers come in handy - all you need is a |
|
|
2969 | single global idle watcher that is active as long as you have one active |
|
|
2970 | C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop |
|
|
2971 | will not sleep, and the C<ev_check> watcher makes sure a callback gets |
|
|
2972 | invoked. Neither watcher alone can do that. |
2928 | |
2973 | |
2929 | =head3 Watcher-Specific Functions and Data Members |
2974 | =head3 Watcher-Specific Functions and Data Members |
2930 | |
2975 | |
2931 | =over 4 |
2976 | =over 4 |
2932 | |
2977 | |
… | |
… | |
3133 | |
3178 | |
3134 | =over 4 |
3179 | =over 4 |
3135 | |
3180 | |
3136 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3181 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3137 | |
3182 | |
3138 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
3183 | =item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop) |
3139 | |
3184 | |
3140 | Configures the watcher to embed the given loop, which must be |
3185 | Configures the watcher to embed the given loop, which must be |
3141 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3186 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3142 | invoked automatically, otherwise it is the responsibility of the callback |
3187 | invoked automatically, otherwise it is the responsibility of the callback |
3143 | to invoke it (it will continue to be called until the sweep has been done, |
3188 | to invoke it (it will continue to be called until the sweep has been done, |
… | |
… | |
3206 | |
3251 | |
3207 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3252 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3208 | |
3253 | |
3209 | Fork watchers are called when a C<fork ()> was detected (usually because |
3254 | Fork watchers are called when a C<fork ()> was detected (usually because |
3210 | whoever is a good citizen cared to tell libev about it by calling |
3255 | whoever is a good citizen cared to tell libev about it by calling |
3211 | C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the |
3256 | C<ev_loop_fork>). The invocation is done before the event loop blocks next |
3212 | event loop blocks next and before C<ev_check> watchers are being called, |
3257 | and before C<ev_check> watchers are being called, and only in the child |
3213 | and only in the child after the fork. If whoever good citizen calling |
3258 | after the fork. If whoever good citizen calling C<ev_default_fork> cheats |
3214 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
3259 | and calls it in the wrong process, the fork handlers will be invoked, too, |
3215 | handlers will be invoked, too, of course. |
3260 | of course. |
3216 | |
3261 | |
3217 | =head3 The special problem of life after fork - how is it possible? |
3262 | =head3 The special problem of life after fork - how is it possible? |
3218 | |
3263 | |
3219 | Most uses of C<fork()> consist of forking, then some simple calls to set |
3264 | Most uses of C<fork()> consist of forking, then some simple calls to set |
3220 | up/change the process environment, followed by a call to C<exec()>. This |
3265 | up/change the process environment, followed by a call to C<exec()>. This |
… | |
… | |
3313 | it by calling C<ev_async_send>, which is thread- and signal safe. |
3358 | it by calling C<ev_async_send>, which is thread- and signal safe. |
3314 | |
3359 | |
3315 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3360 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3316 | too, are asynchronous in nature, and signals, too, will be compressed |
3361 | too, are asynchronous in nature, and signals, too, will be compressed |
3317 | (i.e. the number of callback invocations may be less than the number of |
3362 | (i.e. the number of callback invocations may be less than the number of |
3318 | C<ev_async_sent> calls). In fact, you could use signal watchers as a kind |
3363 | C<ev_async_send> calls). In fact, you could use signal watchers as a kind |
3319 | of "global async watchers" by using a watcher on an otherwise unused |
3364 | of "global async watchers" by using a watcher on an otherwise unused |
3320 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3365 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3321 | even without knowing which loop owns the signal. |
3366 | even without knowing which loop owns the signal. |
3322 | |
3367 | |
3323 | =head3 Queueing |
3368 | =head3 Queueing |
… | |
… | |
3614 | already been invoked. |
3659 | already been invoked. |
3615 | |
3660 | |
3616 | A common way around all these issues is to make sure that |
3661 | A common way around all these issues is to make sure that |
3617 | C<start_new_request> I<always> returns before the callback is invoked. If |
3662 | C<start_new_request> I<always> returns before the callback is invoked. If |
3618 | C<start_new_request> immediately knows the result, it can artificially |
3663 | C<start_new_request> immediately knows the result, it can artificially |
3619 | delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher |
3664 | delay invoking the callback by using a C<prepare> or C<idle> watcher for |
3620 | for example, or more sneakily, by reusing an existing (stopped) watcher |
3665 | example, or more sneakily, by reusing an existing (stopped) watcher and |
3621 | and pushing it into the pending queue: |
3666 | pushing it into the pending queue: |
3622 | |
3667 | |
3623 | ev_set_cb (watcher, callback); |
3668 | ev_set_cb (watcher, callback); |
3624 | ev_feed_event (EV_A_ watcher, 0); |
3669 | ev_feed_event (EV_A_ watcher, 0); |
3625 | |
3670 | |
3626 | This way, C<start_new_request> can safely return before the callback is |
3671 | This way, C<start_new_request> can safely return before the callback is |
… | |
… | |
3634 | |
3679 | |
3635 | This brings the problem of exiting - a callback might want to finish the |
3680 | This brings the problem of exiting - a callback might want to finish the |
3636 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3681 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3637 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3682 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3638 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3683 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3639 | other combination: In these cases, C<ev_break> will not work alone. |
3684 | other combination: In these cases, a simple C<ev_break> will not work. |
3640 | |
3685 | |
3641 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3686 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3642 | invocation, and use a loop around C<ev_run> until the condition is |
3687 | invocation, and use a loop around C<ev_run> until the condition is |
3643 | triggered, using C<EVRUN_ONCE>: |
3688 | triggered, using C<EVRUN_ONCE>: |
3644 | |
3689 | |
… | |
… | |
3830 | called): |
3875 | called): |
3831 | |
3876 | |
3832 | void |
3877 | void |
3833 | wait_for_event (ev_watcher *w) |
3878 | wait_for_event (ev_watcher *w) |
3834 | { |
3879 | { |
3835 | ev_cb_set (w) = current_coro; |
3880 | ev_set_cb (w, current_coro); |
3836 | switch_to (libev_coro); |
3881 | switch_to (libev_coro); |
3837 | } |
3882 | } |
3838 | |
3883 | |
3839 | That basically suspends the coroutine inside C<wait_for_event> and |
3884 | That basically suspends the coroutine inside C<wait_for_event> and |
3840 | continues the libev coroutine, which, when appropriate, switches back to |
3885 | continues the libev coroutine, which, when appropriate, switches back to |
… | |
… | |
3843 | You can do similar tricks if you have, say, threads with an event queue - |
3888 | You can do similar tricks if you have, say, threads with an event queue - |
3844 | instead of storing a coroutine, you store the queue object and instead of |
3889 | instead of storing a coroutine, you store the queue object and instead of |
3845 | switching to a coroutine, you push the watcher onto the queue and notify |
3890 | switching to a coroutine, you push the watcher onto the queue and notify |
3846 | any waiters. |
3891 | any waiters. |
3847 | |
3892 | |
3848 | To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two |
3893 | To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two |
3849 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3894 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3850 | |
3895 | |
3851 | // my_ev.h |
3896 | // my_ev.h |
3852 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3897 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3853 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); |
3898 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); |
… | |
… | |
3905 | libev sources can be compiled as C++. Therefore, code that uses the C API |
3950 | libev sources can be compiled as C++. Therefore, code that uses the C API |
3906 | will work fine. |
3951 | will work fine. |
3907 | |
3952 | |
3908 | Proper exception specifications might have to be added to callbacks passed |
3953 | Proper exception specifications might have to be added to callbacks passed |
3909 | to libev: exceptions may be thrown only from watcher callbacks, all |
3954 | to libev: exceptions may be thrown only from watcher callbacks, all |
3910 | other callbacks (allocator, syserr, loop acquire/release and periodioc |
3955 | other callbacks (allocator, syserr, loop acquire/release and periodic |
3911 | reschedule callbacks) must not throw exceptions, and might need a C<throw |
3956 | reschedule callbacks) must not throw exceptions, and might need a C<throw |
3912 | ()> specification. If you have code that needs to be compiled as both C |
3957 | ()> specification. If you have code that needs to be compiled as both C |
3913 | and C++ you can use the C<EV_THROW> macro for this: |
3958 | and C++ you can use the C<EV_THROW> macro for this: |
3914 | |
3959 | |
3915 | static void |
3960 | static void |
… | |
… | |
3921 | |
3966 | |
3922 | ... |
3967 | ... |
3923 | ev_set_syserr_cb (fatal_error); |
3968 | ev_set_syserr_cb (fatal_error); |
3924 | |
3969 | |
3925 | The only API functions that can currently throw exceptions are C<ev_run>, |
3970 | The only API functions that can currently throw exceptions are C<ev_run>, |
3926 | C<ev_inoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter |
3971 | C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter |
3927 | because it runs cleanup watchers). |
3972 | because it runs cleanup watchers). |
3928 | |
3973 | |
3929 | Throwing exceptions in watcher callbacks is only supported if libev itself |
3974 | Throwing exceptions in watcher callbacks is only supported if libev itself |
3930 | is compiled with a C++ compiler or your C and C++ environments allow |
3975 | is compiled with a C++ compiler or your C and C++ environments allow |
3931 | throwing exceptions through C libraries (most do). |
3976 | throwing exceptions through C libraries (most do). |
… | |
… | |
4076 | Associates a different C<struct ev_loop> with this watcher. You can only |
4121 | Associates a different C<struct ev_loop> with this watcher. You can only |
4077 | do this when the watcher is inactive (and not pending either). |
4122 | do this when the watcher is inactive (and not pending either). |
4078 | |
4123 | |
4079 | =item w->set ([arguments]) |
4124 | =item w->set ([arguments]) |
4080 | |
4125 | |
4081 | Basically the same as C<ev_TYPE_set>, with the same arguments. Either this |
4126 | Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>), |
4082 | method or a suitable start method must be called at least once. Unlike the |
4127 | with the same arguments. Either this method or a suitable start method |
4083 | C counterpart, an active watcher gets automatically stopped and restarted |
4128 | must be called at least once. Unlike the C counterpart, an active watcher |
4084 | when reconfiguring it with this method. |
4129 | gets automatically stopped and restarted when reconfiguring it with this |
|
|
4130 | method. |
|
|
4131 | |
|
|
4132 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
|
|
4133 | clashing with the C<set (loop)> method. |
4085 | |
4134 | |
4086 | =item w->start () |
4135 | =item w->start () |
4087 | |
4136 | |
4088 | Starts the watcher. Note that there is no C<loop> argument, as the |
4137 | Starts the watcher. Note that there is no C<loop> argument, as the |
4089 | constructor already stores the event loop. |
4138 | constructor already stores the event loop. |
… | |
… | |
4192 | =item Lua |
4241 | =item Lua |
4193 | |
4242 | |
4194 | Brian Maher has written a partial interface to libev for lua (at the |
4243 | Brian Maher has written a partial interface to libev for lua (at the |
4195 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4244 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4196 | L<http://github.com/brimworks/lua-ev>. |
4245 | L<http://github.com/brimworks/lua-ev>. |
|
|
4246 | |
|
|
4247 | =item Javascript |
|
|
4248 | |
|
|
4249 | Node.js (L<http://nodejs.org>) uses libev as the underlying event library. |
|
|
4250 | |
|
|
4251 | =item Others |
|
|
4252 | |
|
|
4253 | There are others, and I stopped counting. |
4197 | |
4254 | |
4198 | =back |
4255 | =back |
4199 | |
4256 | |
4200 | |
4257 | |
4201 | =head1 MACRO MAGIC |
4258 | =head1 MACRO MAGIC |
… | |
… | |
4500 | |
4557 | |
4501 | If programs implement their own fd to handle mapping on win32, then this |
4558 | If programs implement their own fd to handle mapping on win32, then this |
4502 | macro can be used to override the C<close> function, useful to unregister |
4559 | macro can be used to override the C<close> function, useful to unregister |
4503 | file descriptors again. Note that the replacement function has to close |
4560 | file descriptors again. Note that the replacement function has to close |
4504 | the underlying OS handle. |
4561 | the underlying OS handle. |
|
|
4562 | |
|
|
4563 | =item EV_USE_WSASOCKET |
|
|
4564 | |
|
|
4565 | If defined to be C<1>, libev will use C<WSASocket> to create its internal |
|
|
4566 | communication socket, which works better in some environments. Otherwise, |
|
|
4567 | the normal C<socket> function will be used, which works better in other |
|
|
4568 | environments. |
4505 | |
4569 | |
4506 | =item EV_USE_POLL |
4570 | =item EV_USE_POLL |
4507 | |
4571 | |
4508 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4572 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4509 | backend. Otherwise it will be enabled on non-win32 platforms. It |
4573 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
4554 | different cpus (or different cpu cores). This reduces dependencies |
4618 | different cpus (or different cpu cores). This reduces dependencies |
4555 | and makes libev faster. |
4619 | and makes libev faster. |
4556 | |
4620 | |
4557 | =item EV_NO_THREADS |
4621 | =item EV_NO_THREADS |
4558 | |
4622 | |
4559 | If defined to be C<1>, libev will assume that it will never be called |
4623 | If defined to be C<1>, libev will assume that it will never be called from |
4560 | from different threads, which is a stronger assumption than C<EV_NO_SMP>, |
4624 | different threads (that includes signal handlers), which is a stronger |
4561 | above. This reduces dependencies and makes libev faster. |
4625 | assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes |
|
|
4626 | libev faster. |
4562 | |
4627 | |
4563 | =item EV_ATOMIC_T |
4628 | =item EV_ATOMIC_T |
4564 | |
4629 | |
4565 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4630 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4566 | access is atomic and serialised with respect to other threads or signal |
4631 | access is atomic with respect to other threads or signal contexts. No |
4567 | contexts. No such type is easily found in the C language, so you can |
4632 | such type is easily found in the C language, so you can provide your own |
4568 | provide your own type that you know is safe for your purposes. It is used |
4633 | type that you know is safe for your purposes. It is used both for signal |
4569 | both for signal handler "locking" as well as for signal and thread safety |
4634 | handler "locking" as well as for signal and thread safety in C<ev_async> |
4570 | in C<ev_async> watchers. |
4635 | watchers. |
4571 | |
4636 | |
4572 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4637 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4573 | (from F<signal.h>), which is usually good enough on most platforms, |
4638 | (from F<signal.h>), which is usually good enough on most platforms. |
4574 | although strictly speaking using a type that also implies a memory fence |
|
|
4575 | is required. |
|
|
4576 | |
4639 | |
4577 | =item EV_H (h) |
4640 | =item EV_H (h) |
4578 | |
4641 | |
4579 | The name of the F<ev.h> header file used to include it. The default if |
4642 | The name of the F<ev.h> header file used to include it. The default if |
4580 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
4643 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
… | |
… | |
4948 | default loop and triggering an C<ev_async> watcher from the default loop |
5011 | default loop and triggering an C<ev_async> watcher from the default loop |
4949 | watcher callback into the event loop interested in the signal. |
5012 | watcher callback into the event loop interested in the signal. |
4950 | |
5013 | |
4951 | =back |
5014 | =back |
4952 | |
5015 | |
4953 | See also L<THREAD LOCKING EXAMPLE>. |
5016 | See also L</THREAD LOCKING EXAMPLE>. |
4954 | |
5017 | |
4955 | =head3 COROUTINES |
5018 | =head3 COROUTINES |
4956 | |
5019 | |
4957 | Libev is very accommodating to coroutines ("cooperative threads"): |
5020 | Libev is very accommodating to coroutines ("cooperative threads"): |
4958 | libev fully supports nesting calls to its functions from different |
5021 | libev fully supports nesting calls to its functions from different |
… | |
… | |
5249 | thread" or will block signals process-wide, both behaviours would |
5312 | thread" or will block signals process-wide, both behaviours would |
5250 | be compatible with libev. Interaction between C<sigprocmask> and |
5313 | be compatible with libev. Interaction between C<sigprocmask> and |
5251 | C<pthread_sigmask> could complicate things, however. |
5314 | C<pthread_sigmask> could complicate things, however. |
5252 | |
5315 | |
5253 | The most portable way to handle signals is to block signals in all threads |
5316 | The most portable way to handle signals is to block signals in all threads |
5254 | except the initial one, and run the default loop in the initial thread as |
5317 | except the initial one, and run the signal handling loop in the initial |
5255 | well. |
5318 | thread as well. |
5256 | |
5319 | |
5257 | =item C<long> must be large enough for common memory allocation sizes |
5320 | =item C<long> must be large enough for common memory allocation sizes |
5258 | |
5321 | |
5259 | To improve portability and simplify its API, libev uses C<long> internally |
5322 | To improve portability and simplify its API, libev uses C<long> internally |
5260 | instead of C<size_t> when allocating its data structures. On non-POSIX |
5323 | instead of C<size_t> when allocating its data structures. On non-POSIX |
… | |
… | |
5364 | =over 4 |
5427 | =over 4 |
5365 | |
5428 | |
5366 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5429 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5367 | |
5430 | |
5368 | The backward compatibility mechanism can be controlled by |
5431 | The backward compatibility mechanism can be controlled by |
5369 | C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> |
5432 | C<EV_COMPAT3>. See L</PREPROCESSOR SYMBOLS/MACROS> in the L</EMBEDDING> |
5370 | section. |
5433 | section. |
5371 | |
5434 | |
5372 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5435 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5373 | |
5436 | |
5374 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
5437 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
… | |
… | |
5417 | =over 4 |
5480 | =over 4 |
5418 | |
5481 | |
5419 | =item active |
5482 | =item active |
5420 | |
5483 | |
5421 | A watcher is active as long as it has been started and not yet stopped. |
5484 | A watcher is active as long as it has been started and not yet stopped. |
5422 | See L<WATCHER STATES> for details. |
5485 | See L</WATCHER STATES> for details. |
5423 | |
5486 | |
5424 | =item application |
5487 | =item application |
5425 | |
5488 | |
5426 | In this document, an application is whatever is using libev. |
5489 | In this document, an application is whatever is using libev. |
5427 | |
5490 | |
… | |
… | |
5463 | watchers and events. |
5526 | watchers and events. |
5464 | |
5527 | |
5465 | =item pending |
5528 | =item pending |
5466 | |
5529 | |
5467 | A watcher is pending as soon as the corresponding event has been |
5530 | A watcher is pending as soon as the corresponding event has been |
5468 | detected. See L<WATCHER STATES> for details. |
5531 | detected. See L</WATCHER STATES> for details. |
5469 | |
5532 | |
5470 | =item real time |
5533 | =item real time |
5471 | |
5534 | |
5472 | The physical time that is observed. It is apparently strictly monotonic :) |
5535 | The physical time that is observed. It is apparently strictly monotonic :) |
5473 | |
5536 | |