… | |
… | |
98 | =head2 FEATURES |
98 | =head2 FEATURES |
99 | |
99 | |
100 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
100 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
101 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
101 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
102 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
102 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
103 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
103 | (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner |
104 | with customised rescheduling (C<ev_periodic>), synchronous signals |
104 | inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative |
105 | (C<ev_signal>), process status change events (C<ev_child>), and event |
105 | timers (C<ev_timer>), absolute timers with customised rescheduling |
106 | watchers dealing with the event loop mechanism itself (C<ev_idle>, |
106 | (C<ev_periodic>), synchronous signals (C<ev_signal>), process status |
107 | C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as |
107 | change events (C<ev_child>), and event watchers dealing with the event |
108 | file watchers (C<ev_stat>) and even limited support for fork events |
108 | loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and |
109 | (C<ev_fork>). |
109 | C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even |
|
|
110 | limited support for fork events (C<ev_fork>). |
110 | |
111 | |
111 | It also is quite fast (see this |
112 | It also is quite fast (see this |
112 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
113 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
113 | for example). |
114 | for example). |
114 | |
115 | |
… | |
… | |
117 | Libev is very configurable. In this manual the default (and most common) |
118 | Libev is very configurable. In this manual the default (and most common) |
118 | configuration will be described, which supports multiple event loops. For |
119 | configuration will be described, which supports multiple event loops. For |
119 | more info about various configuration options please have a look at |
120 | more info about various configuration options please have a look at |
120 | B<EMBED> section in this manual. If libev was configured without support |
121 | B<EMBED> section in this manual. If libev was configured without support |
121 | for multiple event loops, then all functions taking an initial argument of |
122 | for multiple event loops, then all functions taking an initial argument of |
122 | name C<loop> (which is always of type C<ev_loop *>) will not have |
123 | name C<loop> (which is always of type C<struct ev_loop *>) will not have |
123 | this argument. |
124 | this argument. |
124 | |
125 | |
125 | =head2 TIME REPRESENTATION |
126 | =head2 TIME REPRESENTATION |
126 | |
127 | |
127 | Libev represents time as a single floating point number, representing |
128 | Libev represents time as a single floating point number, representing |
… | |
… | |
362 | flag. |
363 | flag. |
363 | |
364 | |
364 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
365 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
365 | environment variable. |
366 | environment variable. |
366 | |
367 | |
|
|
368 | =item C<EVFLAG_NOINOTIFY> |
|
|
369 | |
|
|
370 | When this flag is specified, then libev will not attempt to use the |
|
|
371 | I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and |
|
|
372 | testing, this flag can be useful to conserve inotify file descriptors, as |
|
|
373 | otherwise each loop using C<ev_stat> watchers consumes one inotify handle. |
|
|
374 | |
|
|
375 | =item C<EVFLAG_SIGNALFD> |
|
|
376 | |
|
|
377 | When this flag is specified, then libev will attempt to use the |
|
|
378 | I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API |
|
|
379 | delivers signals synchronously, which makes it both faster and might make |
|
|
380 | it possible to get the queued signal data. It can also simplify signal |
|
|
381 | handling with threads, as long as you properly block signals in your |
|
|
382 | threads that are not interested in handling them. |
|
|
383 | |
|
|
384 | Signalfd will not be used by default as this changes your signal mask, and |
|
|
385 | there are a lot of shoddy libraries and programs (glib's threadpool for |
|
|
386 | example) that can't properly initialise their signal masks. |
|
|
387 | |
367 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
388 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
368 | |
389 | |
369 | This is your standard select(2) backend. Not I<completely> standard, as |
390 | This is your standard select(2) backend. Not I<completely> standard, as |
370 | libev tries to roll its own fd_set with no limits on the number of fds, |
391 | libev tries to roll its own fd_set with no limits on the number of fds, |
371 | but if that fails, expect a fairly low limit on the number of fds when |
392 | but if that fails, expect a fairly low limit on the number of fds when |
… | |
… | |
394 | |
415 | |
395 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
416 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
396 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
417 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
397 | |
418 | |
398 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
419 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
|
|
420 | |
|
|
421 | Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
|
|
422 | kernels). |
399 | |
423 | |
400 | For few fds, this backend is a bit little slower than poll and select, |
424 | For few fds, this backend is a bit little slower than poll and select, |
401 | but it scales phenomenally better. While poll and select usually scale |
425 | but it scales phenomenally better. While poll and select usually scale |
402 | like O(total_fds) where n is the total number of fds (or the highest fd), |
426 | like O(total_fds) where n is the total number of fds (or the highest fd), |
403 | epoll scales either O(1) or O(active_fds). |
427 | epoll scales either O(1) or O(active_fds). |
… | |
… | |
518 | |
542 | |
519 | It is definitely not recommended to use this flag. |
543 | It is definitely not recommended to use this flag. |
520 | |
544 | |
521 | =back |
545 | =back |
522 | |
546 | |
523 | If one or more of these are or'ed into the flags value, then only these |
547 | If one or more of the backend flags are or'ed into the flags value, |
524 | backends will be tried (in the reverse order as listed here). If none are |
548 | then only these backends will be tried (in the reverse order as listed |
525 | specified, all backends in C<ev_recommended_backends ()> will be tried. |
549 | here). If none are specified, all backends in C<ev_recommended_backends |
|
|
550 | ()> will be tried. |
526 | |
551 | |
527 | Example: This is the most typical usage. |
552 | Example: This is the most typical usage. |
528 | |
553 | |
529 | if (!ev_default_loop (0)) |
554 | if (!ev_default_loop (0)) |
530 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
555 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
… | |
… | |
573 | as signal and child watchers) would need to be stopped manually. |
598 | as signal and child watchers) would need to be stopped manually. |
574 | |
599 | |
575 | In general it is not advisable to call this function except in the |
600 | In general it is not advisable to call this function except in the |
576 | rare occasion where you really need to free e.g. the signal handling |
601 | rare occasion where you really need to free e.g. the signal handling |
577 | pipe fds. If you need dynamically allocated loops it is better to use |
602 | pipe fds. If you need dynamically allocated loops it is better to use |
578 | C<ev_loop_new> and C<ev_loop_destroy>). |
603 | C<ev_loop_new> and C<ev_loop_destroy>. |
579 | |
604 | |
580 | =item ev_loop_destroy (loop) |
605 | =item ev_loop_destroy (loop) |
581 | |
606 | |
582 | Like C<ev_default_destroy>, but destroys an event loop created by an |
607 | Like C<ev_default_destroy>, but destroys an event loop created by an |
583 | earlier call to C<ev_loop_new>. |
608 | earlier call to C<ev_loop_new>. |
… | |
… | |
621 | |
646 | |
622 | This value can sometimes be useful as a generation counter of sorts (it |
647 | This value can sometimes be useful as a generation counter of sorts (it |
623 | "ticks" the number of loop iterations), as it roughly corresponds with |
648 | "ticks" the number of loop iterations), as it roughly corresponds with |
624 | C<ev_prepare> and C<ev_check> calls. |
649 | C<ev_prepare> and C<ev_check> calls. |
625 | |
650 | |
|
|
651 | =item unsigned int ev_loop_depth (loop) |
|
|
652 | |
|
|
653 | Returns the number of times C<ev_loop> was entered minus the number of |
|
|
654 | times C<ev_loop> was exited, in other words, the recursion depth. |
|
|
655 | |
|
|
656 | Outside C<ev_loop>, this number is zero. In a callback, this number is |
|
|
657 | C<1>, unless C<ev_loop> was invoked recursively (or from another thread), |
|
|
658 | in which case it is higher. |
|
|
659 | |
|
|
660 | Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread |
|
|
661 | etc.), doesn't count as exit. |
|
|
662 | |
626 | =item unsigned int ev_backend (loop) |
663 | =item unsigned int ev_backend (loop) |
627 | |
664 | |
628 | Returns one of the C<EVBACKEND_*> flags indicating the event backend in |
665 | Returns one of the C<EVBACKEND_*> flags indicating the event backend in |
629 | use. |
666 | use. |
630 | |
667 | |
… | |
… | |
675 | event loop time (see C<ev_now_update>). |
712 | event loop time (see C<ev_now_update>). |
676 | |
713 | |
677 | =item ev_loop (loop, int flags) |
714 | =item ev_loop (loop, int flags) |
678 | |
715 | |
679 | Finally, this is it, the event handler. This function usually is called |
716 | Finally, this is it, the event handler. This function usually is called |
680 | after you initialised all your watchers and you want to start handling |
717 | after you have initialised all your watchers and you want to start |
681 | events. |
718 | handling events. |
682 | |
719 | |
683 | If the flags argument is specified as C<0>, it will not return until |
720 | If the flags argument is specified as C<0>, it will not return until |
684 | either no event watchers are active anymore or C<ev_unloop> was called. |
721 | either no event watchers are active anymore or C<ev_unloop> was called. |
685 | |
722 | |
686 | Please note that an explicit C<ev_unloop> is usually better than |
723 | Please note that an explicit C<ev_unloop> is usually better than |
… | |
… | |
760 | |
797 | |
761 | Ref/unref can be used to add or remove a reference count on the event |
798 | Ref/unref can be used to add or remove a reference count on the event |
762 | loop: Every watcher keeps one reference, and as long as the reference |
799 | loop: Every watcher keeps one reference, and as long as the reference |
763 | count is nonzero, C<ev_loop> will not return on its own. |
800 | count is nonzero, C<ev_loop> will not return on its own. |
764 | |
801 | |
765 | If you have a watcher you never unregister that should not keep C<ev_loop> |
802 | This is useful when you have a watcher that you never intend to |
766 | from returning, call ev_unref() after starting, and ev_ref() before |
803 | unregister, but that nevertheless should not keep C<ev_loop> from |
|
|
804 | returning. In such a case, call C<ev_unref> after starting, and C<ev_ref> |
767 | stopping it. |
805 | before stopping it. |
768 | |
806 | |
769 | As an example, libev itself uses this for its internal signal pipe: It |
807 | As an example, libev itself uses this for its internal signal pipe: It |
770 | is not visible to the libev user and should not keep C<ev_loop> from |
808 | is not visible to the libev user and should not keep C<ev_loop> from |
771 | exiting if no event watchers registered by it are active. It is also an |
809 | exiting if no event watchers registered by it are active. It is also an |
772 | excellent way to do this for generic recurring timers or from within |
810 | excellent way to do this for generic recurring timers or from within |
… | |
… | |
811 | |
849 | |
812 | By setting a higher I<io collect interval> you allow libev to spend more |
850 | By setting a higher I<io collect interval> you allow libev to spend more |
813 | time collecting I/O events, so you can handle more events per iteration, |
851 | time collecting I/O events, so you can handle more events per iteration, |
814 | at the cost of increasing latency. Timeouts (both C<ev_periodic> and |
852 | at the cost of increasing latency. Timeouts (both C<ev_periodic> and |
815 | C<ev_timer>) will be not affected. Setting this to a non-null value will |
853 | C<ev_timer>) will be not affected. Setting this to a non-null value will |
816 | introduce an additional C<ev_sleep ()> call into most loop iterations. |
854 | introduce an additional C<ev_sleep ()> call into most loop iterations. The |
|
|
855 | sleep time ensures that libev will not poll for I/O events more often then |
|
|
856 | once per this interval, on average. |
817 | |
857 | |
818 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
858 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
819 | to spend more time collecting timeouts, at the expense of increased |
859 | to spend more time collecting timeouts, at the expense of increased |
820 | latency/jitter/inexactness (the watcher callback will be called |
860 | latency/jitter/inexactness (the watcher callback will be called |
821 | later). C<ev_io> watchers will not be affected. Setting this to a non-null |
861 | later). C<ev_io> watchers will not be affected. Setting this to a non-null |
… | |
… | |
823 | |
863 | |
824 | Many (busy) programs can usually benefit by setting the I/O collect |
864 | Many (busy) programs can usually benefit by setting the I/O collect |
825 | interval to a value near C<0.1> or so, which is often enough for |
865 | interval to a value near C<0.1> or so, which is often enough for |
826 | interactive servers (of course not for games), likewise for timeouts. It |
866 | interactive servers (of course not for games), likewise for timeouts. It |
827 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
867 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
828 | as this approaches the timing granularity of most systems. |
868 | as this approaches the timing granularity of most systems. Note that if |
|
|
869 | you do transactions with the outside world and you can't increase the |
|
|
870 | parallelity, then this setting will limit your transaction rate (if you |
|
|
871 | need to poll once per transaction and the I/O collect interval is 0.01, |
|
|
872 | then you can't do more than 100 transations per second). |
829 | |
873 | |
830 | Setting the I<timeout collect interval> can improve the opportunity for |
874 | Setting the I<timeout collect interval> can improve the opportunity for |
831 | saving power, as the program will "bundle" timer callback invocations that |
875 | saving power, as the program will "bundle" timer callback invocations that |
832 | are "near" in time together, by delaying some, thus reducing the number of |
876 | are "near" in time together, by delaying some, thus reducing the number of |
833 | times the process sleeps and wakes up again. Another useful technique to |
877 | times the process sleeps and wakes up again. Another useful technique to |
834 | reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure |
878 | reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure |
835 | they fire on, say, one-second boundaries only. |
879 | they fire on, say, one-second boundaries only. |
|
|
880 | |
|
|
881 | Example: we only need 0.1s timeout granularity, and we wish not to poll |
|
|
882 | more often than 100 times per second: |
|
|
883 | |
|
|
884 | ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1); |
|
|
885 | ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01); |
|
|
886 | |
|
|
887 | =item ev_invoke_pending (loop) |
|
|
888 | |
|
|
889 | This call will simply invoke all pending watchers while resetting their |
|
|
890 | pending state. Normally, C<ev_loop> does this automatically when required, |
|
|
891 | but when overriding the invoke callback this call comes handy. |
|
|
892 | |
|
|
893 | =item int ev_pending_count (loop) |
|
|
894 | |
|
|
895 | Returns the number of pending watchers - zero indicates that no watchers |
|
|
896 | are pending. |
|
|
897 | |
|
|
898 | =item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P)) |
|
|
899 | |
|
|
900 | This overrides the invoke pending functionality of the loop: Instead of |
|
|
901 | invoking all pending watchers when there are any, C<ev_loop> will call |
|
|
902 | this callback instead. This is useful, for example, when you want to |
|
|
903 | invoke the actual watchers inside another context (another thread etc.). |
|
|
904 | |
|
|
905 | If you want to reset the callback, use C<ev_invoke_pending> as new |
|
|
906 | callback. |
|
|
907 | |
|
|
908 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) |
|
|
909 | |
|
|
910 | Sometimes you want to share the same loop between multiple threads. This |
|
|
911 | can be done relatively simply by putting mutex_lock/unlock calls around |
|
|
912 | each call to a libev function. |
|
|
913 | |
|
|
914 | However, C<ev_loop> can run an indefinite time, so it is not feasible to |
|
|
915 | wait for it to return. One way around this is to wake up the loop via |
|
|
916 | C<ev_unloop> and C<av_async_send>, another way is to set these I<release> |
|
|
917 | and I<acquire> callbacks on the loop. |
|
|
918 | |
|
|
919 | When set, then C<release> will be called just before the thread is |
|
|
920 | suspended waiting for new events, and C<acquire> is called just |
|
|
921 | afterwards. |
|
|
922 | |
|
|
923 | Ideally, C<release> will just call your mutex_unlock function, and |
|
|
924 | C<acquire> will just call the mutex_lock function again. |
|
|
925 | |
|
|
926 | While event loop modifications are allowed between invocations of |
|
|
927 | C<release> and C<acquire> (that's their only purpose after all), no |
|
|
928 | modifications done will affect the event loop, i.e. adding watchers will |
|
|
929 | have no effect on the set of file descriptors being watched, or the time |
|
|
930 | waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it |
|
|
931 | to take note of any changes you made. |
|
|
932 | |
|
|
933 | In theory, threads executing C<ev_loop> will be async-cancel safe between |
|
|
934 | invocations of C<release> and C<acquire>. |
|
|
935 | |
|
|
936 | See also the locking example in the C<THREADS> section later in this |
|
|
937 | document. |
|
|
938 | |
|
|
939 | =item ev_set_userdata (loop, void *data) |
|
|
940 | |
|
|
941 | =item ev_userdata (loop) |
|
|
942 | |
|
|
943 | Set and retrieve a single C<void *> associated with a loop. When |
|
|
944 | C<ev_set_userdata> has never been called, then C<ev_userdata> returns |
|
|
945 | C<0.> |
|
|
946 | |
|
|
947 | These two functions can be used to associate arbitrary data with a loop, |
|
|
948 | and are intended solely for the C<invoke_pending_cb>, C<release> and |
|
|
949 | C<acquire> callbacks described above, but of course can be (ab-)used for |
|
|
950 | any other purpose as well. |
836 | |
951 | |
837 | =item ev_loop_verify (loop) |
952 | =item ev_loop_verify (loop) |
838 | |
953 | |
839 | This function only does something when C<EV_VERIFY> support has been |
954 | This function only does something when C<EV_VERIFY> support has been |
840 | compiled in, which is the default for non-minimal builds. It tries to go |
955 | compiled in, which is the default for non-minimal builds. It tries to go |
… | |
… | |
1017 | |
1132 | |
1018 | ev_io w; |
1133 | ev_io w; |
1019 | ev_init (&w, my_cb); |
1134 | ev_init (&w, my_cb); |
1020 | ev_io_set (&w, STDIN_FILENO, EV_READ); |
1135 | ev_io_set (&w, STDIN_FILENO, EV_READ); |
1021 | |
1136 | |
1022 | =item C<ev_TYPE_set> (ev_TYPE *, [args]) |
1137 | =item C<ev_TYPE_set> (ev_TYPE *watcher, [args]) |
1023 | |
1138 | |
1024 | This macro initialises the type-specific parts of a watcher. You need to |
1139 | This macro initialises the type-specific parts of a watcher. You need to |
1025 | call C<ev_init> at least once before you call this macro, but you can |
1140 | call C<ev_init> at least once before you call this macro, but you can |
1026 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
1141 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
1027 | macro on a watcher that is active (it can be pending, however, which is a |
1142 | macro on a watcher that is active (it can be pending, however, which is a |
… | |
… | |
1040 | |
1155 | |
1041 | Example: Initialise and set an C<ev_io> watcher in one step. |
1156 | Example: Initialise and set an C<ev_io> watcher in one step. |
1042 | |
1157 | |
1043 | ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
1158 | ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
1044 | |
1159 | |
1045 | =item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) |
1160 | =item C<ev_TYPE_start> (loop, ev_TYPE *watcher) |
1046 | |
1161 | |
1047 | Starts (activates) the given watcher. Only active watchers will receive |
1162 | Starts (activates) the given watcher. Only active watchers will receive |
1048 | events. If the watcher is already active nothing will happen. |
1163 | events. If the watcher is already active nothing will happen. |
1049 | |
1164 | |
1050 | Example: Start the C<ev_io> watcher that is being abused as example in this |
1165 | Example: Start the C<ev_io> watcher that is being abused as example in this |
1051 | whole section. |
1166 | whole section. |
1052 | |
1167 | |
1053 | ev_io_start (EV_DEFAULT_UC, &w); |
1168 | ev_io_start (EV_DEFAULT_UC, &w); |
1054 | |
1169 | |
1055 | =item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) |
1170 | =item C<ev_TYPE_stop> (loop, ev_TYPE *watcher) |
1056 | |
1171 | |
1057 | Stops the given watcher if active, and clears the pending status (whether |
1172 | Stops the given watcher if active, and clears the pending status (whether |
1058 | the watcher was active or not). |
1173 | the watcher was active or not). |
1059 | |
1174 | |
1060 | It is possible that stopped watchers are pending - for example, |
1175 | It is possible that stopped watchers are pending - for example, |
… | |
… | |
1085 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1200 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1086 | |
1201 | |
1087 | Change the callback. You can change the callback at virtually any time |
1202 | Change the callback. You can change the callback at virtually any time |
1088 | (modulo threads). |
1203 | (modulo threads). |
1089 | |
1204 | |
1090 | =item ev_set_priority (ev_TYPE *watcher, priority) |
1205 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
1091 | |
1206 | |
1092 | =item int ev_priority (ev_TYPE *watcher) |
1207 | =item int ev_priority (ev_TYPE *watcher) |
1093 | |
1208 | |
1094 | Set and query the priority of the watcher. The priority is a small |
1209 | Set and query the priority of the watcher. The priority is a small |
1095 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
1210 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
… | |
… | |
1126 | returns its C<revents> bitset (as if its callback was invoked). If the |
1241 | returns its C<revents> bitset (as if its callback was invoked). If the |
1127 | watcher isn't pending it does nothing and returns C<0>. |
1242 | watcher isn't pending it does nothing and returns C<0>. |
1128 | |
1243 | |
1129 | Sometimes it can be useful to "poll" a watcher instead of waiting for its |
1244 | Sometimes it can be useful to "poll" a watcher instead of waiting for its |
1130 | callback to be invoked, which can be accomplished with this function. |
1245 | callback to be invoked, which can be accomplished with this function. |
|
|
1246 | |
|
|
1247 | =item ev_feed_event (loop, ev_TYPE *watcher, int revents) |
|
|
1248 | |
|
|
1249 | Feeds the given event set into the event loop, as if the specified event |
|
|
1250 | had happened for the specified watcher (which must be a pointer to an |
|
|
1251 | initialised but not necessarily started event watcher). Obviously you must |
|
|
1252 | not free the watcher as long as it has pending events. |
|
|
1253 | |
|
|
1254 | Stopping the watcher, letting libev invoke it, or calling |
|
|
1255 | C<ev_clear_pending> will clear the pending event, even if the watcher was |
|
|
1256 | not started in the first place. |
|
|
1257 | |
|
|
1258 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
|
|
1259 | functions that do not need a watcher. |
1131 | |
1260 | |
1132 | =back |
1261 | =back |
1133 | |
1262 | |
1134 | |
1263 | |
1135 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
1264 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
… | |
… | |
1184 | #include <stddef.h> |
1313 | #include <stddef.h> |
1185 | |
1314 | |
1186 | static void |
1315 | static void |
1187 | t1_cb (EV_P_ ev_timer *w, int revents) |
1316 | t1_cb (EV_P_ ev_timer *w, int revents) |
1188 | { |
1317 | { |
1189 | struct my_biggy big = (struct my_biggy * |
1318 | struct my_biggy big = (struct my_biggy *) |
1190 | (((char *)w) - offsetof (struct my_biggy, t1)); |
1319 | (((char *)w) - offsetof (struct my_biggy, t1)); |
1191 | } |
1320 | } |
1192 | |
1321 | |
1193 | static void |
1322 | static void |
1194 | t2_cb (EV_P_ ev_timer *w, int revents) |
1323 | t2_cb (EV_P_ ev_timer *w, int revents) |
1195 | { |
1324 | { |
1196 | struct my_biggy big = (struct my_biggy * |
1325 | struct my_biggy big = (struct my_biggy *) |
1197 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1326 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1198 | } |
1327 | } |
1199 | |
1328 | |
1200 | =head2 WATCHER PRIORITY MODELS |
1329 | =head2 WATCHER PRIORITY MODELS |
1201 | |
1330 | |
… | |
… | |
1277 | // with the default priority are receiving events. |
1406 | // with the default priority are receiving events. |
1278 | ev_idle_start (EV_A_ &idle); |
1407 | ev_idle_start (EV_A_ &idle); |
1279 | } |
1408 | } |
1280 | |
1409 | |
1281 | static void |
1410 | static void |
1282 | idle-cb (EV_P_ ev_idle *w, int revents) |
1411 | idle_cb (EV_P_ ev_idle *w, int revents) |
1283 | { |
1412 | { |
1284 | // actual processing |
1413 | // actual processing |
1285 | read (STDIN_FILENO, ...); |
1414 | read (STDIN_FILENO, ...); |
1286 | |
1415 | |
1287 | // have to start the I/O watcher again, as |
1416 | // have to start the I/O watcher again, as |
… | |
… | |
1465 | year, it will still time out after (roughly) one hour. "Roughly" because |
1594 | year, it will still time out after (roughly) one hour. "Roughly" because |
1466 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1595 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1467 | monotonic clock option helps a lot here). |
1596 | monotonic clock option helps a lot here). |
1468 | |
1597 | |
1469 | The callback is guaranteed to be invoked only I<after> its timeout has |
1598 | The callback is guaranteed to be invoked only I<after> its timeout has |
1470 | passed. If multiple timers become ready during the same loop iteration |
1599 | passed (not I<at>, so on systems with very low-resolution clocks this |
1471 | then the ones with earlier time-out values are invoked before ones with |
1600 | might introduce a small delay). If multiple timers become ready during the |
1472 | later time-out values (but this is no longer true when a callback calls |
1601 | same loop iteration then the ones with earlier time-out values are invoked |
1473 | C<ev_loop> recursively). |
1602 | before ones of the same priority with later time-out values (but this is |
|
|
1603 | no longer true when a callback calls C<ev_loop> recursively). |
1474 | |
1604 | |
1475 | =head3 Be smart about timeouts |
1605 | =head3 Be smart about timeouts |
1476 | |
1606 | |
1477 | Many real-world problems involve some kind of timeout, usually for error |
1607 | Many real-world problems involve some kind of timeout, usually for error |
1478 | recovery. A typical example is an HTTP request - if the other side hangs, |
1608 | recovery. A typical example is an HTTP request - if the other side hangs, |
… | |
… | |
1522 | C<after> argument to C<ev_timer_set>, and only ever use the C<repeat> |
1652 | C<after> argument to C<ev_timer_set>, and only ever use the C<repeat> |
1523 | member and C<ev_timer_again>. |
1653 | member and C<ev_timer_again>. |
1524 | |
1654 | |
1525 | At start: |
1655 | At start: |
1526 | |
1656 | |
1527 | ev_timer_init (timer, callback); |
1657 | ev_init (timer, callback); |
1528 | timer->repeat = 60.; |
1658 | timer->repeat = 60.; |
1529 | ev_timer_again (loop, timer); |
1659 | ev_timer_again (loop, timer); |
1530 | |
1660 | |
1531 | Each time there is some activity: |
1661 | Each time there is some activity: |
1532 | |
1662 | |
… | |
… | |
1594 | |
1724 | |
1595 | To start the timer, simply initialise the watcher and set C<last_activity> |
1725 | To start the timer, simply initialise the watcher and set C<last_activity> |
1596 | to the current time (meaning we just have some activity :), then call the |
1726 | to the current time (meaning we just have some activity :), then call the |
1597 | callback, which will "do the right thing" and start the timer: |
1727 | callback, which will "do the right thing" and start the timer: |
1598 | |
1728 | |
1599 | ev_timer_init (timer, callback); |
1729 | ev_init (timer, callback); |
1600 | last_activity = ev_now (loop); |
1730 | last_activity = ev_now (loop); |
1601 | callback (loop, timer, EV_TIMEOUT); |
1731 | callback (loop, timer, EV_TIMEOUT); |
1602 | |
1732 | |
1603 | And when there is some activity, simply store the current time in |
1733 | And when there is some activity, simply store the current time in |
1604 | C<last_activity>, no libev calls at all: |
1734 | C<last_activity>, no libev calls at all: |
… | |
… | |
1665 | |
1795 | |
1666 | If the event loop is suspended for a long time, you can also force an |
1796 | If the event loop is suspended for a long time, you can also force an |
1667 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1797 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1668 | ()>. |
1798 | ()>. |
1669 | |
1799 | |
|
|
1800 | =head3 The special problems of suspended animation |
|
|
1801 | |
|
|
1802 | When you leave the server world it is quite customary to hit machines that |
|
|
1803 | can suspend/hibernate - what happens to the clocks during such a suspend? |
|
|
1804 | |
|
|
1805 | Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes |
|
|
1806 | all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue |
|
|
1807 | to run until the system is suspended, but they will not advance while the |
|
|
1808 | system is suspended. That means, on resume, it will be as if the program |
|
|
1809 | was frozen for a few seconds, but the suspend time will not be counted |
|
|
1810 | towards C<ev_timer> when a monotonic clock source is used. The real time |
|
|
1811 | clock advanced as expected, but if it is used as sole clocksource, then a |
|
|
1812 | long suspend would be detected as a time jump by libev, and timers would |
|
|
1813 | be adjusted accordingly. |
|
|
1814 | |
|
|
1815 | I would not be surprised to see different behaviour in different between |
|
|
1816 | operating systems, OS versions or even different hardware. |
|
|
1817 | |
|
|
1818 | The other form of suspend (job control, or sending a SIGSTOP) will see a |
|
|
1819 | time jump in the monotonic clocks and the realtime clock. If the program |
|
|
1820 | is suspended for a very long time, and monotonic clock sources are in use, |
|
|
1821 | then you can expect C<ev_timer>s to expire as the full suspension time |
|
|
1822 | will be counted towards the timers. When no monotonic clock source is in |
|
|
1823 | use, then libev will again assume a timejump and adjust accordingly. |
|
|
1824 | |
|
|
1825 | It might be beneficial for this latter case to call C<ev_suspend> |
|
|
1826 | and C<ev_resume> in code that handles C<SIGTSTP>, to at least get |
|
|
1827 | deterministic behaviour in this case (you can do nothing against |
|
|
1828 | C<SIGSTOP>). |
|
|
1829 | |
1670 | =head3 Watcher-Specific Functions and Data Members |
1830 | =head3 Watcher-Specific Functions and Data Members |
1671 | |
1831 | |
1672 | =over 4 |
1832 | =over 4 |
1673 | |
1833 | |
1674 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
1834 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
… | |
… | |
1699 | If the timer is repeating, either start it if necessary (with the |
1859 | If the timer is repeating, either start it if necessary (with the |
1700 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1860 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1701 | |
1861 | |
1702 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
1862 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
1703 | usage example. |
1863 | usage example. |
|
|
1864 | |
|
|
1865 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
|
|
1866 | |
|
|
1867 | Returns the remaining time until a timer fires. If the timer is active, |
|
|
1868 | then this time is relative to the current event loop time, otherwise it's |
|
|
1869 | the timeout value currently configured. |
|
|
1870 | |
|
|
1871 | That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns |
|
|
1872 | C<5>. When the timer is started and one second passes, C<ev_timer_remaining> |
|
|
1873 | will return C<4>. When the timer expires and is restarted, it will return |
|
|
1874 | roughly C<7> (likely slightly less as callback invocation takes some time, |
|
|
1875 | too), and so on. |
1704 | |
1876 | |
1705 | =item ev_tstamp repeat [read-write] |
1877 | =item ev_tstamp repeat [read-write] |
1706 | |
1878 | |
1707 | The current C<repeat> value. Will be used each time the watcher times out |
1879 | The current C<repeat> value. Will be used each time the watcher times out |
1708 | or C<ev_timer_again> is called, and determines the next timeout (if any), |
1880 | or C<ev_timer_again> is called, and determines the next timeout (if any), |
… | |
… | |
1944 | Signal watchers will trigger an event when the process receives a specific |
2116 | Signal watchers will trigger an event when the process receives a specific |
1945 | signal one or more times. Even though signals are very asynchronous, libev |
2117 | signal one or more times. Even though signals are very asynchronous, libev |
1946 | will try it's best to deliver signals synchronously, i.e. as part of the |
2118 | will try it's best to deliver signals synchronously, i.e. as part of the |
1947 | normal event processing, like any other event. |
2119 | normal event processing, like any other event. |
1948 | |
2120 | |
1949 | If you want signals asynchronously, just use C<sigaction> as you would |
2121 | If you want signals to be delivered truly asynchronously, just use |
1950 | do without libev and forget about sharing the signal. You can even use |
2122 | C<sigaction> as you would do without libev and forget about sharing |
1951 | C<ev_async> from a signal handler to synchronously wake up an event loop. |
2123 | the signal. You can even use C<ev_async> from a signal handler to |
|
|
2124 | synchronously wake up an event loop. |
1952 | |
2125 | |
1953 | You can configure as many watchers as you like per signal. Only when the |
2126 | You can configure as many watchers as you like for the same signal, but |
|
|
2127 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
|
|
2128 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
|
|
2129 | C<SIGINT> in both the default loop and another loop at the same time. At |
|
|
2130 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
|
|
2131 | |
1954 | first watcher gets started will libev actually register a signal handler |
2132 | When the first watcher gets started will libev actually register something |
1955 | with the kernel (thus it coexists with your own signal handlers as long as |
2133 | with the kernel (thus it coexists with your own signal handlers as long as |
1956 | you don't register any with libev for the same signal). Similarly, when |
2134 | you don't register any with libev for the same signal). |
1957 | the last signal watcher for a signal is stopped, libev will reset the |
|
|
1958 | signal handler to SIG_DFL (regardless of what it was set to before). |
|
|
1959 | |
2135 | |
1960 | If possible and supported, libev will install its handlers with |
2136 | If possible and supported, libev will install its handlers with |
1961 | C<SA_RESTART> behaviour enabled, so system calls should not be unduly |
2137 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
1962 | interrupted. If you have a problem with system calls getting interrupted by |
2138 | not be unduly interrupted. If you have a problem with system calls getting |
1963 | signals you can block all signals in an C<ev_check> watcher and unblock |
2139 | interrupted by signals you can block all signals in an C<ev_check> watcher |
1964 | them in an C<ev_prepare> watcher. |
2140 | and unblock them in an C<ev_prepare> watcher. |
|
|
2141 | |
|
|
2142 | =head3 The special problem of inheritance over fork/execve/pthread_create |
|
|
2143 | |
|
|
2144 | Both the signal mask (C<sigprocmask>) and the signal disposition |
|
|
2145 | (C<sigaction>) are unspecified after starting a signal watcher (and after |
|
|
2146 | stopping it again), that is, libev might or might not block the signal, |
|
|
2147 | and might or might not set or restore the installed signal handler. |
|
|
2148 | |
|
|
2149 | While this does not matter for the signal disposition (libev never |
|
|
2150 | sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on |
|
|
2151 | C<execve>), this matters for the signal mask: many programs do not expect |
|
|
2152 | certain signals to be blocked. |
|
|
2153 | |
|
|
2154 | This means that before calling C<exec> (from the child) you should reset |
|
|
2155 | the signal mask to whatever "default" you expect (all clear is a good |
|
|
2156 | choice usually). |
|
|
2157 | |
|
|
2158 | The simplest way to ensure that the signal mask is reset in the child is |
|
|
2159 | to install a fork handler with C<pthread_atfork> that resets it. That will |
|
|
2160 | catch fork calls done by libraries (such as the libc) as well. |
|
|
2161 | |
|
|
2162 | In current versions of libev, the signal will not be blocked indefinitely |
|
|
2163 | unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces |
|
|
2164 | the window of opportunity for problems, it will not go away, as libev |
|
|
2165 | I<has> to modify the signal mask, at least temporarily. |
|
|
2166 | |
|
|
2167 | So I can't stress this enough: I<If you do not reset your signal mask when |
|
|
2168 | you expect it to be empty, you have a race condition in your code>. This |
|
|
2169 | is not a libev-specific thing, this is true for most event libraries. |
1965 | |
2170 | |
1966 | =head3 Watcher-Specific Functions and Data Members |
2171 | =head3 Watcher-Specific Functions and Data Members |
1967 | |
2172 | |
1968 | =over 4 |
2173 | =over 4 |
1969 | |
2174 | |
… | |
… | |
2001 | some child status changes (most typically when a child of yours dies or |
2206 | some child status changes (most typically when a child of yours dies or |
2002 | exits). It is permissible to install a child watcher I<after> the child |
2207 | exits). It is permissible to install a child watcher I<after> the child |
2003 | has been forked (which implies it might have already exited), as long |
2208 | has been forked (which implies it might have already exited), as long |
2004 | as the event loop isn't entered (or is continued from a watcher), i.e., |
2209 | as the event loop isn't entered (or is continued from a watcher), i.e., |
2005 | forking and then immediately registering a watcher for the child is fine, |
2210 | forking and then immediately registering a watcher for the child is fine, |
2006 | but forking and registering a watcher a few event loop iterations later is |
2211 | but forking and registering a watcher a few event loop iterations later or |
2007 | not. |
2212 | in the next callback invocation is not. |
2008 | |
2213 | |
2009 | Only the default event loop is capable of handling signals, and therefore |
2214 | Only the default event loop is capable of handling signals, and therefore |
2010 | you can only register child watchers in the default event loop. |
2215 | you can only register child watchers in the default event loop. |
2011 | |
2216 | |
|
|
2217 | Due to some design glitches inside libev, child watchers will always be |
|
|
2218 | handled at maximum priority (their priority is set to C<EV_MAXPRI> by |
|
|
2219 | libev) |
|
|
2220 | |
2012 | =head3 Process Interaction |
2221 | =head3 Process Interaction |
2013 | |
2222 | |
2014 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
2223 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
2015 | initialised. This is necessary to guarantee proper behaviour even if |
2224 | initialised. This is necessary to guarantee proper behaviour even if the |
2016 | the first child watcher is started after the child exits. The occurrence |
2225 | first child watcher is started after the child exits. The occurrence |
2017 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
2226 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
2018 | synchronously as part of the event loop processing. Libev always reaps all |
2227 | synchronously as part of the event loop processing. Libev always reaps all |
2019 | children, even ones not watched. |
2228 | children, even ones not watched. |
2020 | |
2229 | |
2021 | =head3 Overriding the Built-In Processing |
2230 | =head3 Overriding the Built-In Processing |
… | |
… | |
2031 | =head3 Stopping the Child Watcher |
2240 | =head3 Stopping the Child Watcher |
2032 | |
2241 | |
2033 | Currently, the child watcher never gets stopped, even when the |
2242 | Currently, the child watcher never gets stopped, even when the |
2034 | child terminates, so normally one needs to stop the watcher in the |
2243 | child terminates, so normally one needs to stop the watcher in the |
2035 | callback. Future versions of libev might stop the watcher automatically |
2244 | callback. Future versions of libev might stop the watcher automatically |
2036 | when a child exit is detected. |
2245 | when a child exit is detected (calling C<ev_child_stop> twice is not a |
|
|
2246 | problem). |
2037 | |
2247 | |
2038 | =head3 Watcher-Specific Functions and Data Members |
2248 | =head3 Watcher-Specific Functions and Data Members |
2039 | |
2249 | |
2040 | =over 4 |
2250 | =over 4 |
2041 | |
2251 | |
… | |
… | |
2367 | // no longer anything immediate to do. |
2577 | // no longer anything immediate to do. |
2368 | } |
2578 | } |
2369 | |
2579 | |
2370 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
2580 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
2371 | ev_idle_init (idle_watcher, idle_cb); |
2581 | ev_idle_init (idle_watcher, idle_cb); |
2372 | ev_idle_start (loop, idle_cb); |
2582 | ev_idle_start (loop, idle_watcher); |
2373 | |
2583 | |
2374 | |
2584 | |
2375 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2585 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2376 | |
2586 | |
2377 | Prepare and check watchers are usually (but not always) used in pairs: |
2587 | Prepare and check watchers are usually (but not always) used in pairs: |
… | |
… | |
2470 | struct pollfd fds [nfd]; |
2680 | struct pollfd fds [nfd]; |
2471 | // actual code will need to loop here and realloc etc. |
2681 | // actual code will need to loop here and realloc etc. |
2472 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
2682 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
2473 | |
2683 | |
2474 | /* the callback is illegal, but won't be called as we stop during check */ |
2684 | /* the callback is illegal, but won't be called as we stop during check */ |
2475 | ev_timer_init (&tw, 0, timeout * 1e-3); |
2685 | ev_timer_init (&tw, 0, timeout * 1e-3, 0.); |
2476 | ev_timer_start (loop, &tw); |
2686 | ev_timer_start (loop, &tw); |
2477 | |
2687 | |
2478 | // create one ev_io per pollfd |
2688 | // create one ev_io per pollfd |
2479 | for (int i = 0; i < nfd; ++i) |
2689 | for (int i = 0; i < nfd; ++i) |
2480 | { |
2690 | { |
… | |
… | |
2781 | =head3 Queueing |
2991 | =head3 Queueing |
2782 | |
2992 | |
2783 | C<ev_async> does not support queueing of data in any way. The reason |
2993 | C<ev_async> does not support queueing of data in any way. The reason |
2784 | is that the author does not know of a simple (or any) algorithm for a |
2994 | is that the author does not know of a simple (or any) algorithm for a |
2785 | multiple-writer-single-reader queue that works in all cases and doesn't |
2995 | multiple-writer-single-reader queue that works in all cases and doesn't |
2786 | need elaborate support such as pthreads. |
2996 | need elaborate support such as pthreads or unportable memory access |
|
|
2997 | semantics. |
2787 | |
2998 | |
2788 | That means that if you want to queue data, you have to provide your own |
2999 | That means that if you want to queue data, you have to provide your own |
2789 | queue. But at least I can tell you how to implement locking around your |
3000 | queue. But at least I can tell you how to implement locking around your |
2790 | queue: |
3001 | queue: |
2791 | |
3002 | |
… | |
… | |
2949 | /* doh, nothing entered */; |
3160 | /* doh, nothing entered */; |
2950 | } |
3161 | } |
2951 | |
3162 | |
2952 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3163 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
2953 | |
3164 | |
2954 | =item ev_feed_event (struct ev_loop *, watcher *, int revents) |
|
|
2955 | |
|
|
2956 | Feeds the given event set into the event loop, as if the specified event |
|
|
2957 | had happened for the specified watcher (which must be a pointer to an |
|
|
2958 | initialised but not necessarily started event watcher). |
|
|
2959 | |
|
|
2960 | =item ev_feed_fd_event (struct ev_loop *, int fd, int revents) |
3165 | =item ev_feed_fd_event (loop, int fd, int revents) |
2961 | |
3166 | |
2962 | Feed an event on the given fd, as if a file descriptor backend detected |
3167 | Feed an event on the given fd, as if a file descriptor backend detected |
2963 | the given events it. |
3168 | the given events it. |
2964 | |
3169 | |
2965 | =item ev_feed_signal_event (struct ev_loop *loop, int signum) |
3170 | =item ev_feed_signal_event (loop, int signum) |
2966 | |
3171 | |
2967 | Feed an event as if the given signal occurred (C<loop> must be the default |
3172 | Feed an event as if the given signal occurred (C<loop> must be the default |
2968 | loop!). |
3173 | loop!). |
2969 | |
3174 | |
2970 | =back |
3175 | =back |
… | |
… | |
3050 | |
3255 | |
3051 | =over 4 |
3256 | =over 4 |
3052 | |
3257 | |
3053 | =item ev::TYPE::TYPE () |
3258 | =item ev::TYPE::TYPE () |
3054 | |
3259 | |
3055 | =item ev::TYPE::TYPE (struct ev_loop *) |
3260 | =item ev::TYPE::TYPE (loop) |
3056 | |
3261 | |
3057 | =item ev::TYPE::~TYPE |
3262 | =item ev::TYPE::~TYPE |
3058 | |
3263 | |
3059 | The constructor (optionally) takes an event loop to associate the watcher |
3264 | The constructor (optionally) takes an event loop to associate the watcher |
3060 | with. If it is omitted, it will use C<EV_DEFAULT>. |
3265 | with. If it is omitted, it will use C<EV_DEFAULT>. |
… | |
… | |
3137 | Example: Use a plain function as callback. |
3342 | Example: Use a plain function as callback. |
3138 | |
3343 | |
3139 | static void io_cb (ev::io &w, int revents) { } |
3344 | static void io_cb (ev::io &w, int revents) { } |
3140 | iow.set <io_cb> (); |
3345 | iow.set <io_cb> (); |
3141 | |
3346 | |
3142 | =item w->set (struct ev_loop *) |
3347 | =item w->set (loop) |
3143 | |
3348 | |
3144 | Associates a different C<struct ev_loop> with this watcher. You can only |
3349 | Associates a different C<struct ev_loop> with this watcher. You can only |
3145 | do this when the watcher is inactive (and not pending either). |
3350 | do this when the watcher is inactive (and not pending either). |
3146 | |
3351 | |
3147 | =item w->set ([arguments]) |
3352 | =item w->set ([arguments]) |
… | |
… | |
3244 | =item Ocaml |
3449 | =item Ocaml |
3245 | |
3450 | |
3246 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
3451 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
3247 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
3452 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
3248 | |
3453 | |
|
|
3454 | =item Lua |
|
|
3455 | |
|
|
3456 | Brian Maher has written a partial interface to libev for lua (at the |
|
|
3457 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
|
|
3458 | L<http://github.com/brimworks/lua-ev>. |
|
|
3459 | |
3249 | =back |
3460 | =back |
3250 | |
3461 | |
3251 | |
3462 | |
3252 | =head1 MACRO MAGIC |
3463 | =head1 MACRO MAGIC |
3253 | |
3464 | |
… | |
… | |
3406 | libev.m4 |
3617 | libev.m4 |
3407 | |
3618 | |
3408 | =head2 PREPROCESSOR SYMBOLS/MACROS |
3619 | =head2 PREPROCESSOR SYMBOLS/MACROS |
3409 | |
3620 | |
3410 | Libev can be configured via a variety of preprocessor symbols you have to |
3621 | Libev can be configured via a variety of preprocessor symbols you have to |
3411 | define before including any of its files. The default in the absence of |
3622 | define before including (or compiling) any of its files. The default in |
3412 | autoconf is documented for every option. |
3623 | the absence of autoconf is documented for every option. |
|
|
3624 | |
|
|
3625 | Symbols marked with "(h)" do not change the ABI, and can have different |
|
|
3626 | values when compiling libev vs. including F<ev.h>, so it is permissible |
|
|
3627 | to redefine them before including F<ev.h> without breakign compatibility |
|
|
3628 | to a compiled library. All other symbols change the ABI, which means all |
|
|
3629 | users of libev and the libev code itself must be compiled with compatible |
|
|
3630 | settings. |
3413 | |
3631 | |
3414 | =over 4 |
3632 | =over 4 |
3415 | |
3633 | |
3416 | =item EV_STANDALONE |
3634 | =item EV_STANDALONE (h) |
3417 | |
3635 | |
3418 | Must always be C<1> if you do not use autoconf configuration, which |
3636 | Must always be C<1> if you do not use autoconf configuration, which |
3419 | keeps libev from including F<config.h>, and it also defines dummy |
3637 | keeps libev from including F<config.h>, and it also defines dummy |
3420 | implementations for some libevent functions (such as logging, which is not |
3638 | implementations for some libevent functions (such as logging, which is not |
3421 | supported). It will also not define any of the structs usually found in |
3639 | supported). It will also not define any of the structs usually found in |
3422 | F<event.h> that are not directly supported by the libev core alone. |
3640 | F<event.h> that are not directly supported by the libev core alone. |
3423 | |
3641 | |
3424 | In stanbdalone mode, libev will still try to automatically deduce the |
3642 | In standalone mode, libev will still try to automatically deduce the |
3425 | configuration, but has to be more conservative. |
3643 | configuration, but has to be more conservative. |
3426 | |
3644 | |
3427 | =item EV_USE_MONOTONIC |
3645 | =item EV_USE_MONOTONIC |
3428 | |
3646 | |
3429 | If defined to be C<1>, libev will try to detect the availability of the |
3647 | If defined to be C<1>, libev will try to detect the availability of the |
… | |
… | |
3494 | be used is the winsock select). This means that it will call |
3712 | be used is the winsock select). This means that it will call |
3495 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
3713 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
3496 | it is assumed that all these functions actually work on fds, even |
3714 | it is assumed that all these functions actually work on fds, even |
3497 | on win32. Should not be defined on non-win32 platforms. |
3715 | on win32. Should not be defined on non-win32 platforms. |
3498 | |
3716 | |
3499 | =item EV_FD_TO_WIN32_HANDLE |
3717 | =item EV_FD_TO_WIN32_HANDLE(fd) |
3500 | |
3718 | |
3501 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
3719 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
3502 | file descriptors to socket handles. When not defining this symbol (the |
3720 | file descriptors to socket handles. When not defining this symbol (the |
3503 | default), then libev will call C<_get_osfhandle>, which is usually |
3721 | default), then libev will call C<_get_osfhandle>, which is usually |
3504 | correct. In some cases, programs use their own file descriptor management, |
3722 | correct. In some cases, programs use their own file descriptor management, |
3505 | in which case they can provide this function to map fds to socket handles. |
3723 | in which case they can provide this function to map fds to socket handles. |
|
|
3724 | |
|
|
3725 | =item EV_WIN32_HANDLE_TO_FD(handle) |
|
|
3726 | |
|
|
3727 | If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors |
|
|
3728 | using the standard C<_open_osfhandle> function. For programs implementing |
|
|
3729 | their own fd to handle mapping, overwriting this function makes it easier |
|
|
3730 | to do so. This can be done by defining this macro to an appropriate value. |
|
|
3731 | |
|
|
3732 | =item EV_WIN32_CLOSE_FD(fd) |
|
|
3733 | |
|
|
3734 | If programs implement their own fd to handle mapping on win32, then this |
|
|
3735 | macro can be used to override the C<close> function, useful to unregister |
|
|
3736 | file descriptors again. Note that the replacement function has to close |
|
|
3737 | the underlying OS handle. |
3506 | |
3738 | |
3507 | =item EV_USE_POLL |
3739 | =item EV_USE_POLL |
3508 | |
3740 | |
3509 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
3741 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
3510 | backend. Otherwise it will be enabled on non-win32 platforms. It |
3742 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
3557 | as well as for signal and thread safety in C<ev_async> watchers. |
3789 | as well as for signal and thread safety in C<ev_async> watchers. |
3558 | |
3790 | |
3559 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
3791 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
3560 | (from F<signal.h>), which is usually good enough on most platforms. |
3792 | (from F<signal.h>), which is usually good enough on most platforms. |
3561 | |
3793 | |
3562 | =item EV_H |
3794 | =item EV_H (h) |
3563 | |
3795 | |
3564 | The name of the F<ev.h> header file used to include it. The default if |
3796 | The name of the F<ev.h> header file used to include it. The default if |
3565 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
3797 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
3566 | used to virtually rename the F<ev.h> header file in case of conflicts. |
3798 | used to virtually rename the F<ev.h> header file in case of conflicts. |
3567 | |
3799 | |
3568 | =item EV_CONFIG_H |
3800 | =item EV_CONFIG_H (h) |
3569 | |
3801 | |
3570 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
3802 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
3571 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
3803 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
3572 | C<EV_H>, above. |
3804 | C<EV_H>, above. |
3573 | |
3805 | |
3574 | =item EV_EVENT_H |
3806 | =item EV_EVENT_H (h) |
3575 | |
3807 | |
3576 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
3808 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
3577 | of how the F<event.h> header can be found, the default is C<"event.h">. |
3809 | of how the F<event.h> header can be found, the default is C<"event.h">. |
3578 | |
3810 | |
3579 | =item EV_PROTOTYPES |
3811 | =item EV_PROTOTYPES (h) |
3580 | |
3812 | |
3581 | If defined to be C<0>, then F<ev.h> will not define any function |
3813 | If defined to be C<0>, then F<ev.h> will not define any function |
3582 | prototypes, but still define all the structs and other symbols. This is |
3814 | prototypes, but still define all the structs and other symbols. This is |
3583 | occasionally useful if you want to provide your own wrapper functions |
3815 | occasionally useful if you want to provide your own wrapper functions |
3584 | around libev functions. |
3816 | around libev functions. |
… | |
… | |
3634 | =item EV_FORK_ENABLE |
3866 | =item EV_FORK_ENABLE |
3635 | |
3867 | |
3636 | If undefined or defined to be C<1>, then fork watchers are supported. If |
3868 | If undefined or defined to be C<1>, then fork watchers are supported. If |
3637 | defined to be C<0>, then they are not. |
3869 | defined to be C<0>, then they are not. |
3638 | |
3870 | |
|
|
3871 | =item EV_SIGNAL_ENABLE |
|
|
3872 | |
|
|
3873 | If undefined or defined to be C<1>, then signal watchers are supported. If |
|
|
3874 | defined to be C<0>, then they are not. |
|
|
3875 | |
3639 | =item EV_ASYNC_ENABLE |
3876 | =item EV_ASYNC_ENABLE |
3640 | |
3877 | |
3641 | If undefined or defined to be C<1>, then async watchers are supported. If |
3878 | If undefined or defined to be C<1>, then async watchers are supported. If |
3642 | defined to be C<0>, then they are not. |
3879 | defined to be C<0>, then they are not. |
3643 | |
3880 | |
|
|
3881 | =item EV_CHILD_ENABLE |
|
|
3882 | |
|
|
3883 | If undefined or defined to be C<1> (and C<_WIN32> is not defined), then |
|
|
3884 | child watchers are supported. If defined to be C<0>, then they are not. |
|
|
3885 | |
3644 | =item EV_MINIMAL |
3886 | =item EV_MINIMAL |
3645 | |
3887 | |
3646 | If you need to shave off some kilobytes of code at the expense of some |
3888 | If you need to shave off some kilobytes of code at the expense of some |
3647 | speed, define this symbol to C<1>. Currently this is used to override some |
3889 | speed (but with the full API), define this symbol to C<1>. Currently this |
3648 | inlining decisions, saves roughly 30% code size on amd64. It also selects a |
3890 | is used to override some inlining decisions, saves roughly 30% code size |
3649 | much smaller 2-heap for timer management over the default 4-heap. |
3891 | on amd64. It also selects a much smaller 2-heap for timer management over |
|
|
3892 | the default 4-heap. |
|
|
3893 | |
|
|
3894 | You can save even more by disabling watcher types you do not need |
|
|
3895 | and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert> |
|
|
3896 | (C<-DNDEBUG>) will usually reduce code size a lot. Disabling inotify, |
|
|
3897 | eventfd and signalfd will further help, and disabling backends one doesn't |
|
|
3898 | need (e.g. poll, epoll, kqueue, ports) will help further. |
|
|
3899 | |
|
|
3900 | Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to |
|
|
3901 | provide a bare-bones event library. See C<ev.h> for details on what parts |
|
|
3902 | of the API are still available, and do not complain if this subset changes |
|
|
3903 | over time. |
|
|
3904 | |
|
|
3905 | This example set of settings reduces the compiled size of libev from 24Kb |
|
|
3906 | to 8Kb on my GNU/Linux amd64 system (and leaves little in - there is also |
|
|
3907 | an effect on the amount of memory used). With an intelligent-enough linker |
|
|
3908 | further unused functions might be left out as well automatically. |
|
|
3909 | |
|
|
3910 | // tuning and API changes |
|
|
3911 | #define EV_MINIMAL 2 |
|
|
3912 | #define EV_MULTIPLICITY 0 |
|
|
3913 | #define EV_MINPRI 0 |
|
|
3914 | #define EV_MAXPRI 0 |
|
|
3915 | |
|
|
3916 | // OS-specific backends |
|
|
3917 | #define EV_USE_INOTIFY 0 |
|
|
3918 | #define EV_USE_EVENTFD 0 |
|
|
3919 | #define EV_USE_SIGNALFD 0 |
|
|
3920 | #define EV_USE_REALTIME 0 |
|
|
3921 | #define EV_USE_MONOTONIC 0 |
|
|
3922 | #define EV_USE_CLOCK_SYSCALL 0 |
|
|
3923 | |
|
|
3924 | // disable all backends except select |
|
|
3925 | #define EV_USE_POLL 0 |
|
|
3926 | #define EV_USE_PORT 0 |
|
|
3927 | #define EV_USE_KQUEUE 0 |
|
|
3928 | #define EV_USE_EPOLL 0 |
|
|
3929 | |
|
|
3930 | // disable all watcher types that cna be disabled |
|
|
3931 | #define EV_STAT_ENABLE 0 |
|
|
3932 | #define EV_PERIODIC_ENABLE 0 |
|
|
3933 | #define EV_IDLE_ENABLE 0 |
|
|
3934 | #define EV_FORK_ENABLE 0 |
|
|
3935 | #define EV_SIGNAL_ENABLE 0 |
|
|
3936 | #define EV_CHILD_ENABLE 0 |
|
|
3937 | #define EV_ASYNC_ENABLE 0 |
|
|
3938 | #define EV_EMBED_ENABLE 0 |
|
|
3939 | |
|
|
3940 | =item EV_AVOID_STDIO |
|
|
3941 | |
|
|
3942 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
|
|
3943 | functions (printf, scanf, perror etc.). This will increase the codesize |
|
|
3944 | somewhat, but if your program doesn't otherwise depend on stdio and your |
|
|
3945 | libc allows it, this avoids linking in the stdio library which is quite |
|
|
3946 | big. |
|
|
3947 | |
|
|
3948 | Note that error messages might become less precise when this option is |
|
|
3949 | enabled. |
|
|
3950 | |
|
|
3951 | =item EV_NSIG |
|
|
3952 | |
|
|
3953 | The highest supported signal number, +1 (or, the number of |
|
|
3954 | signals): Normally, libev tries to deduce the maximum number of signals |
|
|
3955 | automatically, but sometimes this fails, in which case it can be |
|
|
3956 | specified. Also, using a lower number than detected (C<32> should be |
|
|
3957 | good for about any system in existance) can save some memory, as libev |
|
|
3958 | statically allocates some 12-24 bytes per signal number. |
3650 | |
3959 | |
3651 | =item EV_PID_HASHSIZE |
3960 | =item EV_PID_HASHSIZE |
3652 | |
3961 | |
3653 | C<ev_child> watchers use a small hash table to distribute workload by |
3962 | C<ev_child> watchers use a small hash table to distribute workload by |
3654 | pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more |
3963 | pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more |
… | |
… | |
3840 | default loop and triggering an C<ev_async> watcher from the default loop |
4149 | default loop and triggering an C<ev_async> watcher from the default loop |
3841 | watcher callback into the event loop interested in the signal. |
4150 | watcher callback into the event loop interested in the signal. |
3842 | |
4151 | |
3843 | =back |
4152 | =back |
3844 | |
4153 | |
|
|
4154 | =head4 THREAD LOCKING EXAMPLE |
|
|
4155 | |
|
|
4156 | Here is a fictitious example of how to run an event loop in a different |
|
|
4157 | thread than where callbacks are being invoked and watchers are |
|
|
4158 | created/added/removed. |
|
|
4159 | |
|
|
4160 | For a real-world example, see the C<EV::Loop::Async> perl module, |
|
|
4161 | which uses exactly this technique (which is suited for many high-level |
|
|
4162 | languages). |
|
|
4163 | |
|
|
4164 | The example uses a pthread mutex to protect the loop data, a condition |
|
|
4165 | variable to wait for callback invocations, an async watcher to notify the |
|
|
4166 | event loop thread and an unspecified mechanism to wake up the main thread. |
|
|
4167 | |
|
|
4168 | First, you need to associate some data with the event loop: |
|
|
4169 | |
|
|
4170 | typedef struct { |
|
|
4171 | mutex_t lock; /* global loop lock */ |
|
|
4172 | ev_async async_w; |
|
|
4173 | thread_t tid; |
|
|
4174 | cond_t invoke_cv; |
|
|
4175 | } userdata; |
|
|
4176 | |
|
|
4177 | void prepare_loop (EV_P) |
|
|
4178 | { |
|
|
4179 | // for simplicity, we use a static userdata struct. |
|
|
4180 | static userdata u; |
|
|
4181 | |
|
|
4182 | ev_async_init (&u->async_w, async_cb); |
|
|
4183 | ev_async_start (EV_A_ &u->async_w); |
|
|
4184 | |
|
|
4185 | pthread_mutex_init (&u->lock, 0); |
|
|
4186 | pthread_cond_init (&u->invoke_cv, 0); |
|
|
4187 | |
|
|
4188 | // now associate this with the loop |
|
|
4189 | ev_set_userdata (EV_A_ u); |
|
|
4190 | ev_set_invoke_pending_cb (EV_A_ l_invoke); |
|
|
4191 | ev_set_loop_release_cb (EV_A_ l_release, l_acquire); |
|
|
4192 | |
|
|
4193 | // then create the thread running ev_loop |
|
|
4194 | pthread_create (&u->tid, 0, l_run, EV_A); |
|
|
4195 | } |
|
|
4196 | |
|
|
4197 | The callback for the C<ev_async> watcher does nothing: the watcher is used |
|
|
4198 | solely to wake up the event loop so it takes notice of any new watchers |
|
|
4199 | that might have been added: |
|
|
4200 | |
|
|
4201 | static void |
|
|
4202 | async_cb (EV_P_ ev_async *w, int revents) |
|
|
4203 | { |
|
|
4204 | // just used for the side effects |
|
|
4205 | } |
|
|
4206 | |
|
|
4207 | The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex |
|
|
4208 | protecting the loop data, respectively. |
|
|
4209 | |
|
|
4210 | static void |
|
|
4211 | l_release (EV_P) |
|
|
4212 | { |
|
|
4213 | userdata *u = ev_userdata (EV_A); |
|
|
4214 | pthread_mutex_unlock (&u->lock); |
|
|
4215 | } |
|
|
4216 | |
|
|
4217 | static void |
|
|
4218 | l_acquire (EV_P) |
|
|
4219 | { |
|
|
4220 | userdata *u = ev_userdata (EV_A); |
|
|
4221 | pthread_mutex_lock (&u->lock); |
|
|
4222 | } |
|
|
4223 | |
|
|
4224 | The event loop thread first acquires the mutex, and then jumps straight |
|
|
4225 | into C<ev_loop>: |
|
|
4226 | |
|
|
4227 | void * |
|
|
4228 | l_run (void *thr_arg) |
|
|
4229 | { |
|
|
4230 | struct ev_loop *loop = (struct ev_loop *)thr_arg; |
|
|
4231 | |
|
|
4232 | l_acquire (EV_A); |
|
|
4233 | pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0); |
|
|
4234 | ev_loop (EV_A_ 0); |
|
|
4235 | l_release (EV_A); |
|
|
4236 | |
|
|
4237 | return 0; |
|
|
4238 | } |
|
|
4239 | |
|
|
4240 | Instead of invoking all pending watchers, the C<l_invoke> callback will |
|
|
4241 | signal the main thread via some unspecified mechanism (signals? pipe |
|
|
4242 | writes? C<Async::Interrupt>?) and then waits until all pending watchers |
|
|
4243 | have been called (in a while loop because a) spurious wakeups are possible |
|
|
4244 | and b) skipping inter-thread-communication when there are no pending |
|
|
4245 | watchers is very beneficial): |
|
|
4246 | |
|
|
4247 | static void |
|
|
4248 | l_invoke (EV_P) |
|
|
4249 | { |
|
|
4250 | userdata *u = ev_userdata (EV_A); |
|
|
4251 | |
|
|
4252 | while (ev_pending_count (EV_A)) |
|
|
4253 | { |
|
|
4254 | wake_up_other_thread_in_some_magic_or_not_so_magic_way (); |
|
|
4255 | pthread_cond_wait (&u->invoke_cv, &u->lock); |
|
|
4256 | } |
|
|
4257 | } |
|
|
4258 | |
|
|
4259 | Now, whenever the main thread gets told to invoke pending watchers, it |
|
|
4260 | will grab the lock, call C<ev_invoke_pending> and then signal the loop |
|
|
4261 | thread to continue: |
|
|
4262 | |
|
|
4263 | static void |
|
|
4264 | real_invoke_pending (EV_P) |
|
|
4265 | { |
|
|
4266 | userdata *u = ev_userdata (EV_A); |
|
|
4267 | |
|
|
4268 | pthread_mutex_lock (&u->lock); |
|
|
4269 | ev_invoke_pending (EV_A); |
|
|
4270 | pthread_cond_signal (&u->invoke_cv); |
|
|
4271 | pthread_mutex_unlock (&u->lock); |
|
|
4272 | } |
|
|
4273 | |
|
|
4274 | Whenever you want to start/stop a watcher or do other modifications to an |
|
|
4275 | event loop, you will now have to lock: |
|
|
4276 | |
|
|
4277 | ev_timer timeout_watcher; |
|
|
4278 | userdata *u = ev_userdata (EV_A); |
|
|
4279 | |
|
|
4280 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
|
|
4281 | |
|
|
4282 | pthread_mutex_lock (&u->lock); |
|
|
4283 | ev_timer_start (EV_A_ &timeout_watcher); |
|
|
4284 | ev_async_send (EV_A_ &u->async_w); |
|
|
4285 | pthread_mutex_unlock (&u->lock); |
|
|
4286 | |
|
|
4287 | Note that sending the C<ev_async> watcher is required because otherwise |
|
|
4288 | an event loop currently blocking in the kernel will have no knowledge |
|
|
4289 | about the newly added timer. By waking up the loop it will pick up any new |
|
|
4290 | watchers in the next event loop iteration. |
|
|
4291 | |
3845 | =head3 COROUTINES |
4292 | =head3 COROUTINES |
3846 | |
4293 | |
3847 | Libev is very accommodating to coroutines ("cooperative threads"): |
4294 | Libev is very accommodating to coroutines ("cooperative threads"): |
3848 | libev fully supports nesting calls to its functions from different |
4295 | libev fully supports nesting calls to its functions from different |
3849 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
4296 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
3850 | different coroutines, and switch freely between both coroutines running the |
4297 | different coroutines, and switch freely between both coroutines running |
3851 | loop, as long as you don't confuse yourself). The only exception is that |
4298 | the loop, as long as you don't confuse yourself). The only exception is |
3852 | you must not do this from C<ev_periodic> reschedule callbacks. |
4299 | that you must not do this from C<ev_periodic> reschedule callbacks. |
3853 | |
4300 | |
3854 | Care has been taken to ensure that libev does not keep local state inside |
4301 | Care has been taken to ensure that libev does not keep local state inside |
3855 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
4302 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
3856 | they do not call any callbacks. |
4303 | they do not call any callbacks. |
3857 | |
4304 | |
… | |
… | |
3934 | way (note also that glib is the slowest event library known to man). |
4381 | way (note also that glib is the slowest event library known to man). |
3935 | |
4382 | |
3936 | There is no supported compilation method available on windows except |
4383 | There is no supported compilation method available on windows except |
3937 | embedding it into other applications. |
4384 | embedding it into other applications. |
3938 | |
4385 | |
|
|
4386 | Sensible signal handling is officially unsupported by Microsoft - libev |
|
|
4387 | tries its best, but under most conditions, signals will simply not work. |
|
|
4388 | |
3939 | Not a libev limitation but worth mentioning: windows apparently doesn't |
4389 | Not a libev limitation but worth mentioning: windows apparently doesn't |
3940 | accept large writes: instead of resulting in a partial write, windows will |
4390 | accept large writes: instead of resulting in a partial write, windows will |
3941 | either accept everything or return C<ENOBUFS> if the buffer is too large, |
4391 | either accept everything or return C<ENOBUFS> if the buffer is too large, |
3942 | so make sure you only write small amounts into your sockets (less than a |
4392 | so make sure you only write small amounts into your sockets (less than a |
3943 | megabyte seems safe, but this apparently depends on the amount of memory |
4393 | megabyte seems safe, but this apparently depends on the amount of memory |
… | |
… | |
3947 | the abysmal performance of winsockets, using a large number of sockets |
4397 | the abysmal performance of winsockets, using a large number of sockets |
3948 | is not recommended (and not reasonable). If your program needs to use |
4398 | is not recommended (and not reasonable). If your program needs to use |
3949 | more than a hundred or so sockets, then likely it needs to use a totally |
4399 | more than a hundred or so sockets, then likely it needs to use a totally |
3950 | different implementation for windows, as libev offers the POSIX readiness |
4400 | different implementation for windows, as libev offers the POSIX readiness |
3951 | notification model, which cannot be implemented efficiently on windows |
4401 | notification model, which cannot be implemented efficiently on windows |
3952 | (Microsoft monopoly games). |
4402 | (due to Microsoft monopoly games). |
3953 | |
4403 | |
3954 | A typical way to use libev under windows is to embed it (see the embedding |
4404 | A typical way to use libev under windows is to embed it (see the embedding |
3955 | section for details) and use the following F<evwrap.h> header file instead |
4405 | section for details) and use the following F<evwrap.h> header file instead |
3956 | of F<ev.h>: |
4406 | of F<ev.h>: |
3957 | |
4407 | |
… | |
… | |
3993 | |
4443 | |
3994 | Early versions of winsocket's select only supported waiting for a maximum |
4444 | Early versions of winsocket's select only supported waiting for a maximum |
3995 | of C<64> handles (probably owning to the fact that all windows kernels |
4445 | of C<64> handles (probably owning to the fact that all windows kernels |
3996 | can only wait for C<64> things at the same time internally; Microsoft |
4446 | can only wait for C<64> things at the same time internally; Microsoft |
3997 | recommends spawning a chain of threads and wait for 63 handles and the |
4447 | recommends spawning a chain of threads and wait for 63 handles and the |
3998 | previous thread in each. Great). |
4448 | previous thread in each. Sounds great!). |
3999 | |
4449 | |
4000 | Newer versions support more handles, but you need to define C<FD_SETSIZE> |
4450 | Newer versions support more handles, but you need to define C<FD_SETSIZE> |
4001 | to some high number (e.g. C<2048>) before compiling the winsocket select |
4451 | to some high number (e.g. C<2048>) before compiling the winsocket select |
4002 | call (which might be in libev or elsewhere, for example, perl does its own |
4452 | call (which might be in libev or elsewhere, for example, perl and many |
4003 | select emulation on windows). |
4453 | other interpreters do their own select emulation on windows). |
4004 | |
4454 | |
4005 | Another limit is the number of file descriptors in the Microsoft runtime |
4455 | Another limit is the number of file descriptors in the Microsoft runtime |
4006 | libraries, which by default is C<64> (there must be a hidden I<64> fetish |
4456 | libraries, which by default is C<64> (there must be a hidden I<64> |
4007 | or something like this inside Microsoft). You can increase this by calling |
4457 | fetish or something like this inside Microsoft). You can increase this |
4008 | C<_setmaxstdio>, which can increase this limit to C<2048> (another |
4458 | by calling C<_setmaxstdio>, which can increase this limit to C<2048> |
4009 | arbitrary limit), but is broken in many versions of the Microsoft runtime |
4459 | (another arbitrary limit), but is broken in many versions of the Microsoft |
4010 | libraries. |
|
|
4011 | |
|
|
4012 | This might get you to about C<512> or C<2048> sockets (depending on |
4460 | runtime libraries. This might get you to about C<512> or C<2048> sockets |
4013 | windows version and/or the phase of the moon). To get more, you need to |
4461 | (depending on windows version and/or the phase of the moon). To get more, |
4014 | wrap all I/O functions and provide your own fd management, but the cost of |
4462 | you need to wrap all I/O functions and provide your own fd management, but |
4015 | calling select (O(n²)) will likely make this unworkable. |
4463 | the cost of calling select (O(n²)) will likely make this unworkable. |
4016 | |
4464 | |
4017 | =back |
4465 | =back |
4018 | |
4466 | |
4019 | =head2 PORTABILITY REQUIREMENTS |
4467 | =head2 PORTABILITY REQUIREMENTS |
4020 | |
4468 | |
… | |
… | |
4063 | =item C<double> must hold a time value in seconds with enough accuracy |
4511 | =item C<double> must hold a time value in seconds with enough accuracy |
4064 | |
4512 | |
4065 | The type C<double> is used to represent timestamps. It is required to |
4513 | The type C<double> is used to represent timestamps. It is required to |
4066 | have at least 51 bits of mantissa (and 9 bits of exponent), which is good |
4514 | have at least 51 bits of mantissa (and 9 bits of exponent), which is good |
4067 | enough for at least into the year 4000. This requirement is fulfilled by |
4515 | enough for at least into the year 4000. This requirement is fulfilled by |
4068 | implementations implementing IEEE 754 (basically all existing ones). |
4516 | implementations implementing IEEE 754, which is basically all existing |
|
|
4517 | ones. With IEEE 754 doubles, you get microsecond accuracy until at least |
|
|
4518 | 2200. |
4069 | |
4519 | |
4070 | =back |
4520 | =back |
4071 | |
4521 | |
4072 | If you know of other additional requirements drop me a note. |
4522 | If you know of other additional requirements drop me a note. |
4073 | |
4523 | |