… | |
… | |
551 | usually a better approach for this kind of thing. |
551 | usually a better approach for this kind of thing. |
552 | |
552 | |
553 | Here are the gory details of what C<ev_loop> does: |
553 | Here are the gory details of what C<ev_loop> does: |
554 | |
554 | |
555 | - Before the first iteration, call any pending watchers. |
555 | - Before the first iteration, call any pending watchers. |
556 | * If there are no active watchers (reference count is zero), return. |
556 | * If EVFLAG_FORKCHECK was used, check for a fork. |
557 | - Queue all prepare watchers and then call all outstanding watchers. |
557 | - If a fork was detected, queue and call all fork watchers. |
|
|
558 | - Queue and call all prepare watchers. |
558 | - If we have been forked, recreate the kernel state. |
559 | - If we have been forked, recreate the kernel state. |
559 | - Update the kernel state with all outstanding changes. |
560 | - Update the kernel state with all outstanding changes. |
560 | - Update the "event loop time". |
561 | - Update the "event loop time". |
561 | - Calculate for how long to block. |
562 | - Calculate for how long to sleep or block, if at all |
|
|
563 | (active idle watchers, EVLOOP_NONBLOCK or not having |
|
|
564 | any active watchers at all will result in not sleeping). |
|
|
565 | - Sleep if the I/O and timer collect interval say so. |
562 | - Block the process, waiting for any events. |
566 | - Block the process, waiting for any events. |
563 | - Queue all outstanding I/O (fd) events. |
567 | - Queue all outstanding I/O (fd) events. |
564 | - Update the "event loop time" and do time jump handling. |
568 | - Update the "event loop time" and do time jump handling. |
565 | - Queue all outstanding timers. |
569 | - Queue all outstanding timers. |
566 | - Queue all outstanding periodics. |
570 | - Queue all outstanding periodics. |
567 | - If no events are pending now, queue all idle watchers. |
571 | - If no events are pending now, queue all idle watchers. |
568 | - Queue all check watchers. |
572 | - Queue all check watchers. |
569 | - Call all queued watchers in reverse order (i.e. check watchers first). |
573 | - Call all queued watchers in reverse order (i.e. check watchers first). |
570 | Signals and child watchers are implemented as I/O watchers, and will |
574 | Signals and child watchers are implemented as I/O watchers, and will |
571 | be handled here by queueing them when their watcher gets executed. |
575 | be handled here by queueing them when their watcher gets executed. |
572 | - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
576 | - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
573 | were used, return, otherwise continue with step *. |
577 | were used, or there are no active watchers, return, otherwise |
|
|
578 | continue with step *. |
574 | |
579 | |
575 | Example: Queue some jobs and then loop until no events are outsanding |
580 | Example: Queue some jobs and then loop until no events are outstanding |
576 | anymore. |
581 | anymore. |
577 | |
582 | |
578 | ... queue jobs here, make sure they register event watchers as long |
583 | ... queue jobs here, make sure they register event watchers as long |
579 | ... as they still have work to do (even an idle watcher will do..) |
584 | ... as they still have work to do (even an idle watcher will do..) |
580 | ev_loop (my_loop, 0); |
585 | ev_loop (my_loop, 0); |
… | |
… | |
584 | |
589 | |
585 | Can be used to make a call to C<ev_loop> return early (but only after it |
590 | Can be used to make a call to C<ev_loop> return early (but only after it |
586 | has processed all outstanding events). The C<how> argument must be either |
591 | has processed all outstanding events). The C<how> argument must be either |
587 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
592 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
588 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
593 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
|
|
594 | |
|
|
595 | This "unloop state" will be cleared when entering C<ev_loop> again. |
589 | |
596 | |
590 | =item ev_ref (loop) |
597 | =item ev_ref (loop) |
591 | |
598 | |
592 | =item ev_unref (loop) |
599 | =item ev_unref (loop) |
593 | |
600 | |
… | |
… | |
1068 | |
1075 | |
1069 | The events being watched. |
1076 | The events being watched. |
1070 | |
1077 | |
1071 | =back |
1078 | =back |
1072 | |
1079 | |
|
|
1080 | =head3 Examples |
|
|
1081 | |
1073 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
1082 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
1074 | readable, but only once. Since it is likely line-buffered, you could |
1083 | readable, but only once. Since it is likely line-buffered, you could |
1075 | attempt to read a whole line in the callback. |
1084 | attempt to read a whole line in the callback. |
1076 | |
1085 | |
1077 | static void |
1086 | static void |
… | |
… | |
1174 | or C<ev_timer_again> is called and determines the next timeout (if any), |
1183 | or C<ev_timer_again> is called and determines the next timeout (if any), |
1175 | which is also when any modifications are taken into account. |
1184 | which is also when any modifications are taken into account. |
1176 | |
1185 | |
1177 | =back |
1186 | =back |
1178 | |
1187 | |
|
|
1188 | =head3 Examples |
|
|
1189 | |
1179 | Example: Create a timer that fires after 60 seconds. |
1190 | Example: Create a timer that fires after 60 seconds. |
1180 | |
1191 | |
1181 | static void |
1192 | static void |
1182 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1193 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1183 | { |
1194 | { |
… | |
… | |
1340 | When active, contains the absolute time that the watcher is supposed to |
1351 | When active, contains the absolute time that the watcher is supposed to |
1341 | trigger next. |
1352 | trigger next. |
1342 | |
1353 | |
1343 | =back |
1354 | =back |
1344 | |
1355 | |
|
|
1356 | =head3 Examples |
|
|
1357 | |
1345 | Example: Call a callback every hour, or, more precisely, whenever the |
1358 | Example: Call a callback every hour, or, more precisely, whenever the |
1346 | system clock is divisible by 3600. The callback invocation times have |
1359 | system clock is divisible by 3600. The callback invocation times have |
1347 | potentially a lot of jittering, but good long-term stability. |
1360 | potentially a lot of jittering, but good long-term stability. |
1348 | |
1361 | |
1349 | static void |
1362 | static void |
… | |
… | |
1440 | |
1453 | |
1441 | The process exit/trace status caused by C<rpid> (see your systems |
1454 | The process exit/trace status caused by C<rpid> (see your systems |
1442 | C<waitpid> and C<sys/wait.h> documentation for details). |
1455 | C<waitpid> and C<sys/wait.h> documentation for details). |
1443 | |
1456 | |
1444 | =back |
1457 | =back |
|
|
1458 | |
|
|
1459 | =head3 Examples |
1445 | |
1460 | |
1446 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
1461 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
1447 | |
1462 | |
1448 | static void |
1463 | static void |
1449 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1464 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
… | |
… | |
1658 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
1673 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
1659 | believe me. |
1674 | believe me. |
1660 | |
1675 | |
1661 | =back |
1676 | =back |
1662 | |
1677 | |
|
|
1678 | =head3 Examples |
|
|
1679 | |
1663 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
1680 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
1664 | callback, free it. Also, use no error checking, as usual. |
1681 | callback, free it. Also, use no error checking, as usual. |
1665 | |
1682 | |
1666 | static void |
1683 | static void |
1667 | idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1684 | idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
… | |
… | |
1738 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1755 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1739 | macros, but using them is utterly, utterly and completely pointless. |
1756 | macros, but using them is utterly, utterly and completely pointless. |
1740 | |
1757 | |
1741 | =back |
1758 | =back |
1742 | |
1759 | |
|
|
1760 | =head3 Examples |
|
|
1761 | |
1743 | There are a number of principal ways to embed other event loops or modules |
1762 | There are a number of principal ways to embed other event loops or modules |
1744 | into libev. Here are some ideas on how to include libadns into libev |
1763 | into libev. Here are some ideas on how to include libadns into libev |
1745 | (there is a Perl module named C<EV::ADNS> that does this, which you could |
1764 | (there is a Perl module named C<EV::ADNS> that does this, which you could |
1746 | use for an actually working example. Another Perl module named C<EV::Glib> |
1765 | use for an actually working example. Another Perl module named C<EV::Glib> |
1747 | embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV |
1766 | embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV |
… | |
… | |
1915 | portable one. |
1934 | portable one. |
1916 | |
1935 | |
1917 | So when you want to use this feature you will always have to be prepared |
1936 | So when you want to use this feature you will always have to be prepared |
1918 | that you cannot get an embeddable loop. The recommended way to get around |
1937 | that you cannot get an embeddable loop. The recommended way to get around |
1919 | this is to have a separate variables for your embeddable loop, try to |
1938 | this is to have a separate variables for your embeddable loop, try to |
1920 | create it, and if that fails, use the normal loop for everything: |
1939 | create it, and if that fails, use the normal loop for everything. |
|
|
1940 | |
|
|
1941 | =head3 Watcher-Specific Functions and Data Members |
|
|
1942 | |
|
|
1943 | =over 4 |
|
|
1944 | |
|
|
1945 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
|
|
1946 | |
|
|
1947 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
|
|
1948 | |
|
|
1949 | Configures the watcher to embed the given loop, which must be |
|
|
1950 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
|
|
1951 | invoked automatically, otherwise it is the responsibility of the callback |
|
|
1952 | to invoke it (it will continue to be called until the sweep has been done, |
|
|
1953 | if you do not want thta, you need to temporarily stop the embed watcher). |
|
|
1954 | |
|
|
1955 | =item ev_embed_sweep (loop, ev_embed *) |
|
|
1956 | |
|
|
1957 | Make a single, non-blocking sweep over the embedded loop. This works |
|
|
1958 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
|
|
1959 | apropriate way for embedded loops. |
|
|
1960 | |
|
|
1961 | =item struct ev_loop *other [read-only] |
|
|
1962 | |
|
|
1963 | The embedded event loop. |
|
|
1964 | |
|
|
1965 | =back |
|
|
1966 | |
|
|
1967 | =head3 Examples |
|
|
1968 | |
|
|
1969 | Example: Try to get an embeddable event loop and embed it into the default |
|
|
1970 | event loop. If that is not possible, use the default loop. The default |
|
|
1971 | loop is stored in C<loop_hi>, while the mebeddable loop is stored in |
|
|
1972 | C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be |
|
|
1973 | used). |
1921 | |
1974 | |
1922 | struct ev_loop *loop_hi = ev_default_init (0); |
1975 | struct ev_loop *loop_hi = ev_default_init (0); |
1923 | struct ev_loop *loop_lo = 0; |
1976 | struct ev_loop *loop_lo = 0; |
1924 | struct ev_embed embed; |
1977 | struct ev_embed embed; |
1925 | |
1978 | |
… | |
… | |
1936 | ev_embed_start (loop_hi, &embed); |
1989 | ev_embed_start (loop_hi, &embed); |
1937 | } |
1990 | } |
1938 | else |
1991 | else |
1939 | loop_lo = loop_hi; |
1992 | loop_lo = loop_hi; |
1940 | |
1993 | |
1941 | =head3 Watcher-Specific Functions and Data Members |
1994 | Example: Check if kqueue is available but not recommended and create |
|
|
1995 | a kqueue backend for use with sockets (which usually work with any |
|
|
1996 | kqueue implementation). Store the kqueue/socket-only event loop in |
|
|
1997 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
1942 | |
1998 | |
1943 | =over 4 |
1999 | struct ev_loop *loop = ev_default_init (0); |
|
|
2000 | struct ev_loop *loop_socket = 0; |
|
|
2001 | struct ev_embed embed; |
|
|
2002 | |
|
|
2003 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
|
|
2004 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
|
|
2005 | { |
|
|
2006 | ev_embed_init (&embed, 0, loop_socket); |
|
|
2007 | ev_embed_start (loop, &embed); |
|
|
2008 | } |
1944 | |
2009 | |
1945 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
2010 | if (!loop_socket) |
|
|
2011 | loop_socket = loop; |
1946 | |
2012 | |
1947 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
2013 | // now use loop_socket for all sockets, and loop for everything else |
1948 | |
|
|
1949 | Configures the watcher to embed the given loop, which must be |
|
|
1950 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
|
|
1951 | invoked automatically, otherwise it is the responsibility of the callback |
|
|
1952 | to invoke it (it will continue to be called until the sweep has been done, |
|
|
1953 | if you do not want thta, you need to temporarily stop the embed watcher). |
|
|
1954 | |
|
|
1955 | =item ev_embed_sweep (loop, ev_embed *) |
|
|
1956 | |
|
|
1957 | Make a single, non-blocking sweep over the embedded loop. This works |
|
|
1958 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
|
|
1959 | apropriate way for embedded loops. |
|
|
1960 | |
|
|
1961 | =item struct ev_loop *other [read-only] |
|
|
1962 | |
|
|
1963 | The embedded event loop. |
|
|
1964 | |
|
|
1965 | =back |
|
|
1966 | |
2014 | |
1967 | |
2015 | |
1968 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
2016 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
1969 | |
2017 | |
1970 | Fork watchers are called when a C<fork ()> was detected (usually because |
2018 | Fork watchers are called when a C<fork ()> was detected (usually because |
… | |
… | |
2449 | wants osf handles on win32 (this is the case when the select to |
2497 | wants osf handles on win32 (this is the case when the select to |
2450 | be used is the winsock select). This means that it will call |
2498 | be used is the winsock select). This means that it will call |
2451 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
2499 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
2452 | it is assumed that all these functions actually work on fds, even |
2500 | it is assumed that all these functions actually work on fds, even |
2453 | on win32. Should not be defined on non-win32 platforms. |
2501 | on win32. Should not be defined on non-win32 platforms. |
|
|
2502 | |
|
|
2503 | =item EV_FD_TO_WIN32_HANDLE |
|
|
2504 | |
|
|
2505 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
|
|
2506 | file descriptors to socket handles. When not defining this symbol (the |
|
|
2507 | default), then libev will call C<_get_osfhandle>, which is usually |
|
|
2508 | correct. In some cases, programs use their own file descriptor management, |
|
|
2509 | in which case they can provide this function to map fds to socket handles. |
2454 | |
2510 | |
2455 | =item EV_USE_POLL |
2511 | =item EV_USE_POLL |
2456 | |
2512 | |
2457 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
2513 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
2458 | backend. Otherwise it will be enabled on non-win32 platforms. It |
2514 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
2731 | watchers becomes O(1) w.r.t. prioritiy handling. |
2787 | watchers becomes O(1) w.r.t. prioritiy handling. |
2732 | |
2788 | |
2733 | =back |
2789 | =back |
2734 | |
2790 | |
2735 | |
2791 | |
|
|
2792 | =head1 Win32 platform limitations and workarounds |
|
|
2793 | |
|
|
2794 | Win32 doesn't support any of the standards (e.g. POSIX) that libev |
|
|
2795 | requires, and its I/O model is fundamentally incompatible with the POSIX |
|
|
2796 | model. Libev still offers limited functionality on this platform in |
|
|
2797 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
|
|
2798 | descriptors. This only applies when using Win32 natively, not when using |
|
|
2799 | e.g. cygwin. |
|
|
2800 | |
|
|
2801 | There is no supported compilation method available on windows except |
|
|
2802 | embedding it into other applications. |
|
|
2803 | |
|
|
2804 | Due to the many, low, and arbitrary limits on the win32 platform and the |
|
|
2805 | abysmal performance of winsockets, using a large number of sockets is not |
|
|
2806 | recommended (and not reasonable). If your program needs to use more than |
|
|
2807 | a hundred or so sockets, then likely it needs to use a totally different |
|
|
2808 | implementation for windows, as libev offers the POSIX model, which cannot |
|
|
2809 | be implemented efficiently on windows (microsoft monopoly games). |
|
|
2810 | |
|
|
2811 | =over 4 |
|
|
2812 | |
|
|
2813 | =item The winsocket select function |
|
|
2814 | |
|
|
2815 | The winsocket C<select> function doesn't follow POSIX in that it requires |
|
|
2816 | socket I<handles> and not socket I<file descriptors>. This makes select |
|
|
2817 | very inefficient, and also requires a mapping from file descriptors |
|
|
2818 | to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>, |
|
|
2819 | C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor |
|
|
2820 | symbols for more info. |
|
|
2821 | |
|
|
2822 | The configuration for a "naked" win32 using the microsoft runtime |
|
|
2823 | libraries and raw winsocket select is: |
|
|
2824 | |
|
|
2825 | #define EV_USE_SELECT 1 |
|
|
2826 | #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ |
|
|
2827 | |
|
|
2828 | Note that winsockets handling of fd sets is O(n), so you can easily get a |
|
|
2829 | complexity in the O(n²) range when using win32. |
|
|
2830 | |
|
|
2831 | =item Limited number of file descriptors |
|
|
2832 | |
|
|
2833 | Windows has numerous arbitrary (and low) limits on things. Early versions |
|
|
2834 | of winsocket's select only supported waiting for a max. of C<64> handles |
|
|
2835 | (probably owning to the fact that all windows kernels can only wait for |
|
|
2836 | C<64> things at the same time internally; microsoft recommends spawning a |
|
|
2837 | chain of threads and wait for 63 handles and the previous thread in each). |
|
|
2838 | |
|
|
2839 | Newer versions support more handles, but you need to define C<FD_SETSIZE> |
|
|
2840 | to some high number (e.g. C<2048>) before compiling the winsocket select |
|
|
2841 | call (which might be in libev or elsewhere, for example, perl does its own |
|
|
2842 | select emulation on windows). |
|
|
2843 | |
|
|
2844 | Another limit is the number of file descriptors in the microsoft runtime |
|
|
2845 | libraries, which by default is C<64> (there must be a hidden I<64> fetish |
|
|
2846 | or something like this inside microsoft). You can increase this by calling |
|
|
2847 | C<_setmaxstdio>, which can increase this limit to C<2048> (another |
|
|
2848 | arbitrary limit), but is broken in many versions of the microsoft runtime |
|
|
2849 | libraries. |
|
|
2850 | |
|
|
2851 | This might get you to about C<512> or C<2048> sockets (depending on |
|
|
2852 | windows version and/or the phase of the moon). To get more, you need to |
|
|
2853 | wrap all I/O functions and provide your own fd management, but the cost of |
|
|
2854 | calling select (O(n²)) will likely make this unworkable. |
|
|
2855 | |
|
|
2856 | =back |
|
|
2857 | |
|
|
2858 | |
2736 | =head1 AUTHOR |
2859 | =head1 AUTHOR |
2737 | |
2860 | |
2738 | Marc Lehmann <libev@schmorp.de>. |
2861 | Marc Lehmann <libev@schmorp.de>. |
2739 | |
2862 | |