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

Comparing libev/ev.pod (file contents):
Revision 1.369 by root, Mon May 30 18:34:28 2011 UTC vs.
Revision 1.429 by root, Fri Oct 11 07:50:43 2013 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines