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

Comparing libev/ev.pod (file contents):
Revision 1.368 by root, Thu Apr 14 23:02:33 2011 UTC vs.
Revision 1.388 by root, Tue Dec 20 04:08:35 2011 UTC

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.
4990.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
500forks 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
501set, which can take considerable time (one syscall per file descriptor) 507set, which can take considerable time (one syscall per file descriptor)
502and is of course hard to detect. 508and is of course hard to detect.
503 509
504Epoll is also notoriously buggy - embedding epoll fds I<should> work, but 510Epoll is also notoriously buggy - embedding epoll fds I<should> work,
505of 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
506I<different> file descriptors (even already closed ones, so one cannot 512totally I<different> file descriptors (even already closed ones, so
507even remove them from the set) than registered in the set (especially 513one cannot even remove them from the set) than registered in the set
508on SMP systems). Libev tries to counter these spurious notifications by 514(especially on SMP systems). Libev tries to counter these spurious
509employing an additional generation counter and comparing that against the 515notifications by employing an additional generation counter and comparing
510events 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
511not 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
512perfectly fine with C<select> (files, many character devices...). 521perfectly fine with C<select> (files, many character devices...).
513 522
514Epoll is truly the train wreck analog among event poll mechanisms, 523Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
515a frankenpoll, cobbled together in a hurry, no thought to design or 524cobbled together in a hurry, no thought to design or interaction with
516interaction with others. 525others. Oh, the pain, will it ever stop...
517 526
518While 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
519will 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
520incident (because the same I<file descriptor> could point to a different 529incident (because the same I<file descriptor> could point to a different
521I<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
599among the OS-specific backends (I vastly prefer correctness over speed 608among the OS-specific backends (I vastly prefer correctness over speed
600hacks). 609hacks).
601 610
602On the negative side, the interface is I<bizarre> - so bizarre that 611On the negative side, the interface is I<bizarre> - so bizarre that
603even 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
604function sometimes returning events to the caller even though an error 613function sometimes returns events to the caller even though an error
605occurred, 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
606even documented that way) - deadly for edge-triggered interfaces where 615even documented that way) - deadly for edge-triggered interfaces where you
607you 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
608have to re-arm the watcher. 617to re-arm the watcher.
609 618
610Fortunately libev seems to be able to work around these idiocies. 619Fortunately libev seems to be able to work around these idiocies.
611 620
612This 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
613C<EVBACKEND_POLL>. 622C<EVBACKEND_POLL>.
825This 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
826with something not expressible using other libev watchers (i.e. "roll your 835with something not expressible using other libev watchers (i.e. "roll your
827own 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
828usually a better approach for this kind of thing. 837usually a better approach for this kind of thing.
829 838
830Here 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):
831 842
832 - Increment loop depth. 843 - Increment loop depth.
833 - Reset the ev_break status. 844 - Reset the ev_break status.
834 - Before the first iteration, call any pending watchers. 845 - Before the first iteration, call any pending watchers.
835 LOOP: 846 LOOP:
941overhead for the actual polling but can deliver many events at once. 952overhead for the actual polling but can deliver many events at once.
942 953
943By 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
944time 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,
945at the cost of increasing latency. Timeouts (both C<ev_periodic> and 956at the cost of increasing latency. Timeouts (both C<ev_periodic> and
946C<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
947introduce an additional C<ev_sleep ()> call into most loop iterations. The 958introduce an additional C<ev_sleep ()> call into most loop iterations. The
948sleep 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
949once per this interval, on average. 960once per this interval, on average (as long as the host time resolution is
961good enough).
950 962
951Likewise, by setting a higher I<timeout collect interval> you allow libev 963Likewise, by setting a higher I<timeout collect interval> you allow libev
952to spend more time collecting timeouts, at the expense of increased 964to spend more time collecting timeouts, at the expense of increased
953latency/jitter/inexactness (the watcher callback will be called 965latency/jitter/inexactness (the watcher callback will be called
954later). 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
1008can be done relatively simply by putting mutex_lock/unlock calls around 1020can be done relatively simply by putting mutex_lock/unlock calls around
1009each call to a libev function. 1021each call to a libev function.
1010 1022
1011However, 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
1012to 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
1013loop 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
1014I<release> and I<acquire> callbacks on the loop. 1026I<release> and I<acquire> callbacks on the loop.
1015 1027
1016When 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
1017suspended waiting for new events, and C<acquire> is called just 1029suspended waiting for new events, and C<acquire> is called just
1018afterwards. 1030afterwards.
1374 1386
1375=over 4 1387=over 4
1376 1388
1377=item initialiased 1389=item initialiased
1378 1390
1379Before 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
1380initialised. 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
1381C<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.
1382 1394
1383In this state it is simply some block of memory that is suitable for 1395In this state it is simply some block of memory that is suitable for
1384use in an event loop. It can be moved around, freed, reused etc. at 1396use in an event loop. It can be moved around, freed, reused etc. at
1759detecting time jumps is hard, and some inaccuracies are unavoidable (the 1771detecting time jumps is hard, and some inaccuracies are unavoidable (the
1760monotonic clock option helps a lot here). 1772monotonic clock option helps a lot here).
1761 1773
1762The 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
1763passed (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
1764might 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
1765same loop iteration then the ones with earlier time-out values are invoked 1778iteration then the ones with earlier time-out values are invoked before
1766before 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
1767no longer true when a callback calls C<ev_run> recursively). 1780longer true when a callback calls C<ev_run> recursively).
1768 1781
1769=head3 Be smart about timeouts 1782=head3 Be smart about timeouts
1770 1783
1771Many real-world problems involve some kind of timeout, usually for error 1784Many real-world problems involve some kind of timeout, usually for error
1772recovery. 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,
1847 1860
1848In this case, it would be more efficient to leave the C<ev_timer> alone, 1861In this case, it would be more efficient to leave the C<ev_timer> alone,
1849but remember the time of last activity, and check for a real timeout only 1862but remember the time of last activity, and check for a real timeout only
1850within the callback: 1863within the callback:
1851 1864
1865 ev_tstamp timeout = 60.;
1852 ev_tstamp last_activity; // time of last activity 1866 ev_tstamp last_activity; // time of last activity
1867 ev_timer timer;
1853 1868
1854 static void 1869 static void
1855 callback (EV_P_ ev_timer *w, int revents) 1870 callback (EV_P_ ev_timer *w, int revents)
1856 { 1871 {
1857 ev_tstamp now = ev_now (EV_A); 1872 // calculate when the timeout would happen
1858 ev_tstamp timeout = last_activity + 60.; 1873 ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1859 1874
1860 // if last_activity + 60. is older than now, we did time out 1875 // if negative, it means we the timeout already occured
1861 if (timeout < now) 1876 if (after < 0.)
1862 { 1877 {
1863 // timeout occurred, take action 1878 // timeout occurred, take action
1864 } 1879 }
1865 else 1880 else
1866 { 1881 {
1867 // callback was invoked, but there was some activity, re-arm 1882 // callback was invoked, but there was some recent
1868 // the watcher to fire in last_activity + 60, which is 1883 // activity. simply restart the timer to time out
1869 // guaranteed to be in the future, so "again" is positive: 1884 // after "after" seconds, which is the earliest time
1870 w->repeat = timeout - now; 1885 // the timeout can occur.
1886 ev_timer_set (w, after, 0.);
1871 ev_timer_again (EV_A_ w); 1887 ev_timer_start (EV_A_ w);
1872 } 1888 }
1873 } 1889 }
1874 1890
1875To summarise the callback: first calculate the real timeout (defined 1891To summarise the callback: first calculate in how many seconds the
1876as "60 seconds after the last activity"), then check if that time has 1892timeout will occur (by calculating the absolute time when it would occur,
1877been reached, which means something I<did>, in fact, time out. Otherwise 1893C<last_activity + timeout>, and subtracting the current time, C<ev_now
1878the callback was invoked too early (C<timeout> is in the future), so 1894(EV_A)> from that).
1879re-schedule the timer to fire at that future time, to see if maybe we have
1880a timeout then.
1881 1895
1882Note how C<ev_timer_again> is used, taking advantage of the 1896If this value is negative, then we are already past the timeout, i.e. we
1883C<ev_timer_again> optimisation when the timer is already running. 1897timed out, and need to do whatever is needed in this case.
1898
1899Otherwise, we now the earliest time at which the timeout would trigger,
1900and simply start the timer with this timeout value.
1901
1902In other words, each time the callback is invoked it will check whether
1903the timeout cocured. If not, it will simply reschedule itself to check
1904again at the earliest time it could time out. Rinse. Repeat.
1884 1905
1885This scheme causes more callback invocations (about one every 60 seconds 1906This scheme causes more callback invocations (about one every 60 seconds
1886minus half the average time between activity), but virtually no calls to 1907minus half the average time between activity), but virtually no calls to
1887libev to change the timeout. 1908libev to change the timeout.
1888 1909
1889To start the timer, simply initialise the watcher and set C<last_activity> 1910To start the machinery, simply initialise the watcher and set
1890to the current time (meaning we just have some activity :), then call the 1911C<last_activity> to the current time (meaning there was some activity just
1891callback, which will "do the right thing" and start the timer: 1912now), then call the callback, which will "do the right thing" and start
1913the timer:
1892 1914
1915 last_activity = ev_now (EV_A);
1893 ev_init (timer, callback); 1916 ev_init (&timer, callback);
1894 last_activity = ev_now (loop); 1917 callback (EV_A_ &timer, 0);
1895 callback (loop, timer, EV_TIMER);
1896 1918
1897And when there is some activity, simply store the current time in 1919When there is some activity, simply store the current time in
1898C<last_activity>, no libev calls at all: 1920C<last_activity>, no libev calls at all:
1899 1921
1922 if (activity detected)
1900 last_activity = ev_now (loop); 1923 last_activity = ev_now (EV_A);
1924
1925When your timeout value changes, then the timeout can be changed by simply
1926providing a new value, stopping the timer and calling the callback, which
1927will agaion do the right thing (for example, time out immediately :).
1928
1929 timeout = new_value;
1930 ev_timer_stop (EV_A_ &timer);
1931 callback (EV_A_ &timer, 0);
1901 1932
1902This technique is slightly more complex, but in most cases where the 1933This technique is slightly more complex, but in most cases where the
1903time-out is unlikely to be triggered, much more efficient. 1934time-out is unlikely to be triggered, much more efficient.
1904
1905Changing the timeout is trivial as well (if it isn't hard-coded in the
1906callback :) - just change the timeout and invoke the callback, which will
1907fix things for you.
1908 1935
1909=item 4. Wee, just use a double-linked list for your timeouts. 1936=item 4. Wee, just use a double-linked list for your timeouts.
1910 1937
1911If there is not one request, but many thousands (millions...), all 1938If there is not one request, but many thousands (millions...), all
1912employing some kind of timeout with the same timeout value, then one can 1939employing some kind of timeout with the same timeout value, then one can
1939Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 1966Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1940rather complicated, but extremely efficient, something that really pays 1967rather complicated, but extremely efficient, something that really pays
1941off after the first million or so of active timers, i.e. it's usually 1968off after the first million or so of active timers, i.e. it's usually
1942overkill :) 1969overkill :)
1943 1970
1971=head3 The special problem of being too early
1972
1973If you ask a timer to call your callback after three seconds, then
1974you expect it to be invoked after three seconds - but of course, this
1975cannot be guaranteed to infinite precision. Less obviously, it cannot be
1976guaranteed to any precision by libev - imagine somebody suspending the
1977process with a STOP signal for a few hours for example.
1978
1979So, libev tries to invoke your callback as soon as possible I<after> the
1980delay has occurred, but cannot guarantee this.
1981
1982A less obvious failure mode is calling your callback too early: many event
1983loops compare timestamps with a "elapsed delay >= requested delay", but
1984this can cause your callback to be invoked much earlier than you would
1985expect.
1986
1987To see why, imagine a system with a clock that only offers full second
1988resolution (think windows if you can't come up with a broken enough OS
1989yourself). If you schedule a one-second timer at the time 500.9, then the
1990event loop will schedule your timeout to elapse at a system time of 500
1991(500.9 truncated to the resolution) + 1, or 501.
1992
1993If an event library looks at the timeout 0.1s later, it will see "501 >=
1994501" and invoke the callback 0.1s after it was started, even though a
1995one-second delay was requested - this is being "too early", despite best
1996intentions.
1997
1998This is the reason why libev will never invoke the callback if the elapsed
1999delay equals the requested delay, but only when the elapsed delay is
2000larger than the requested delay. In the example above, libev would only invoke
2001the callback at system time 502, or 1.1s after the timer was started.
2002
2003So, while libev cannot guarantee that your callback will be invoked
2004exactly when requested, it I<can> and I<does> guarantee that the requested
2005delay has actually elapsed, or in other words, it always errs on the "too
2006late" side of things.
2007
1944=head3 The special problem of time updates 2008=head3 The special problem of time updates
1945 2009
1946Establishing the current time is a costly operation (it usually takes at 2010Establishing the current time is a costly operation (it usually takes
1947least two system calls): EV therefore updates its idea of the current 2011at least one system call): EV therefore updates its idea of the current
1948time only before and after C<ev_run> collects new events, which causes a 2012time only before and after C<ev_run> collects new events, which causes a
1949growing difference between C<ev_now ()> and C<ev_time ()> when handling 2013growing difference between C<ev_now ()> and C<ev_time ()> when handling
1950lots of events in one iteration. 2014lots of events in one iteration.
1951 2015
1952The relative timeouts are calculated relative to the C<ev_now ()> 2016The relative timeouts are calculated relative to the C<ev_now ()>
1958 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2022 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1959 2023
1960If the event loop is suspended for a long time, you can also force an 2024If the event loop is suspended for a long time, you can also force an
1961update of the time returned by C<ev_now ()> by calling C<ev_now_update 2025update of the time returned by C<ev_now ()> by calling C<ev_now_update
1962()>. 2026()>.
2027
2028=head3 The special problem of unsynchronised clocks
2029
2030Modern systems have a variety of clocks - libev itself uses the normal
2031"wall clock" clock and, if available, the monotonic clock (to avoid time
2032jumps).
2033
2034Neither of these clocks is synchronised with each other or any other clock
2035on the system, so C<ev_time ()> might return a considerably different time
2036than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
2037a call to C<gettimeofday> might return a second count that is one higher
2038than a directly following call to C<time>.
2039
2040The moral of this is to only compare libev-related timestamps with
2041C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
2042a second or so.
2043
2044One more problem arises due to this lack of synchronisation: if libev uses
2045the system monotonic clock and you compare timestamps from C<ev_time>
2046or C<ev_now> from when you started your timer and when your callback is
2047invoked, you will find that sometimes the callback is a bit "early".
2048
2049This is because C<ev_timer>s work in real time, not wall clock time, so
2050libev makes sure your callback is not invoked before the delay happened,
2051I<measured according to the real time>, not the system clock.
2052
2053If your timeouts are based on a physical timescale (e.g. "time out this
2054connection after 100 seconds") then this shouldn't bother you as it is
2055exactly the right behaviour.
2056
2057If you want to compare wall clock/system timestamps to your timers, then
2058you need to use C<ev_periodic>s, as these are based on the wall clock
2059time, where your comparisons will always generate correct results.
1963 2060
1964=head3 The special problems of suspended animation 2061=head3 The special problems of suspended animation
1965 2062
1966When you leave the server world it is quite customary to hit machines that 2063When you leave the server world it is quite customary to hit machines that
1967can suspend/hibernate - what happens to the clocks during such a suspend? 2064can suspend/hibernate - what happens to the clocks during such a suspend?
2011keep up with the timer (because it takes longer than those 10 seconds to 2108keep up with the timer (because it takes longer than those 10 seconds to
2012do stuff) the timer will not fire more than once per event loop iteration. 2109do stuff) the timer will not fire more than once per event loop iteration.
2013 2110
2014=item ev_timer_again (loop, ev_timer *) 2111=item ev_timer_again (loop, ev_timer *)
2015 2112
2016This will act as if the timer timed out and restart it again if it is 2113This will act as if the timer timed out and restarts it again if it is
2017repeating. The exact semantics are: 2114repeating. The exact semantics are:
2018 2115
2019If the timer is pending, its pending status is cleared. 2116If the timer is pending, its pending status is cleared.
2020 2117
2021If the timer is started but non-repeating, stop it (as if it timed out). 2118If the timer is started but non-repeating, stop it (as if it timed out).
3208C<ev_async_sent> calls). In fact, you could use signal watchers as a kind 3305C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
3209of "global async watchers" by using a watcher on an otherwise unused 3306of "global async watchers" by using a watcher on an otherwise unused
3210signal, and C<ev_feed_signal> to signal this watcher from another thread, 3307signal, and C<ev_feed_signal> to signal this watcher from another thread,
3211even without knowing which loop owns the signal. 3308even without knowing which loop owns the signal.
3212 3309
3213Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3214just the default loop.
3215
3216=head3 Queueing 3310=head3 Queueing
3217 3311
3218C<ev_async> does not support queueing of data in any way. The reason 3312C<ev_async> does not support queueing of data in any way. The reason
3219is that the author does not know of a simple (or any) algorithm for a 3313is that the author does not know of a simple (or any) algorithm for a
3220multiple-writer-single-reader queue that works in all cases and doesn't 3314multiple-writer-single-reader queue that works in all cases and doesn't
3319Unlike C<ev_feed_event>, this call is safe to do from other threads, 3413Unlike C<ev_feed_event>, this call is safe to do from other threads,
3320signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the 3414signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3321embedding section below on what exactly this means). 3415embedding section below on what exactly this means).
3322 3416
3323Note that, as with other watchers in libev, multiple events might get 3417Note that, as with other watchers in libev, multiple events might get
3324compressed into a single callback invocation (another way to look at this 3418compressed into a single callback invocation (another way to look at
3325is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, 3419this is that C<ev_async> watchers are level-triggered: they are set on
3326reset when the event loop detects that). 3420C<ev_async_send>, reset when the event loop detects that).
3327 3421
3328This call incurs the overhead of a system call only once per event loop 3422This call incurs the overhead of at most one extra system call per event
3329iteration, so while the overhead might be noticeable, it doesn't apply to 3423loop iteration, if the event loop is blocked, and no syscall at all if
3330repeated calls to C<ev_async_send> for the same event loop. 3424the event loop (or your program) is processing events. That means that
3425repeated calls are basically free (there is no need to avoid calls for
3426performance reasons) and that the overhead becomes smaller (typically
3427zero) under load.
3331 3428
3332=item bool = ev_async_pending (ev_async *) 3429=item bool = ev_async_pending (ev_async *)
3333 3430
3334Returns a non-zero value when C<ev_async_send> has been called on the 3431Returns a non-zero value when C<ev_async_send> has been called on the
3335watcher but the event has not yet been processed (or even noted) by the 3432watcher but the event has not yet been processed (or even noted) by the
3390 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3487 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3391 3488
3392=item ev_feed_fd_event (loop, int fd, int revents) 3489=item ev_feed_fd_event (loop, int fd, int revents)
3393 3490
3394Feed an event on the given fd, as if a file descriptor backend detected 3491Feed an event on the given fd, as if a file descriptor backend detected
3395the given events it. 3492the given events.
3396 3493
3397=item ev_feed_signal_event (loop, int signum) 3494=item ev_feed_signal_event (loop, int signum)
3398 3495
3399Feed an event as if the given signal occurred. See also C<ev_feed_signal>, 3496Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3400which is async-safe. 3497which is async-safe.
3473 t2_cb (EV_P_ ev_timer *w, int revents) 3570 t2_cb (EV_P_ ev_timer *w, int revents)
3474 { 3571 {
3475 struct my_biggy big = (struct my_biggy *) 3572 struct my_biggy big = (struct my_biggy *)
3476 (((char *)w) - offsetof (struct my_biggy, t2)); 3573 (((char *)w) - offsetof (struct my_biggy, t2));
3477 } 3574 }
3575
3576=head2 AVOIDING FINISHING BEFORE RETURNING
3577
3578Often you have structures like this in event-based programs:
3579
3580 callback ()
3581 {
3582 free (request);
3583 }
3584
3585 request = start_new_request (..., callback);
3586
3587The intent is to start some "lengthy" operation. The C<request> could be
3588used to cancel the operation, or do other things with it.
3589
3590It's not uncommon to have code paths in C<start_new_request> that
3591immediately invoke the callback, for example, to report errors. Or you add
3592some caching layer that finds that it can skip the lengthy aspects of the
3593operation and simply invoke the callback with the result.
3594
3595The problem here is that this will happen I<before> C<start_new_request>
3596has returned, so C<request> is not set.
3597
3598Even if you pass the request by some safer means to the callback, you
3599might want to do something to the request after starting it, such as
3600canceling it, which probably isn't working so well when the callback has
3601already been invoked.
3602
3603A common way around all these issues is to make sure that
3604C<start_new_request> I<always> returns before the callback is invoked. If
3605C<start_new_request> immediately knows the result, it can artificially
3606delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher
3607for example, or more sneakily, by reusing an existing (stopped) watcher
3608and pushing it into the pending queue:
3609
3610 ev_set_cb (watcher, callback);
3611 ev_feed_event (EV_A_ watcher, 0);
3612
3613This way, C<start_new_request> can safely return before the callback is
3614invoked, while not delaying callback invocation too much.
3478 3615
3479=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS 3616=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
3480 3617
3481Often (especially in GUI toolkits) there are places where you have 3618Often (especially in GUI toolkits) there are places where you have
3482I<modal> interaction, which is most easily implemented by recursively 3619I<modal> interaction, which is most easily implemented by recursively
3932watchers in the constructor. 4069watchers in the constructor.
3933 4070
3934 class myclass 4071 class myclass
3935 { 4072 {
3936 ev::io io ; void io_cb (ev::io &w, int revents); 4073 ev::io io ; void io_cb (ev::io &w, int revents);
3937 ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4074 ev::io io2 ; void io2_cb (ev::io &w, int revents);
3938 ev::idle idle; void idle_cb (ev::idle &w, int revents); 4075 ev::idle idle; void idle_cb (ev::idle &w, int revents);
3939 4076
3940 myclass (int fd) 4077 myclass (int fd)
3941 { 4078 {
3942 io .set <myclass, &myclass::io_cb > (this); 4079 io .set <myclass, &myclass::io_cb > (this);
3993L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. 4130L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3994 4131
3995=item D 4132=item D
3996 4133
3997Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 4134Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3998be found at L<http://proj.llucax.com.ar/wiki/evd>. 4135be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3999 4136
4000=item Ocaml 4137=item Ocaml
4001 4138
4002Erkki Seppala has written Ocaml bindings for libev, to be found at 4139Erkki Seppala has written Ocaml bindings for libev, to be found at
4003L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 4140L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
4051suitable for use with C<EV_A>. 4188suitable for use with C<EV_A>.
4052 4189
4053=item C<EV_DEFAULT>, C<EV_DEFAULT_> 4190=item C<EV_DEFAULT>, C<EV_DEFAULT_>
4054 4191
4055Similar to the other two macros, this gives you the value of the default 4192Similar to the other two macros, this gives you the value of the default
4056loop, if multiple loops are supported ("ev loop default"). 4193loop, if multiple loops are supported ("ev loop default"). The default loop
4194will be initialised if it isn't already initialised.
4195
4196For non-multiplicity builds, these macros do nothing, so you always have
4197to initialise the loop somewhere.
4057 4198
4058=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> 4199=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
4059 4200
4060Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the 4201Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
4061default loop has been initialised (C<UC> == unchecked). Their behaviour 4202default loop has been initialised (C<UC> == unchecked). Their behaviour
4357indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4498indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4358 4499
4359=item EV_ATOMIC_T 4500=item EV_ATOMIC_T
4360 4501
4361Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4502Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4362access is atomic with respect to other threads or signal contexts. No such 4503access is atomic and serialised with respect to other threads or signal
4363type is easily found in the C language, so you can provide your own type 4504contexts. No such type is easily found in the C language, so you can
4364that you know is safe for your purposes. It is used both for signal handler "locking" 4505provide your own type that you know is safe for your purposes. It is used
4365as well as for signal and thread safety in C<ev_async> watchers. 4506both for signal handler "locking" as well as for signal and thread safety
4507in C<ev_async> watchers.
4366 4508
4367In the absence of this define, libev will use C<sig_atomic_t volatile> 4509In the absence of this define, libev will use C<sig_atomic_t volatile>
4368(from F<signal.h>), which is usually good enough on most platforms. 4510(from F<signal.h>), which is usually good enough on most platforms,
4511although strictly speaking using a type that also implies a memory fence
4512is required.
4369 4513
4370=item EV_H (h) 4514=item EV_H (h)
4371 4515
4372The name of the F<ev.h> header file used to include it. The default if 4516The name of the F<ev.h> header file used to include it. The default if
4373undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 4517undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
4397will have the C<struct ev_loop *> as first argument, and you can create 4541will have the C<struct ev_loop *> as first argument, and you can create
4398additional independent event loops. Otherwise there will be no support 4542additional independent event loops. Otherwise there will be no support
4399for multiple event loops and there is no first event loop pointer 4543for multiple event loops and there is no first event loop pointer
4400argument. Instead, all functions act on the single default loop. 4544argument. Instead, all functions act on the single default loop.
4401 4545
4546Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
4547default loop when multiplicity is switched off - you always have to
4548initialise the loop manually in this case.
4549
4402=item EV_MINPRI 4550=item EV_MINPRI
4403 4551
4404=item EV_MAXPRI 4552=item EV_MAXPRI
4405 4553
4406The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to 4554The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
4503 4651
4504With an intelligent-enough linker (gcc+binutils are intelligent enough 4652With an intelligent-enough linker (gcc+binutils are intelligent enough
4505when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by 4653when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
4506your program might be left out as well - a binary starting a timer and an 4654your program might be left out as well - a binary starting a timer and an
4507I/O watcher then might come out at only 5Kb. 4655I/O watcher then might come out at only 5Kb.
4656
4657=item EV_API_STATIC
4658
4659If this symbol is defined (by default it is not), then all identifiers
4660will have static linkage. This means that libev will not export any
4661identifiers, and you cannot link against libev anymore. This can be useful
4662when you embed libev, only want to use libev functions in a single file,
4663and do not want its identifiers to be visible.
4664
4665To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
4666wants to use libev.
4508 4667
4509=item EV_AVOID_STDIO 4668=item EV_AVOID_STDIO
4510 4669
4511If this is set to C<1> at compiletime, then libev will avoid using stdio 4670If this is set to C<1> at compiletime, then libev will avoid using stdio
4512functions (printf, scanf, perror etc.). This will increase the code size 4671functions (printf, scanf, perror etc.). This will increase the code size
4892requires, and its I/O model is fundamentally incompatible with the POSIX 5051requires, and its I/O model is fundamentally incompatible with the POSIX
4893model. Libev still offers limited functionality on this platform in 5052model. Libev still offers limited functionality on this platform in
4894the form of the C<EVBACKEND_SELECT> backend, and only supports socket 5053the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4895descriptors. This only applies when using Win32 natively, not when using 5054descriptors. This only applies when using Win32 natively, not when using
4896e.g. cygwin. Actually, it only applies to the microsofts own compilers, 5055e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4897as every compielr comes with a slightly differently broken/incompatible 5056as every compiler comes with a slightly differently broken/incompatible
4898environment. 5057environment.
4899 5058
4900Lifting these limitations would basically require the full 5059Lifting these limitations would basically require the full
4901re-implementation of the I/O system. If you are into this kind of thing, 5060re-implementation of the I/O system. If you are into this kind of thing,
4902then note that glib does exactly that for you in a very portable way (note 5061then note that glib does exactly that for you in a very portable way (note
5035 5194
5036The type C<double> is used to represent timestamps. It is required to 5195The type C<double> is used to represent timestamps. It is required to
5037have at least 51 bits of mantissa (and 9 bits of exponent), which is 5196have at least 51 bits of mantissa (and 9 bits of exponent), which is
5038good enough for at least into the year 4000 with millisecond accuracy 5197good enough for at least into the year 4000 with millisecond accuracy
5039(the design goal for libev). This requirement is overfulfilled by 5198(the design goal for libev). This requirement is overfulfilled by
5040implementations using IEEE 754, which is basically all existing ones. With 5199implementations using IEEE 754, which is basically all existing ones.
5200
5041IEEE 754 doubles, you get microsecond accuracy until at least 2200. 5201With IEEE 754 doubles, you get microsecond accuracy until at least the
5202year 2255 (and millisecond accuracy till the year 287396 - by then, libev
5203is either obsolete or somebody patched it to use C<long double> or
5204something like that, just kidding).
5042 5205
5043=back 5206=back
5044 5207
5045If you know of other additional requirements drop me a note. 5208If you know of other additional requirements drop me a note.
5046 5209
5108=item Processing ev_async_send: O(number_of_async_watchers) 5271=item Processing ev_async_send: O(number_of_async_watchers)
5109 5272
5110=item Processing signals: O(max_signal_number) 5273=item Processing signals: O(max_signal_number)
5111 5274
5112Sending involves a system call I<iff> there were no other C<ev_async_send> 5275Sending involves a system call I<iff> there were no other C<ev_async_send>
5113calls in the current loop iteration. Checking for async and signal events 5276calls in the current loop iteration and the loop is currently
5277blocked. Checking for async and signal events involves iterating over all
5114involves iterating over all running async watchers or all signal numbers. 5278running async watchers or all signal numbers.
5115 5279
5116=back 5280=back
5117 5281
5118 5282
5119=head1 PORTING FROM LIBEV 3.X TO 4.X 5283=head1 PORTING FROM LIBEV 3.X TO 4.X

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines