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

Comparing libev/ev.pod (file contents):
Revision 1.370 by root, Thu Jun 2 23:42:40 2011 UTC vs.
Revision 1.432 by root, Sat Apr 26 14:28:48 2014 UTC

1=encoding utf-8
2
1=head1 NAME 3=head1 NAME
2 4
3libev - a high performance full-featured event loop written in C 5libev - a high performance full-featured event loop written in C
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
82 84
83=head1 WHAT TO READ WHEN IN A HURRY 85=head1 WHAT TO READ WHEN IN A HURRY
84 86
85This manual tries to be very detailed, but unfortunately, this also makes 87This manual tries to be very detailed, but unfortunately, this also makes
86it very long. If you just want to know the basics of libev, I suggest 88it very long. If you just want to know the basics of libev, I suggest
87reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and 89reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and
88look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and 90look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and
89C<ev_timer> sections in L<WATCHER TYPES>. 91C<ev_timer> sections in L</WATCHER TYPES>.
90 92
91=head1 ABOUT LIBEV 93=head1 ABOUT LIBEV
92 94
93Libev is an event loop: you register interest in certain events (such as a 95Libev is an event loop: you register interest in certain events (such as a
94file descriptor being readable or a timeout occurring), and it will manage 96file descriptor being readable or a timeout occurring), and it will manage
174=item ev_tstamp ev_time () 176=item ev_tstamp ev_time ()
175 177
176Returns the current time as libev would use it. Please note that the 178Returns 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 179C<ev_now> function is usually faster and also often returns the timestamp
178you actually want to know. Also interesting is the combination of 180you actually want to know. Also interesting is the combination of
179C<ev_update_now> and C<ev_now>. 181C<ev_now_update> and C<ev_now>.
180 182
181=item ev_sleep (ev_tstamp interval) 183=item ev_sleep (ev_tstamp interval)
182 184
183Sleep for the given interval: The current thread will be blocked until 185Sleep for the given interval: The current thread will be blocked
184either it is interrupted or the given time interval has passed. Basically 186until either it is interrupted or the given time interval has
187passed (approximately - it might return a bit earlier even if not
188interrupted). Returns immediately if C<< interval <= 0 >>.
189
185this is a sub-second-resolution C<sleep ()>. 190Basically this is a sub-second-resolution C<sleep ()>.
191
192The range of the C<interval> is limited - libev only guarantees to work
193with sleep times of up to one day (C<< interval <= 86400 >>).
186 194
187=item int ev_version_major () 195=item int ev_version_major ()
188 196
189=item int ev_version_minor () 197=item int ev_version_minor ()
190 198
241the current system, you would need to look at C<ev_embeddable_backends () 249the current system, you would need to look at C<ev_embeddable_backends ()
242& ev_supported_backends ()>, likewise for recommended ones. 250& ev_supported_backends ()>, likewise for recommended ones.
243 251
244See the description of C<ev_embed> watchers for more info. 252See the description of C<ev_embed> watchers for more info.
245 253
246=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 254=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
247 255
248Sets the allocation function to use (the prototype is similar - the 256Sets the allocation function to use (the prototype is similar - the
249semantics are identical to the C<realloc> C89/SuS/POSIX function). It is 257semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
250used to allocate and free memory (no surprises here). If it returns zero 258used to allocate and free memory (no surprises here). If it returns zero
251when memory needs to be allocated (C<size != 0>), the library might abort 259when memory needs to be allocated (C<size != 0>), the library might abort
277 } 285 }
278 286
279 ... 287 ...
280 ev_set_allocator (persistent_realloc); 288 ev_set_allocator (persistent_realloc);
281 289
282=item ev_set_syserr_cb (void (*cb)(const char *msg)) 290=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
283 291
284Set the callback function to call on a retryable system call error (such 292Set the callback function to call on a retryable system call error (such
285as failed select, poll, epoll_wait). The message is a printable string 293as failed select, poll, epoll_wait). The message is a printable string
286indicating the system call or subsystem causing the problem. If this 294indicating the system call or subsystem causing the problem. If this
287callback is set, then libev will expect it to remedy the situation, no 295callback is set, then libev will expect it to remedy the situation, no
390 398
391If this flag bit is or'ed into the flag value (or the program runs setuid 399If this flag bit is or'ed into the flag value (or the program runs setuid
392or setgid) then libev will I<not> look at the environment variable 400or setgid) then libev will I<not> look at the environment variable
393C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 401C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
394override the flags completely if it is found in the environment. This is 402override the flags completely if it is found in the environment. This is
395useful to try out specific backends to test their performance, or to work 403useful to try out specific backends to test their performance, to work
396around bugs. 404around bugs, or to make libev threadsafe (accessing environment variables
405cannot be done in a threadsafe way, but usually it works if no other
406thread modifies them).
397 407
398=item C<EVFLAG_FORKCHECK> 408=item C<EVFLAG_FORKCHECK>
399 409
400Instead of calling C<ev_loop_fork> manually after a fork, you can also 410Instead of calling C<ev_loop_fork> manually after a fork, you can also
401make libev check for a fork in each iteration by enabling this flag. 411make libev check for a fork in each iteration by enabling this flag.
435example) that can't properly initialise their signal masks. 445example) that can't properly initialise their signal masks.
436 446
437=item C<EVFLAG_NOSIGMASK> 447=item C<EVFLAG_NOSIGMASK>
438 448
439When this flag is specified, then libev will avoid to modify the signal 449When this flag is specified, then libev will avoid to modify the signal
440mask. Specifically, this means you ahve to make sure signals are unblocked 450mask. Specifically, this means you have to make sure signals are unblocked
441when you want to receive them. 451when you want to receive them.
442 452
443This behaviour is useful when you want to do your own signal handling, or 453This 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 454want to handle signals only in specific threads and want to avoid libev
445unblocking the signals. 455unblocking the signals.
506totally I<different> file descriptors (even already closed ones, so 516totally I<different> file descriptors (even already closed ones, so
507one cannot even remove them from the set) than registered in the set 517one cannot even remove them from the set) than registered in the set
508(especially on SMP systems). Libev tries to counter these spurious 518(especially on SMP systems). Libev tries to counter these spurious
509notifications by employing an additional generation counter and comparing 519notifications by employing an additional generation counter and comparing
510that against the events to filter out spurious ones, recreating the set 520that against the events to filter out spurious ones, recreating the set
511when required. Epoll also errornously rounds down timeouts, but gives you 521when required. Epoll also erroneously rounds down timeouts, but gives you
512no way to know when and by how much, so sometimes you have to busy-wait 522no way to know when and by how much, so sometimes you have to busy-wait
513because epoll returns immediately despite a nonzero timeout. And last 523because epoll returns immediately despite a nonzero timeout. And last
514not least, it also refuses to work with some file descriptors which work 524not least, it also refuses to work with some file descriptors which work
515perfectly fine with C<select> (files, many character devices...). 525perfectly fine with C<select> (files, many character devices...).
516 526
561 571
562It scales in the same way as the epoll backend, but the interface to the 572It scales in the same way as the epoll backend, but the interface to the
563kernel is more efficient (which says nothing about its actual speed, of 573kernel is more efficient (which says nothing about its actual speed, of
564course). While stopping, setting and starting an I/O watcher does never 574course). While stopping, setting and starting an I/O watcher does never
565cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to 575cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
566two event changes per incident. Support for C<fork ()> is very bad (but 576two event changes per incident. Support for C<fork ()> is very bad (you
567sane, unlike epoll) and it drops fds silently in similarly hard-to-detect 577might have to leak fd's on fork, but it's more sane than epoll) and it
568cases 578drops fds silently in similarly hard-to-detect cases.
569 579
570This backend usually performs well under most conditions. 580This backend usually performs well under most conditions.
571 581
572While nominally embeddable in other event loops, this doesn't work 582While nominally embeddable in other event loops, this doesn't work
573everywhere, so you might need to test for this. And since it is broken 583everywhere, so you might need to test for this. And since it is broken
602among the OS-specific backends (I vastly prefer correctness over speed 612among the OS-specific backends (I vastly prefer correctness over speed
603hacks). 613hacks).
604 614
605On the negative side, the interface is I<bizarre> - so bizarre that 615On the negative side, the interface is I<bizarre> - so bizarre that
606even sun itself gets it wrong in their code examples: The event polling 616even sun itself gets it wrong in their code examples: The event polling
607function sometimes returning events to the caller even though an error 617function sometimes returns events to the caller even though an error
608occurred, but with no indication whether it has done so or not (yes, it's 618occurred, but with no indication whether it has done so or not (yes, it's
609even documented that way) - deadly for edge-triggered interfaces where 619even documented that way) - deadly for edge-triggered interfaces where you
610you absolutely have to know whether an event occurred or not because you 620absolutely have to know whether an event occurred or not because you have
611have to re-arm the watcher. 621to re-arm the watcher.
612 622
613Fortunately libev seems to be able to work around these idiocies. 623Fortunately libev seems to be able to work around these idiocies.
614 624
615This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 625This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
616C<EVBACKEND_POLL>. 626C<EVBACKEND_POLL>.
678reinitialise the kernel state for backends that have one. Despite the 688reinitialise the kernel state for backends that have one. Despite the
679name, you can call it anytime, but it makes most sense after forking, in 689name, you can call it anytime, but it makes most sense after forking, in
680the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the 690the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the
681child before resuming or calling C<ev_run>. 691child before resuming or calling C<ev_run>.
682 692
683Again, you I<have> to call it on I<any> loop that you want to re-use after 693Again, you I<have> to call it on I<any> loop that you want to re-use after
684a fork, I<even if you do not plan to use the loop in the parent>. This is 694a fork, I<even if you do not plan to use the loop in the parent>. This is
685because some kernel interfaces *cough* I<kqueue> *cough* do funny things 695because some kernel interfaces *cough* I<kqueue> *cough* do funny things
686during fork. 696during fork.
687 697
688On the other hand, you only need to call this function in the child 698On the other hand, you only need to call this function in the child
758 768
759This function is rarely useful, but when some event callback runs for a 769This function is rarely useful, but when some event callback runs for a
760very long time without entering the event loop, updating libev's idea of 770very long time without entering the event loop, updating libev's idea of
761the current time is a good idea. 771the current time is a good idea.
762 772
763See also L<The special problem of time updates> in the C<ev_timer> section. 773See also L</The special problem of time updates> in the C<ev_timer> section.
764 774
765=item ev_suspend (loop) 775=item ev_suspend (loop)
766 776
767=item ev_resume (loop) 777=item ev_resume (loop)
768 778
786without a previous call to C<ev_suspend>. 796without a previous call to C<ev_suspend>.
787 797
788Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the 798Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
789event loop time (see C<ev_now_update>). 799event loop time (see C<ev_now_update>).
790 800
791=item ev_run (loop, int flags) 801=item bool ev_run (loop, int flags)
792 802
793Finally, this is it, the event handler. This function usually is called 803Finally, this is it, the event handler. This function usually is called
794after you have initialised all your watchers and you want to start 804after you have initialised all your watchers and you want to start
795handling events. It will ask the operating system for any new events, call 805handling events. It will ask the operating system for any new events, call
796the watcher callbacks, an then repeat the whole process indefinitely: This 806the watcher callbacks, and then repeat the whole process indefinitely: This
797is why event loops are called I<loops>. 807is why event loops are called I<loops>.
798 808
799If the flags argument is specified as C<0>, it will keep handling events 809If the flags argument is specified as C<0>, it will keep handling events
800until either no event watchers are active anymore or C<ev_break> was 810until either no event watchers are active anymore or C<ev_break> was
801called. 811called.
812
813The return value is false if there are no more active watchers (which
814usually means "all jobs done" or "deadlock"), and true in all other cases
815(which usually means " you should call C<ev_run> again").
802 816
803Please note that an explicit C<ev_break> is usually better than 817Please note that an explicit C<ev_break> is usually better than
804relying on all watchers to be stopped when deciding when a program has 818relying on all watchers to be stopped when deciding when a program has
805finished (especially in interactive programs), but having a program 819finished (especially in interactive programs), but having a program
806that automatically loops as long as it has to and no longer by virtue 820that automatically loops as long as it has to and no longer by virtue
807of relying on its watchers stopping correctly, that is truly a thing of 821of relying on its watchers stopping correctly, that is truly a thing of
808beauty. 822beauty.
809 823
810This function is also I<mostly> exception-safe - you can break out of 824This function is I<mostly> exception-safe - you can break out of a
811a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++ 825C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
812exception and so on. This does not decrement the C<ev_depth> value, nor 826exception and so on. This does not decrement the C<ev_depth> value, nor
813will it clear any outstanding C<EVBREAK_ONE> breaks. 827will it clear any outstanding C<EVBREAK_ONE> breaks.
814 828
815A flags value of C<EVRUN_NOWAIT> will look for new events, will handle 829A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
816those events and any already outstanding ones, but will not wait and 830those events and any already outstanding ones, but will not wait and
946overhead for the actual polling but can deliver many events at once. 960overhead for the actual polling but can deliver many events at once.
947 961
948By setting a higher I<io collect interval> you allow libev to spend more 962By setting a higher I<io collect interval> you allow libev to spend more
949time collecting I/O events, so you can handle more events per iteration, 963time collecting I/O events, so you can handle more events per iteration,
950at the cost of increasing latency. Timeouts (both C<ev_periodic> and 964at the cost of increasing latency. Timeouts (both C<ev_periodic> and
951C<ev_timer>) will be not affected. Setting this to a non-null value will 965C<ev_timer>) will not be affected. Setting this to a non-null value will
952introduce an additional C<ev_sleep ()> call into most loop iterations. The 966introduce an additional C<ev_sleep ()> call into most loop iterations. The
953sleep time ensures that libev will not poll for I/O events more often then 967sleep time ensures that libev will not poll for I/O events more often then
954once per this interval, on average. 968once per this interval, on average (as long as the host time resolution is
969good enough).
955 970
956Likewise, by setting a higher I<timeout collect interval> you allow libev 971Likewise, by setting a higher I<timeout collect interval> you allow libev
957to spend more time collecting timeouts, at the expense of increased 972to spend more time collecting timeouts, at the expense of increased
958latency/jitter/inexactness (the watcher callback will be called 973latency/jitter/inexactness (the watcher callback will be called
959later). C<ev_io> watchers will not be affected. Setting this to a non-null 974later). C<ev_io> watchers will not be affected. Setting this to a non-null
1005invoke the actual watchers inside another context (another thread etc.). 1020invoke the actual watchers inside another context (another thread etc.).
1006 1021
1007If you want to reset the callback, use C<ev_invoke_pending> as new 1022If you want to reset the callback, use C<ev_invoke_pending> as new
1008callback. 1023callback.
1009 1024
1010=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) 1025=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
1011 1026
1012Sometimes you want to share the same loop between multiple threads. This 1027Sometimes you want to share the same loop between multiple threads. This
1013can be done relatively simply by putting mutex_lock/unlock calls around 1028can be done relatively simply by putting mutex_lock/unlock calls around
1014each call to a libev function. 1029each call to a libev function.
1015 1030
1016However, C<ev_run> can run an indefinite time, so it is not feasible 1031However, C<ev_run> can run an indefinite time, so it is not feasible
1017to wait for it to return. One way around this is to wake up the event 1032to wait for it to return. One way around this is to wake up the event
1018loop via C<ev_break> and C<av_async_send>, another way is to set these 1033loop via C<ev_break> and C<ev_async_send>, another way is to set these
1019I<release> and I<acquire> callbacks on the loop. 1034I<release> and I<acquire> callbacks on the loop.
1020 1035
1021When set, then C<release> will be called just before the thread is 1036When set, then C<release> will be called just before the thread is
1022suspended waiting for new events, and C<acquire> is called just 1037suspended waiting for new events, and C<acquire> is called just
1023afterwards. 1038afterwards.
1163 1178
1164=item C<EV_PREPARE> 1179=item C<EV_PREPARE>
1165 1180
1166=item C<EV_CHECK> 1181=item C<EV_CHECK>
1167 1182
1168All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts 1183All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1169to gather new events, and all C<ev_check> watchers are invoked just after 1184gather new events, and all C<ev_check> watchers are queued (not invoked)
1170C<ev_run> has gathered them, but before it invokes any callbacks for any 1185just after C<ev_run> has gathered them, but before it queues any callbacks
1186for any received events. That means C<ev_prepare> watchers are the last
1187watchers invoked before the event loop sleeps or polls for new events, and
1188C<ev_check> watchers will be invoked before any other watchers of the same
1189or lower priority within an event loop iteration.
1190
1171received events. Callbacks of both watcher types can start and stop as 1191Callbacks of both watcher types can start and stop as many watchers as
1172many watchers as they want, and all of them will be taken into account 1192they want, and all of them will be taken into account (for example, a
1173(for example, a C<ev_prepare> watcher might start an idle watcher to keep 1193C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1174C<ev_run> from blocking). 1194blocking).
1175 1195
1176=item C<EV_EMBED> 1196=item C<EV_EMBED>
1177 1197
1178The embedded event loop specified in the C<ev_embed> watcher needs attention. 1198The embedded event loop specified in the C<ev_embed> watcher needs attention.
1179 1199
1302 1322
1303=item callback ev_cb (ev_TYPE *watcher) 1323=item callback ev_cb (ev_TYPE *watcher)
1304 1324
1305Returns the callback currently set on the watcher. 1325Returns the callback currently set on the watcher.
1306 1326
1307=item ev_cb_set (ev_TYPE *watcher, callback) 1327=item ev_set_cb (ev_TYPE *watcher, callback)
1308 1328
1309Change the callback. You can change the callback at virtually any time 1329Change the callback. You can change the callback at virtually any time
1310(modulo threads). 1330(modulo threads).
1311 1331
1312=item ev_set_priority (ev_TYPE *watcher, int priority) 1332=item ev_set_priority (ev_TYPE *watcher, int priority)
1330or might not have been clamped to the valid range. 1350or might not have been clamped to the valid range.
1331 1351
1332The default priority used by watchers when no priority has been set is 1352The default priority used by watchers when no priority has been set is
1333always C<0>, which is supposed to not be too high and not be too low :). 1353always C<0>, which is supposed to not be too high and not be too low :).
1334 1354
1335See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1355See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1336priorities. 1356priorities.
1337 1357
1338=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1358=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1339 1359
1340Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1360Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1365See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related 1385See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1366functions that do not need a watcher. 1386functions that do not need a watcher.
1367 1387
1368=back 1388=back
1369 1389
1370See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1390See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1371OWN COMPOSITE WATCHERS> idioms. 1391OWN COMPOSITE WATCHERS> idioms.
1372 1392
1373=head2 WATCHER STATES 1393=head2 WATCHER STATES
1374 1394
1375There are various watcher states mentioned throughout this manual - 1395There are various watcher states mentioned throughout this manual -
1377transition between them will be described in more detail - and while these 1397transition between them will be described in more detail - and while these
1378rules might look complicated, they usually do "the right thing". 1398rules might look complicated, they usually do "the right thing".
1379 1399
1380=over 4 1400=over 4
1381 1401
1382=item initialiased 1402=item initialised
1383 1403
1384Before a watcher can be registered with the event looop it has to be 1404Before a watcher can be registered with the event loop it has to be
1385initialised. This can be done with a call to C<ev_TYPE_init>, or calls to 1405initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1386C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. 1406C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1387 1407
1388In this state it is simply some block of memory that is suitable for 1408In this state it is simply some block of memory that is suitable for
1389use in an event loop. It can be moved around, freed, reused etc. at 1409use in an event loop. It can be moved around, freed, reused etc. at
1764detecting time jumps is hard, and some inaccuracies are unavoidable (the 1784detecting time jumps is hard, and some inaccuracies are unavoidable (the
1765monotonic clock option helps a lot here). 1785monotonic clock option helps a lot here).
1766 1786
1767The callback is guaranteed to be invoked only I<after> its timeout has 1787The callback is guaranteed to be invoked only I<after> its timeout has
1768passed (not I<at>, so on systems with very low-resolution clocks this 1788passed (not I<at>, so on systems with very low-resolution clocks this
1769might introduce a small delay). If multiple timers become ready during the 1789might introduce a small delay, see "the special problem of being too
1790early", below). If multiple timers become ready during the same loop
1770same loop iteration then the ones with earlier time-out values are invoked 1791iteration then the ones with earlier time-out values are invoked before
1771before ones of the same priority with later time-out values (but this is 1792ones of the same priority with later time-out values (but this is no
1772no longer true when a callback calls C<ev_run> recursively). 1793longer true when a callback calls C<ev_run> recursively).
1773 1794
1774=head3 Be smart about timeouts 1795=head3 Be smart about timeouts
1775 1796
1776Many real-world problems involve some kind of timeout, usually for error 1797Many real-world problems involve some kind of timeout, usually for error
1777recovery. A typical example is an HTTP request - if the other side hangs, 1798recovery. A typical example is an HTTP request - if the other side hangs,
1852 1873
1853In this case, it would be more efficient to leave the C<ev_timer> alone, 1874In this case, it would be more efficient to leave the C<ev_timer> alone,
1854but remember the time of last activity, and check for a real timeout only 1875but remember the time of last activity, and check for a real timeout only
1855within the callback: 1876within the callback:
1856 1877
1878 ev_tstamp timeout = 60.;
1857 ev_tstamp last_activity; // time of last activity 1879 ev_tstamp last_activity; // time of last activity
1880 ev_timer timer;
1858 1881
1859 static void 1882 static void
1860 callback (EV_P_ ev_timer *w, int revents) 1883 callback (EV_P_ ev_timer *w, int revents)
1861 { 1884 {
1862 ev_tstamp now = ev_now (EV_A); 1885 // calculate when the timeout would happen
1863 ev_tstamp timeout = last_activity + 60.; 1886 ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1864 1887
1865 // if last_activity + 60. is older than now, we did time out 1888 // if negative, it means we the timeout already occurred
1866 if (timeout < now) 1889 if (after < 0.)
1867 { 1890 {
1868 // timeout occurred, take action 1891 // timeout occurred, take action
1869 } 1892 }
1870 else 1893 else
1871 { 1894 {
1872 // callback was invoked, but there was some activity, re-arm 1895 // callback was invoked, but there was some recent
1873 // the watcher to fire in last_activity + 60, which is 1896 // activity. simply restart the timer to time out
1874 // guaranteed to be in the future, so "again" is positive: 1897 // after "after" seconds, which is the earliest time
1875 w->repeat = timeout - now; 1898 // the timeout can occur.
1899 ev_timer_set (w, after, 0.);
1876 ev_timer_again (EV_A_ w); 1900 ev_timer_start (EV_A_ w);
1877 } 1901 }
1878 } 1902 }
1879 1903
1880To summarise the callback: first calculate the real timeout (defined 1904To summarise the callback: first calculate in how many seconds the
1881as "60 seconds after the last activity"), then check if that time has 1905timeout will occur (by calculating the absolute time when it would occur,
1882been reached, which means something I<did>, in fact, time out. Otherwise 1906C<last_activity + timeout>, and subtracting the current time, C<ev_now
1883the callback was invoked too early (C<timeout> is in the future), so 1907(EV_A)> from that).
1884re-schedule the timer to fire at that future time, to see if maybe we have
1885a timeout then.
1886 1908
1887Note how C<ev_timer_again> is used, taking advantage of the 1909If this value is negative, then we are already past the timeout, i.e. we
1888C<ev_timer_again> optimisation when the timer is already running. 1910timed out, and need to do whatever is needed in this case.
1911
1912Otherwise, we now the earliest time at which the timeout would trigger,
1913and simply start the timer with this timeout value.
1914
1915In other words, each time the callback is invoked it will check whether
1916the timeout occurred. If not, it will simply reschedule itself to check
1917again at the earliest time it could time out. Rinse. Repeat.
1889 1918
1890This scheme causes more callback invocations (about one every 60 seconds 1919This scheme causes more callback invocations (about one every 60 seconds
1891minus half the average time between activity), but virtually no calls to 1920minus half the average time between activity), but virtually no calls to
1892libev to change the timeout. 1921libev to change the timeout.
1893 1922
1894To start the timer, simply initialise the watcher and set C<last_activity> 1923To start the machinery, simply initialise the watcher and set
1895to the current time (meaning we just have some activity :), then call the 1924C<last_activity> to the current time (meaning there was some activity just
1896callback, which will "do the right thing" and start the timer: 1925now), then call the callback, which will "do the right thing" and start
1926the timer:
1897 1927
1928 last_activity = ev_now (EV_A);
1898 ev_init (timer, callback); 1929 ev_init (&timer, callback);
1899 last_activity = ev_now (loop); 1930 callback (EV_A_ &timer, 0);
1900 callback (loop, timer, EV_TIMER);
1901 1931
1902And when there is some activity, simply store the current time in 1932When there is some activity, simply store the current time in
1903C<last_activity>, no libev calls at all: 1933C<last_activity>, no libev calls at all:
1904 1934
1935 if (activity detected)
1905 last_activity = ev_now (loop); 1936 last_activity = ev_now (EV_A);
1937
1938When your timeout value changes, then the timeout can be changed by simply
1939providing a new value, stopping the timer and calling the callback, which
1940will again do the right thing (for example, time out immediately :).
1941
1942 timeout = new_value;
1943 ev_timer_stop (EV_A_ &timer);
1944 callback (EV_A_ &timer, 0);
1906 1945
1907This technique is slightly more complex, but in most cases where the 1946This technique is slightly more complex, but in most cases where the
1908time-out is unlikely to be triggered, much more efficient. 1947time-out is unlikely to be triggered, much more efficient.
1909
1910Changing the timeout is trivial as well (if it isn't hard-coded in the
1911callback :) - just change the timeout and invoke the callback, which will
1912fix things for you.
1913 1948
1914=item 4. Wee, just use a double-linked list for your timeouts. 1949=item 4. Wee, just use a double-linked list for your timeouts.
1915 1950
1916If there is not one request, but many thousands (millions...), all 1951If there is not one request, but many thousands (millions...), all
1917employing some kind of timeout with the same timeout value, then one can 1952employing some kind of timeout with the same timeout value, then one can
1944Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 1979Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1945rather complicated, but extremely efficient, something that really pays 1980rather complicated, but extremely efficient, something that really pays
1946off after the first million or so of active timers, i.e. it's usually 1981off after the first million or so of active timers, i.e. it's usually
1947overkill :) 1982overkill :)
1948 1983
1984=head3 The special problem of being too early
1985
1986If you ask a timer to call your callback after three seconds, then
1987you expect it to be invoked after three seconds - but of course, this
1988cannot be guaranteed to infinite precision. Less obviously, it cannot be
1989guaranteed to any precision by libev - imagine somebody suspending the
1990process with a STOP signal for a few hours for example.
1991
1992So, libev tries to invoke your callback as soon as possible I<after> the
1993delay has occurred, but cannot guarantee this.
1994
1995A less obvious failure mode is calling your callback too early: many event
1996loops compare timestamps with a "elapsed delay >= requested delay", but
1997this can cause your callback to be invoked much earlier than you would
1998expect.
1999
2000To see why, imagine a system with a clock that only offers full second
2001resolution (think windows if you can't come up with a broken enough OS
2002yourself). If you schedule a one-second timer at the time 500.9, then the
2003event loop will schedule your timeout to elapse at a system time of 500
2004(500.9 truncated to the resolution) + 1, or 501.
2005
2006If an event library looks at the timeout 0.1s later, it will see "501 >=
2007501" and invoke the callback 0.1s after it was started, even though a
2008one-second delay was requested - this is being "too early", despite best
2009intentions.
2010
2011This is the reason why libev will never invoke the callback if the elapsed
2012delay equals the requested delay, but only when the elapsed delay is
2013larger than the requested delay. In the example above, libev would only invoke
2014the callback at system time 502, or 1.1s after the timer was started.
2015
2016So, while libev cannot guarantee that your callback will be invoked
2017exactly when requested, it I<can> and I<does> guarantee that the requested
2018delay has actually elapsed, or in other words, it always errs on the "too
2019late" side of things.
2020
1949=head3 The special problem of time updates 2021=head3 The special problem of time updates
1950 2022
1951Establishing the current time is a costly operation (it usually takes at 2023Establishing the current time is a costly operation (it usually takes
1952least two system calls): EV therefore updates its idea of the current 2024at least one system call): EV therefore updates its idea of the current
1953time only before and after C<ev_run> collects new events, which causes a 2025time only before and after C<ev_run> collects new events, which causes a
1954growing difference between C<ev_now ()> and C<ev_time ()> when handling 2026growing difference between C<ev_now ()> and C<ev_time ()> when handling
1955lots of events in one iteration. 2027lots of events in one iteration.
1956 2028
1957The relative timeouts are calculated relative to the C<ev_now ()> 2029The relative timeouts are calculated relative to the C<ev_now ()>
1963 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2035 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1964 2036
1965If the event loop is suspended for a long time, you can also force an 2037If the event loop is suspended for a long time, you can also force an
1966update of the time returned by C<ev_now ()> by calling C<ev_now_update 2038update of the time returned by C<ev_now ()> by calling C<ev_now_update
1967()>. 2039()>.
2040
2041=head3 The special problem of unsynchronised clocks
2042
2043Modern systems have a variety of clocks - libev itself uses the normal
2044"wall clock" clock and, if available, the monotonic clock (to avoid time
2045jumps).
2046
2047Neither of these clocks is synchronised with each other or any other clock
2048on the system, so C<ev_time ()> might return a considerably different time
2049than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
2050a call to C<gettimeofday> might return a second count that is one higher
2051than a directly following call to C<time>.
2052
2053The moral of this is to only compare libev-related timestamps with
2054C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
2055a second or so.
2056
2057One more problem arises due to this lack of synchronisation: if libev uses
2058the system monotonic clock and you compare timestamps from C<ev_time>
2059or C<ev_now> from when you started your timer and when your callback is
2060invoked, you will find that sometimes the callback is a bit "early".
2061
2062This is because C<ev_timer>s work in real time, not wall clock time, so
2063libev makes sure your callback is not invoked before the delay happened,
2064I<measured according to the real time>, not the system clock.
2065
2066If your timeouts are based on a physical timescale (e.g. "time out this
2067connection after 100 seconds") then this shouldn't bother you as it is
2068exactly the right behaviour.
2069
2070If you want to compare wall clock/system timestamps to your timers, then
2071you need to use C<ev_periodic>s, as these are based on the wall clock
2072time, where your comparisons will always generate correct results.
1968 2073
1969=head3 The special problems of suspended animation 2074=head3 The special problems of suspended animation
1970 2075
1971When you leave the server world it is quite customary to hit machines that 2076When you leave the server world it is quite customary to hit machines that
1972can suspend/hibernate - what happens to the clocks during such a suspend? 2077can suspend/hibernate - what happens to the clocks during such a suspend?
2016keep up with the timer (because it takes longer than those 10 seconds to 2121keep up with the timer (because it takes longer than those 10 seconds to
2017do stuff) the timer will not fire more than once per event loop iteration. 2122do stuff) the timer will not fire more than once per event loop iteration.
2018 2123
2019=item ev_timer_again (loop, ev_timer *) 2124=item ev_timer_again (loop, ev_timer *)
2020 2125
2021This will act as if the timer timed out and restart it again if it is 2126This will act as if the timer timed out, and restarts it again if it is
2022repeating. The exact semantics are: 2127repeating. It basically works like calling C<ev_timer_stop>, updating the
2128timeout to the C<repeat> value and calling C<ev_timer_start>.
2023 2129
2130The exact semantics are as in the following rules, all of which will be
2131applied to the watcher:
2132
2133=over 4
2134
2024If the timer is pending, its pending status is cleared. 2135=item If the timer is pending, the pending status is always cleared.
2025 2136
2026If the timer is started but non-repeating, stop it (as if it timed out). 2137=item If the timer is started but non-repeating, stop it (as if it timed
2138out, without invoking it).
2027 2139
2028If the timer is repeating, either start it if necessary (with the 2140=item If the timer is repeating, make the C<repeat> value the new timeout
2029C<repeat> value), or reset the running timer to the C<repeat> value. 2141and start the timer, if necessary.
2030 2142
2143=back
2144
2031This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2145This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2032usage example. 2146usage example.
2033 2147
2034=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2148=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2035 2149
2036Returns the remaining time until a timer fires. If the timer is active, 2150Returns the remaining time until a timer fires. If the timer is active,
2279 2393
2280 ev_periodic hourly_tick; 2394 ev_periodic hourly_tick;
2281 ev_periodic_init (&hourly_tick, clock_cb, 2395 ev_periodic_init (&hourly_tick, clock_cb,
2282 fmod (ev_now (loop), 3600.), 3600., 0); 2396 fmod (ev_now (loop), 3600.), 3600., 0);
2283 ev_periodic_start (loop, &hourly_tick); 2397 ev_periodic_start (loop, &hourly_tick);
2284 2398
2285 2399
2286=head2 C<ev_signal> - signal me when a signal gets signalled! 2400=head2 C<ev_signal> - signal me when a signal gets signalled!
2287 2401
2288Signal watchers will trigger an event when the process receives a specific 2402Signal watchers will trigger an event when the process receives a specific
2289signal one or more times. Even though signals are very asynchronous, libev 2403signal one or more times. Even though signals are very asynchronous, libev
2299only within the same loop, i.e. you can watch for C<SIGINT> in your 2413only within the same loop, i.e. you can watch for C<SIGINT> in your
2300default loop and for C<SIGIO> in another loop, but you cannot watch for 2414default loop and for C<SIGIO> in another loop, but you cannot watch for
2301C<SIGINT> in both the default loop and another loop at the same time. At 2415C<SIGINT> in both the default loop and another loop at the same time. At
2302the moment, C<SIGCHLD> is permanently tied to the default loop. 2416the moment, C<SIGCHLD> is permanently tied to the default loop.
2303 2417
2304When the first watcher gets started will libev actually register something 2418Only after the first watcher for a signal is started will libev actually
2305with the kernel (thus it coexists with your own signal handlers as long as 2419register something with the kernel. It thus coexists with your own signal
2306you don't register any with libev for the same signal). 2420handlers as long as you don't register any with libev for the same signal.
2307 2421
2308If possible and supported, libev will install its handlers with 2422If possible and supported, libev will install its handlers with
2309C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2423C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2310not be unduly interrupted. If you have a problem with system calls getting 2424not be unduly interrupted. If you have a problem with system calls getting
2311interrupted by signals you can block all signals in an C<ev_check> watcher 2425interrupted by signals you can block all signals in an C<ev_check> watcher
2496 2610
2497=head2 C<ev_stat> - did the file attributes just change? 2611=head2 C<ev_stat> - did the file attributes just change?
2498 2612
2499This watches a file system path for attribute changes. That is, it calls 2613This watches a file system path for attribute changes. That is, it calls
2500C<stat> on that path in regular intervals (or when the OS says it changed) 2614C<stat> on that path in regular intervals (or when the OS says it changed)
2501and sees if it changed compared to the last time, invoking the callback if 2615and sees if it changed compared to the last time, invoking the callback
2502it did. 2616if it did. Starting the watcher C<stat>'s the file, so only changes that
2617happen after the watcher has been started will be reported.
2503 2618
2504The path does not need to exist: changing from "path exists" to "path does 2619The path does not need to exist: changing from "path exists" to "path does
2505not exist" is a status change like any other. The condition "path does not 2620not exist" is a status change like any other. The condition "path does not
2506exist" (or more correctly "path cannot be stat'ed") is signified by the 2621exist" (or more correctly "path cannot be stat'ed") is signified by the
2507C<st_nlink> field being zero (which is otherwise always forced to be at 2622C<st_nlink> field being zero (which is otherwise always forced to be at
2737Apart from keeping your process non-blocking (which is a useful 2852Apart from keeping your process non-blocking (which is a useful
2738effect on its own sometimes), idle watchers are a good place to do 2853effect on its own sometimes), idle watchers are a good place to do
2739"pseudo-background processing", or delay processing stuff to after the 2854"pseudo-background processing", or delay processing stuff to after the
2740event loop has handled all outstanding events. 2855event loop has handled all outstanding events.
2741 2856
2857=head3 Abusing an C<ev_idle> watcher for its side-effect
2858
2859As long as there is at least one active idle watcher, libev will never
2860sleep unnecessarily. Or in other words, it will loop as fast as possible.
2861For this to work, the idle watcher doesn't need to be invoked at all - the
2862lowest priority will do.
2863
2864This mode of operation can be useful together with an C<ev_check> watcher,
2865to do something on each event loop iteration - for example to balance load
2866between different connections.
2867
2868See L</Abusing an ev_check watcher for its side-effect> for a longer
2869example.
2870
2742=head3 Watcher-Specific Functions and Data Members 2871=head3 Watcher-Specific Functions and Data Members
2743 2872
2744=over 4 2873=over 4
2745 2874
2746=item ev_idle_init (ev_idle *, callback) 2875=item ev_idle_init (ev_idle *, callback)
2757callback, free it. Also, use no error checking, as usual. 2886callback, free it. Also, use no error checking, as usual.
2758 2887
2759 static void 2888 static void
2760 idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 2889 idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2761 { 2890 {
2891 // stop the watcher
2892 ev_idle_stop (loop, w);
2893
2894 // now we can free it
2762 free (w); 2895 free (w);
2896
2763 // now do something you wanted to do when the program has 2897 // now do something you wanted to do when the program has
2764 // no longer anything immediate to do. 2898 // no longer anything immediate to do.
2765 } 2899 }
2766 2900
2767 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2901 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2769 ev_idle_start (loop, idle_watcher); 2903 ev_idle_start (loop, idle_watcher);
2770 2904
2771 2905
2772=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2906=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2773 2907
2774Prepare and check watchers are usually (but not always) used in pairs: 2908Prepare and check watchers are often (but not always) used in pairs:
2775prepare watchers get invoked before the process blocks and check watchers 2909prepare watchers get invoked before the process blocks and check watchers
2776afterwards. 2910afterwards.
2777 2911
2778You I<must not> call C<ev_run> or similar functions that enter 2912You I<must not> call C<ev_run> or similar functions that enter
2779the current event loop from either C<ev_prepare> or C<ev_check> 2913the current event loop from either C<ev_prepare> or C<ev_check>
2807with priority higher than or equal to the event loop and one coroutine 2941with priority higher than or equal to the event loop and one coroutine
2808of lower priority, but only once, using idle watchers to keep the event 2942of lower priority, but only once, using idle watchers to keep the event
2809loop from blocking if lower-priority coroutines are active, thus mapping 2943loop from blocking if lower-priority coroutines are active, thus mapping
2810low-priority coroutines to idle/background tasks). 2944low-priority coroutines to idle/background tasks).
2811 2945
2812It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 2946When used for this purpose, it is recommended to give C<ev_check> watchers
2813priority, to ensure that they are being run before any other watchers 2947highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2814after the poll (this doesn't matter for C<ev_prepare> watchers). 2948any other watchers after the poll (this doesn't matter for C<ev_prepare>
2949watchers).
2815 2950
2816Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not 2951Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2817activate ("feed") events into libev. While libev fully supports this, they 2952activate ("feed") events into libev. While libev fully supports this, they
2818might get executed before other C<ev_check> watchers did their job. As 2953might get executed before other C<ev_check> watchers did their job. As
2819C<ev_check> watchers are often used to embed other (non-libev) event 2954C<ev_check> watchers are often used to embed other (non-libev) event
2820loops those other event loops might be in an unusable state until their 2955loops those other event loops might be in an unusable state until their
2821C<ev_check> watcher ran (always remind yourself to coexist peacefully with 2956C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2822others). 2957others).
2958
2959=head3 Abusing an C<ev_check> watcher for its side-effect
2960
2961C<ev_check> (and less often also C<ev_prepare>) watchers can also be
2962useful because they are called once per event loop iteration. For
2963example, if you want to handle a large number of connections fairly, you
2964normally only do a bit of work for each active connection, and if there
2965is more work to do, you wait for the next event loop iteration, so other
2966connections have a chance of making progress.
2967
2968Using an C<ev_check> watcher is almost enough: it will be called on the
2969next event loop iteration. However, that isn't as soon as possible -
2970without external events, your C<ev_check> watcher will not be invoked.
2971
2972This is where C<ev_idle> watchers come in handy - all you need is a
2973single global idle watcher that is active as long as you have one active
2974C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
2975will not sleep, and the C<ev_check> watcher makes sure a callback gets
2976invoked. Neither watcher alone can do that.
2823 2977
2824=head3 Watcher-Specific Functions and Data Members 2978=head3 Watcher-Specific Functions and Data Members
2825 2979
2826=over 4 2980=over 4
2827 2981
3028 3182
3029=over 4 3183=over 4
3030 3184
3031=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3185=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3032 3186
3033=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3187=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3034 3188
3035Configures the watcher to embed the given loop, which must be 3189Configures the watcher to embed the given loop, which must be
3036embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3190embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3037invoked automatically, otherwise it is the responsibility of the callback 3191invoked automatically, otherwise it is the responsibility of the callback
3038to invoke it (it will continue to be called until the sweep has been done, 3192to invoke it (it will continue to be called until the sweep has been done,
3059used). 3213used).
3060 3214
3061 struct ev_loop *loop_hi = ev_default_init (0); 3215 struct ev_loop *loop_hi = ev_default_init (0);
3062 struct ev_loop *loop_lo = 0; 3216 struct ev_loop *loop_lo = 0;
3063 ev_embed embed; 3217 ev_embed embed;
3064 3218
3065 // see if there is a chance of getting one that works 3219 // see if there is a chance of getting one that works
3066 // (remember that a flags value of 0 means autodetection) 3220 // (remember that a flags value of 0 means autodetection)
3067 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3221 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3068 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3222 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3069 : 0; 3223 : 0;
3083C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3237C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3084 3238
3085 struct ev_loop *loop = ev_default_init (0); 3239 struct ev_loop *loop = ev_default_init (0);
3086 struct ev_loop *loop_socket = 0; 3240 struct ev_loop *loop_socket = 0;
3087 ev_embed embed; 3241 ev_embed embed;
3088 3242
3089 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3243 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3090 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3244 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3091 { 3245 {
3092 ev_embed_init (&embed, 0, loop_socket); 3246 ev_embed_init (&embed, 0, loop_socket);
3093 ev_embed_start (loop, &embed); 3247 ev_embed_start (loop, &embed);
3101 3255
3102=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3256=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3103 3257
3104Fork watchers are called when a C<fork ()> was detected (usually because 3258Fork watchers are called when a C<fork ()> was detected (usually because
3105whoever is a good citizen cared to tell libev about it by calling 3259whoever is a good citizen cared to tell libev about it by calling
3106C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the 3260C<ev_loop_fork>). The invocation is done before the event loop blocks next
3107event loop blocks next and before C<ev_check> watchers are being called, 3261and before C<ev_check> watchers are being called, and only in the child
3108and only in the child after the fork. If whoever good citizen calling 3262after the fork. If whoever good citizen calling C<ev_default_fork> cheats
3109C<ev_default_fork> cheats and calls it in the wrong process, the fork 3263and calls it in the wrong process, the fork handlers will be invoked, too,
3110handlers will be invoked, too, of course. 3264of course.
3111 3265
3112=head3 The special problem of life after fork - how is it possible? 3266=head3 The special problem of life after fork - how is it possible?
3113 3267
3114Most uses of C<fork()> consist of forking, then some simple calls to set 3268Most uses of C<fork()> consist of forking, then some simple calls to set
3115up/change the process environment, followed by a call to C<exec()>. This 3269up/change the process environment, followed by a call to C<exec()>. This
3208it by calling C<ev_async_send>, which is thread- and signal safe. 3362it by calling C<ev_async_send>, which is thread- and signal safe.
3209 3363
3210This functionality is very similar to C<ev_signal> watchers, as signals, 3364This functionality is very similar to C<ev_signal> watchers, as signals,
3211too, are asynchronous in nature, and signals, too, will be compressed 3365too, are asynchronous in nature, and signals, too, will be compressed
3212(i.e. the number of callback invocations may be less than the number of 3366(i.e. the number of callback invocations may be less than the number of
3213C<ev_async_sent> calls). In fact, you could use signal watchers as a kind 3367C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3214of "global async watchers" by using a watcher on an otherwise unused 3368of "global async watchers" by using a watcher on an otherwise unused
3215signal, and C<ev_feed_signal> to signal this watcher from another thread, 3369signal, and C<ev_feed_signal> to signal this watcher from another thread,
3216even without knowing which loop owns the signal. 3370even without knowing which loop owns the signal.
3217
3218Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3219just the default loop.
3220 3371
3221=head3 Queueing 3372=head3 Queueing
3222 3373
3223C<ev_async> does not support queueing of data in any way. The reason 3374C<ev_async> does not support queueing of data in any way. The reason
3224is that the author does not know of a simple (or any) algorithm for a 3375is that the author does not know of a simple (or any) algorithm for a
3324Unlike C<ev_feed_event>, this call is safe to do from other threads, 3475Unlike C<ev_feed_event>, this call is safe to do from other threads,
3325signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the 3476signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3326embedding section below on what exactly this means). 3477embedding section below on what exactly this means).
3327 3478
3328Note that, as with other watchers in libev, multiple events might get 3479Note that, as with other watchers in libev, multiple events might get
3329compressed into a single callback invocation (another way to look at this 3480compressed into a single callback invocation (another way to look at
3330is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, 3481this is that C<ev_async> watchers are level-triggered: they are set on
3331reset when the event loop detects that). 3482C<ev_async_send>, reset when the event loop detects that).
3332 3483
3333This call incurs the overhead of a system call only once per event loop 3484This call incurs the overhead of at most one extra system call per event
3334iteration, so while the overhead might be noticeable, it doesn't apply to 3485loop iteration, if the event loop is blocked, and no syscall at all if
3335repeated calls to C<ev_async_send> for the same event loop. 3486the event loop (or your program) is processing events. That means that
3487repeated calls are basically free (there is no need to avoid calls for
3488performance reasons) and that the overhead becomes smaller (typically
3489zero) under load.
3336 3490
3337=item bool = ev_async_pending (ev_async *) 3491=item bool = ev_async_pending (ev_async *)
3338 3492
3339Returns a non-zero value when C<ev_async_send> has been called on the 3493Returns a non-zero value when C<ev_async_send> has been called on the
3340watcher but the event has not yet been processed (or even noted) by the 3494watcher but the event has not yet been processed (or even noted) by the
3395 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3549 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3396 3550
3397=item ev_feed_fd_event (loop, int fd, int revents) 3551=item ev_feed_fd_event (loop, int fd, int revents)
3398 3552
3399Feed an event on the given fd, as if a file descriptor backend detected 3553Feed an event on the given fd, as if a file descriptor backend detected
3400the given events it. 3554the given events.
3401 3555
3402=item ev_feed_signal_event (loop, int signum) 3556=item ev_feed_signal_event (loop, int signum)
3403 3557
3404Feed an event as if the given signal occurred. See also C<ev_feed_signal>, 3558Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3405which is async-safe. 3559which is async-safe.
3479 { 3633 {
3480 struct my_biggy big = (struct my_biggy *) 3634 struct my_biggy big = (struct my_biggy *)
3481 (((char *)w) - offsetof (struct my_biggy, t2)); 3635 (((char *)w) - offsetof (struct my_biggy, t2));
3482 } 3636 }
3483 3637
3638=head2 AVOIDING FINISHING BEFORE RETURNING
3639
3640Often you have structures like this in event-based programs:
3641
3642 callback ()
3643 {
3644 free (request);
3645 }
3646
3647 request = start_new_request (..., callback);
3648
3649The intent is to start some "lengthy" operation. The C<request> could be
3650used to cancel the operation, or do other things with it.
3651
3652It's not uncommon to have code paths in C<start_new_request> that
3653immediately invoke the callback, for example, to report errors. Or you add
3654some caching layer that finds that it can skip the lengthy aspects of the
3655operation and simply invoke the callback with the result.
3656
3657The problem here is that this will happen I<before> C<start_new_request>
3658has returned, so C<request> is not set.
3659
3660Even if you pass the request by some safer means to the callback, you
3661might want to do something to the request after starting it, such as
3662canceling it, which probably isn't working so well when the callback has
3663already been invoked.
3664
3665A common way around all these issues is to make sure that
3666C<start_new_request> I<always> returns before the callback is invoked. If
3667C<start_new_request> immediately knows the result, it can artificially
3668delay invoking the callback by using a C<prepare> or C<idle> watcher for
3669example, or more sneakily, by reusing an existing (stopped) watcher and
3670pushing it into the pending queue:
3671
3672 ev_set_cb (watcher, callback);
3673 ev_feed_event (EV_A_ watcher, 0);
3674
3675This way, C<start_new_request> can safely return before the callback is
3676invoked, while not delaying callback invocation too much.
3677
3484=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS 3678=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
3485 3679
3486Often (especially in GUI toolkits) there are places where you have 3680Often (especially in GUI toolkits) there are places where you have
3487I<modal> interaction, which is most easily implemented by recursively 3681I<modal> interaction, which is most easily implemented by recursively
3488invoking C<ev_run>. 3682invoking C<ev_run>.
3489 3683
3490This brings the problem of exiting - a callback might want to finish the 3684This brings the problem of exiting - a callback might want to finish the
3491main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but 3685main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3492a modal "Are you sure?" dialog is still waiting), or just the nested one 3686a modal "Are you sure?" dialog is still waiting), or just the nested one
3493and not the main one (e.g. user clocked "Ok" in a modal dialog), or some 3687and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3494other combination: In these cases, C<ev_break> will not work alone. 3688other combination: In these cases, a simple C<ev_break> will not work.
3495 3689
3496The solution is to maintain "break this loop" variable for each C<ev_run> 3690The solution is to maintain "break this loop" variable for each C<ev_run>
3497invocation, and use a loop around C<ev_run> until the condition is 3691invocation, and use a loop around C<ev_run> until the condition is
3498triggered, using C<EVRUN_ONCE>: 3692triggered, using C<EVRUN_ONCE>:
3499 3693
3501 int exit_main_loop = 0; 3695 int exit_main_loop = 0;
3502 3696
3503 while (!exit_main_loop) 3697 while (!exit_main_loop)
3504 ev_run (EV_DEFAULT_ EVRUN_ONCE); 3698 ev_run (EV_DEFAULT_ EVRUN_ONCE);
3505 3699
3506 // in a model watcher 3700 // in a modal watcher
3507 int exit_nested_loop = 0; 3701 int exit_nested_loop = 0;
3508 3702
3509 while (!exit_nested_loop) 3703 while (!exit_nested_loop)
3510 ev_run (EV_A_ EVRUN_ONCE); 3704 ev_run (EV_A_ EVRUN_ONCE);
3511 3705
3685called): 3879called):
3686 3880
3687 void 3881 void
3688 wait_for_event (ev_watcher *w) 3882 wait_for_event (ev_watcher *w)
3689 { 3883 {
3690 ev_cb_set (w) = current_coro; 3884 ev_set_cb (w, current_coro);
3691 switch_to (libev_coro); 3885 switch_to (libev_coro);
3692 } 3886 }
3693 3887
3694That basically suspends the coroutine inside C<wait_for_event> and 3888That basically suspends the coroutine inside C<wait_for_event> and
3695continues the libev coroutine, which, when appropriate, switches back to 3889continues the libev coroutine, which, when appropriate, switches back to
3696this or any other coroutine. I am sure if you sue this your own :) 3890this or any other coroutine.
3697 3891
3698You can do similar tricks if you have, say, threads with an event queue - 3892You can do similar tricks if you have, say, threads with an event queue -
3699instead of storing a coroutine, you store the queue object and instead of 3893instead of storing a coroutine, you store the queue object and instead of
3700switching to a coroutine, you push the watcher onto the queue and notify 3894switching to a coroutine, you push the watcher onto the queue and notify
3701any waiters. 3895any waiters.
3702 3896
3703To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 3897To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3704files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 3898files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3705 3899
3706 // my_ev.h 3900 // my_ev.h
3707 #define EV_CB_DECLARE(type) struct my_coro *cb; 3901 #define EV_CB_DECLARE(type) struct my_coro *cb;
3708 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 3902 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
3752 3946
3753=back 3947=back
3754 3948
3755=head1 C++ SUPPORT 3949=head1 C++ SUPPORT
3756 3950
3951=head2 C API
3952
3953The normal C API should work fine when used from C++: both ev.h and the
3954libev sources can be compiled as C++. Therefore, code that uses the C API
3955will work fine.
3956
3957Proper exception specifications might have to be added to callbacks passed
3958to libev: exceptions may be thrown only from watcher callbacks, all
3959other callbacks (allocator, syserr, loop acquire/release and periodic
3960reschedule callbacks) must not throw exceptions, and might need a C<throw
3961()> specification. If you have code that needs to be compiled as both C
3962and C++ you can use the C<EV_THROW> macro for this:
3963
3964 static void
3965 fatal_error (const char *msg) EV_THROW
3966 {
3967 perror (msg);
3968 abort ();
3969 }
3970
3971 ...
3972 ev_set_syserr_cb (fatal_error);
3973
3974The only API functions that can currently throw exceptions are C<ev_run>,
3975C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
3976because it runs cleanup watchers).
3977
3978Throwing exceptions in watcher callbacks is only supported if libev itself
3979is compiled with a C++ compiler or your C and C++ environments allow
3980throwing exceptions through C libraries (most do).
3981
3982=head2 C++ API
3983
3757Libev comes with some simplistic wrapper classes for C++ that mainly allow 3984Libev comes with some simplistic wrapper classes for C++ that mainly allow
3758you to use some convenience methods to start/stop watchers and also change 3985you to use some convenience methods to start/stop watchers and also change
3759the callback model to a model using method callbacks on objects. 3986the callback model to a model using method callbacks on objects.
3760 3987
3761To use it, 3988To use it,
3762 3989
3763 #include <ev++.h> 3990 #include <ev++.h>
3764 3991
3765This automatically includes F<ev.h> and puts all of its definitions (many 3992This automatically includes F<ev.h> and puts all of its definitions (many
3766of them macros) into the global namespace. All C++ specific things are 3993of them macros) into the global namespace. All C++ specific things are
3767put into the C<ev> namespace. It should support all the same embedding 3994put into the C<ev> namespace. It should support all the same embedding
3776with C<operator ()> can be used as callbacks. Other types should be easy 4003with C<operator ()> can be used as callbacks. Other types should be easy
3777to add as long as they only need one additional pointer for context. If 4004to add as long as they only need one additional pointer for context. If
3778you need support for other types of functors please contact the author 4005you need support for other types of functors please contact the author
3779(preferably after implementing it). 4006(preferably after implementing it).
3780 4007
4008For all this to work, your C++ compiler either has to use the same calling
4009conventions as your C compiler (for static member functions), or you have
4010to embed libev and compile libev itself as C++.
4011
3781Here is a list of things available in the C<ev> namespace: 4012Here is a list of things available in the C<ev> namespace:
3782 4013
3783=over 4 4014=over 4
3784 4015
3785=item C<ev::READ>, C<ev::WRITE> etc. 4016=item C<ev::READ>, C<ev::WRITE> etc.
3794=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. 4025=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3795 4026
3796For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of 4027For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3797the same name in the C<ev> namespace, with the exception of C<ev_signal> 4028the same name in the C<ev> namespace, with the exception of C<ev_signal>
3798which is called C<ev::sig> to avoid clashes with the C<signal> macro 4029which is called C<ev::sig> to avoid clashes with the C<signal> macro
3799defines by many implementations. 4030defined by many implementations.
3800 4031
3801All of those classes have these methods: 4032All of those classes have these methods:
3802 4033
3803=over 4 4034=over 4
3804 4035
3866 void operator() (ev::io &w, int revents) 4097 void operator() (ev::io &w, int revents)
3867 { 4098 {
3868 ... 4099 ...
3869 } 4100 }
3870 } 4101 }
3871 4102
3872 myfunctor f; 4103 myfunctor f;
3873 4104
3874 ev::io w; 4105 ev::io w;
3875 w.set (&f); 4106 w.set (&f);
3876 4107
3894Associates a different C<struct ev_loop> with this watcher. You can only 4125Associates a different C<struct ev_loop> with this watcher. You can only
3895do this when the watcher is inactive (and not pending either). 4126do this when the watcher is inactive (and not pending either).
3896 4127
3897=item w->set ([arguments]) 4128=item w->set ([arguments])
3898 4129
3899Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4130Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
3900method or a suitable start method must be called at least once. Unlike the 4131with the same arguments. Either this method or a suitable start method
3901C counterpart, an active watcher gets automatically stopped and restarted 4132must be called at least once. Unlike the C counterpart, an active watcher
3902when reconfiguring it with this method. 4133gets automatically stopped and restarted when reconfiguring it with this
4134method.
4135
4136For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4137clashing with the C<set (loop)> method.
3903 4138
3904=item w->start () 4139=item w->start ()
3905 4140
3906Starts the watcher. Note that there is no C<loop> argument, as the 4141Starts the watcher. Note that there is no C<loop> argument, as the
3907constructor already stores the event loop. 4142constructor already stores the event loop.
3937watchers in the constructor. 4172watchers in the constructor.
3938 4173
3939 class myclass 4174 class myclass
3940 { 4175 {
3941 ev::io io ; void io_cb (ev::io &w, int revents); 4176 ev::io io ; void io_cb (ev::io &w, int revents);
3942 ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4177 ev::io io2 ; void io2_cb (ev::io &w, int revents);
3943 ev::idle idle; void idle_cb (ev::idle &w, int revents); 4178 ev::idle idle; void idle_cb (ev::idle &w, int revents);
3944 4179
3945 myclass (int fd) 4180 myclass (int fd)
3946 { 4181 {
3947 io .set <myclass, &myclass::io_cb > (this); 4182 io .set <myclass, &myclass::io_cb > (this);
3998L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. 4233L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3999 4234
4000=item D 4235=item D
4001 4236
4002Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 4237Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
4003be found at L<http://proj.llucax.com.ar/wiki/evd>. 4238be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
4004 4239
4005=item Ocaml 4240=item Ocaml
4006 4241
4007Erkki Seppala has written Ocaml bindings for libev, to be found at 4242Erkki Seppala has written Ocaml bindings for libev, to be found at
4008L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 4243L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
4011 4246
4012Brian Maher has written a partial interface to libev for lua (at the 4247Brian Maher has written a partial interface to libev for lua (at the
4013time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4248time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4014L<http://github.com/brimworks/lua-ev>. 4249L<http://github.com/brimworks/lua-ev>.
4015 4250
4251=item Javascript
4252
4253Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4254
4255=item Others
4256
4257There are others, and I stopped counting.
4258
4016=back 4259=back
4017 4260
4018 4261
4019=head1 MACRO MAGIC 4262=head1 MACRO MAGIC
4020 4263
4056suitable for use with C<EV_A>. 4299suitable for use with C<EV_A>.
4057 4300
4058=item C<EV_DEFAULT>, C<EV_DEFAULT_> 4301=item C<EV_DEFAULT>, C<EV_DEFAULT_>
4059 4302
4060Similar to the other two macros, this gives you the value of the default 4303Similar to the other two macros, this gives you the value of the default
4061loop, if multiple loops are supported ("ev loop default"). 4304loop, if multiple loops are supported ("ev loop default"). The default loop
4305will be initialised if it isn't already initialised.
4306
4307For non-multiplicity builds, these macros do nothing, so you always have
4308to initialise the loop somewhere.
4062 4309
4063=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> 4310=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
4064 4311
4065Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the 4312Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
4066default loop has been initialised (C<UC> == unchecked). Their behaviour 4313default loop has been initialised (C<UC> == unchecked). Their behaviour
4314 4561
4315If programs implement their own fd to handle mapping on win32, then this 4562If programs implement their own fd to handle mapping on win32, then this
4316macro can be used to override the C<close> function, useful to unregister 4563macro can be used to override the C<close> function, useful to unregister
4317file descriptors again. Note that the replacement function has to close 4564file descriptors again. Note that the replacement function has to close
4318the underlying OS handle. 4565the underlying OS handle.
4566
4567=item EV_USE_WSASOCKET
4568
4569If defined to be C<1>, libev will use C<WSASocket> to create its internal
4570communication socket, which works better in some environments. Otherwise,
4571the normal C<socket> function will be used, which works better in other
4572environments.
4319 4573
4320=item EV_USE_POLL 4574=item EV_USE_POLL
4321 4575
4322If defined to be C<1>, libev will compile in support for the C<poll>(2) 4576If defined to be C<1>, libev will compile in support for the C<poll>(2)
4323backend. Otherwise it will be enabled on non-win32 platforms. It 4577backend. Otherwise it will be enabled on non-win32 platforms. It
4359If defined to be C<1>, libev will compile in support for the Linux inotify 4613If defined to be C<1>, libev will compile in support for the Linux inotify
4360interface to speed up C<ev_stat> watchers. Its actual availability will 4614interface to speed up C<ev_stat> watchers. Its actual availability will
4361be detected at runtime. If undefined, it will be enabled if the headers 4615be detected at runtime. If undefined, it will be enabled if the headers
4362indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4616indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4363 4617
4618=item EV_NO_SMP
4619
4620If defined to be C<1>, libev will assume that memory is always coherent
4621between threads, that is, threads can be used, but threads never run on
4622different cpus (or different cpu cores). This reduces dependencies
4623and makes libev faster.
4624
4625=item EV_NO_THREADS
4626
4627If defined to be C<1>, libev will assume that it will never be called from
4628different threads (that includes signal handlers), which is a stronger
4629assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4630libev faster.
4631
4364=item EV_ATOMIC_T 4632=item EV_ATOMIC_T
4365 4633
4366Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4634Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4367access is atomic with respect to other threads or signal contexts. No such 4635access is atomic with respect to other threads or signal contexts. No
4368type is easily found in the C language, so you can provide your own type 4636such type is easily found in the C language, so you can provide your own
4369that you know is safe for your purposes. It is used both for signal handler "locking" 4637type that you know is safe for your purposes. It is used both for signal
4370as well as for signal and thread safety in C<ev_async> watchers. 4638handler "locking" as well as for signal and thread safety in C<ev_async>
4639watchers.
4371 4640
4372In the absence of this define, libev will use C<sig_atomic_t volatile> 4641In the absence of this define, libev will use C<sig_atomic_t volatile>
4373(from F<signal.h>), which is usually good enough on most platforms. 4642(from F<signal.h>), which is usually good enough on most platforms.
4374 4643
4375=item EV_H (h) 4644=item EV_H (h)
4402will have the C<struct ev_loop *> as first argument, and you can create 4671will have the C<struct ev_loop *> as first argument, and you can create
4403additional independent event loops. Otherwise there will be no support 4672additional independent event loops. Otherwise there will be no support
4404for multiple event loops and there is no first event loop pointer 4673for multiple event loops and there is no first event loop pointer
4405argument. Instead, all functions act on the single default loop. 4674argument. Instead, all functions act on the single default loop.
4406 4675
4676Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
4677default loop when multiplicity is switched off - you always have to
4678initialise the loop manually in this case.
4679
4407=item EV_MINPRI 4680=item EV_MINPRI
4408 4681
4409=item EV_MAXPRI 4682=item EV_MAXPRI
4410 4683
4411The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to 4684The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
4447 #define EV_USE_POLL 1 4720 #define EV_USE_POLL 1
4448 #define EV_CHILD_ENABLE 1 4721 #define EV_CHILD_ENABLE 1
4449 #define EV_ASYNC_ENABLE 1 4722 #define EV_ASYNC_ENABLE 1
4450 4723
4451The actual value is a bitset, it can be a combination of the following 4724The actual value is a bitset, it can be a combination of the following
4452values: 4725values (by default, all of these are enabled):
4453 4726
4454=over 4 4727=over 4
4455 4728
4456=item C<1> - faster/larger code 4729=item C<1> - faster/larger code
4457 4730
4461code size by roughly 30% on amd64). 4734code size by roughly 30% on amd64).
4462 4735
4463When optimising for size, use of compiler flags such as C<-Os> with 4736When optimising for size, use of compiler flags such as C<-Os> with
4464gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of 4737gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4465assertions. 4738assertions.
4739
4740The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4741(e.g. gcc with C<-Os>).
4466 4742
4467=item C<2> - faster/larger data structures 4743=item C<2> - faster/larger data structures
4468 4744
4469Replaces the small 2-heap for timer management by a faster 4-heap, larger 4745Replaces the small 2-heap for timer management by a faster 4-heap, larger
4470hash table sizes and so on. This will usually further increase code size 4746hash table sizes and so on. This will usually further increase code size
4471and can additionally have an effect on the size of data structures at 4747and can additionally have an effect on the size of data structures at
4472runtime. 4748runtime.
4473 4749
4750The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4751(e.g. gcc with C<-Os>).
4752
4474=item C<4> - full API configuration 4753=item C<4> - full API configuration
4475 4754
4476This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and 4755This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4477enables multiplicity (C<EV_MULTIPLICITY>=1). 4756enables multiplicity (C<EV_MULTIPLICITY>=1).
4478 4757
4508 4787
4509With an intelligent-enough linker (gcc+binutils are intelligent enough 4788With an intelligent-enough linker (gcc+binutils are intelligent enough
4510when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by 4789when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
4511your program might be left out as well - a binary starting a timer and an 4790your program might be left out as well - a binary starting a timer and an
4512I/O watcher then might come out at only 5Kb. 4791I/O watcher then might come out at only 5Kb.
4792
4793=item EV_API_STATIC
4794
4795If this symbol is defined (by default it is not), then all identifiers
4796will have static linkage. This means that libev will not export any
4797identifiers, and you cannot link against libev anymore. This can be useful
4798when you embed libev, only want to use libev functions in a single file,
4799and do not want its identifiers to be visible.
4800
4801To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
4802wants to use libev.
4803
4804This option only works when libev is compiled with a C compiler, as C++
4805doesn't support the required declaration syntax.
4513 4806
4514=item EV_AVOID_STDIO 4807=item EV_AVOID_STDIO
4515 4808
4516If this is set to C<1> at compiletime, then libev will avoid using stdio 4809If this is set to C<1> at compiletime, then libev will avoid using stdio
4517functions (printf, scanf, perror etc.). This will increase the code size 4810functions (printf, scanf, perror etc.). This will increase the code size
4722default loop and triggering an C<ev_async> watcher from the default loop 5015default loop and triggering an C<ev_async> watcher from the default loop
4723watcher callback into the event loop interested in the signal. 5016watcher callback into the event loop interested in the signal.
4724 5017
4725=back 5018=back
4726 5019
4727See also L<THREAD LOCKING EXAMPLE>. 5020See also L</THREAD LOCKING EXAMPLE>.
4728 5021
4729=head3 COROUTINES 5022=head3 COROUTINES
4730 5023
4731Libev is very accommodating to coroutines ("cooperative threads"): 5024Libev is very accommodating to coroutines ("cooperative threads"):
4732libev fully supports nesting calls to its functions from different 5025libev fully supports nesting calls to its functions from different
4897requires, and its I/O model is fundamentally incompatible with the POSIX 5190requires, and its I/O model is fundamentally incompatible with the POSIX
4898model. Libev still offers limited functionality on this platform in 5191model. Libev still offers limited functionality on this platform in
4899the form of the C<EVBACKEND_SELECT> backend, and only supports socket 5192the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4900descriptors. This only applies when using Win32 natively, not when using 5193descriptors. This only applies when using Win32 natively, not when using
4901e.g. cygwin. Actually, it only applies to the microsofts own compilers, 5194e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4902as every compielr comes with a slightly differently broken/incompatible 5195as every compiler comes with a slightly differently broken/incompatible
4903environment. 5196environment.
4904 5197
4905Lifting these limitations would basically require the full 5198Lifting these limitations would basically require the full
4906re-implementation of the I/O system. If you are into this kind of thing, 5199re-implementation of the I/O system. If you are into this kind of thing,
4907then note that glib does exactly that for you in a very portable way (note 5200then note that glib does exactly that for you in a very portable way (note
5023thread" or will block signals process-wide, both behaviours would 5316thread" or will block signals process-wide, both behaviours would
5024be compatible with libev. Interaction between C<sigprocmask> and 5317be compatible with libev. Interaction between C<sigprocmask> and
5025C<pthread_sigmask> could complicate things, however. 5318C<pthread_sigmask> could complicate things, however.
5026 5319
5027The most portable way to handle signals is to block signals in all threads 5320The most portable way to handle signals is to block signals in all threads
5028except the initial one, and run the default loop in the initial thread as 5321except the initial one, and run the signal handling loop in the initial
5029well. 5322thread as well.
5030 5323
5031=item C<long> must be large enough for common memory allocation sizes 5324=item C<long> must be large enough for common memory allocation sizes
5032 5325
5033To improve portability and simplify its API, libev uses C<long> internally 5326To improve portability and simplify its API, libev uses C<long> internally
5034instead of C<size_t> when allocating its data structures. On non-POSIX 5327instead of C<size_t> when allocating its data structures. On non-POSIX
5040 5333
5041The type C<double> is used to represent timestamps. It is required to 5334The type C<double> is used to represent timestamps. It is required to
5042have at least 51 bits of mantissa (and 9 bits of exponent), which is 5335have at least 51 bits of mantissa (and 9 bits of exponent), which is
5043good enough for at least into the year 4000 with millisecond accuracy 5336good enough for at least into the year 4000 with millisecond accuracy
5044(the design goal for libev). This requirement is overfulfilled by 5337(the design goal for libev). This requirement is overfulfilled by
5045implementations using IEEE 754, which is basically all existing ones. With 5338implementations using IEEE 754, which is basically all existing ones.
5339
5046IEEE 754 doubles, you get microsecond accuracy until at least 2200. 5340With IEEE 754 doubles, you get microsecond accuracy until at least the
5341year 2255 (and millisecond accuracy till the year 287396 - by then, libev
5342is either obsolete or somebody patched it to use C<long double> or
5343something like that, just kidding).
5047 5344
5048=back 5345=back
5049 5346
5050If you know of other additional requirements drop me a note. 5347If you know of other additional requirements drop me a note.
5051 5348
5113=item Processing ev_async_send: O(number_of_async_watchers) 5410=item Processing ev_async_send: O(number_of_async_watchers)
5114 5411
5115=item Processing signals: O(max_signal_number) 5412=item Processing signals: O(max_signal_number)
5116 5413
5117Sending involves a system call I<iff> there were no other C<ev_async_send> 5414Sending involves a system call I<iff> there were no other C<ev_async_send>
5118calls in the current loop iteration. Checking for async and signal events 5415calls in the current loop iteration and the loop is currently
5416blocked. Checking for async and signal events involves iterating over all
5119involves iterating over all running async watchers or all signal numbers. 5417running async watchers or all signal numbers.
5120 5418
5121=back 5419=back
5122 5420
5123 5421
5124=head1 PORTING FROM LIBEV 3.X TO 4.X 5422=head1 PORTING FROM LIBEV 3.X TO 4.X
5133=over 4 5431=over 4
5134 5432
5135=item C<EV_COMPAT3> backwards compatibility mechanism 5433=item C<EV_COMPAT3> backwards compatibility mechanism
5136 5434
5137The backward compatibility mechanism can be controlled by 5435The backward compatibility mechanism can be controlled by
5138C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5436C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5139section. 5437section.
5140 5438
5141=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5439=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5142 5440
5143These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5441These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5186=over 4 5484=over 4
5187 5485
5188=item active 5486=item active
5189 5487
5190A watcher is active as long as it has been started and not yet stopped. 5488A watcher is active as long as it has been started and not yet stopped.
5191See L<WATCHER STATES> for details. 5489See L</WATCHER STATES> for details.
5192 5490
5193=item application 5491=item application
5194 5492
5195In this document, an application is whatever is using libev. 5493In this document, an application is whatever is using libev.
5196 5494
5232watchers and events. 5530watchers and events.
5233 5531
5234=item pending 5532=item pending
5235 5533
5236A watcher is pending as soon as the corresponding event has been 5534A watcher is pending as soon as the corresponding event has been
5237detected. See L<WATCHER STATES> for details. 5535detected. See L</WATCHER STATES> for details.
5238 5536
5239=item real time 5537=item real time
5240 5538
5241The physical time that is observed. It is apparently strictly monotonic :) 5539The physical time that is observed. It is apparently strictly monotonic :)
5242 5540

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines