ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.pod
(Generate patch)

Comparing libev/ev.pod (file contents):
Revision 1.223 by root, Sun Dec 14 21:58:08 2008 UTC vs.
Revision 1.288 by root, Tue Mar 16 00:54:52 2010 UTC

62 62
63 // unloop was called, so exit 63 // unloop was called, so exit
64 return 0; 64 return 0;
65 } 65 }
66 66
67=head1 DESCRIPTION 67=head1 ABOUT THIS DOCUMENT
68
69This document documents the libev software package.
68 70
69The newest version of this document is also available as an html-formatted 71The newest version of this document is also available as an html-formatted
70web page you might find easier to navigate when reading it for the first 72web page you might find easier to navigate when reading it for the first
71time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. 73time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
74
75While this document tries to be as complete as possible in documenting
76libev, its usage and the rationale behind its design, it is not a tutorial
77on event-based programming, nor will it introduce event-based programming
78with libev.
79
80Familarity with event based programming techniques in general is assumed
81throughout this document.
82
83=head1 ABOUT LIBEV
72 84
73Libev is an event loop: you register interest in certain events (such as a 85Libev is an event loop: you register interest in certain events (such as a
74file descriptor being readable or a timeout occurring), and it will manage 86file descriptor being readable or a timeout occurring), and it will manage
75these event sources and provide your program with events. 87these event sources and provide your program with events.
76 88
86=head2 FEATURES 98=head2 FEATURES
87 99
88Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 100Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
89BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 101BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
90for file descriptor events (C<ev_io>), the Linux C<inotify> interface 102for file descriptor events (C<ev_io>), the Linux C<inotify> interface
91(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers 103(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
92with customised rescheduling (C<ev_periodic>), synchronous signals 104inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
93(C<ev_signal>), process status change events (C<ev_child>), and event 105timers (C<ev_timer>), absolute timers with customised rescheduling
94watchers dealing with the event loop mechanism itself (C<ev_idle>, 106(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
95C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as 107change events (C<ev_child>), and event watchers dealing with the event
96file watchers (C<ev_stat>) and even limited support for fork events 108loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
97(C<ev_fork>). 109C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even
110limited support for fork events (C<ev_fork>).
98 111
99It also is quite fast (see this 112It also is quite fast (see this
100L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent 113L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
101for example). 114for example).
102 115
105Libev is very configurable. In this manual the default (and most common) 118Libev is very configurable. In this manual the default (and most common)
106configuration will be described, which supports multiple event loops. For 119configuration will be described, which supports multiple event loops. For
107more info about various configuration options please have a look at 120more info about various configuration options please have a look at
108B<EMBED> section in this manual. If libev was configured without support 121B<EMBED> section in this manual. If libev was configured without support
109for multiple event loops, then all functions taking an initial argument of 122for multiple event loops, then all functions taking an initial argument of
110name C<loop> (which is always of type C<ev_loop *>) will not have 123name C<loop> (which is always of type C<struct ev_loop *>) will not have
111this argument. 124this argument.
112 125
113=head2 TIME REPRESENTATION 126=head2 TIME REPRESENTATION
114 127
115Libev represents time as a single floating point number, representing the 128Libev represents time as a single floating point number, representing
116(fractional) number of seconds since the (POSIX) epoch (somewhere near 129the (fractional) number of seconds since the (POSIX) epoch (somewhere
117the beginning of 1970, details are complicated, don't ask). This type is 130near the beginning of 1970, details are complicated, don't ask). This
118called C<ev_tstamp>, which is what you should use too. It usually aliases 131type is called C<ev_tstamp>, which is what you should use too. It usually
119to the C<double> type in C, and when you need to do any calculations on 132aliases to the C<double> type in C. When you need to do any calculations
120it, you should treat it as some floating point value. Unlike the name 133on it, you should treat it as some floating point value. Unlike the name
121component C<stamp> might indicate, it is also used for time differences 134component C<stamp> might indicate, it is also used for time differences
122throughout libev. 135throughout libev.
123 136
124=head1 ERROR HANDLING 137=head1 ERROR HANDLING
125 138
350flag. 363flag.
351 364
352This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> 365This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
353environment variable. 366environment variable.
354 367
368=item C<EVFLAG_NOINOTIFY>
369
370When this flag is specified, then libev will not attempt to use the
371I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and
372testing, this flag can be useful to conserve inotify file descriptors, as
373otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
374
375=item C<EVFLAG_SIGNALFD>
376
377When this flag is specified, then libev will attempt to use the
378I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API
379delivers signals synchronously, which makes it both faster and might make
380it possible to get the queued signal data. It can also simplify signal
381handling with threads, as long as you properly block signals in your
382threads that are not interested in handling them.
383
384Signalfd will not be used by default as this changes your signal mask, and
385there are a lot of shoddy libraries and programs (glib's threadpool for
386example) that can't properly initialise their signal masks.
387
355=item C<EVBACKEND_SELECT> (value 1, portable select backend) 388=item C<EVBACKEND_SELECT> (value 1, portable select backend)
356 389
357This is your standard select(2) backend. Not I<completely> standard, as 390This is your standard select(2) backend. Not I<completely> standard, as
358libev tries to roll its own fd_set with no limits on the number of fds, 391libev tries to roll its own fd_set with no limits on the number of fds,
359but if that fails, expect a fairly low limit on the number of fds when 392but if that fails, expect a fairly low limit on the number of fds when
382 415
383This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and 416This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
384C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. 417C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
385 418
386=item C<EVBACKEND_EPOLL> (value 4, Linux) 419=item C<EVBACKEND_EPOLL> (value 4, Linux)
420
421Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
422kernels).
387 423
388For few fds, this backend is a bit little slower than poll and select, 424For few fds, this backend is a bit little slower than poll and select,
389but it scales phenomenally better. While poll and select usually scale 425but it scales phenomenally better. While poll and select usually scale
390like O(total_fds) where n is the total number of fds (or the highest fd), 426like O(total_fds) where n is the total number of fds (or the highest fd),
391epoll scales either O(1) or O(active_fds). 427epoll scales either O(1) or O(active_fds).
506 542
507It is definitely not recommended to use this flag. 543It is definitely not recommended to use this flag.
508 544
509=back 545=back
510 546
511If one or more of these are or'ed into the flags value, then only these 547If one or more of the backend flags are or'ed into the flags value,
512backends will be tried (in the reverse order as listed here). If none are 548then only these backends will be tried (in the reverse order as listed
513specified, all backends in C<ev_recommended_backends ()> will be tried. 549here). If none are specified, all backends in C<ev_recommended_backends
550()> will be tried.
514 551
515Example: This is the most typical usage. 552Example: This is the most typical usage.
516 553
517 if (!ev_default_loop (0)) 554 if (!ev_default_loop (0))
518 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 555 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
561as signal and child watchers) would need to be stopped manually. 598as signal and child watchers) would need to be stopped manually.
562 599
563In general it is not advisable to call this function except in the 600In general it is not advisable to call this function except in the
564rare occasion where you really need to free e.g. the signal handling 601rare occasion where you really need to free e.g. the signal handling
565pipe fds. If you need dynamically allocated loops it is better to use 602pipe fds. If you need dynamically allocated loops it is better to use
566C<ev_loop_new> and C<ev_loop_destroy>). 603C<ev_loop_new> and C<ev_loop_destroy>.
567 604
568=item ev_loop_destroy (loop) 605=item ev_loop_destroy (loop)
569 606
570Like C<ev_default_destroy>, but destroys an event loop created by an 607Like C<ev_default_destroy>, but destroys an event loop created by an
571earlier call to C<ev_loop_new>. 608earlier call to C<ev_loop_new>.
609 646
610This value can sometimes be useful as a generation counter of sorts (it 647This value can sometimes be useful as a generation counter of sorts (it
611"ticks" the number of loop iterations), as it roughly corresponds with 648"ticks" the number of loop iterations), as it roughly corresponds with
612C<ev_prepare> and C<ev_check> calls. 649C<ev_prepare> and C<ev_check> calls.
613 650
651=item unsigned int ev_loop_depth (loop)
652
653Returns the number of times C<ev_loop> was entered minus the number of
654times C<ev_loop> was exited, in other words, the recursion depth.
655
656Outside C<ev_loop>, this number is zero. In a callback, this number is
657C<1>, unless C<ev_loop> was invoked recursively (or from another thread),
658in which case it is higher.
659
660Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread
661etc.), doesn't count as exit.
662
614=item unsigned int ev_backend (loop) 663=item unsigned int ev_backend (loop)
615 664
616Returns one of the C<EVBACKEND_*> flags indicating the event backend in 665Returns one of the C<EVBACKEND_*> flags indicating the event backend in
617use. 666use.
618 667
632 681
633This function is rarely useful, but when some event callback runs for a 682This function is rarely useful, but when some event callback runs for a
634very long time without entering the event loop, updating libev's idea of 683very long time without entering the event loop, updating libev's idea of
635the current time is a good idea. 684the current time is a good idea.
636 685
637See also "The special problem of time updates" in the C<ev_timer> section. 686See also L<The special problem of time updates> in the C<ev_timer> section.
687
688=item ev_suspend (loop)
689
690=item ev_resume (loop)
691
692These two functions suspend and resume a loop, for use when the loop is
693not used for a while and timeouts should not be processed.
694
695A typical use case would be an interactive program such as a game: When
696the user presses C<^Z> to suspend the game and resumes it an hour later it
697would be best to handle timeouts as if no time had actually passed while
698the program was suspended. This can be achieved by calling C<ev_suspend>
699in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
700C<ev_resume> directly afterwards to resume timer processing.
701
702Effectively, all C<ev_timer> watchers will be delayed by the time spend
703between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
704will be rescheduled (that is, they will lose any events that would have
705occured while suspended).
706
707After calling C<ev_suspend> you B<must not> call I<any> function on the
708given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
709without a previous call to C<ev_suspend>.
710
711Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
712event loop time (see C<ev_now_update>).
638 713
639=item ev_loop (loop, int flags) 714=item ev_loop (loop, int flags)
640 715
641Finally, this is it, the event handler. This function usually is called 716Finally, this is it, the event handler. This function usually is called
642after you initialised all your watchers and you want to start handling 717after you have initialised all your watchers and you want to start
643events. 718handling events.
644 719
645If the flags argument is specified as C<0>, it will not return until 720If the flags argument is specified as C<0>, it will not return until
646either no event watchers are active anymore or C<ev_unloop> was called. 721either no event watchers are active anymore or C<ev_unloop> was called.
647 722
648Please note that an explicit C<ev_unloop> is usually better than 723Please note that an explicit C<ev_unloop> is usually better than
722 797
723Ref/unref can be used to add or remove a reference count on the event 798Ref/unref can be used to add or remove a reference count on the event
724loop: Every watcher keeps one reference, and as long as the reference 799loop: Every watcher keeps one reference, and as long as the reference
725count is nonzero, C<ev_loop> will not return on its own. 800count is nonzero, C<ev_loop> will not return on its own.
726 801
727If you have a watcher you never unregister that should not keep C<ev_loop> 802This is useful when you have a watcher that you never intend to
728from returning, call ev_unref() after starting, and ev_ref() before 803unregister, but that nevertheless should not keep C<ev_loop> from
804returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
729stopping it. 805before stopping it.
730 806
731As an example, libev itself uses this for its internal signal pipe: It is 807As an example, libev itself uses this for its internal signal pipe: It
732not visible to the libev user and should not keep C<ev_loop> from exiting 808is not visible to the libev user and should not keep C<ev_loop> from
733if no event watchers registered by it are active. It is also an excellent 809exiting if no event watchers registered by it are active. It is also an
734way to do this for generic recurring timers or from within third-party 810excellent way to do this for generic recurring timers or from within
735libraries. Just remember to I<unref after start> and I<ref before stop> 811third-party libraries. Just remember to I<unref after start> and I<ref
736(but only if the watcher wasn't active before, or was active before, 812before stop> (but only if the watcher wasn't active before, or was active
737respectively). 813before, respectively. Note also that libev might stop watchers itself
814(e.g. non-repeating timers) in which case you have to C<ev_ref>
815in the callback).
738 816
739Example: Create a signal watcher, but keep it from keeping C<ev_loop> 817Example: Create a signal watcher, but keep it from keeping C<ev_loop>
740running when nothing else is active. 818running when nothing else is active.
741 819
742 ev_signal exitsig; 820 ev_signal exitsig;
771 849
772By setting a higher I<io collect interval> you allow libev to spend more 850By setting a higher I<io collect interval> you allow libev to spend more
773time collecting I/O events, so you can handle more events per iteration, 851time collecting I/O events, so you can handle more events per iteration,
774at the cost of increasing latency. Timeouts (both C<ev_periodic> and 852at the cost of increasing latency. Timeouts (both C<ev_periodic> and
775C<ev_timer>) will be not affected. Setting this to a non-null value will 853C<ev_timer>) will be not affected. Setting this to a non-null value will
776introduce an additional C<ev_sleep ()> call into most loop iterations. 854introduce an additional C<ev_sleep ()> call into most loop iterations. The
855sleep time ensures that libev will not poll for I/O events more often then
856once per this interval, on average.
777 857
778Likewise, by setting a higher I<timeout collect interval> you allow libev 858Likewise, by setting a higher I<timeout collect interval> you allow libev
779to spend more time collecting timeouts, at the expense of increased 859to spend more time collecting timeouts, at the expense of increased
780latency/jitter/inexactness (the watcher callback will be called 860latency/jitter/inexactness (the watcher callback will be called
781later). C<ev_io> watchers will not be affected. Setting this to a non-null 861later). C<ev_io> watchers will not be affected. Setting this to a non-null
783 863
784Many (busy) programs can usually benefit by setting the I/O collect 864Many (busy) programs can usually benefit by setting the I/O collect
785interval to a value near C<0.1> or so, which is often enough for 865interval to a value near C<0.1> or so, which is often enough for
786interactive servers (of course not for games), likewise for timeouts. It 866interactive servers (of course not for games), likewise for timeouts. It
787usually doesn't make much sense to set it to a lower value than C<0.01>, 867usually doesn't make much sense to set it to a lower value than C<0.01>,
788as this approaches the timing granularity of most systems. 868as this approaches the timing granularity of most systems. Note that if
869you do transactions with the outside world and you can't increase the
870parallelity, then this setting will limit your transaction rate (if you
871need to poll once per transaction and the I/O collect interval is 0.01,
872then you can't do more than 100 transations per second).
789 873
790Setting the I<timeout collect interval> can improve the opportunity for 874Setting the I<timeout collect interval> can improve the opportunity for
791saving power, as the program will "bundle" timer callback invocations that 875saving power, as the program will "bundle" timer callback invocations that
792are "near" in time together, by delaying some, thus reducing the number of 876are "near" in time together, by delaying some, thus reducing the number of
793times the process sleeps and wakes up again. Another useful technique to 877times the process sleeps and wakes up again. Another useful technique to
794reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure 878reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
795they fire on, say, one-second boundaries only. 879they fire on, say, one-second boundaries only.
880
881Example: we only need 0.1s timeout granularity, and we wish not to poll
882more 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
889This call will simply invoke all pending watchers while resetting their
890pending state. Normally, C<ev_loop> does this automatically when required,
891but when overriding the invoke callback this call comes handy.
892
893=item int ev_pending_count (loop)
894
895Returns the number of pending watchers - zero indicates that no watchers
896are pending.
897
898=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
899
900This overrides the invoke pending functionality of the loop: Instead of
901invoking all pending watchers when there are any, C<ev_loop> will call
902this callback instead. This is useful, for example, when you want to
903invoke the actual watchers inside another context (another thread etc.).
904
905If you want to reset the callback, use C<ev_invoke_pending> as new
906callback.
907
908=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
909
910Sometimes you want to share the same loop between multiple threads. This
911can be done relatively simply by putting mutex_lock/unlock calls around
912each call to a libev function.
913
914However, C<ev_loop> can run an indefinite time, so it is not feasible to
915wait for it to return. One way around this is to wake up the loop via
916C<ev_unloop> and C<av_async_send>, another way is to set these I<release>
917and I<acquire> callbacks on the loop.
918
919When set, then C<release> will be called just before the thread is
920suspended waiting for new events, and C<acquire> is called just
921afterwards.
922
923Ideally, C<release> will just call your mutex_unlock function, and
924C<acquire> will just call the mutex_lock function again.
925
926While event loop modifications are allowed between invocations of
927C<release> and C<acquire> (that's their only purpose after all), no
928modifications done will affect the event loop, i.e. adding watchers will
929have no effect on the set of file descriptors being watched, or the time
930waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it
931to take note of any changes you made.
932
933In theory, threads executing C<ev_loop> will be async-cancel safe between
934invocations of C<release> and C<acquire>.
935
936See also the locking example in the C<THREADS> section later in this
937document.
938
939=item ev_set_userdata (loop, void *data)
940
941=item ev_userdata (loop)
942
943Set and retrieve a single C<void *> associated with a loop. When
944C<ev_set_userdata> has never been called, then C<ev_userdata> returns
945C<0.>
946
947These two functions can be used to associate arbitrary data with a loop,
948and are intended solely for the C<invoke_pending_cb>, C<release> and
949C<acquire> callbacks described above, but of course can be (ab-)used for
950any other purpose as well.
796 951
797=item ev_loop_verify (loop) 952=item ev_loop_verify (loop)
798 953
799This function only does something when C<EV_VERIFY> support has been 954This function only does something when C<EV_VERIFY> support has been
800compiled in, which is the default for non-minimal builds. It tries to go 955compiled in, which is the default for non-minimal builds. It tries to go
926 1081
927=item C<EV_ASYNC> 1082=item C<EV_ASYNC>
928 1083
929The given async watcher has been asynchronously notified (see C<ev_async>). 1084The given async watcher has been asynchronously notified (see C<ev_async>).
930 1085
1086=item C<EV_CUSTOM>
1087
1088Not ever sent (or otherwise used) by libev itself, but can be freely used
1089by libev users to signal watchers (e.g. via C<ev_feed_event>).
1090
931=item C<EV_ERROR> 1091=item C<EV_ERROR>
932 1092
933An unspecified error has occurred, the watcher has been stopped. This might 1093An unspecified error has occurred, the watcher has been stopped. This might
934happen because the watcher could not be properly started because libev 1094happen because the watcher could not be properly started because libev
935ran out of memory, a file descriptor was found to be closed or any other 1095ran out of memory, a file descriptor was found to be closed or any other
972 1132
973 ev_io w; 1133 ev_io w;
974 ev_init (&w, my_cb); 1134 ev_init (&w, my_cb);
975 ev_io_set (&w, STDIN_FILENO, EV_READ); 1135 ev_io_set (&w, STDIN_FILENO, EV_READ);
976 1136
977=item C<ev_TYPE_set> (ev_TYPE *, [args]) 1137=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
978 1138
979This macro initialises the type-specific parts of a watcher. You need to 1139This macro initialises the type-specific parts of a watcher. You need to
980call C<ev_init> at least once before you call this macro, but you can 1140call C<ev_init> at least once before you call this macro, but you can
981call C<ev_TYPE_set> any number of times. You must not, however, call this 1141call C<ev_TYPE_set> any number of times. You must not, however, call this
982macro on a watcher that is active (it can be pending, however, which is a 1142macro on a watcher that is active (it can be pending, however, which is a
995 1155
996Example: Initialise and set an C<ev_io> watcher in one step. 1156Example: Initialise and set an C<ev_io> watcher in one step.
997 1157
998 ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); 1158 ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
999 1159
1000=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) 1160=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1001 1161
1002Starts (activates) the given watcher. Only active watchers will receive 1162Starts (activates) the given watcher. Only active watchers will receive
1003events. If the watcher is already active nothing will happen. 1163events. If the watcher is already active nothing will happen.
1004 1164
1005Example: Start the C<ev_io> watcher that is being abused as example in this 1165Example: Start the C<ev_io> watcher that is being abused as example in this
1006whole section. 1166whole section.
1007 1167
1008 ev_io_start (EV_DEFAULT_UC, &w); 1168 ev_io_start (EV_DEFAULT_UC, &w);
1009 1169
1010=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) 1170=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1011 1171
1012Stops the given watcher if active, and clears the pending status (whether 1172Stops the given watcher if active, and clears the pending status (whether
1013the watcher was active or not). 1173the watcher was active or not).
1014 1174
1015It is possible that stopped watchers are pending - for example, 1175It is possible that stopped watchers are pending - for example,
1040=item ev_cb_set (ev_TYPE *watcher, callback) 1200=item ev_cb_set (ev_TYPE *watcher, callback)
1041 1201
1042Change the callback. You can change the callback at virtually any time 1202Change the callback. You can change the callback at virtually any time
1043(modulo threads). 1203(modulo threads).
1044 1204
1045=item ev_set_priority (ev_TYPE *watcher, priority) 1205=item ev_set_priority (ev_TYPE *watcher, int priority)
1046 1206
1047=item int ev_priority (ev_TYPE *watcher) 1207=item int ev_priority (ev_TYPE *watcher)
1048 1208
1049Set and query the priority of the watcher. The priority is a small 1209Set and query the priority of the watcher. The priority is a small
1050integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> 1210integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1051(default: C<-2>). Pending watchers with higher priority will be invoked 1211(default: C<-2>). Pending watchers with higher priority will be invoked
1052before watchers with lower priority, but priority will not keep watchers 1212before watchers with lower priority, but priority will not keep watchers
1053from being executed (except for C<ev_idle> watchers). 1213from being executed (except for C<ev_idle> watchers).
1054 1214
1055This means that priorities are I<only> used for ordering callback
1056invocation after new events have been received. This is useful, for
1057example, to reduce latency after idling, or more often, to bind two
1058watchers on the same event and make sure one is called first.
1059
1060If you need to suppress invocation when higher priority events are pending 1215If you need to suppress invocation when higher priority events are pending
1061you need to look at C<ev_idle> watchers, which provide this functionality. 1216you need to look at C<ev_idle> watchers, which provide this functionality.
1062 1217
1063You I<must not> change the priority of a watcher as long as it is active or 1218You I<must not> change the priority of a watcher as long as it is active or
1064pending. 1219pending.
1065
1066The default priority used by watchers when no priority has been set is
1067always C<0>, which is supposed to not be too high and not be too low :).
1068 1220
1069Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is 1221Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
1070fine, as long as you do not mind that the priority value you query might 1222fine, as long as you do not mind that the priority value you query might
1071or might not have been clamped to the valid range. 1223or might not have been clamped to the valid range.
1224
1225The default priority used by watchers when no priority has been set is
1226always C<0>, which is supposed to not be too high and not be too low :).
1227
1228See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1229priorities.
1072 1230
1073=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1231=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1074 1232
1075Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1233Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1076C<loop> nor C<revents> need to be valid as long as the watcher callback 1234C<loop> nor C<revents> need to be valid as long as the watcher callback
1083returns its C<revents> bitset (as if its callback was invoked). If the 1241returns its C<revents> bitset (as if its callback was invoked). If the
1084watcher isn't pending it does nothing and returns C<0>. 1242watcher isn't pending it does nothing and returns C<0>.
1085 1243
1086Sometimes it can be useful to "poll" a watcher instead of waiting for its 1244Sometimes it can be useful to "poll" a watcher instead of waiting for its
1087callback to be invoked, which can be accomplished with this function. 1245callback to be invoked, which can be accomplished with this function.
1246
1247=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
1248
1249Feeds the given event set into the event loop, as if the specified event
1250had happened for the specified watcher (which must be a pointer to an
1251initialised but not necessarily started event watcher). Obviously you must
1252not free the watcher as long as it has pending events.
1253
1254Stopping the watcher, letting libev invoke it, or calling
1255C<ev_clear_pending> will clear the pending event, even if the watcher was
1256not started in the first place.
1257
1258See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1259functions that do not need a watcher.
1088 1260
1089=back 1261=back
1090 1262
1091 1263
1092=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER 1264=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
1141 #include <stddef.h> 1313 #include <stddef.h>
1142 1314
1143 static void 1315 static void
1144 t1_cb (EV_P_ ev_timer *w, int revents) 1316 t1_cb (EV_P_ ev_timer *w, int revents)
1145 { 1317 {
1146 struct my_biggy big = (struct my_biggy * 1318 struct my_biggy big = (struct my_biggy *)
1147 (((char *)w) - offsetof (struct my_biggy, t1)); 1319 (((char *)w) - offsetof (struct my_biggy, t1));
1148 } 1320 }
1149 1321
1150 static void 1322 static void
1151 t2_cb (EV_P_ ev_timer *w, int revents) 1323 t2_cb (EV_P_ ev_timer *w, int revents)
1152 { 1324 {
1153 struct my_biggy big = (struct my_biggy * 1325 struct my_biggy big = (struct my_biggy *)
1154 (((char *)w) - offsetof (struct my_biggy, t2)); 1326 (((char *)w) - offsetof (struct my_biggy, t2));
1155 } 1327 }
1328
1329=head2 WATCHER PRIORITY MODELS
1330
1331Many event loops support I<watcher priorities>, which are usually small
1332integers that influence the ordering of event callback invocation
1333between watchers in some way, all else being equal.
1334
1335In libev, Watcher priorities can be set using C<ev_set_priority>. See its
1336description for the more technical details such as the actual priority
1337range.
1338
1339There are two common ways how these these priorities are being interpreted
1340by event loops:
1341
1342In the more common lock-out model, higher priorities "lock out" invocation
1343of lower priority watchers, which means as long as higher priority
1344watchers receive events, lower priority watchers are not being invoked.
1345
1346The less common only-for-ordering model uses priorities solely to order
1347callback invocation within a single event loop iteration: Higher priority
1348watchers are invoked before lower priority ones, but they all get invoked
1349before polling for new events.
1350
1351Libev uses the second (only-for-ordering) model for all its watchers
1352except for idle watchers (which use the lock-out model).
1353
1354The rationale behind this is that implementing the lock-out model for
1355watchers is not well supported by most kernel interfaces, and most event
1356libraries will just poll for the same events again and again as long as
1357their callbacks have not been executed, which is very inefficient in the
1358common case of one high-priority watcher locking out a mass of lower
1359priority ones.
1360
1361Static (ordering) priorities are most useful when you have two or more
1362watchers handling the same resource: a typical usage example is having an
1363C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
1364timeouts. Under load, data might be received while the program handles
1365other jobs, but since timers normally get invoked first, the timeout
1366handler will be executed before checking for data. In that case, giving
1367the timer a lower priority than the I/O watcher ensures that I/O will be
1368handled first even under adverse conditions (which is usually, but not
1369always, what you want).
1370
1371Since idle watchers use the "lock-out" model, meaning that idle watchers
1372will only be executed when no same or higher priority watchers have
1373received events, they can be used to implement the "lock-out" model when
1374required.
1375
1376For example, to emulate how many other event libraries handle priorities,
1377you can associate an C<ev_idle> watcher to each such watcher, and in
1378the normal watcher callback, you just start the idle watcher. The real
1379processing is done in the idle watcher callback. This causes libev to
1380continously poll and process kernel event data for the watcher, but when
1381the lock-out case is known to be rare (which in turn is rare :), this is
1382workable.
1383
1384Usually, however, the lock-out model implemented that way will perform
1385miserably under the type of load it was designed to handle. In that case,
1386it might be preferable to stop the real watcher before starting the
1387idle watcher, so the kernel will not have to process the event in case
1388the actual processing will be delayed for considerable time.
1389
1390Here is an example of an I/O watcher that should run at a strictly lower
1391priority than the default, and which should only process data when no
1392other events are pending:
1393
1394 ev_idle idle; // actual processing watcher
1395 ev_io io; // actual event watcher
1396
1397 static void
1398 io_cb (EV_P_ ev_io *w, int revents)
1399 {
1400 // stop the I/O watcher, we received the event, but
1401 // are not yet ready to handle it.
1402 ev_io_stop (EV_A_ w);
1403
1404 // start the idle watcher to ahndle the actual event.
1405 // it will not be executed as long as other watchers
1406 // with the default priority are receiving events.
1407 ev_idle_start (EV_A_ &idle);
1408 }
1409
1410 static void
1411 idle_cb (EV_P_ ev_idle *w, int revents)
1412 {
1413 // actual processing
1414 read (STDIN_FILENO, ...);
1415
1416 // have to start the I/O watcher again, as
1417 // we have handled the event
1418 ev_io_start (EV_P_ &io);
1419 }
1420
1421 // initialisation
1422 ev_idle_init (&idle, idle_cb);
1423 ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
1424 ev_io_start (EV_DEFAULT_ &io);
1425
1426In the "real" world, it might also be beneficial to start a timer, so that
1427low-priority connections can not be locked out forever under load. This
1428enables your program to keep a lower latency for important connections
1429during short periods of high load, while not completely locking out less
1430important ones.
1156 1431
1157 1432
1158=head1 WATCHER TYPES 1433=head1 WATCHER TYPES
1159 1434
1160This section describes each watcher in detail, but will not repeat 1435This section describes each watcher in detail, but will not repeat
1186descriptors to non-blocking mode is also usually a good idea (but not 1461descriptors to non-blocking mode is also usually a good idea (but not
1187required if you know what you are doing). 1462required if you know what you are doing).
1188 1463
1189If you cannot use non-blocking mode, then force the use of a 1464If you cannot use non-blocking mode, then force the use of a
1190known-to-be-good backend (at the time of this writing, this includes only 1465known-to-be-good backend (at the time of this writing, this includes only
1191C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). 1466C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1467descriptors for which non-blocking operation makes no sense (such as
1468files) - libev doesn't guarentee any specific behaviour in that case.
1192 1469
1193Another thing you have to watch out for is that it is quite easy to 1470Another thing you have to watch out for is that it is quite easy to
1194receive "spurious" readiness notifications, that is your callback might 1471receive "spurious" readiness notifications, that is your callback might
1195be called with C<EV_READ> but a subsequent C<read>(2) will actually block 1472be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1196because there is no data. Not only are some backends known to create a 1473because there is no data. Not only are some backends known to create a
1261 1538
1262So when you encounter spurious, unexplained daemon exits, make sure you 1539So when you encounter spurious, unexplained daemon exits, make sure you
1263ignore SIGPIPE (and maybe make sure you log the exit status of your daemon 1540ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1264somewhere, as that would have given you a big clue). 1541somewhere, as that would have given you a big clue).
1265 1542
1543=head3 The special problem of accept()ing when you can't
1544
1545Many implementations of the POSIX C<accept> function (for example,
1546found in port-2004 Linux) have the peculiar behaviour of not removing a
1547connection from the pending queue in all error cases.
1548
1549For example, larger servers often run out of file descriptors (because
1550of resource limits), causing C<accept> to fail with C<ENFILE> but not
1551rejecting the connection, leading to libev signalling readiness on
1552the next iteration again (the connection still exists after all), and
1553typically causing the program to loop at 100% CPU usage.
1554
1555Unfortunately, the set of errors that cause this issue differs between
1556operating systems, there is usually little the app can do to remedy the
1557situation, and no known thread-safe method of removing the connection to
1558cope with overload is known (to me).
1559
1560One of the easiest ways to handle this situation is to just ignore it
1561- when the program encounters an overload, it will just loop until the
1562situation is over. While this is a form of busy waiting, no OS offers an
1563event-based way to handle this situation, so it's the best one can do.
1564
1565A better way to handle the situation is to log any errors other than
1566C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such
1567messages, and continue as usual, which at least gives the user an idea of
1568what could be wrong ("raise the ulimit!"). For extra points one could stop
1569the C<ev_io> watcher on the listening fd "for a while", which reduces CPU
1570usage.
1571
1572If your program is single-threaded, then you could also keep a dummy file
1573descriptor for overload situations (e.g. by opening F</dev/null>), and
1574when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>,
1575close that fd, and create a new dummy fd. This will gracefully refuse
1576clients under typical overload conditions.
1577
1578The last way to handle it is to simply log the error and C<exit>, as
1579is often done with C<malloc> failures, but this results in an easy
1580opportunity for a DoS attack.
1266 1581
1267=head3 Watcher-Specific Functions 1582=head3 Watcher-Specific Functions
1268 1583
1269=over 4 1584=over 4
1270 1585
1317year, it will still time out after (roughly) one hour. "Roughly" because 1632year, it will still time out after (roughly) one hour. "Roughly" because
1318detecting time jumps is hard, and some inaccuracies are unavoidable (the 1633detecting time jumps is hard, and some inaccuracies are unavoidable (the
1319monotonic clock option helps a lot here). 1634monotonic clock option helps a lot here).
1320 1635
1321The callback is guaranteed to be invoked only I<after> its timeout has 1636The callback is guaranteed to be invoked only I<after> its timeout has
1322passed, but if multiple timers become ready during the same loop iteration 1637passed (not I<at>, so on systems with very low-resolution clocks this
1323then order of execution is undefined. 1638might introduce a small delay). If multiple timers become ready during the
1639same loop iteration then the ones with earlier time-out values are invoked
1640before ones of the same priority with later time-out values (but this is
1641no longer true when a callback calls C<ev_loop> recursively).
1324 1642
1325=head3 Be smart about timeouts 1643=head3 Be smart about timeouts
1326 1644
1327Many real-world problems involve some kind of timeout, usually for error 1645Many real-world problems involve some kind of timeout, usually for error
1328recovery. A typical example is an HTTP request - if the other side hangs, 1646recovery. A typical example is an HTTP request - if the other side hangs,
1372C<after> argument to C<ev_timer_set>, and only ever use the C<repeat> 1690C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1373member and C<ev_timer_again>. 1691member and C<ev_timer_again>.
1374 1692
1375At start: 1693At start:
1376 1694
1377 ev_timer_init (timer, callback); 1695 ev_init (timer, callback);
1378 timer->repeat = 60.; 1696 timer->repeat = 60.;
1379 ev_timer_again (loop, timer); 1697 ev_timer_again (loop, timer);
1380 1698
1381Each time there is some activity: 1699Each time there is some activity:
1382 1700
1444 1762
1445To start the timer, simply initialise the watcher and set C<last_activity> 1763To start the timer, simply initialise the watcher and set C<last_activity>
1446to the current time (meaning we just have some activity :), then call the 1764to the current time (meaning we just have some activity :), then call the
1447callback, which will "do the right thing" and start the timer: 1765callback, which will "do the right thing" and start the timer:
1448 1766
1449 ev_timer_init (timer, callback); 1767 ev_init (timer, callback);
1450 last_activity = ev_now (loop); 1768 last_activity = ev_now (loop);
1451 callback (loop, timer, EV_TIMEOUT); 1769 callback (loop, timer, EV_TIMEOUT);
1452 1770
1453And when there is some activity, simply store the current time in 1771And when there is some activity, simply store the current time in
1454C<last_activity>, no libev calls at all: 1772C<last_activity>, no libev calls at all:
1515 1833
1516If the event loop is suspended for a long time, you can also force an 1834If the event loop is suspended for a long time, you can also force an
1517update of the time returned by C<ev_now ()> by calling C<ev_now_update 1835update of the time returned by C<ev_now ()> by calling C<ev_now_update
1518()>. 1836()>.
1519 1837
1838=head3 The special problems of suspended animation
1839
1840When you leave the server world it is quite customary to hit machines that
1841can suspend/hibernate - what happens to the clocks during such a suspend?
1842
1843Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
1844all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
1845to run until the system is suspended, but they will not advance while the
1846system is suspended. That means, on resume, it will be as if the program
1847was frozen for a few seconds, but the suspend time will not be counted
1848towards C<ev_timer> when a monotonic clock source is used. The real time
1849clock advanced as expected, but if it is used as sole clocksource, then a
1850long suspend would be detected as a time jump by libev, and timers would
1851be adjusted accordingly.
1852
1853I would not be surprised to see different behaviour in different between
1854operating systems, OS versions or even different hardware.
1855
1856The other form of suspend (job control, or sending a SIGSTOP) will see a
1857time jump in the monotonic clocks and the realtime clock. If the program
1858is suspended for a very long time, and monotonic clock sources are in use,
1859then you can expect C<ev_timer>s to expire as the full suspension time
1860will be counted towards the timers. When no monotonic clock source is in
1861use, then libev will again assume a timejump and adjust accordingly.
1862
1863It might be beneficial for this latter case to call C<ev_suspend>
1864and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
1865deterministic behaviour in this case (you can do nothing against
1866C<SIGSTOP>).
1867
1520=head3 Watcher-Specific Functions and Data Members 1868=head3 Watcher-Specific Functions and Data Members
1521 1869
1522=over 4 1870=over 4
1523 1871
1524=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1872=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1547If the timer is started but non-repeating, stop it (as if it timed out). 1895If the timer is started but non-repeating, stop it (as if it timed out).
1548 1896
1549If the timer is repeating, either start it if necessary (with the 1897If the timer is repeating, either start it if necessary (with the
1550C<repeat> value), or reset the running timer to the C<repeat> value. 1898C<repeat> value), or reset the running timer to the C<repeat> value.
1551 1899
1552This sounds a bit complicated, see "Be smart about timeouts", above, for a 1900This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1553usage example. 1901usage example.
1902
1903=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
1904
1905Returns the remaining time until a timer fires. If the timer is active,
1906then this time is relative to the current event loop time, otherwise it's
1907the timeout value currently configured.
1908
1909That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1910C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
1911will return C<4>. When the timer expires and is restarted, it will return
1912roughly C<7> (likely slightly less as callback invocation takes some time,
1913too), and so on.
1554 1914
1555=item ev_tstamp repeat [read-write] 1915=item ev_tstamp repeat [read-write]
1556 1916
1557The current C<repeat> value. Will be used each time the watcher times out 1917The current C<repeat> value. Will be used each time the watcher times out
1558or C<ev_timer_again> is called, and determines the next timeout (if any), 1918or C<ev_timer_again> is called, and determines the next timeout (if any),
1596=head2 C<ev_periodic> - to cron or not to cron? 1956=head2 C<ev_periodic> - to cron or not to cron?
1597 1957
1598Periodic watchers are also timers of a kind, but they are very versatile 1958Periodic watchers are also timers of a kind, but they are very versatile
1599(and unfortunately a bit complex). 1959(and unfortunately a bit complex).
1600 1960
1601Unlike C<ev_timer>'s, they are not based on real time (or relative time) 1961Unlike C<ev_timer>, periodic watchers are not based on real time (or
1602but on wall clock time (absolute time). You can tell a periodic watcher 1962relative time, the physical time that passes) but on wall clock time
1603to trigger after some specific point in time. For example, if you tell a 1963(absolute time, the thing you can read on your calender or clock). The
1604periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now () 1964difference is that wall clock time can run faster or slower than real
1605+ 10.>, that is, an absolute time not a delay) and then reset your system 1965time, and time jumps are not uncommon (e.g. when you adjust your
1606clock to January of the previous year, then it will take more than year 1966wrist-watch).
1607to trigger the event (unlike an C<ev_timer>, which would still trigger
1608roughly 10 seconds later as it uses a relative timeout).
1609 1967
1968You can tell a periodic watcher to trigger after some specific point
1969in time: for example, if you tell a periodic watcher to trigger "in 10
1970seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
1971not a delay) and then reset your system clock to January of the previous
1972year, then it will take a year or more to trigger the event (unlike an
1973C<ev_timer>, which would still trigger roughly 10 seconds after starting
1974it, as it uses a relative timeout).
1975
1610C<ev_periodic>s can also be used to implement vastly more complex timers, 1976C<ev_periodic> watchers can also be used to implement vastly more complex
1611such as triggering an event on each "midnight, local time", or other 1977timers, such as triggering an event on each "midnight, local time", or
1612complicated rules. 1978other complicated rules. This cannot be done with C<ev_timer> watchers, as
1979those cannot react to time jumps.
1613 1980
1614As with timers, the callback is guaranteed to be invoked only when the 1981As with timers, the callback is guaranteed to be invoked only when the
1615time (C<at>) has passed, but if multiple periodic timers become ready 1982point in time where it is supposed to trigger has passed. If multiple
1616during the same loop iteration, then order of execution is undefined. 1983timers become ready during the same loop iteration then the ones with
1984earlier time-out values are invoked before ones with later time-out values
1985(but this is no longer true when a callback calls C<ev_loop> recursively).
1617 1986
1618=head3 Watcher-Specific Functions and Data Members 1987=head3 Watcher-Specific Functions and Data Members
1619 1988
1620=over 4 1989=over 4
1621 1990
1622=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) 1991=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1623 1992
1624=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) 1993=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1625 1994
1626Lots of arguments, lets sort it out... There are basically three modes of 1995Lots of arguments, let's sort it out... There are basically three modes of
1627operation, and we will explain them from simplest to most complex: 1996operation, and we will explain them from simplest to most complex:
1628 1997
1629=over 4 1998=over 4
1630 1999
1631=item * absolute timer (at = time, interval = reschedule_cb = 0) 2000=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1632 2001
1633In this configuration the watcher triggers an event after the wall clock 2002In this configuration the watcher triggers an event after the wall clock
1634time C<at> has passed. It will not repeat and will not adjust when a time 2003time C<offset> has passed. It will not repeat and will not adjust when a
1635jump occurs, that is, if it is to be run at January 1st 2011 then it will 2004time jump occurs, that is, if it is to be run at January 1st 2011 then it
1636only run when the system clock reaches or surpasses this time. 2005will be stopped and invoked when the system clock reaches or surpasses
2006this point in time.
1637 2007
1638=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 2008=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1639 2009
1640In this mode the watcher will always be scheduled to time out at the next 2010In this mode the watcher will always be scheduled to time out at the next
1641C<at + N * interval> time (for some integer N, which can also be negative) 2011C<offset + N * interval> time (for some integer N, which can also be
1642and then repeat, regardless of any time jumps. 2012negative) and then repeat, regardless of any time jumps. The C<offset>
2013argument is merely an offset into the C<interval> periods.
1643 2014
1644This can be used to create timers that do not drift with respect to the 2015This can be used to create timers that do not drift with respect to the
1645system clock, for example, here is a C<ev_periodic> that triggers each 2016system clock, for example, here is an C<ev_periodic> that triggers each
1646hour, on the hour: 2017hour, on the hour (with respect to UTC):
1647 2018
1648 ev_periodic_set (&periodic, 0., 3600., 0); 2019 ev_periodic_set (&periodic, 0., 3600., 0);
1649 2020
1650This doesn't mean there will always be 3600 seconds in between triggers, 2021This doesn't mean there will always be 3600 seconds in between triggers,
1651but only that the callback will be called when the system time shows a 2022but only that the callback will be called when the system time shows a
1652full hour (UTC), or more correctly, when the system time is evenly divisible 2023full hour (UTC), or more correctly, when the system time is evenly divisible
1653by 3600. 2024by 3600.
1654 2025
1655Another way to think about it (for the mathematically inclined) is that 2026Another way to think about it (for the mathematically inclined) is that
1656C<ev_periodic> will try to run the callback in this mode at the next possible 2027C<ev_periodic> will try to run the callback in this mode at the next possible
1657time where C<time = at (mod interval)>, regardless of any time jumps. 2028time where C<time = offset (mod interval)>, regardless of any time jumps.
1658 2029
1659For numerical stability it is preferable that the C<at> value is near 2030For numerical stability it is preferable that the C<offset> value is near
1660C<ev_now ()> (the current time), but there is no range requirement for 2031C<ev_now ()> (the current time), but there is no range requirement for
1661this value, and in fact is often specified as zero. 2032this value, and in fact is often specified as zero.
1662 2033
1663Note also that there is an upper limit to how often a timer can fire (CPU 2034Note also that there is an upper limit to how often a timer can fire (CPU
1664speed for example), so if C<interval> is very small then timing stability 2035speed for example), so if C<interval> is very small then timing stability
1665will of course deteriorate. Libev itself tries to be exact to be about one 2036will of course deteriorate. Libev itself tries to be exact to be about one
1666millisecond (if the OS supports it and the machine is fast enough). 2037millisecond (if the OS supports it and the machine is fast enough).
1667 2038
1668=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) 2039=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1669 2040
1670In this mode the values for C<interval> and C<at> are both being 2041In this mode the values for C<interval> and C<offset> are both being
1671ignored. Instead, each time the periodic watcher gets scheduled, the 2042ignored. Instead, each time the periodic watcher gets scheduled, the
1672reschedule callback will be called with the watcher as first, and the 2043reschedule callback will be called with the watcher as first, and the
1673current time as second argument. 2044current time as second argument.
1674 2045
1675NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, 2046NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1676ever, or make ANY event loop modifications whatsoever>. 2047or make ANY other event loop modifications whatsoever, unless explicitly
2048allowed by documentation here>.
1677 2049
1678If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop 2050If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
1679it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the 2051it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1680only event loop modification you are allowed to do). 2052only event loop modification you are allowed to do).
1681 2053
1711a different time than the last time it was called (e.g. in a crond like 2083a different time than the last time it was called (e.g. in a crond like
1712program when the crontabs have changed). 2084program when the crontabs have changed).
1713 2085
1714=item ev_tstamp ev_periodic_at (ev_periodic *) 2086=item ev_tstamp ev_periodic_at (ev_periodic *)
1715 2087
1716When active, returns the absolute time that the watcher is supposed to 2088When active, returns the absolute time that the watcher is supposed
1717trigger next. 2089to trigger next. This is not the same as the C<offset> argument to
2090C<ev_periodic_set>, but indeed works even in interval and manual
2091rescheduling modes.
1718 2092
1719=item ev_tstamp offset [read-write] 2093=item ev_tstamp offset [read-write]
1720 2094
1721When repeating, this contains the offset value, otherwise this is the 2095When repeating, this contains the offset value, otherwise this is the
1722absolute point in time (the C<at> value passed to C<ev_periodic_set>). 2096absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
2097although libev might modify this value for better numerical stability).
1723 2098
1724Can be modified any time, but changes only take effect when the periodic 2099Can be modified any time, but changes only take effect when the periodic
1725timer fires or C<ev_periodic_again> is being called. 2100timer fires or C<ev_periodic_again> is being called.
1726 2101
1727=item ev_tstamp interval [read-write] 2102=item ev_tstamp interval [read-write]
1779Signal watchers will trigger an event when the process receives a specific 2154Signal watchers will trigger an event when the process receives a specific
1780signal one or more times. Even though signals are very asynchronous, libev 2155signal one or more times. Even though signals are very asynchronous, libev
1781will try it's best to deliver signals synchronously, i.e. as part of the 2156will try it's best to deliver signals synchronously, i.e. as part of the
1782normal event processing, like any other event. 2157normal event processing, like any other event.
1783 2158
1784If you want signals asynchronously, just use C<sigaction> as you would 2159If you want signals to be delivered truly asynchronously, just use
1785do without libev and forget about sharing the signal. You can even use 2160C<sigaction> as you would do without libev and forget about sharing
1786C<ev_async> from a signal handler to synchronously wake up an event loop. 2161the signal. You can even use C<ev_async> from a signal handler to
2162synchronously wake up an event loop.
1787 2163
1788You can configure as many watchers as you like per signal. Only when the 2164You can configure as many watchers as you like for the same signal, but
2165only within the same loop, i.e. you can watch for C<SIGINT> in your
2166default loop and for C<SIGIO> in another loop, but you cannot watch for
2167C<SIGINT> in both the default loop and another loop at the same time. At
2168the moment, C<SIGCHLD> is permanently tied to the default loop.
2169
1789first watcher gets started will libev actually register a signal handler 2170When the first watcher gets started will libev actually register something
1790with the kernel (thus it coexists with your own signal handlers as long as 2171with the kernel (thus it coexists with your own signal handlers as long as
1791you don't register any with libev for the same signal). Similarly, when 2172you don't register any with libev for the same signal).
1792the last signal watcher for a signal is stopped, libev will reset the
1793signal handler to SIG_DFL (regardless of what it was set to before).
1794 2173
1795If possible and supported, libev will install its handlers with 2174If possible and supported, libev will install its handlers with
1796C<SA_RESTART> behaviour enabled, so system calls should not be unduly 2175C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1797interrupted. If you have a problem with system calls getting interrupted by 2176not be unduly interrupted. If you have a problem with system calls getting
1798signals you can block all signals in an C<ev_check> watcher and unblock 2177interrupted by signals you can block all signals in an C<ev_check> watcher
1799them in an C<ev_prepare> watcher. 2178and unblock them in an C<ev_prepare> watcher.
2179
2180=head3 The special problem of inheritance over fork/execve/pthread_create
2181
2182Both the signal mask (C<sigprocmask>) and the signal disposition
2183(C<sigaction>) are unspecified after starting a signal watcher (and after
2184stopping it again), that is, libev might or might not block the signal,
2185and might or might not set or restore the installed signal handler.
2186
2187While this does not matter for the signal disposition (libev never
2188sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2189C<execve>), this matters for the signal mask: many programs do not expect
2190certain signals to be blocked.
2191
2192This means that before calling C<exec> (from the child) you should reset
2193the signal mask to whatever "default" you expect (all clear is a good
2194choice usually).
2195
2196The simplest way to ensure that the signal mask is reset in the child is
2197to install a fork handler with C<pthread_atfork> that resets it. That will
2198catch fork calls done by libraries (such as the libc) as well.
2199
2200In current versions of libev, the signal will not be blocked indefinitely
2201unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
2202the window of opportunity for problems, it will not go away, as libev
2203I<has> to modify the signal mask, at least temporarily.
2204
2205So I can't stress this enough: I<If you do not reset your signal mask when
2206you expect it to be empty, you have a race condition in your code>. This
2207is not a libev-specific thing, this is true for most event libraries.
1800 2208
1801=head3 Watcher-Specific Functions and Data Members 2209=head3 Watcher-Specific Functions and Data Members
1802 2210
1803=over 4 2211=over 4
1804 2212
1836some child status changes (most typically when a child of yours dies or 2244some child status changes (most typically when a child of yours dies or
1837exits). It is permissible to install a child watcher I<after> the child 2245exits). It is permissible to install a child watcher I<after> the child
1838has been forked (which implies it might have already exited), as long 2246has been forked (which implies it might have already exited), as long
1839as the event loop isn't entered (or is continued from a watcher), i.e., 2247as the event loop isn't entered (or is continued from a watcher), i.e.,
1840forking and then immediately registering a watcher for the child is fine, 2248forking and then immediately registering a watcher for the child is fine,
1841but forking and registering a watcher a few event loop iterations later is 2249but forking and registering a watcher a few event loop iterations later or
1842not. 2250in the next callback invocation is not.
1843 2251
1844Only the default event loop is capable of handling signals, and therefore 2252Only the default event loop is capable of handling signals, and therefore
1845you can only register child watchers in the default event loop. 2253you can only register child watchers in the default event loop.
1846 2254
2255Due to some design glitches inside libev, child watchers will always be
2256handled at maximum priority (their priority is set to C<EV_MAXPRI> by
2257libev)
2258
1847=head3 Process Interaction 2259=head3 Process Interaction
1848 2260
1849Libev grabs C<SIGCHLD> as soon as the default event loop is 2261Libev grabs C<SIGCHLD> as soon as the default event loop is
1850initialised. This is necessary to guarantee proper behaviour even if 2262initialised. This is necessary to guarantee proper behaviour even if the
1851the first child watcher is started after the child exits. The occurrence 2263first child watcher is started after the child exits. The occurrence
1852of C<SIGCHLD> is recorded asynchronously, but child reaping is done 2264of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1853synchronously as part of the event loop processing. Libev always reaps all 2265synchronously as part of the event loop processing. Libev always reaps all
1854children, even ones not watched. 2266children, even ones not watched.
1855 2267
1856=head3 Overriding the Built-In Processing 2268=head3 Overriding the Built-In Processing
1866=head3 Stopping the Child Watcher 2278=head3 Stopping the Child Watcher
1867 2279
1868Currently, the child watcher never gets stopped, even when the 2280Currently, the child watcher never gets stopped, even when the
1869child terminates, so normally one needs to stop the watcher in the 2281child terminates, so normally one needs to stop the watcher in the
1870callback. Future versions of libev might stop the watcher automatically 2282callback. Future versions of libev might stop the watcher automatically
1871when a child exit is detected. 2283when a child exit is detected (calling C<ev_child_stop> twice is not a
2284problem).
1872 2285
1873=head3 Watcher-Specific Functions and Data Members 2286=head3 Watcher-Specific Functions and Data Members
1874 2287
1875=over 4 2288=over 4
1876 2289
2179 2592
2180=head3 Watcher-Specific Functions and Data Members 2593=head3 Watcher-Specific Functions and Data Members
2181 2594
2182=over 4 2595=over 4
2183 2596
2184=item ev_idle_init (ev_signal *, callback) 2597=item ev_idle_init (ev_idle *, callback)
2185 2598
2186Initialises and configures the idle watcher - it has no parameters of any 2599Initialises and configures the idle watcher - it has no parameters of any
2187kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 2600kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
2188believe me. 2601believe me.
2189 2602
2202 // no longer anything immediate to do. 2615 // no longer anything immediate to do.
2203 } 2616 }
2204 2617
2205 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2618 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2206 ev_idle_init (idle_watcher, idle_cb); 2619 ev_idle_init (idle_watcher, idle_cb);
2207 ev_idle_start (loop, idle_cb); 2620 ev_idle_start (loop, idle_watcher);
2208 2621
2209 2622
2210=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2623=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2211 2624
2212Prepare and check watchers are usually (but not always) used in pairs: 2625Prepare and check watchers are usually (but not always) used in pairs:
2305 struct pollfd fds [nfd]; 2718 struct pollfd fds [nfd];
2306 // actual code will need to loop here and realloc etc. 2719 // actual code will need to loop here and realloc etc.
2307 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2720 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2308 2721
2309 /* the callback is illegal, but won't be called as we stop during check */ 2722 /* the callback is illegal, but won't be called as we stop during check */
2310 ev_timer_init (&tw, 0, timeout * 1e-3); 2723 ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2311 ev_timer_start (loop, &tw); 2724 ev_timer_start (loop, &tw);
2312 2725
2313 // create one ev_io per pollfd 2726 // create one ev_io per pollfd
2314 for (int i = 0; i < nfd; ++i) 2727 for (int i = 0; i < nfd; ++i)
2315 { 2728 {
2545event loop blocks next and before C<ev_check> watchers are being called, 2958event loop blocks next and before C<ev_check> watchers are being called,
2546and only in the child after the fork. If whoever good citizen calling 2959and only in the child after the fork. If whoever good citizen calling
2547C<ev_default_fork> cheats and calls it in the wrong process, the fork 2960C<ev_default_fork> cheats and calls it in the wrong process, the fork
2548handlers will be invoked, too, of course. 2961handlers will be invoked, too, of course.
2549 2962
2963=head3 The special problem of life after fork - how is it possible?
2964
2965Most uses of C<fork()> consist of forking, then some simple calls to ste
2966up/change the process environment, followed by a call to C<exec()>. This
2967sequence should be handled by libev without any problems.
2968
2969This changes when the application actually wants to do event handling
2970in the child, or both parent in child, in effect "continuing" after the
2971fork.
2972
2973The default mode of operation (for libev, with application help to detect
2974forks) is to duplicate all the state in the child, as would be expected
2975when I<either> the parent I<or> the child process continues.
2976
2977When both processes want to continue using libev, then this is usually the
2978wrong result. In that case, usually one process (typically the parent) is
2979supposed to continue with all watchers in place as before, while the other
2980process typically wants to start fresh, i.e. without any active watchers.
2981
2982The cleanest and most efficient way to achieve that with libev is to
2983simply create a new event loop, which of course will be "empty", and
2984use that for new watchers. This has the advantage of not touching more
2985memory than necessary, and thus avoiding the copy-on-write, and the
2986disadvantage of having to use multiple event loops (which do not support
2987signal watchers).
2988
2989When this is not possible, or you want to use the default loop for
2990other reasons, then in the process that wants to start "fresh", call
2991C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying
2992the default loop will "orphan" (not stop) all registered watchers, so you
2993have to be careful not to execute code that modifies those watchers. Note
2994also that in that case, you have to re-register any signal watchers.
2995
2550=head3 Watcher-Specific Functions and Data Members 2996=head3 Watcher-Specific Functions and Data Members
2551 2997
2552=over 4 2998=over 4
2553 2999
2554=item ev_fork_init (ev_signal *, callback) 3000=item ev_fork_init (ev_signal *, callback)
2583=head3 Queueing 3029=head3 Queueing
2584 3030
2585C<ev_async> does not support queueing of data in any way. The reason 3031C<ev_async> does not support queueing of data in any way. The reason
2586is that the author does not know of a simple (or any) algorithm for a 3032is that the author does not know of a simple (or any) algorithm for a
2587multiple-writer-single-reader queue that works in all cases and doesn't 3033multiple-writer-single-reader queue that works in all cases and doesn't
2588need elaborate support such as pthreads. 3034need elaborate support such as pthreads or unportable memory access
3035semantics.
2589 3036
2590That means that if you want to queue data, you have to provide your own 3037That means that if you want to queue data, you have to provide your own
2591queue. But at least I can tell you how to implement locking around your 3038queue. But at least I can tell you how to implement locking around your
2592queue: 3039queue:
2593 3040
2682an C<EV_ASYNC> event on the watcher into the event loop. Unlike 3129an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2683C<ev_feed_event>, this call is safe to do from other threads, signal or 3130C<ev_feed_event>, this call is safe to do from other threads, signal or
2684similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding 3131similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2685section below on what exactly this means). 3132section below on what exactly this means).
2686 3133
3134Note that, as with other watchers in libev, multiple events might get
3135compressed into a single callback invocation (another way to look at this
3136is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
3137reset when the event loop detects that).
3138
2687This call incurs the overhead of a system call only once per loop iteration, 3139This call incurs the overhead of a system call only once per event loop
2688so while the overhead might be noticeable, it doesn't apply to repeated 3140iteration, so while the overhead might be noticeable, it doesn't apply to
2689calls to C<ev_async_send>. 3141repeated calls to C<ev_async_send> for the same event loop.
2690 3142
2691=item bool = ev_async_pending (ev_async *) 3143=item bool = ev_async_pending (ev_async *)
2692 3144
2693Returns a non-zero value when C<ev_async_send> has been called on the 3145Returns a non-zero value when C<ev_async_send> has been called on the
2694watcher but the event has not yet been processed (or even noted) by the 3146watcher but the event has not yet been processed (or even noted) by the
2697C<ev_async_send> sets a flag in the watcher and wakes up the loop. When 3149C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2698the loop iterates next and checks for the watcher to have become active, 3150the loop iterates next and checks for the watcher to have become active,
2699it will reset the flag again. C<ev_async_pending> can be used to very 3151it will reset the flag again. C<ev_async_pending> can be used to very
2700quickly check whether invoking the loop might be a good idea. 3152quickly check whether invoking the loop might be a good idea.
2701 3153
2702Not that this does I<not> check whether the watcher itself is pending, only 3154Not that this does I<not> check whether the watcher itself is pending,
2703whether it has been requested to make this watcher pending. 3155only whether it has been requested to make this watcher pending: there
3156is a time window between the event loop checking and resetting the async
3157notification, and the callback being invoked.
2704 3158
2705=back 3159=back
2706 3160
2707 3161
2708=head1 OTHER FUNCTIONS 3162=head1 OTHER FUNCTIONS
2744 /* doh, nothing entered */; 3198 /* doh, nothing entered */;
2745 } 3199 }
2746 3200
2747 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3201 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2748 3202
2749=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2750
2751Feeds the given event set into the event loop, as if the specified event
2752had happened for the specified watcher (which must be a pointer to an
2753initialised but not necessarily started event watcher).
2754
2755=item ev_feed_fd_event (struct ev_loop *, int fd, int revents) 3203=item ev_feed_fd_event (loop, int fd, int revents)
2756 3204
2757Feed an event on the given fd, as if a file descriptor backend detected 3205Feed an event on the given fd, as if a file descriptor backend detected
2758the given events it. 3206the given events it.
2759 3207
2760=item ev_feed_signal_event (struct ev_loop *loop, int signum) 3208=item ev_feed_signal_event (loop, int signum)
2761 3209
2762Feed an event as if the given signal occurred (C<loop> must be the default 3210Feed an event as if the given signal occurred (C<loop> must be the default
2763loop!). 3211loop!).
2764 3212
2765=back 3213=back
2845 3293
2846=over 4 3294=over 4
2847 3295
2848=item ev::TYPE::TYPE () 3296=item ev::TYPE::TYPE ()
2849 3297
2850=item ev::TYPE::TYPE (struct ev_loop *) 3298=item ev::TYPE::TYPE (loop)
2851 3299
2852=item ev::TYPE::~TYPE 3300=item ev::TYPE::~TYPE
2853 3301
2854The constructor (optionally) takes an event loop to associate the watcher 3302The constructor (optionally) takes an event loop to associate the watcher
2855with. If it is omitted, it will use C<EV_DEFAULT>. 3303with. If it is omitted, it will use C<EV_DEFAULT>.
2932Example: Use a plain function as callback. 3380Example: Use a plain function as callback.
2933 3381
2934 static void io_cb (ev::io &w, int revents) { } 3382 static void io_cb (ev::io &w, int revents) { }
2935 iow.set <io_cb> (); 3383 iow.set <io_cb> ();
2936 3384
2937=item w->set (struct ev_loop *) 3385=item w->set (loop)
2938 3386
2939Associates a different C<struct ev_loop> with this watcher. You can only 3387Associates a different C<struct ev_loop> with this watcher. You can only
2940do this when the watcher is inactive (and not pending either). 3388do this when the watcher is inactive (and not pending either).
2941 3389
2942=item w->set ([arguments]) 3390=item w->set ([arguments])
3012L<http://software.schmorp.de/pkg/EV>. 3460L<http://software.schmorp.de/pkg/EV>.
3013 3461
3014=item Python 3462=item Python
3015 3463
3016Python bindings can be found at L<http://code.google.com/p/pyev/>. It 3464Python bindings can be found at L<http://code.google.com/p/pyev/>. It
3017seems to be quite complete and well-documented. Note, however, that the 3465seems to be quite complete and well-documented.
3018patch they require for libev is outright dangerous as it breaks the ABI
3019for everybody else, and therefore, should never be applied in an installed
3020libev (if python requires an incompatible ABI then it needs to embed
3021libev).
3022 3466
3023=item Ruby 3467=item Ruby
3024 3468
3025Tony Arcieri has written a ruby extension that offers access to a subset 3469Tony Arcieri has written a ruby extension that offers access to a subset
3026of the libev API and adds file handle abstractions, asynchronous DNS and 3470of the libev API and adds file handle abstractions, asynchronous DNS and
3028L<http://rev.rubyforge.org/>. 3472L<http://rev.rubyforge.org/>.
3029 3473
3030Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190> 3474Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
3031makes rev work even on mingw. 3475makes rev work even on mingw.
3032 3476
3477=item Haskell
3478
3479A haskell binding to libev is available at
3480L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3481
3033=item D 3482=item D
3034 3483
3035Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 3484Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3036be found at L<http://proj.llucax.com.ar/wiki/evd>. 3485be found at L<http://proj.llucax.com.ar/wiki/evd>.
3037 3486
3038=item Ocaml 3487=item Ocaml
3039 3488
3040Erkki Seppala has written Ocaml bindings for libev, to be found at 3489Erkki Seppala has written Ocaml bindings for libev, to be found at
3041L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 3490L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3491
3492=item Lua
3493
3494Brian Maher has written a partial interface to libev for lua (at the
3495time of this writing, only C<ev_io> and C<ev_timer>), to be found at
3496L<http://github.com/brimworks/lua-ev>.
3042 3497
3043=back 3498=back
3044 3499
3045 3500
3046=head1 MACRO MAGIC 3501=head1 MACRO MAGIC
3200 libev.m4 3655 libev.m4
3201 3656
3202=head2 PREPROCESSOR SYMBOLS/MACROS 3657=head2 PREPROCESSOR SYMBOLS/MACROS
3203 3658
3204Libev can be configured via a variety of preprocessor symbols you have to 3659Libev can be configured via a variety of preprocessor symbols you have to
3205define before including any of its files. The default in the absence of 3660define before including (or compiling) any of its files. The default in
3206autoconf is documented for every option. 3661the absence of autoconf is documented for every option.
3662
3663Symbols marked with "(h)" do not change the ABI, and can have different
3664values when compiling libev vs. including F<ev.h>, so it is permissible
3665to redefine them before including F<ev.h> without breakign compatibility
3666to a compiled library. All other symbols change the ABI, which means all
3667users of libev and the libev code itself must be compiled with compatible
3668settings.
3207 3669
3208=over 4 3670=over 4
3209 3671
3210=item EV_STANDALONE 3672=item EV_STANDALONE (h)
3211 3673
3212Must always be C<1> if you do not use autoconf configuration, which 3674Must always be C<1> if you do not use autoconf configuration, which
3213keeps libev from including F<config.h>, and it also defines dummy 3675keeps libev from including F<config.h>, and it also defines dummy
3214implementations for some libevent functions (such as logging, which is not 3676implementations for some libevent functions (such as logging, which is not
3215supported). It will also not define any of the structs usually found in 3677supported). It will also not define any of the structs usually found in
3216F<event.h> that are not directly supported by the libev core alone. 3678F<event.h> that are not directly supported by the libev core alone.
3217 3679
3218In stanbdalone mode, libev will still try to automatically deduce the 3680In standalone mode, libev will still try to automatically deduce the
3219configuration, but has to be more conservative. 3681configuration, but has to be more conservative.
3220 3682
3221=item EV_USE_MONOTONIC 3683=item EV_USE_MONOTONIC
3222 3684
3223If defined to be C<1>, libev will try to detect the availability of the 3685If defined to be C<1>, libev will try to detect the availability of the
3229function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>. 3691function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
3230 3692
3231=item EV_USE_REALTIME 3693=item EV_USE_REALTIME
3232 3694
3233If defined to be C<1>, libev will try to detect the availability of the 3695If defined to be C<1>, libev will try to detect the availability of the
3234real-time clock option at compile time (and assume its availability at 3696real-time clock option at compile time (and assume its availability
3235runtime if successful). Otherwise no use of the real-time clock option will 3697at runtime if successful). Otherwise no use of the real-time clock
3236be attempted. This effectively replaces C<gettimeofday> by C<clock_get 3698option will be attempted. This effectively replaces C<gettimeofday>
3237(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the 3699by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
3238note about libraries in the description of C<EV_USE_MONOTONIC>, though. 3700correctness. See the note about libraries in the description of
3701C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
3702C<EV_USE_CLOCK_SYSCALL>.
3239 3703
3240=item EV_USE_CLOCK_SYSCALL 3704=item EV_USE_CLOCK_SYSCALL
3241 3705
3242If defined to be C<1>, libev will try to use a direct syscall instead 3706If defined to be C<1>, libev will try to use a direct syscall instead
3243of calling the system-provided C<clock_gettime> function. This option 3707of calling the system-provided C<clock_gettime> function. This option
3286be used is the winsock select). This means that it will call 3750be used is the winsock select). This means that it will call
3287C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 3751C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3288it is assumed that all these functions actually work on fds, even 3752it is assumed that all these functions actually work on fds, even
3289on win32. Should not be defined on non-win32 platforms. 3753on win32. Should not be defined on non-win32 platforms.
3290 3754
3291=item EV_FD_TO_WIN32_HANDLE 3755=item EV_FD_TO_WIN32_HANDLE(fd)
3292 3756
3293If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map 3757If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3294file descriptors to socket handles. When not defining this symbol (the 3758file descriptors to socket handles. When not defining this symbol (the
3295default), then libev will call C<_get_osfhandle>, which is usually 3759default), then libev will call C<_get_osfhandle>, which is usually
3296correct. In some cases, programs use their own file descriptor management, 3760correct. In some cases, programs use their own file descriptor management,
3297in which case they can provide this function to map fds to socket handles. 3761in which case they can provide this function to map fds to socket handles.
3762
3763=item EV_WIN32_HANDLE_TO_FD(handle)
3764
3765If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
3766using the standard C<_open_osfhandle> function. For programs implementing
3767their own fd to handle mapping, overwriting this function makes it easier
3768to do so. This can be done by defining this macro to an appropriate value.
3769
3770=item EV_WIN32_CLOSE_FD(fd)
3771
3772If programs implement their own fd to handle mapping on win32, then this
3773macro can be used to override the C<close> function, useful to unregister
3774file descriptors again. Note that the replacement function has to close
3775the underlying OS handle.
3298 3776
3299=item EV_USE_POLL 3777=item EV_USE_POLL
3300 3778
3301If defined to be C<1>, libev will compile in support for the C<poll>(2) 3779If defined to be C<1>, libev will compile in support for the C<poll>(2)
3302backend. Otherwise it will be enabled on non-win32 platforms. It 3780backend. Otherwise it will be enabled on non-win32 platforms. It
3349as well as for signal and thread safety in C<ev_async> watchers. 3827as well as for signal and thread safety in C<ev_async> watchers.
3350 3828
3351In the absence of this define, libev will use C<sig_atomic_t volatile> 3829In the absence of this define, libev will use C<sig_atomic_t volatile>
3352(from F<signal.h>), which is usually good enough on most platforms. 3830(from F<signal.h>), which is usually good enough on most platforms.
3353 3831
3354=item EV_H 3832=item EV_H (h)
3355 3833
3356The name of the F<ev.h> header file used to include it. The default if 3834The name of the F<ev.h> header file used to include it. The default if
3357undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 3835undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3358used to virtually rename the F<ev.h> header file in case of conflicts. 3836used to virtually rename the F<ev.h> header file in case of conflicts.
3359 3837
3360=item EV_CONFIG_H 3838=item EV_CONFIG_H (h)
3361 3839
3362If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 3840If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3363F<ev.c>'s idea of where to find the F<config.h> file, similarly to 3841F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3364C<EV_H>, above. 3842C<EV_H>, above.
3365 3843
3366=item EV_EVENT_H 3844=item EV_EVENT_H (h)
3367 3845
3368Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 3846Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3369of how the F<event.h> header can be found, the default is C<"event.h">. 3847of how the F<event.h> header can be found, the default is C<"event.h">.
3370 3848
3371=item EV_PROTOTYPES 3849=item EV_PROTOTYPES (h)
3372 3850
3373If defined to be C<0>, then F<ev.h> will not define any function 3851If defined to be C<0>, then F<ev.h> will not define any function
3374prototypes, but still define all the structs and other symbols. This is 3852prototypes, but still define all the structs and other symbols. This is
3375occasionally useful if you want to provide your own wrapper functions 3853occasionally useful if you want to provide your own wrapper functions
3376around libev functions. 3854around libev functions.
3398fine. 3876fine.
3399 3877
3400If your embedding application does not need any priorities, defining these 3878If your embedding application does not need any priorities, defining these
3401both to C<0> will save some memory and CPU. 3879both to C<0> will save some memory and CPU.
3402 3880
3403=item EV_PERIODIC_ENABLE 3881=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
3882EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
3883EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3404 3884
3405If undefined or defined to be C<1>, then periodic timers are supported. If 3885If undefined or defined to be C<1> (and the platform supports it), then
3406defined to be C<0>, then they are not. Disabling them saves a few kB of 3886the respective watcher type is supported. If defined to be C<0>, then it
3407code. 3887is not. Disabling watcher types mainly saves codesize.
3408 3888
3409=item EV_IDLE_ENABLE 3889=item EV_FEATURES
3410
3411If undefined or defined to be C<1>, then idle watchers are supported. If
3412defined to be C<0>, then they are not. Disabling them saves a few kB of
3413code.
3414
3415=item EV_EMBED_ENABLE
3416
3417If undefined or defined to be C<1>, then embed watchers are supported. If
3418defined to be C<0>, then they are not. Embed watchers rely on most other
3419watcher types, which therefore must not be disabled.
3420
3421=item EV_STAT_ENABLE
3422
3423If undefined or defined to be C<1>, then stat watchers are supported. If
3424defined to be C<0>, then they are not.
3425
3426=item EV_FORK_ENABLE
3427
3428If undefined or defined to be C<1>, then fork watchers are supported. If
3429defined to be C<0>, then they are not.
3430
3431=item EV_ASYNC_ENABLE
3432
3433If undefined or defined to be C<1>, then async watchers are supported. If
3434defined to be C<0>, then they are not.
3435
3436=item EV_MINIMAL
3437 3890
3438If you need to shave off some kilobytes of code at the expense of some 3891If you need to shave off some kilobytes of code at the expense of some
3439speed, define this symbol to C<1>. Currently this is used to override some 3892speed (but with the full API), you can define this symbol to request
3440inlining decisions, saves roughly 30% code size on amd64. It also selects a 3893certain subsets of functionality. The default is to enable all features
3441much smaller 2-heap for timer management over the default 4-heap. 3894that can be enabled on the platform.
3895
3896A typical way to use this symbol is to define it to C<0> (or to a bitset
3897with some broad features you want) and then selectively re-enable
3898additional parts you want, for example if you want everything minimal,
3899but multiple event loop support, async and child watchers and the poll
3900backend, use this:
3901
3902 #define EV_FEATURES 0
3903 #define EV_MULTIPLICITY 1
3904 #define EV_USE_POLL 1
3905 #define EV_CHILD_ENABLE 1
3906 #define EV_ASYNC_ENABLE 1
3907
3908The actual value is a bitset, it can be a combination of the following
3909values:
3910
3911=over 4
3912
3913=item C<1> - faster/larger code
3914
3915Use larger code to speed up some operations.
3916
3917Currently this is used to override some inlining decisions (enlarging the roughly
391830% code size on amd64.
3919
3920When optimising for size, use of compiler flags such as C<-Os> with
3921gcc recommended, as well as C<-DNDEBUG>, as libev contains a number of
3922assertions.
3923
3924=item C<2> - faster/larger data structures
3925
3926Replaces the small 2-heap for timer management by a faster 4-heap, larger
3927hash table sizes and so on. This will usually further increase codesize
3928and can additionally have an effect on the size of data structures at
3929runtime.
3930
3931=item C<4> - full API configuration
3932
3933This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
3934enables multiplicity (C<EV_MULTIPLICITY>=1).
3935
3936=item C<8> - full API
3937
3938This enables a lot of the "lesser used" API functions. See C<ev.h> for
3939details on which parts of the API are still available without this
3940feature, and do not complain if this subset changes over time.
3941
3942=item C<16> - enable all optional watcher types
3943
3944Enables all optional watcher types. If you want to selectively enable
3945only some watcher types other than I/O and timers (e.g. prepare,
3946embed, async, child...) you can enable them manually by defining
3947C<EV_watchertype_ENABLE> to C<1> instead.
3948
3949=item C<32> - enable all backends
3950
3951This enables all backends - without this feature, you need to enable at
3952least one backend manually (C<EV_USE_SELECT> is a good choice).
3953
3954=item C<64> - enable OS-specific "helper" APIs
3955
3956Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
3957default.
3958
3959=back
3960
3961Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
3962reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
3963code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
3964watchers, timers and monotonic clock support.
3965
3966With an intelligent-enough linker (gcc+binutils are intelligent enough
3967when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
3968your program might be left out as well - a binary starting a timer and an
3969I/O watcher then might come out at only 5Kb.
3970
3971=item EV_AVOID_STDIO
3972
3973If this is set to C<1> at compiletime, then libev will avoid using stdio
3974functions (printf, scanf, perror etc.). This will increase the codesize
3975somewhat, but if your program doesn't otherwise depend on stdio and your
3976libc allows it, this avoids linking in the stdio library which is quite
3977big.
3978
3979Note that error messages might become less precise when this option is
3980enabled.
3981
3982=item EV_NSIG
3983
3984The highest supported signal number, +1 (or, the number of
3985signals): Normally, libev tries to deduce the maximum number of signals
3986automatically, but sometimes this fails, in which case it can be
3987specified. Also, using a lower number than detected (C<32> should be
3988good for about any system in existance) can save some memory, as libev
3989statically allocates some 12-24 bytes per signal number.
3442 3990
3443=item EV_PID_HASHSIZE 3991=item EV_PID_HASHSIZE
3444 3992
3445C<ev_child> watchers use a small hash table to distribute workload by 3993C<ev_child> watchers use a small hash table to distribute workload by
3446pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more 3994pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3447than enough. If you need to manage thousands of children you might want to 3995usually more than enough. If you need to manage thousands of children you
3448increase this value (I<must> be a power of two). 3996might want to increase this value (I<must> be a power of two).
3449 3997
3450=item EV_INOTIFY_HASHSIZE 3998=item EV_INOTIFY_HASHSIZE
3451 3999
3452C<ev_stat> watchers use a small hash table to distribute workload by 4000C<ev_stat> watchers use a small hash table to distribute workload by
3453inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), 4001inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3454usually more than enough. If you need to manage thousands of C<ev_stat> 4002disabled), usually more than enough. If you need to manage thousands of
3455watchers you might want to increase this value (I<must> be a power of 4003C<ev_stat> watchers you might want to increase this value (I<must> be a
3456two). 4004power of two).
3457 4005
3458=item EV_USE_4HEAP 4006=item EV_USE_4HEAP
3459 4007
3460Heaps are not very cache-efficient. To improve the cache-efficiency of the 4008Heaps are not very cache-efficient. To improve the cache-efficiency of the
3461timer and periodics heaps, libev uses a 4-heap when this symbol is defined 4009timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3462to C<1>. The 4-heap uses more complicated (longer) code but has noticeably 4010to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3463faster performance with many (thousands) of watchers. 4011faster performance with many (thousands) of watchers.
3464 4012
3465The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> 4013The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3466(disabled). 4014will be C<0>.
3467 4015
3468=item EV_HEAP_CACHE_AT 4016=item EV_HEAP_CACHE_AT
3469 4017
3470Heaps are not very cache-efficient. To improve the cache-efficiency of the 4018Heaps are not very cache-efficient. To improve the cache-efficiency of the
3471timer and periodics heaps, libev can cache the timestamp (I<at>) within 4019timer and periodics heaps, libev can cache the timestamp (I<at>) within
3472the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), 4020the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3473which uses 8-12 bytes more per watcher and a few hundred bytes more code, 4021which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3474but avoids random read accesses on heap changes. This improves performance 4022but avoids random read accesses on heap changes. This improves performance
3475noticeably with many (hundreds) of watchers. 4023noticeably with many (hundreds) of watchers.
3476 4024
3477The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> 4025The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3478(disabled). 4026will be C<0>.
3479 4027
3480=item EV_VERIFY 4028=item EV_VERIFY
3481 4029
3482Controls how much internal verification (see C<ev_loop_verify ()>) will 4030Controls how much internal verification (see C<ev_loop_verify ()>) will
3483be done: If set to C<0>, no internal verification code will be compiled 4031be done: If set to C<0>, no internal verification code will be compiled
3485called. If set to C<2>, then the internal verification code will be 4033called. If set to C<2>, then the internal verification code will be
3486called once per loop, which can slow down libev. If set to C<3>, then the 4034called once per loop, which can slow down libev. If set to C<3>, then the
3487verification code will be called very frequently, which will slow down 4035verification code will be called very frequently, which will slow down
3488libev considerably. 4036libev considerably.
3489 4037
3490The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be 4038The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3491C<0>. 4039will be C<0>.
3492 4040
3493=item EV_COMMON 4041=item EV_COMMON
3494 4042
3495By default, all watchers have a C<void *data> member. By redefining 4043By default, all watchers have a C<void *data> member. By redefining
3496this macro to a something else you can include more and other types of 4044this macro to a something else you can include more and other types of
3554file. 4102file.
3555 4103
3556The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file 4104The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3557that everybody includes and which overrides some configure choices: 4105that everybody includes and which overrides some configure choices:
3558 4106
3559 #define EV_MINIMAL 1 4107 #define EV_FEATURES 8
3560 #define EV_USE_POLL 0 4108 #define EV_USE_SELECT 1
3561 #define EV_MULTIPLICITY 0
3562 #define EV_PERIODIC_ENABLE 0 4109 #define EV_PREPARE_ENABLE 1
4110 #define EV_IDLE_ENABLE 1
3563 #define EV_STAT_ENABLE 0 4111 #define EV_SIGNAL_ENABLE 1
3564 #define EV_FORK_ENABLE 0 4112 #define EV_CHILD_ENABLE 1
4113 #define EV_USE_STDEXCEPT 0
3565 #define EV_CONFIG_H <config.h> 4114 #define EV_CONFIG_H <config.h>
3566 #define EV_MINPRI 0
3567 #define EV_MAXPRI 0
3568 4115
3569 #include "ev++.h" 4116 #include "ev++.h"
3570 4117
3571And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: 4118And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3572 4119
3632default loop and triggering an C<ev_async> watcher from the default loop 4179default loop and triggering an C<ev_async> watcher from the default loop
3633watcher callback into the event loop interested in the signal. 4180watcher callback into the event loop interested in the signal.
3634 4181
3635=back 4182=back
3636 4183
4184=head4 THREAD LOCKING EXAMPLE
4185
4186Here is a fictitious example of how to run an event loop in a different
4187thread than where callbacks are being invoked and watchers are
4188created/added/removed.
4189
4190For a real-world example, see the C<EV::Loop::Async> perl module,
4191which uses exactly this technique (which is suited for many high-level
4192languages).
4193
4194The example uses a pthread mutex to protect the loop data, a condition
4195variable to wait for callback invocations, an async watcher to notify the
4196event loop thread and an unspecified mechanism to wake up the main thread.
4197
4198First, you need to associate some data with the event loop:
4199
4200 typedef struct {
4201 mutex_t lock; /* global loop lock */
4202 ev_async async_w;
4203 thread_t tid;
4204 cond_t invoke_cv;
4205 } userdata;
4206
4207 void prepare_loop (EV_P)
4208 {
4209 // for simplicity, we use a static userdata struct.
4210 static userdata u;
4211
4212 ev_async_init (&u->async_w, async_cb);
4213 ev_async_start (EV_A_ &u->async_w);
4214
4215 pthread_mutex_init (&u->lock, 0);
4216 pthread_cond_init (&u->invoke_cv, 0);
4217
4218 // now associate this with the loop
4219 ev_set_userdata (EV_A_ u);
4220 ev_set_invoke_pending_cb (EV_A_ l_invoke);
4221 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4222
4223 // then create the thread running ev_loop
4224 pthread_create (&u->tid, 0, l_run, EV_A);
4225 }
4226
4227The callback for the C<ev_async> watcher does nothing: the watcher is used
4228solely to wake up the event loop so it takes notice of any new watchers
4229that might have been added:
4230
4231 static void
4232 async_cb (EV_P_ ev_async *w, int revents)
4233 {
4234 // just used for the side effects
4235 }
4236
4237The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4238protecting the loop data, respectively.
4239
4240 static void
4241 l_release (EV_P)
4242 {
4243 userdata *u = ev_userdata (EV_A);
4244 pthread_mutex_unlock (&u->lock);
4245 }
4246
4247 static void
4248 l_acquire (EV_P)
4249 {
4250 userdata *u = ev_userdata (EV_A);
4251 pthread_mutex_lock (&u->lock);
4252 }
4253
4254The event loop thread first acquires the mutex, and then jumps straight
4255into C<ev_loop>:
4256
4257 void *
4258 l_run (void *thr_arg)
4259 {
4260 struct ev_loop *loop = (struct ev_loop *)thr_arg;
4261
4262 l_acquire (EV_A);
4263 pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4264 ev_loop (EV_A_ 0);
4265 l_release (EV_A);
4266
4267 return 0;
4268 }
4269
4270Instead of invoking all pending watchers, the C<l_invoke> callback will
4271signal the main thread via some unspecified mechanism (signals? pipe
4272writes? C<Async::Interrupt>?) and then waits until all pending watchers
4273have been called (in a while loop because a) spurious wakeups are possible
4274and b) skipping inter-thread-communication when there are no pending
4275watchers is very beneficial):
4276
4277 static void
4278 l_invoke (EV_P)
4279 {
4280 userdata *u = ev_userdata (EV_A);
4281
4282 while (ev_pending_count (EV_A))
4283 {
4284 wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4285 pthread_cond_wait (&u->invoke_cv, &u->lock);
4286 }
4287 }
4288
4289Now, whenever the main thread gets told to invoke pending watchers, it
4290will grab the lock, call C<ev_invoke_pending> and then signal the loop
4291thread to continue:
4292
4293 static void
4294 real_invoke_pending (EV_P)
4295 {
4296 userdata *u = ev_userdata (EV_A);
4297
4298 pthread_mutex_lock (&u->lock);
4299 ev_invoke_pending (EV_A);
4300 pthread_cond_signal (&u->invoke_cv);
4301 pthread_mutex_unlock (&u->lock);
4302 }
4303
4304Whenever you want to start/stop a watcher or do other modifications to an
4305event loop, you will now have to lock:
4306
4307 ev_timer timeout_watcher;
4308 userdata *u = ev_userdata (EV_A);
4309
4310 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4311
4312 pthread_mutex_lock (&u->lock);
4313 ev_timer_start (EV_A_ &timeout_watcher);
4314 ev_async_send (EV_A_ &u->async_w);
4315 pthread_mutex_unlock (&u->lock);
4316
4317Note that sending the C<ev_async> watcher is required because otherwise
4318an event loop currently blocking in the kernel will have no knowledge
4319about the newly added timer. By waking up the loop it will pick up any new
4320watchers in the next event loop iteration.
4321
3637=head3 COROUTINES 4322=head3 COROUTINES
3638 4323
3639Libev is very accommodating to coroutines ("cooperative threads"): 4324Libev is very accommodating to coroutines ("cooperative threads"):
3640libev fully supports nesting calls to its functions from different 4325libev fully supports nesting calls to its functions from different
3641coroutines (e.g. you can call C<ev_loop> on the same loop from two 4326coroutines (e.g. you can call C<ev_loop> on the same loop from two
3642different coroutines, and switch freely between both coroutines running the 4327different coroutines, and switch freely between both coroutines running
3643loop, as long as you don't confuse yourself). The only exception is that 4328the loop, as long as you don't confuse yourself). The only exception is
3644you must not do this from C<ev_periodic> reschedule callbacks. 4329that you must not do this from C<ev_periodic> reschedule callbacks.
3645 4330
3646Care has been taken to ensure that libev does not keep local state inside 4331Care has been taken to ensure that libev does not keep local state inside
3647C<ev_loop>, and other calls do not usually allow for coroutine switches as 4332C<ev_loop>, and other calls do not usually allow for coroutine switches as
3648they do not call any callbacks. 4333they do not call any callbacks.
3649 4334
3726way (note also that glib is the slowest event library known to man). 4411way (note also that glib is the slowest event library known to man).
3727 4412
3728There is no supported compilation method available on windows except 4413There is no supported compilation method available on windows except
3729embedding it into other applications. 4414embedding it into other applications.
3730 4415
4416Sensible signal handling is officially unsupported by Microsoft - libev
4417tries its best, but under most conditions, signals will simply not work.
4418
3731Not a libev limitation but worth mentioning: windows apparently doesn't 4419Not a libev limitation but worth mentioning: windows apparently doesn't
3732accept large writes: instead of resulting in a partial write, windows will 4420accept large writes: instead of resulting in a partial write, windows will
3733either accept everything or return C<ENOBUFS> if the buffer is too large, 4421either accept everything or return C<ENOBUFS> if the buffer is too large,
3734so make sure you only write small amounts into your sockets (less than a 4422so make sure you only write small amounts into your sockets (less than a
3735megabyte seems safe, but this apparently depends on the amount of memory 4423megabyte seems safe, but this apparently depends on the amount of memory
3739the abysmal performance of winsockets, using a large number of sockets 4427the abysmal performance of winsockets, using a large number of sockets
3740is not recommended (and not reasonable). If your program needs to use 4428is not recommended (and not reasonable). If your program needs to use
3741more than a hundred or so sockets, then likely it needs to use a totally 4429more than a hundred or so sockets, then likely it needs to use a totally
3742different implementation for windows, as libev offers the POSIX readiness 4430different implementation for windows, as libev offers the POSIX readiness
3743notification model, which cannot be implemented efficiently on windows 4431notification model, which cannot be implemented efficiently on windows
3744(Microsoft monopoly games). 4432(due to Microsoft monopoly games).
3745 4433
3746A typical way to use libev under windows is to embed it (see the embedding 4434A typical way to use libev under windows is to embed it (see the embedding
3747section for details) and use the following F<evwrap.h> header file instead 4435section for details) and use the following F<evwrap.h> header file instead
3748of F<ev.h>: 4436of F<ev.h>:
3749 4437
3785 4473
3786Early versions of winsocket's select only supported waiting for a maximum 4474Early versions of winsocket's select only supported waiting for a maximum
3787of C<64> handles (probably owning to the fact that all windows kernels 4475of C<64> handles (probably owning to the fact that all windows kernels
3788can only wait for C<64> things at the same time internally; Microsoft 4476can only wait for C<64> things at the same time internally; Microsoft
3789recommends spawning a chain of threads and wait for 63 handles and the 4477recommends spawning a chain of threads and wait for 63 handles and the
3790previous thread in each. Great). 4478previous thread in each. Sounds great!).
3791 4479
3792Newer versions support more handles, but you need to define C<FD_SETSIZE> 4480Newer versions support more handles, but you need to define C<FD_SETSIZE>
3793to some high number (e.g. C<2048>) before compiling the winsocket select 4481to some high number (e.g. C<2048>) before compiling the winsocket select
3794call (which might be in libev or elsewhere, for example, perl does its own 4482call (which might be in libev or elsewhere, for example, perl and many
3795select emulation on windows). 4483other interpreters do their own select emulation on windows).
3796 4484
3797Another limit is the number of file descriptors in the Microsoft runtime 4485Another limit is the number of file descriptors in the Microsoft runtime
3798libraries, which by default is C<64> (there must be a hidden I<64> fetish 4486libraries, which by default is C<64> (there must be a hidden I<64>
3799or something like this inside Microsoft). You can increase this by calling 4487fetish or something like this inside Microsoft). You can increase this
3800C<_setmaxstdio>, which can increase this limit to C<2048> (another 4488by calling C<_setmaxstdio>, which can increase this limit to C<2048>
3801arbitrary limit), but is broken in many versions of the Microsoft runtime 4489(another arbitrary limit), but is broken in many versions of the Microsoft
3802libraries.
3803
3804This might get you to about C<512> or C<2048> sockets (depending on 4490runtime libraries. This might get you to about C<512> or C<2048> sockets
3805windows version and/or the phase of the moon). To get more, you need to 4491(depending on windows version and/or the phase of the moon). To get more,
3806wrap all I/O functions and provide your own fd management, but the cost of 4492you need to wrap all I/O functions and provide your own fd management, but
3807calling select (O(n²)) will likely make this unworkable. 4493the cost of calling select (O(n²)) will likely make this unworkable.
3808 4494
3809=back 4495=back
3810 4496
3811=head2 PORTABILITY REQUIREMENTS 4497=head2 PORTABILITY REQUIREMENTS
3812 4498
3855=item C<double> must hold a time value in seconds with enough accuracy 4541=item C<double> must hold a time value in seconds with enough accuracy
3856 4542
3857The type C<double> is used to represent timestamps. It is required to 4543The type C<double> is used to represent timestamps. It is required to
3858have at least 51 bits of mantissa (and 9 bits of exponent), which is good 4544have at least 51 bits of mantissa (and 9 bits of exponent), which is good
3859enough for at least into the year 4000. This requirement is fulfilled by 4545enough for at least into the year 4000. This requirement is fulfilled by
3860implementations implementing IEEE 754 (basically all existing ones). 4546implementations implementing IEEE 754, which is basically all existing
4547ones. With IEEE 754 doubles, you get microsecond accuracy until at least
45482200.
3861 4549
3862=back 4550=back
3863 4551
3864If you know of other additional requirements drop me a note. 4552If you know of other additional requirements drop me a note.
3865 4553
3933involves iterating over all running async watchers or all signal numbers. 4621involves iterating over all running async watchers or all signal numbers.
3934 4622
3935=back 4623=back
3936 4624
3937 4625
4626=head1 GLOSSARY
4627
4628=over 4
4629
4630=item active
4631
4632A watcher is active as long as it has been started (has been attached to
4633an event loop) but not yet stopped (disassociated from the event loop).
4634
4635=item application
4636
4637In this document, an application is whatever is using libev.
4638
4639=item callback
4640
4641The address of a function that is called when some event has been
4642detected. Callbacks are being passed the event loop, the watcher that
4643received the event, and the actual event bitset.
4644
4645=item callback invocation
4646
4647The act of calling the callback associated with a watcher.
4648
4649=item event
4650
4651A change of state of some external event, such as data now being available
4652for reading on a file descriptor, time having passed or simply not having
4653any other events happening anymore.
4654
4655In libev, events are represented as single bits (such as C<EV_READ> or
4656C<EV_TIMEOUT>).
4657
4658=item event library
4659
4660A software package implementing an event model and loop.
4661
4662=item event loop
4663
4664An entity that handles and processes external events and converts them
4665into callback invocations.
4666
4667=item event model
4668
4669The model used to describe how an event loop handles and processes
4670watchers and events.
4671
4672=item pending
4673
4674A watcher is pending as soon as the corresponding event has been detected,
4675and stops being pending as soon as the watcher will be invoked or its
4676pending status is explicitly cleared by the application.
4677
4678A watcher can be pending, but not active. Stopping a watcher also clears
4679its pending status.
4680
4681=item real time
4682
4683The physical time that is observed. It is apparently strictly monotonic :)
4684
4685=item wall-clock time
4686
4687The time and date as shown on clocks. Unlike real time, it can actually
4688be wrong and jump forwards and backwards, e.g. when the you adjust your
4689clock.
4690
4691=item watcher
4692
4693A data structure that describes interest in certain events. Watchers need
4694to be started (attached to an event loop) before they can receive events.
4695
4696=item watcher invocation
4697
4698The act of calling the callback associated with a watcher.
4699
4700=back
4701
3938=head1 AUTHOR 4702=head1 AUTHOR
3939 4703
3940Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. 4704Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3941 4705

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines