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

Comparing libev/ev.pod (file contents):
Revision 1.357 by root, Tue Jan 11 02:15:58 2011 UTC vs.
Revision 1.385 by root, Tue Nov 29 15:10:05 2011 UTC

58 ev_timer_start (loop, &timeout_watcher); 58 ev_timer_start (loop, &timeout_watcher);
59 59
60 // now wait for events to arrive 60 // now wait for events to arrive
61 ev_run (loop, 0); 61 ev_run (loop, 0);
62 62
63 // unloop was called, so exit 63 // break was called, so exit
64 return 0; 64 return 0;
65 } 65 }
66 66
67=head1 ABOUT THIS DOCUMENT 67=head1 ABOUT THIS DOCUMENT
68 68
174=item ev_tstamp ev_time () 174=item ev_tstamp ev_time ()
175 175
176Returns the current time as libev would use it. Please note that the 176Returns the current time as libev would use it. Please note that the
177C<ev_now> function is usually faster and also often returns the timestamp 177C<ev_now> function is usually faster and also often returns the timestamp
178you actually want to know. Also interesting is the combination of 178you actually want to know. Also interesting is the combination of
179C<ev_update_now> and C<ev_now>. 179C<ev_now_update> and C<ev_now>.
180 180
181=item ev_sleep (ev_tstamp interval) 181=item ev_sleep (ev_tstamp interval)
182 182
183Sleep for the given interval: The current thread will be blocked until 183Sleep for the given interval: The current thread will be blocked
184either it is interrupted or the given time interval has passed. Basically 184until either it is interrupted or the given time interval has
185passed (approximately - it might return a bit earlier even if not
186interrupted). Returns immediately if C<< interval <= 0 >>.
187
185this is a sub-second-resolution C<sleep ()>. 188Basically this is a sub-second-resolution C<sleep ()>.
189
190The range of the C<interval> is limited - libev only guarantees to work
191with sleep times of up to one day (C<< interval <= 86400 >>).
186 192
187=item int ev_version_major () 193=item int ev_version_major ()
188 194
189=item int ev_version_minor () 195=item int ev_version_minor ()
190 196
435example) that can't properly initialise their signal masks. 441example) that can't properly initialise their signal masks.
436 442
437=item C<EVFLAG_NOSIGMASK> 443=item C<EVFLAG_NOSIGMASK>
438 444
439When this flag is specified, then libev will avoid to modify the signal 445When this flag is specified, then libev will avoid to modify the signal
440mask. Specifically, this means you ahve to make sure signals are unblocked 446mask. Specifically, this means you have to make sure signals are unblocked
441when you want to receive them. 447when you want to receive them.
442 448
443This behaviour is useful when you want to do your own signal handling, or 449This behaviour is useful when you want to do your own signal handling, or
444want to handle signals only in specific threads and want to avoid libev 450want to handle signals only in specific threads and want to avoid libev
445unblocking the signals. 451unblocking the signals.
452
453It's also required by POSIX in a threaded program, as libev calls
454C<sigprocmask>, whose behaviour is officially unspecified.
446 455
447This flag's behaviour will become the default in future versions of libev. 456This flag's behaviour will become the default in future versions of libev.
448 457
449=item C<EVBACKEND_SELECT> (value 1, portable select backend) 458=item C<EVBACKEND_SELECT> (value 1, portable select backend)
450 459
480=item C<EVBACKEND_EPOLL> (value 4, Linux) 489=item C<EVBACKEND_EPOLL> (value 4, Linux)
481 490
482Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 491Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
483kernels). 492kernels).
484 493
485For few fds, this backend is a bit little slower than poll and select, 494For few fds, this backend is a bit little slower than poll and select, but
486but it scales phenomenally better. While poll and select usually scale 495it scales phenomenally better. While poll and select usually scale like
487like O(total_fds) where n is the total number of fds (or the highest fd), 496O(total_fds) where total_fds is the total number of fds (or the highest
488epoll scales either O(1) or O(active_fds). 497fd), epoll scales either O(1) or O(active_fds).
489 498
490The epoll mechanism deserves honorable mention as the most misdesigned 499The epoll mechanism deserves honorable mention as the most misdesigned
491of the more advanced event mechanisms: mere annoyances include silently 500of the more advanced event mechanisms: mere annoyances include silently
492dropping file descriptors, requiring a system call per change per file 501dropping file descriptors, requiring a system call per change per file
493descriptor (and unnecessary guessing of parameters), problems with dup, 502descriptor (and unnecessary guessing of parameters), problems with dup,
4960.1ms) and so on. The biggest issue is fork races, however - if a program 5050.1ms) and so on. The biggest issue is fork races, however - if a program
497forks then I<both> parent and child process have to recreate the epoll 506forks then I<both> parent and child process have to recreate the epoll
498set, which can take considerable time (one syscall per file descriptor) 507set, which can take considerable time (one syscall per file descriptor)
499and is of course hard to detect. 508and is of course hard to detect.
500 509
501Epoll is also notoriously buggy - embedding epoll fds I<should> work, but 510Epoll is also notoriously buggy - embedding epoll fds I<should> work,
502of course I<doesn't>, and epoll just loves to report events for totally 511but of course I<doesn't>, and epoll just loves to report events for
503I<different> file descriptors (even already closed ones, so one cannot 512totally I<different> file descriptors (even already closed ones, so
504even remove them from the set) than registered in the set (especially 513one cannot even remove them from the set) than registered in the set
505on SMP systems). Libev tries to counter these spurious notifications by 514(especially on SMP systems). Libev tries to counter these spurious
506employing an additional generation counter and comparing that against the 515notifications by employing an additional generation counter and comparing
507events to filter out spurious ones, recreating the set when required. Last 516that against the events to filter out spurious ones, recreating the set
517when required. Epoll also erroneously rounds down timeouts, but gives you
518no way to know when and by how much, so sometimes you have to busy-wait
519because epoll returns immediately despite a nonzero timeout. And last
508not least, it also refuses to work with some file descriptors which work 520not least, it also refuses to work with some file descriptors which work
509perfectly fine with C<select> (files, many character devices...). 521perfectly fine with C<select> (files, many character devices...).
510 522
511Epoll is truly the train wreck analog among event poll mechanisms, 523Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
512a frankenpoll, cobbled together in a hurry, no thought to design or 524cobbled together in a hurry, no thought to design or interaction with
513interaction with others. 525others. Oh, the pain, will it ever stop...
514 526
515While stopping, setting and starting an I/O watcher in the same iteration 527While stopping, setting and starting an I/O watcher in the same iteration
516will result in some caching, there is still a system call per such 528will result in some caching, there is still a system call per such
517incident (because the same I<file descriptor> could point to a different 529incident (because the same I<file descriptor> could point to a different
518I<file description> now), so its best to avoid that. Also, C<dup ()>'ed 530I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
596among the OS-specific backends (I vastly prefer correctness over speed 608among the OS-specific backends (I vastly prefer correctness over speed
597hacks). 609hacks).
598 610
599On the negative side, the interface is I<bizarre> - so bizarre that 611On the negative side, the interface is I<bizarre> - so bizarre that
600even sun itself gets it wrong in their code examples: The event polling 612even sun itself gets it wrong in their code examples: The event polling
601function sometimes returning events to the caller even though an error 613function sometimes returns events to the caller even though an error
602occurred, but with no indication whether it has done so or not (yes, it's 614occurred, but with no indication whether it has done so or not (yes, it's
603even documented that way) - deadly for edge-triggered interfaces where 615even documented that way) - deadly for edge-triggered interfaces where you
604you absolutely have to know whether an event occurred or not because you 616absolutely have to know whether an event occurred or not because you have
605have to re-arm the watcher. 617to re-arm the watcher.
606 618
607Fortunately libev seems to be able to work around these idiocies. 619Fortunately libev seems to be able to work around these idiocies.
608 620
609This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 621This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
610C<EVBACKEND_POLL>. 622C<EVBACKEND_POLL>.
822This is useful if you are waiting for some external event in conjunction 834This is useful if you are waiting for some external event in conjunction
823with something not expressible using other libev watchers (i.e. "roll your 835with something not expressible using other libev watchers (i.e. "roll your
824own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is 836own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
825usually a better approach for this kind of thing. 837usually a better approach for this kind of thing.
826 838
827Here are the gory details of what C<ev_run> does: 839Here are the gory details of what C<ev_run> does (this is for your
840understanding, not a guarantee that things will work exactly like this in
841future versions):
828 842
829 - Increment loop depth. 843 - Increment loop depth.
830 - Reset the ev_break status. 844 - Reset the ev_break status.
831 - Before the first iteration, call any pending watchers. 845 - Before the first iteration, call any pending watchers.
832 LOOP: 846 LOOP:
865anymore. 879anymore.
866 880
867 ... queue jobs here, make sure they register event watchers as long 881 ... queue jobs here, make sure they register event watchers as long
868 ... as they still have work to do (even an idle watcher will do..) 882 ... as they still have work to do (even an idle watcher will do..)
869 ev_run (my_loop, 0); 883 ev_run (my_loop, 0);
870 ... jobs done or somebody called unloop. yeah! 884 ... jobs done or somebody called break. yeah!
871 885
872=item ev_break (loop, how) 886=item ev_break (loop, how)
873 887
874Can be used to make a call to C<ev_run> return early (but only after it 888Can be used to make a call to C<ev_run> return early (but only after it
875has processed all outstanding events). The C<how> argument must be either 889has processed all outstanding events). The C<how> argument must be either
938overhead for the actual polling but can deliver many events at once. 952overhead for the actual polling but can deliver many events at once.
939 953
940By setting a higher I<io collect interval> you allow libev to spend more 954By setting a higher I<io collect interval> you allow libev to spend more
941time collecting I/O events, so you can handle more events per iteration, 955time collecting I/O events, so you can handle more events per iteration,
942at the cost of increasing latency. Timeouts (both C<ev_periodic> and 956at the cost of increasing latency. Timeouts (both C<ev_periodic> and
943C<ev_timer>) will be not affected. Setting this to a non-null value will 957C<ev_timer>) will not be affected. Setting this to a non-null value will
944introduce an additional C<ev_sleep ()> call into most loop iterations. The 958introduce an additional C<ev_sleep ()> call into most loop iterations. The
945sleep time ensures that libev will not poll for I/O events more often then 959sleep time ensures that libev will not poll for I/O events more often then
946once per this interval, on average. 960once per this interval, on average (as long as the host time resolution is
961good enough).
947 962
948Likewise, by setting a higher I<timeout collect interval> you allow libev 963Likewise, by setting a higher I<timeout collect interval> you allow libev
949to spend more time collecting timeouts, at the expense of increased 964to spend more time collecting timeouts, at the expense of increased
950latency/jitter/inexactness (the watcher callback will be called 965latency/jitter/inexactness (the watcher callback will be called
951later). C<ev_io> watchers will not be affected. Setting this to a non-null 966later). C<ev_io> watchers will not be affected. Setting this to a non-null
1005can be done relatively simply by putting mutex_lock/unlock calls around 1020can be done relatively simply by putting mutex_lock/unlock calls around
1006each call to a libev function. 1021each call to a libev function.
1007 1022
1008However, C<ev_run> can run an indefinite time, so it is not feasible 1023However, C<ev_run> can run an indefinite time, so it is not feasible
1009to wait for it to return. One way around this is to wake up the event 1024to wait for it to return. One way around this is to wake up the event
1010loop via C<ev_break> and C<av_async_send>, another way is to set these 1025loop via C<ev_break> and C<ev_async_send>, another way is to set these
1011I<release> and I<acquire> callbacks on the loop. 1026I<release> and I<acquire> callbacks on the loop.
1012 1027
1013When set, then C<release> will be called just before the thread is 1028When set, then C<release> will be called just before the thread is
1014suspended waiting for new events, and C<acquire> is called just 1029suspended waiting for new events, and C<acquire> is called just
1015afterwards. 1030afterwards.
1371 1386
1372=over 4 1387=over 4
1373 1388
1374=item initialiased 1389=item initialiased
1375 1390
1376Before a watcher can be registered with the event looop it has to be 1391Before a watcher can be registered with the event loop it has to be
1377initialised. This can be done with a call to C<ev_TYPE_init>, or calls to 1392initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1378C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. 1393C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1379 1394
1380In this state it is simply some block of memory that is suitable for use 1395In this state it is simply some block of memory that is suitable for
1381in an event loop. It can be moved around, freed, reused etc. at will. 1396use in an event loop. It can be moved around, freed, reused etc. at
1397will - as long as you either keep the memory contents intact, or call
1398C<ev_TYPE_init> again.
1382 1399
1383=item started/running/active 1400=item started/running/active
1384 1401
1385Once a watcher has been started with a call to C<ev_TYPE_start> it becomes 1402Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1386property of the event loop, and is actively waiting for events. While in 1403property of the event loop, and is actively waiting for events. While in
1414latter will clear any pending state the watcher might be in, regardless 1431latter will clear any pending state the watcher might be in, regardless
1415of whether it was active or not, so stopping a watcher explicitly before 1432of whether it was active or not, so stopping a watcher explicitly before
1416freeing it is often a good idea. 1433freeing it is often a good idea.
1417 1434
1418While stopped (and not pending) the watcher is essentially in the 1435While stopped (and not pending) the watcher is essentially in the
1419initialised state, that is it can be reused, moved, modified in any way 1436initialised state, that is, it can be reused, moved, modified in any way
1420you wish. 1437you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
1438it again).
1421 1439
1422=back 1440=back
1423 1441
1424=head2 WATCHER PRIORITY MODELS 1442=head2 WATCHER PRIORITY MODELS
1425 1443
1618always get a readiness notification instantly, and your read (or possibly 1636always get a readiness notification instantly, and your read (or possibly
1619write) will still block on the disk I/O. 1637write) will still block on the disk I/O.
1620 1638
1621Another way to view it is that in the case of sockets, pipes, character 1639Another way to view it is that in the case of sockets, pipes, character
1622devices and so on, there is another party (the sender) that delivers data 1640devices and so on, there is another party (the sender) that delivers data
1623on it's own, but in the case of files, there is no such thing: the disk 1641on its own, but in the case of files, there is no such thing: the disk
1624will not send data on it's own, simply because it doesn't know what you 1642will not send data on its own, simply because it doesn't know what you
1625wish to read - you would first have to request some data. 1643wish to read - you would first have to request some data.
1626 1644
1627Since files are typically not-so-well supported by advanced notification 1645Since files are typically not-so-well supported by advanced notification
1628mechanism, libev tries hard to emulate POSIX behaviour with respect 1646mechanism, libev tries hard to emulate POSIX behaviour with respect
1629to files, even though you should not use it. The reason for this is 1647to files, even though you should not use it. The reason for this is
1753detecting time jumps is hard, and some inaccuracies are unavoidable (the 1771detecting time jumps is hard, and some inaccuracies are unavoidable (the
1754monotonic clock option helps a lot here). 1772monotonic clock option helps a lot here).
1755 1773
1756The callback is guaranteed to be invoked only I<after> its timeout has 1774The callback is guaranteed to be invoked only I<after> its timeout has
1757passed (not I<at>, so on systems with very low-resolution clocks this 1775passed (not I<at>, so on systems with very low-resolution clocks this
1758might introduce a small delay). If multiple timers become ready during the 1776might introduce a small delay, see "the special problem of being too
1777early", below). If multiple timers become ready during the same loop
1759same loop iteration then the ones with earlier time-out values are invoked 1778iteration then the ones with earlier time-out values are invoked before
1760before ones of the same priority with later time-out values (but this is 1779ones of the same priority with later time-out values (but this is no
1761no longer true when a callback calls C<ev_run> recursively). 1780longer true when a callback calls C<ev_run> recursively).
1762 1781
1763=head3 Be smart about timeouts 1782=head3 Be smart about timeouts
1764 1783
1765Many real-world problems involve some kind of timeout, usually for error 1784Many real-world problems involve some kind of timeout, usually for error
1766recovery. A typical example is an HTTP request - if the other side hangs, 1785recovery. A typical example is an HTTP request - if the other side hangs,
1933Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 1952Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1934rather complicated, but extremely efficient, something that really pays 1953rather complicated, but extremely efficient, something that really pays
1935off after the first million or so of active timers, i.e. it's usually 1954off after the first million or so of active timers, i.e. it's usually
1936overkill :) 1955overkill :)
1937 1956
1957=head3 The special problem of being too early
1958
1959If you ask a timer to call your callback after three seconds, then
1960you expect it to be invoked after three seconds - but of course, this
1961cannot be guaranteed to infinite precision. Less obviously, it cannot be
1962guaranteed to any precision by libev - imagine somebody suspending the
1963process a STOP signal for a few hours for example.
1964
1965So, libev tries to invoke your callback as soon as possible I<after> the
1966delay has occurred, but cannot guarantee this.
1967
1968A less obvious failure mode is calling your callback too early: many event
1969loops compare timestamps with a "elapsed delay >= requested delay", but
1970this can cause your callback to be invoked much earlier than you would
1971expect.
1972
1973To see why, imagine a system with a clock that only offers full second
1974resolution (think windows if you can't come up with a broken enough OS
1975yourself). If you schedule a one-second timer at the time 500.9, then the
1976event loop will schedule your timeout to elapse at a system time of 500
1977(500.9 truncated to the resolution) + 1, or 501.
1978
1979If an event library looks at the timeout 0.1s later, it will see "501 >=
1980501" and invoke the callback 0.1s after it was started, even though a
1981one-second delay was requested - this is being "too early", despite best
1982intentions.
1983
1984This is the reason why libev will never invoke the callback if the elapsed
1985delay equals the requested delay, but only when the elapsed delay is
1986larger than the requested delay. In the example above, libev would only invoke
1987the callback at system time 502, or 1.1s after the timer was started.
1988
1989So, while libev cannot guarantee that your callback will be invoked
1990exactly when requested, it I<can> and I<does> guarantee that the requested
1991delay has actually elapsed, or in other words, it always errs on the "too
1992late" side of things.
1993
1938=head3 The special problem of time updates 1994=head3 The special problem of time updates
1939 1995
1940Establishing the current time is a costly operation (it usually takes at 1996Establishing the current time is a costly operation (it usually takes
1941least two system calls): EV therefore updates its idea of the current 1997at least one system call): EV therefore updates its idea of the current
1942time only before and after C<ev_run> collects new events, which causes a 1998time only before and after C<ev_run> collects new events, which causes a
1943growing difference between C<ev_now ()> and C<ev_time ()> when handling 1999growing difference between C<ev_now ()> and C<ev_time ()> when handling
1944lots of events in one iteration. 2000lots of events in one iteration.
1945 2001
1946The relative timeouts are calculated relative to the C<ev_now ()> 2002The relative timeouts are calculated relative to the C<ev_now ()>
1952 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2008 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1953 2009
1954If the event loop is suspended for a long time, you can also force an 2010If the event loop is suspended for a long time, you can also force an
1955update of the time returned by C<ev_now ()> by calling C<ev_now_update 2011update of the time returned by C<ev_now ()> by calling C<ev_now_update
1956()>. 2012()>.
2013
2014=head3 The special problem of unsynchronised clocks
2015
2016Modern systems have a variety of clocks - libev itself uses the normal
2017"wall clock" clock and, if available, the monotonic clock (to avoid time
2018jumps).
2019
2020Neither of these clocks is synchronised with each other or any other clock
2021on the system, so C<ev_time ()> might return a considerably different time
2022than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
2023a call to C<gettimeofday> might return a second count that is one higher
2024than a directly following call to C<time>.
2025
2026The moral of this is to only compare libev-related timestamps with
2027C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
2028a second or so.
2029
2030One more problem arises due to this lack of synchronisation: if libev uses
2031the system monotonic clock and you compare timestamps from C<ev_time>
2032or C<ev_now> from when you started your timer and when your callback is
2033invoked, you will find that sometimes the callback is a bit "early".
2034
2035This is because C<ev_timer>s work in real time, not wall clock time, so
2036libev makes sure your callback is not invoked before the delay happened,
2037I<measured according to the real time>, not the system clock.
2038
2039If your timeouts are based on a physical timescale (e.g. "time out this
2040connection after 100 seconds") then this shouldn't bother you as it is
2041exactly the right behaviour.
2042
2043If you want to compare wall clock/system timestamps to your timers, then
2044you need to use C<ev_periodic>s, as these are based on the wall clock
2045time, where your comparisons will always generate correct results.
1957 2046
1958=head3 The special problems of suspended animation 2047=head3 The special problems of suspended animation
1959 2048
1960When you leave the server world it is quite customary to hit machines that 2049When you leave the server world it is quite customary to hit machines that
1961can suspend/hibernate - what happens to the clocks during such a suspend? 2050can suspend/hibernate - what happens to the clocks during such a suspend?
2005keep up with the timer (because it takes longer than those 10 seconds to 2094keep up with the timer (because it takes longer than those 10 seconds to
2006do stuff) the timer will not fire more than once per event loop iteration. 2095do stuff) the timer will not fire more than once per event loop iteration.
2007 2096
2008=item ev_timer_again (loop, ev_timer *) 2097=item ev_timer_again (loop, ev_timer *)
2009 2098
2010This will act as if the timer timed out and restart it again if it is 2099This will act as if the timer timed out and restarts it again if it is
2011repeating. The exact semantics are: 2100repeating. The exact semantics are:
2012 2101
2013If the timer is pending, its pending status is cleared. 2102If the timer is pending, its pending status is cleared.
2014 2103
2015If the timer is started but non-repeating, stop it (as if it timed out). 2104If the timer is started but non-repeating, stop it (as if it timed out).
2145 2234
2146Another way to think about it (for the mathematically inclined) is that 2235Another way to think about it (for the mathematically inclined) is that
2147C<ev_periodic> will try to run the callback in this mode at the next possible 2236C<ev_periodic> will try to run the callback in this mode at the next possible
2148time where C<time = offset (mod interval)>, regardless of any time jumps. 2237time where C<time = offset (mod interval)>, regardless of any time jumps.
2149 2238
2150For numerical stability it is preferable that the C<offset> value is near 2239The C<interval> I<MUST> be positive, and for numerical stability, the
2151C<ev_now ()> (the current time), but there is no range requirement for 2240interval value should be higher than C<1/8192> (which is around 100
2152this value, and in fact is often specified as zero. 2241microseconds) and C<offset> should be higher than C<0> and should have
2242at most a similar magnitude as the current time (say, within a factor of
2243ten). Typical values for offset are, in fact, C<0> or something between
2244C<0> and C<interval>, which is also the recommended range.
2153 2245
2154Note also that there is an upper limit to how often a timer can fire (CPU 2246Note also that there is an upper limit to how often a timer can fire (CPU
2155speed for example), so if C<interval> is very small then timing stability 2247speed for example), so if C<interval> is very small then timing stability
2156will of course deteriorate. Libev itself tries to be exact to be about one 2248will of course deteriorate. Libev itself tries to be exact to be about one
2157millisecond (if the OS supports it and the machine is fast enough). 2249millisecond (if the OS supports it and the machine is fast enough).
2300=head3 The special problem of inheritance over fork/execve/pthread_create 2392=head3 The special problem of inheritance over fork/execve/pthread_create
2301 2393
2302Both the signal mask (C<sigprocmask>) and the signal disposition 2394Both the signal mask (C<sigprocmask>) and the signal disposition
2303(C<sigaction>) are unspecified after starting a signal watcher (and after 2395(C<sigaction>) are unspecified after starting a signal watcher (and after
2304stopping it again), that is, libev might or might not block the signal, 2396stopping it again), that is, libev might or might not block the signal,
2305and might or might not set or restore the installed signal handler. 2397and might or might not set or restore the installed signal handler (but
2398see C<EVFLAG_NOSIGMASK>).
2306 2399
2307While this does not matter for the signal disposition (libev never 2400While this does not matter for the signal disposition (libev never
2308sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on 2401sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2309C<execve>), this matters for the signal mask: many programs do not expect 2402C<execve>), this matters for the signal mask: many programs do not expect
2310certain signals to be blocked. 2403certain signals to be blocked.
3181 atexit (program_exits); 3274 atexit (program_exits);
3182 3275
3183 3276
3184=head2 C<ev_async> - how to wake up an event loop 3277=head2 C<ev_async> - how to wake up an event loop
3185 3278
3186In general, you cannot use an C<ev_run> from multiple threads or other 3279In general, you cannot use an C<ev_loop> from multiple threads or other
3187asynchronous sources such as signal handlers (as opposed to multiple event 3280asynchronous sources such as signal handlers (as opposed to multiple event
3188loops - those are of course safe to use in different threads). 3281loops - those are of course safe to use in different threads).
3189 3282
3190Sometimes, however, you need to wake up an event loop you do not control, 3283Sometimes, however, you need to wake up an event loop you do not control,
3191for example because it belongs to another thread. This is what C<ev_async> 3284for example because it belongs to another thread. This is what C<ev_async>
3198C<ev_async_sent> calls). In fact, you could use signal watchers as a kind 3291C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
3199of "global async watchers" by using a watcher on an otherwise unused 3292of "global async watchers" by using a watcher on an otherwise unused
3200signal, and C<ev_feed_signal> to signal this watcher from another thread, 3293signal, and C<ev_feed_signal> to signal this watcher from another thread,
3201even without knowing which loop owns the signal. 3294even without knowing which loop owns the signal.
3202 3295
3203Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3204just the default loop.
3205
3206=head3 Queueing 3296=head3 Queueing
3207 3297
3208C<ev_async> does not support queueing of data in any way. The reason 3298C<ev_async> does not support queueing of data in any way. The reason
3209is that the author does not know of a simple (or any) algorithm for a 3299is that the author does not know of a simple (or any) algorithm for a
3210multiple-writer-single-reader queue that works in all cases and doesn't 3300multiple-writer-single-reader queue that works in all cases and doesn't
3301trust me. 3391trust me.
3302 3392
3303=item ev_async_send (loop, ev_async *) 3393=item ev_async_send (loop, ev_async *)
3304 3394
3305Sends/signals/activates the given C<ev_async> watcher, that is, feeds 3395Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3306an C<EV_ASYNC> event on the watcher into the event loop. Unlike 3396an C<EV_ASYNC> event on the watcher into the event loop, and instantly
3397returns.
3398
3307C<ev_feed_event>, this call is safe to do from other threads, signal or 3399Unlike C<ev_feed_event>, this call is safe to do from other threads,
3308similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding 3400signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3309section below on what exactly this means). 3401embedding section below on what exactly this means).
3310 3402
3311Note that, as with other watchers in libev, multiple events might get 3403Note that, as with other watchers in libev, multiple events might get
3312compressed into a single callback invocation (another way to look at this 3404compressed into a single callback invocation (another way to look at
3313is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, 3405this is that C<ev_async> watchers are level-triggered: they are set on
3314reset when the event loop detects that). 3406C<ev_async_send>, reset when the event loop detects that).
3315 3407
3316This call incurs the overhead of a system call only once per event loop 3408This call incurs the overhead of at most one extra system call per event
3317iteration, so while the overhead might be noticeable, it doesn't apply to 3409loop iteration, if the event loop is blocked, and no syscall at all if
3318repeated calls to C<ev_async_send> for the same event loop. 3410the event loop (or your program) is processing events. That means that
3411repeated calls are basically free (there is no need to avoid calls for
3412performance reasons) and that the overhead becomes smaller (typically
3413zero) under load.
3319 3414
3320=item bool = ev_async_pending (ev_async *) 3415=item bool = ev_async_pending (ev_async *)
3321 3416
3322Returns a non-zero value when C<ev_async_send> has been called on the 3417Returns a non-zero value when C<ev_async_send> has been called on the
3323watcher but the event has not yet been processed (or even noted) by the 3418watcher but the event has not yet been processed (or even noted) by the
3504 exit_main_loop = exit_nested_loop = 1; 3599 exit_main_loop = exit_nested_loop = 1;
3505 3600
3506=head2 THREAD LOCKING EXAMPLE 3601=head2 THREAD LOCKING EXAMPLE
3507 3602
3508Here is a fictitious example of how to run an event loop in a different 3603Here is a fictitious example of how to run an event loop in a different
3509thread than where callbacks are being invoked and watchers are 3604thread from where callbacks are being invoked and watchers are
3510created/added/removed. 3605created/added/removed.
3511 3606
3512For a real-world example, see the C<EV::Loop::Async> perl module, 3607For a real-world example, see the C<EV::Loop::Async> perl module,
3513which uses exactly this technique (which is suited for many high-level 3608which uses exactly this technique (which is suited for many high-level
3514languages). 3609languages).
3540 // now associate this with the loop 3635 // now associate this with the loop
3541 ev_set_userdata (EV_A_ u); 3636 ev_set_userdata (EV_A_ u);
3542 ev_set_invoke_pending_cb (EV_A_ l_invoke); 3637 ev_set_invoke_pending_cb (EV_A_ l_invoke);
3543 ev_set_loop_release_cb (EV_A_ l_release, l_acquire); 3638 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3544 3639
3545 // then create the thread running ev_loop 3640 // then create the thread running ev_run
3546 pthread_create (&u->tid, 0, l_run, EV_A); 3641 pthread_create (&u->tid, 0, l_run, EV_A);
3547 } 3642 }
3548 3643
3549The callback for the C<ev_async> watcher does nothing: the watcher is used 3644The callback for the C<ev_async> watcher does nothing: the watcher is used
3550solely to wake up the event loop so it takes notice of any new watchers 3645solely to wake up the event loop so it takes notice of any new watchers
3920watchers in the constructor. 4015watchers in the constructor.
3921 4016
3922 class myclass 4017 class myclass
3923 { 4018 {
3924 ev::io io ; void io_cb (ev::io &w, int revents); 4019 ev::io io ; void io_cb (ev::io &w, int revents);
3925 ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4020 ev::io io2 ; void io2_cb (ev::io &w, int revents);
3926 ev::idle idle; void idle_cb (ev::idle &w, int revents); 4021 ev::idle idle; void idle_cb (ev::idle &w, int revents);
3927 4022
3928 myclass (int fd) 4023 myclass (int fd)
3929 { 4024 {
3930 io .set <myclass, &myclass::io_cb > (this); 4025 io .set <myclass, &myclass::io_cb > (this);
3981L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. 4076L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3982 4077
3983=item D 4078=item D
3984 4079
3985Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 4080Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3986be found at L<http://proj.llucax.com.ar/wiki/evd>. 4081be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3987 4082
3988=item Ocaml 4083=item Ocaml
3989 4084
3990Erkki Seppala has written Ocaml bindings for libev, to be found at 4085Erkki Seppala has written Ocaml bindings for libev, to be found at
3991L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 4086L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
4039suitable for use with C<EV_A>. 4134suitable for use with C<EV_A>.
4040 4135
4041=item C<EV_DEFAULT>, C<EV_DEFAULT_> 4136=item C<EV_DEFAULT>, C<EV_DEFAULT_>
4042 4137
4043Similar to the other two macros, this gives you the value of the default 4138Similar to the other two macros, this gives you the value of the default
4044loop, if multiple loops are supported ("ev loop default"). 4139loop, if multiple loops are supported ("ev loop default"). The default loop
4140will be initialised if it isn't already initialised.
4141
4142For non-multiplicity builds, these macros do nothing, so you always have
4143to initialise the loop somewhere.
4045 4144
4046=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> 4145=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
4047 4146
4048Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the 4147Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
4049default loop has been initialised (C<UC> == unchecked). Their behaviour 4148default loop has been initialised (C<UC> == unchecked). Their behaviour
4194supported). It will also not define any of the structs usually found in 4293supported). It will also not define any of the structs usually found in
4195F<event.h> that are not directly supported by the libev core alone. 4294F<event.h> that are not directly supported by the libev core alone.
4196 4295
4197In standalone mode, libev will still try to automatically deduce the 4296In standalone mode, libev will still try to automatically deduce the
4198configuration, but has to be more conservative. 4297configuration, but has to be more conservative.
4298
4299=item EV_USE_FLOOR
4300
4301If defined to be C<1>, libev will use the C<floor ()> function for its
4302periodic reschedule calculations, otherwise libev will fall back on a
4303portable (slower) implementation. If you enable this, you usually have to
4304link against libm or something equivalent. Enabling this when the C<floor>
4305function is not available will fail, so the safe default is to not enable
4306this.
4199 4307
4200=item EV_USE_MONOTONIC 4308=item EV_USE_MONOTONIC
4201 4309
4202If defined to be C<1>, libev will try to detect the availability of the 4310If defined to be C<1>, libev will try to detect the availability of the
4203monotonic clock option at both compile time and runtime. Otherwise no 4311monotonic clock option at both compile time and runtime. Otherwise no
4336indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4444indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4337 4445
4338=item EV_ATOMIC_T 4446=item EV_ATOMIC_T
4339 4447
4340Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4448Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4341access is atomic with respect to other threads or signal contexts. No such 4449access is atomic and serialised with respect to other threads or signal
4342type is easily found in the C language, so you can provide your own type 4450contexts. No such type is easily found in the C language, so you can
4343that you know is safe for your purposes. It is used both for signal handler "locking" 4451provide your own type that you know is safe for your purposes. It is used
4344as well as for signal and thread safety in C<ev_async> watchers. 4452both for signal handler "locking" as well as for signal and thread safety
4453in C<ev_async> watchers.
4345 4454
4346In the absence of this define, libev will use C<sig_atomic_t volatile> 4455In the absence of this define, libev will use C<sig_atomic_t volatile>
4347(from F<signal.h>), which is usually good enough on most platforms. 4456(from F<signal.h>), which is usually good enough on most platforms,
4457although strictly speaking using a type that also implies a memory fence
4458is required.
4348 4459
4349=item EV_H (h) 4460=item EV_H (h)
4350 4461
4351The name of the F<ev.h> header file used to include it. The default if 4462The name of the F<ev.h> header file used to include it. The default if
4352undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 4463undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
4375If undefined or defined to C<1>, then all event-loop-specific functions 4486If undefined or defined to C<1>, then all event-loop-specific functions
4376will have the C<struct ev_loop *> as first argument, and you can create 4487will have the C<struct ev_loop *> as first argument, and you can create
4377additional independent event loops. Otherwise there will be no support 4488additional independent event loops. Otherwise there will be no support
4378for multiple event loops and there is no first event loop pointer 4489for multiple event loops and there is no first event loop pointer
4379argument. Instead, all functions act on the single default loop. 4490argument. Instead, all functions act on the single default loop.
4491
4492Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
4493default loop when multiplicity is switched off - you always have to
4494initialise the loop manually in this case.
4380 4495
4381=item EV_MINPRI 4496=item EV_MINPRI
4382 4497
4383=item EV_MAXPRI 4498=item EV_MAXPRI
4384 4499
4871requires, and its I/O model is fundamentally incompatible with the POSIX 4986requires, and its I/O model is fundamentally incompatible with the POSIX
4872model. Libev still offers limited functionality on this platform in 4987model. Libev still offers limited functionality on this platform in
4873the form of the C<EVBACKEND_SELECT> backend, and only supports socket 4988the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4874descriptors. This only applies when using Win32 natively, not when using 4989descriptors. This only applies when using Win32 natively, not when using
4875e.g. cygwin. Actually, it only applies to the microsofts own compilers, 4990e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4876as every compielr comes with a slightly differently broken/incompatible 4991as every compiler comes with a slightly differently broken/incompatible
4877environment. 4992environment.
4878 4993
4879Lifting these limitations would basically require the full 4994Lifting these limitations would basically require the full
4880re-implementation of the I/O system. If you are into this kind of thing, 4995re-implementation of the I/O system. If you are into this kind of thing,
4881then note that glib does exactly that for you in a very portable way (note 4996then note that glib does exactly that for you in a very portable way (note
5014 5129
5015The type C<double> is used to represent timestamps. It is required to 5130The type C<double> is used to represent timestamps. It is required to
5016have at least 51 bits of mantissa (and 9 bits of exponent), which is 5131have at least 51 bits of mantissa (and 9 bits of exponent), which is
5017good enough for at least into the year 4000 with millisecond accuracy 5132good enough for at least into the year 4000 with millisecond accuracy
5018(the design goal for libev). This requirement is overfulfilled by 5133(the design goal for libev). This requirement is overfulfilled by
5019implementations using IEEE 754, which is basically all existing ones. With 5134implementations using IEEE 754, which is basically all existing ones.
5135
5020IEEE 754 doubles, you get microsecond accuracy until at least 2200. 5136With IEEE 754 doubles, you get microsecond accuracy until at least the
5137year 2255 (and millisecond accuracy till the year 287396 - by then, libev
5138is either obsolete or somebody patched it to use C<long double> or
5139something like that, just kidding).
5021 5140
5022=back 5141=back
5023 5142
5024If you know of other additional requirements drop me a note. 5143If you know of other additional requirements drop me a note.
5025 5144
5087=item Processing ev_async_send: O(number_of_async_watchers) 5206=item Processing ev_async_send: O(number_of_async_watchers)
5088 5207
5089=item Processing signals: O(max_signal_number) 5208=item Processing signals: O(max_signal_number)
5090 5209
5091Sending involves a system call I<iff> there were no other C<ev_async_send> 5210Sending involves a system call I<iff> there were no other C<ev_async_send>
5092calls in the current loop iteration. Checking for async and signal events 5211calls in the current loop iteration and the loop is currently
5212blocked. Checking for async and signal events involves iterating over all
5093involves iterating over all running async watchers or all signal numbers. 5213running async watchers or all signal numbers.
5094 5214
5095=back 5215=back
5096 5216
5097 5217
5098=head1 PORTING FROM LIBEV 3.X TO 4.X 5218=head1 PORTING FROM LIBEV 3.X TO 4.X
5215The physical time that is observed. It is apparently strictly monotonic :) 5335The physical time that is observed. It is apparently strictly monotonic :)
5216 5336
5217=item wall-clock time 5337=item wall-clock time
5218 5338
5219The time and date as shown on clocks. Unlike real time, it can actually 5339The time and date as shown on clocks. Unlike real time, it can actually
5220be wrong and jump forwards and backwards, e.g. when the you adjust your 5340be wrong and jump forwards and backwards, e.g. when you adjust your
5221clock. 5341clock.
5222 5342
5223=item watcher 5343=item watcher
5224 5344
5225A data structure that describes interest in certain events. Watchers need 5345A data structure that describes interest in certain events. Watchers need
5228=back 5348=back
5229 5349
5230=head1 AUTHOR 5350=head1 AUTHOR
5231 5351
5232Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael 5352Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5233Magnusson and Emanuele Giaquinta. 5353Magnusson and Emanuele Giaquinta, and minor corrections by many others.
5234 5354

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines