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

Comparing libev/ev.pod (file contents):
Revision 1.360 by root, Mon Jan 17 12:11:12 2011 UTC vs.
Revision 1.450 by root, Mon Jun 24 00:04:26 2019 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
58 ev_timer_start (loop, &timeout_watcher); 60 ev_timer_start (loop, &timeout_watcher);
59 61
60 // now wait for events to arrive 62 // now wait for events to arrive
61 ev_run (loop, 0); 63 ev_run (loop, 0);
62 64
63 // unloop was called, so exit 65 // break was called, so exit
64 return 0; 66 return 0;
65 } 67 }
66 68
67=head1 ABOUT THIS DOCUMENT 69=head1 ABOUT THIS DOCUMENT
68 70
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
103details of the event, and then hand it over to libev by I<starting> the 105details of the event, and then hand it over to libev by I<starting> the
104watcher. 106watcher.
105 107
106=head2 FEATURES 108=head2 FEATURES
107 109
108Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 110Libev supports C<select>, C<poll>, the Linux-specific aio and C<epoll>
109BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 111interfaces, the BSD-specific C<kqueue> and the Solaris-specific event port
110for file descriptor events (C<ev_io>), the Linux C<inotify> interface 112mechanisms for file descriptor events (C<ev_io>), the Linux C<inotify>
111(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner 113interface (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
112inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative 114inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
113timers (C<ev_timer>), absolute timers with customised rescheduling 115timers (C<ev_timer>), absolute timers with customised rescheduling
114(C<ev_periodic>), synchronous signals (C<ev_signal>), process status 116(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
115change events (C<ev_child>), and event watchers dealing with the event 117change events (C<ev_child>), and event watchers dealing with the event
116loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and 118loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
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
257 265
258You could override this function in high-availability programs to, say, 266You could override this function in high-availability programs to, say,
259free some memory if it cannot allocate memory, to use a special allocator, 267free some memory if it cannot allocate memory, to use a special allocator,
260or even to sleep a while and retry until some memory is available. 268or even to sleep a while and retry until some memory is available.
261 269
270Example: The following is the C<realloc> function that libev itself uses
271which should work with C<realloc> and C<free> functions of all kinds and
272is probably a good basis for your own implementation.
273
274 static void *
275 ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT
276 {
277 if (size)
278 return realloc (ptr, size);
279
280 free (ptr);
281 return 0;
282 }
283
262Example: Replace the libev allocator with one that waits a bit and then 284Example: Replace the libev allocator with one that waits a bit and then
263retries (example requires a standards-compliant C<realloc>). 285retries.
264 286
265 static void * 287 static void *
266 persistent_realloc (void *ptr, size_t size) 288 persistent_realloc (void *ptr, size_t size)
267 { 289 {
290 if (!size)
291 {
292 free (ptr);
293 return 0;
294 }
295
268 for (;;) 296 for (;;)
269 { 297 {
270 void *newptr = realloc (ptr, size); 298 void *newptr = realloc (ptr, size);
271 299
272 if (newptr) 300 if (newptr)
277 } 305 }
278 306
279 ... 307 ...
280 ev_set_allocator (persistent_realloc); 308 ev_set_allocator (persistent_realloc);
281 309
282=item ev_set_syserr_cb (void (*cb)(const char *msg)) 310=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
283 311
284Set the callback function to call on a retryable system call error (such 312Set the callback function to call on a retryable system call error (such
285as failed select, poll, epoll_wait). The message is a printable string 313as failed select, poll, epoll_wait). The message is a printable string
286indicating the system call or subsystem causing the problem. If this 314indicating the system call or subsystem causing the problem. If this
287callback is set, then libev will expect it to remedy the situation, no 315callback is set, then libev will expect it to remedy the situation, no
390 418
391If this flag bit is or'ed into the flag value (or the program runs setuid 419If 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 420or setgid) then libev will I<not> look at the environment variable
393C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 421C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
394override the flags completely if it is found in the environment. This is 422override 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 423useful to try out specific backends to test their performance, to work
396around bugs. 424around bugs, or to make libev threadsafe (accessing environment variables
425cannot be done in a threadsafe way, but usually it works if no other
426thread modifies them).
397 427
398=item C<EVFLAG_FORKCHECK> 428=item C<EVFLAG_FORKCHECK>
399 429
400Instead of calling C<ev_loop_fork> manually after a fork, you can also 430Instead 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. 431make libev check for a fork in each iteration by enabling this flag.
402 432
403This works by calling C<getpid ()> on every iteration of the loop, 433This works by calling C<getpid ()> on every iteration of the loop,
404and thus this might slow down your event loop if you do a lot of loop 434and thus this might slow down your event loop if you do a lot of loop
405iterations and little real work, but is usually not noticeable (on my 435iterations and little real work, but is usually not noticeable (on my
406GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence 436GNU/Linux system for example, C<getpid> is actually a simple 5-insn
407without a system call and thus I<very> fast, but my GNU/Linux system also has 437sequence without a system call and thus I<very> fast, but my GNU/Linux
408C<pthread_atfork> which is even faster). 438system also has C<pthread_atfork> which is even faster). (Update: glibc
439versions 2.25 apparently removed the C<getpid> optimisation again).
409 440
410The big advantage of this flag is that you can forget about fork (and 441The big advantage of this flag is that you can forget about fork (and
411forget about forgetting to tell libev about forking) when you use this 442forget about forgetting to tell libev about forking, although you still
412flag. 443have to ignore C<SIGPIPE>) when you use this flag.
413 444
414This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> 445This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
415environment variable. 446environment variable.
416 447
417=item C<EVFLAG_NOINOTIFY> 448=item C<EVFLAG_NOINOTIFY>
435example) that can't properly initialise their signal masks. 466example) that can't properly initialise their signal masks.
436 467
437=item C<EVFLAG_NOSIGMASK> 468=item C<EVFLAG_NOSIGMASK>
438 469
439When this flag is specified, then libev will avoid to modify the signal 470When this flag is specified, then libev will avoid to modify the signal
440mask. Specifically, this means you ahve to make sure signals are unblocked 471mask. Specifically, this means you have to make sure signals are unblocked
441when you want to receive them. 472when you want to receive them.
442 473
443This behaviour is useful when you want to do your own signal handling, or 474This 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 475want to handle signals only in specific threads and want to avoid libev
445unblocking the signals. 476unblocking the signals.
483=item C<EVBACKEND_EPOLL> (value 4, Linux) 514=item C<EVBACKEND_EPOLL> (value 4, Linux)
484 515
485Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 516Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
486kernels). 517kernels).
487 518
488For few fds, this backend is a bit little slower than poll and select, 519For few fds, this backend is a bit little slower than poll and select, but
489but it scales phenomenally better. While poll and select usually scale 520it scales phenomenally better. While poll and select usually scale like
490like O(total_fds) where n is the total number of fds (or the highest fd), 521O(total_fds) where total_fds is the total number of fds (or the highest
491epoll scales either O(1) or O(active_fds). 522fd), epoll scales either O(1) or O(active_fds).
492 523
493The epoll mechanism deserves honorable mention as the most misdesigned 524The epoll mechanism deserves honorable mention as the most misdesigned
494of the more advanced event mechanisms: mere annoyances include silently 525of the more advanced event mechanisms: mere annoyances include silently
495dropping file descriptors, requiring a system call per change per file 526dropping file descriptors, requiring a system call per change per file
496descriptor (and unnecessary guessing of parameters), problems with dup, 527descriptor (and unnecessary guessing of parameters), problems with dup,
4990.1ms) and so on. The biggest issue is fork races, however - if a program 5300.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 531forks then I<both> parent and child process have to recreate the epoll
501set, which can take considerable time (one syscall per file descriptor) 532set, which can take considerable time (one syscall per file descriptor)
502and is of course hard to detect. 533and is of course hard to detect.
503 534
504Epoll is also notoriously buggy - embedding epoll fds I<should> work, but 535Epoll is also notoriously buggy - embedding epoll fds I<should> work,
505of course I<doesn't>, and epoll just loves to report events for totally 536but of course I<doesn't>, and epoll just loves to report events for
506I<different> file descriptors (even already closed ones, so one cannot 537totally I<different> file descriptors (even already closed ones, so
507even remove them from the set) than registered in the set (especially 538one cannot even remove them from the set) than registered in the set
508on SMP systems). Libev tries to counter these spurious notifications by 539(especially on SMP systems). Libev tries to counter these spurious
509employing an additional generation counter and comparing that against the 540notifications by employing an additional generation counter and comparing
510events to filter out spurious ones, recreating the set when required. Last 541that against the events to filter out spurious ones, recreating the set
542when required. Epoll also erroneously rounds down timeouts, but gives you
543no way to know when and by how much, so sometimes you have to busy-wait
544because epoll returns immediately despite a nonzero timeout. And last
511not least, it also refuses to work with some file descriptors which work 545not least, it also refuses to work with some file descriptors which work
512perfectly fine with C<select> (files, many character devices...). 546perfectly fine with C<select> (files, many character devices...).
513 547
514Epoll is truly the train wreck analog among event poll mechanisms, 548Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
515a frankenpoll, cobbled together in a hurry, no thought to design or 549cobbled together in a hurry, no thought to design or interaction with
516interaction with others. 550others. Oh, the pain, will it ever stop...
517 551
518While stopping, setting and starting an I/O watcher in the same iteration 552While 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 553will result in some caching, there is still a system call per such
520incident (because the same I<file descriptor> could point to a different 554incident (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 555I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
533All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or 567All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
534faster than epoll for maybe up to a hundred file descriptors, depending on 568faster than epoll for maybe up to a hundred file descriptors, depending on
535the usage. So sad. 569the usage. So sad.
536 570
537While nominally embeddable in other event loops, this feature is broken in 571While nominally embeddable in other event loops, this feature is broken in
538all kernel versions tested so far. 572a lot of kernel revisions, but probably(!) works in current versions.
573
574This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
575C<EVBACKEND_POLL>.
576
577=item C<EVBACKEND_LINUXAIO> (value 64, Linux)
578
579Use the linux-specific linux aio (I<not> C<< aio(7) >> but C<<
580io_submit(2) >>) event interface available in post-4.18 kernels.
581
582If this backend works for you (as of this writing, it was very
583experimental), it is the best event interface available on linux and might
584be well worth enabling it - if it isn't available in your kernel this will
585be detected and this backend will be skipped.
586
587This backend can batch oneshot requests and supports a user-space ring
588buffer to receive events. It also doesn't suffer from most of the design
589problems of epoll (such as not being able to remove event sources from
590the epoll set), and generally sounds too good to be true. Because, this
591being the linux kernel, of course it suffers from a whole new set of
592limitations.
593
594For one, it is not easily embeddable (but probably could be done using
595an event fd at some extra overhead). It also is subject to a system wide
596limit that can be configured in F</proc/sys/fs/aio-max-nr> - each loop
597currently requires C<61> of this number. If no aio requests are left, this
598backend will be skipped during initialisation.
599
600Most problematic in practise, however, is that not all file descriptors
601work with it. For example, in linux 5.1, tcp sockets, pipes, event fds,
602files, F</dev/null> and a few others are supported, but ttys do not work
603properly (a known bug that the kernel developers don't care about, see
604L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
605(yet?) a generic event polling interface.
606
607To work around this latter problem, the current version of libev uses
608epoll as a fallback for file deescriptor types that do not work. Epoll
609is used in, kind of, slow mode that hopefully avoids most of its design
610problems and requires 1-3 extra syscalls per active fd every iteration.
539 611
540This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 612This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
541C<EVBACKEND_POLL>. 613C<EVBACKEND_POLL>.
542 614
543=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 615=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
558 630
559It scales in the same way as the epoll backend, but the interface to the 631It 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 632kernel is more efficient (which says nothing about its actual speed, of
561course). While stopping, setting and starting an I/O watcher does never 633course). 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 634cause 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 635two 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 636might have to leak fd's on fork, but it's more sane than epoll) and it
565cases 637drops fds silently in similarly hard-to-detect cases.
566 638
567This backend usually performs well under most conditions. 639This backend usually performs well under most conditions.
568 640
569While nominally embeddable in other event loops, this doesn't work 641While nominally embeddable in other event loops, this doesn't work
570everywhere, so you might need to test for this. And since it is broken 642everywhere, so you might need to test for this. And since it is broken
599among the OS-specific backends (I vastly prefer correctness over speed 671among the OS-specific backends (I vastly prefer correctness over speed
600hacks). 672hacks).
601 673
602On the negative side, the interface is I<bizarre> - so bizarre that 674On the negative side, the interface is I<bizarre> - so bizarre that
603even sun itself gets it wrong in their code examples: The event polling 675even sun itself gets it wrong in their code examples: The event polling
604function sometimes returning events to the caller even though an error 676function 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 677occurred, but with no indication whether it has done so or not (yes, it's
606even documented that way) - deadly for edge-triggered interfaces where 678even documented that way) - deadly for edge-triggered interfaces where you
607you absolutely have to know whether an event occurred or not because you 679absolutely have to know whether an event occurred or not because you have
608have to re-arm the watcher. 680to re-arm the watcher.
609 681
610Fortunately libev seems to be able to work around these idiocies. 682Fortunately libev seems to be able to work around these idiocies.
611 683
612This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 684This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
613C<EVBACKEND_POLL>. 685C<EVBACKEND_POLL>.
643 715
644Example: Use whatever libev has to offer, but make sure that kqueue is 716Example: Use whatever libev has to offer, but make sure that kqueue is
645used if available. 717used if available.
646 718
647 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 719 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
720
721Example: Similarly, on linux, you mgiht want to take advantage of the
722linux aio backend if possible, but fall back to something else if that
723isn't available.
724
725 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
648 726
649=item ev_loop_destroy (loop) 727=item ev_loop_destroy (loop)
650 728
651Destroys an event loop object (frees all memory and kernel state 729Destroys an event loop object (frees all memory and kernel state
652etc.). None of the active event watchers will be stopped in the normal 730etc.). None of the active event watchers will be stopped in the normal
669If you need dynamically allocated loops it is better to use C<ev_loop_new> 747If you need dynamically allocated loops it is better to use C<ev_loop_new>
670and C<ev_loop_destroy>. 748and C<ev_loop_destroy>.
671 749
672=item ev_loop_fork (loop) 750=item ev_loop_fork (loop)
673 751
674This function sets a flag that causes subsequent C<ev_run> iterations to 752This function sets a flag that causes subsequent C<ev_run> iterations
675reinitialise the kernel state for backends that have one. Despite the 753to reinitialise the kernel state for backends that have one. Despite
676name, you can call it anytime, but it makes most sense after forking, in 754the name, you can call it anytime you are allowed to start or stop
677the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the 755watchers (except inside an C<ev_prepare> callback), but it makes most
756sense after forking, in the child process. You I<must> call it (or use
678child before resuming or calling C<ev_run>. 757C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
679 758
759In addition, if you want to reuse a loop (via this function or
760C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>.
761
680Again, you I<have> to call it on I<any> loop that you want to re-use after 762Again, 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 763a 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 764because some kernel interfaces *cough* I<kqueue> *cough* do funny things
683during fork. 765during fork.
684 766
685On the other hand, you only need to call this function in the child 767On the other hand, you only need to call this function in the child
755 837
756This function is rarely useful, but when some event callback runs for a 838This 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 839very long time without entering the event loop, updating libev's idea of
758the current time is a good idea. 840the current time is a good idea.
759 841
760See also L<The special problem of time updates> in the C<ev_timer> section. 842See also L</The special problem of time updates> in the C<ev_timer> section.
761 843
762=item ev_suspend (loop) 844=item ev_suspend (loop)
763 845
764=item ev_resume (loop) 846=item ev_resume (loop)
765 847
783without a previous call to C<ev_suspend>. 865without a previous call to C<ev_suspend>.
784 866
785Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the 867Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
786event loop time (see C<ev_now_update>). 868event loop time (see C<ev_now_update>).
787 869
788=item ev_run (loop, int flags) 870=item bool ev_run (loop, int flags)
789 871
790Finally, this is it, the event handler. This function usually is called 872Finally, this is it, the event handler. This function usually is called
791after you have initialised all your watchers and you want to start 873after you have initialised all your watchers and you want to start
792handling events. It will ask the operating system for any new events, call 874handling events. It will ask the operating system for any new events, call
793the watcher callbacks, an then repeat the whole process indefinitely: This 875the watcher callbacks, and then repeat the whole process indefinitely: This
794is why event loops are called I<loops>. 876is why event loops are called I<loops>.
795 877
796If the flags argument is specified as C<0>, it will keep handling events 878If 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 879until either no event watchers are active anymore or C<ev_break> was
798called. 880called.
881
882The return value is false if there are no more active watchers (which
883usually means "all jobs done" or "deadlock"), and true in all other cases
884(which usually means " you should call C<ev_run> again").
799 885
800Please note that an explicit C<ev_break> is usually better than 886Please note that an explicit C<ev_break> is usually better than
801relying on all watchers to be stopped when deciding when a program has 887relying on all watchers to be stopped when deciding when a program has
802finished (especially in interactive programs), but having a program 888finished (especially in interactive programs), but having a program
803that automatically loops as long as it has to and no longer by virtue 889that 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 890of relying on its watchers stopping correctly, that is truly a thing of
805beauty. 891beauty.
806 892
807This function is also I<mostly> exception-safe - you can break out of 893This 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++ 894C<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 895exception and so on. This does not decrement the C<ev_depth> value, nor
810will it clear any outstanding C<EVBREAK_ONE> breaks. 896will it clear any outstanding C<EVBREAK_ONE> breaks.
811 897
812A flags value of C<EVRUN_NOWAIT> will look for new events, will handle 898A 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 899those events and any already outstanding ones, but will not wait and
825This is useful if you are waiting for some external event in conjunction 911This is useful if you are waiting for some external event in conjunction
826with something not expressible using other libev watchers (i.e. "roll your 912with something not expressible using other libev watchers (i.e. "roll your
827own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is 913own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
828usually a better approach for this kind of thing. 914usually a better approach for this kind of thing.
829 915
830Here are the gory details of what C<ev_run> does: 916Here are the gory details of what C<ev_run> does (this is for your
917understanding, not a guarantee that things will work exactly like this in
918future versions):
831 919
832 - Increment loop depth. 920 - Increment loop depth.
833 - Reset the ev_break status. 921 - Reset the ev_break status.
834 - Before the first iteration, call any pending watchers. 922 - Before the first iteration, call any pending watchers.
835 LOOP: 923 LOOP:
868anymore. 956anymore.
869 957
870 ... queue jobs here, make sure they register event watchers as long 958 ... queue jobs here, make sure they register event watchers as long
871 ... as they still have work to do (even an idle watcher will do..) 959 ... as they still have work to do (even an idle watcher will do..)
872 ev_run (my_loop, 0); 960 ev_run (my_loop, 0);
873 ... jobs done or somebody called unloop. yeah! 961 ... jobs done or somebody called break. yeah!
874 962
875=item ev_break (loop, how) 963=item ev_break (loop, how)
876 964
877Can be used to make a call to C<ev_run> return early (but only after it 965Can be used to make a call to C<ev_run> return early (but only after it
878has processed all outstanding events). The C<how> argument must be either 966has processed all outstanding events). The C<how> argument must be either
941overhead for the actual polling but can deliver many events at once. 1029overhead for the actual polling but can deliver many events at once.
942 1030
943By setting a higher I<io collect interval> you allow libev to spend more 1031By setting a higher I<io collect interval> you allow libev to spend more
944time collecting I/O events, so you can handle more events per iteration, 1032time collecting I/O events, so you can handle more events per iteration,
945at the cost of increasing latency. Timeouts (both C<ev_periodic> and 1033at the cost of increasing latency. Timeouts (both C<ev_periodic> and
946C<ev_timer>) will be not affected. Setting this to a non-null value will 1034C<ev_timer>) will not be affected. Setting this to a non-null value will
947introduce an additional C<ev_sleep ()> call into most loop iterations. The 1035introduce an additional C<ev_sleep ()> call into most loop iterations. The
948sleep time ensures that libev will not poll for I/O events more often then 1036sleep time ensures that libev will not poll for I/O events more often then
949once per this interval, on average. 1037once per this interval, on average (as long as the host time resolution is
1038good enough).
950 1039
951Likewise, by setting a higher I<timeout collect interval> you allow libev 1040Likewise, by setting a higher I<timeout collect interval> you allow libev
952to spend more time collecting timeouts, at the expense of increased 1041to spend more time collecting timeouts, at the expense of increased
953latency/jitter/inexactness (the watcher callback will be called 1042latency/jitter/inexactness (the watcher callback will be called
954later). C<ev_io> watchers will not be affected. Setting this to a non-null 1043later). C<ev_io> watchers will not be affected. Setting this to a non-null
1000invoke the actual watchers inside another context (another thread etc.). 1089invoke the actual watchers inside another context (another thread etc.).
1001 1090
1002If you want to reset the callback, use C<ev_invoke_pending> as new 1091If you want to reset the callback, use C<ev_invoke_pending> as new
1003callback. 1092callback.
1004 1093
1005=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) 1094=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
1006 1095
1007Sometimes you want to share the same loop between multiple threads. This 1096Sometimes you want to share the same loop between multiple threads. This
1008can be done relatively simply by putting mutex_lock/unlock calls around 1097can be done relatively simply by putting mutex_lock/unlock calls around
1009each call to a libev function. 1098each call to a libev function.
1010 1099
1011However, C<ev_run> can run an indefinite time, so it is not feasible 1100However, C<ev_run> can run an indefinite time, so it is not feasible
1012to wait for it to return. One way around this is to wake up the event 1101to wait for it to return. One way around this is to wake up the event
1013loop via C<ev_break> and C<av_async_send>, another way is to set these 1102loop via C<ev_break> and C<ev_async_send>, another way is to set these
1014I<release> and I<acquire> callbacks on the loop. 1103I<release> and I<acquire> callbacks on the loop.
1015 1104
1016When set, then C<release> will be called just before the thread is 1105When set, then C<release> will be called just before the thread is
1017suspended waiting for new events, and C<acquire> is called just 1106suspended waiting for new events, and C<acquire> is called just
1018afterwards. 1107afterwards.
1158 1247
1159=item C<EV_PREPARE> 1248=item C<EV_PREPARE>
1160 1249
1161=item C<EV_CHECK> 1250=item C<EV_CHECK>
1162 1251
1163All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts 1252All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1164to gather new events, and all C<ev_check> watchers are invoked just after 1253gather new events, and all C<ev_check> watchers are queued (not invoked)
1165C<ev_run> has gathered them, but before it invokes any callbacks for any 1254just after C<ev_run> has gathered them, but before it queues any callbacks
1255for any received events. That means C<ev_prepare> watchers are the last
1256watchers invoked before the event loop sleeps or polls for new events, and
1257C<ev_check> watchers will be invoked before any other watchers of the same
1258or lower priority within an event loop iteration.
1259
1166received events. Callbacks of both watcher types can start and stop as 1260Callbacks of both watcher types can start and stop as many watchers as
1167many watchers as they want, and all of them will be taken into account 1261they want, and all of them will be taken into account (for example, a
1168(for example, a C<ev_prepare> watcher might start an idle watcher to keep 1262C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1169C<ev_run> from blocking). 1263blocking).
1170 1264
1171=item C<EV_EMBED> 1265=item C<EV_EMBED>
1172 1266
1173The embedded event loop specified in the C<ev_embed> watcher needs attention. 1267The embedded event loop specified in the C<ev_embed> watcher needs attention.
1174 1268
1297 1391
1298=item callback ev_cb (ev_TYPE *watcher) 1392=item callback ev_cb (ev_TYPE *watcher)
1299 1393
1300Returns the callback currently set on the watcher. 1394Returns the callback currently set on the watcher.
1301 1395
1302=item ev_cb_set (ev_TYPE *watcher, callback) 1396=item ev_set_cb (ev_TYPE *watcher, callback)
1303 1397
1304Change the callback. You can change the callback at virtually any time 1398Change the callback. You can change the callback at virtually any time
1305(modulo threads). 1399(modulo threads).
1306 1400
1307=item ev_set_priority (ev_TYPE *watcher, int priority) 1401=item ev_set_priority (ev_TYPE *watcher, int priority)
1325or might not have been clamped to the valid range. 1419or might not have been clamped to the valid range.
1326 1420
1327The default priority used by watchers when no priority has been set is 1421The default priority used by watchers when no priority has been set is
1328always C<0>, which is supposed to not be too high and not be too low :). 1422always C<0>, which is supposed to not be too high and not be too low :).
1329 1423
1330See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1424See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1331priorities. 1425priorities.
1332 1426
1333=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1427=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1334 1428
1335Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1429Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1360See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related 1454See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1361functions that do not need a watcher. 1455functions that do not need a watcher.
1362 1456
1363=back 1457=back
1364 1458
1365See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1459See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1366OWN COMPOSITE WATCHERS> idioms. 1460OWN COMPOSITE WATCHERS> idioms.
1367 1461
1368=head2 WATCHER STATES 1462=head2 WATCHER STATES
1369 1463
1370There are various watcher states mentioned throughout this manual - 1464There are various watcher states mentioned throughout this manual -
1372transition between them will be described in more detail - and while these 1466transition between them will be described in more detail - and while these
1373rules might look complicated, they usually do "the right thing". 1467rules might look complicated, they usually do "the right thing".
1374 1468
1375=over 4 1469=over 4
1376 1470
1377=item initialiased 1471=item initialised
1378 1472
1379Before a watcher can be registered with the event looop it has to be 1473Before a watcher can be registered with the event loop it has to be
1380initialised. This can be done with a call to C<ev_TYPE_init>, or calls to 1474initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1381C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. 1475C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1382 1476
1383In this state it is simply some block of memory that is suitable for use 1477In this state it is simply some block of memory that is suitable for
1384in an event loop. It can be moved around, freed, reused etc. at will. 1478use in an event loop. It can be moved around, freed, reused etc. at
1479will - as long as you either keep the memory contents intact, or call
1480C<ev_TYPE_init> again.
1385 1481
1386=item started/running/active 1482=item started/running/active
1387 1483
1388Once a watcher has been started with a call to C<ev_TYPE_start> it becomes 1484Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1389property of the event loop, and is actively waiting for events. While in 1485property of the event loop, and is actively waiting for events. While in
1417latter will clear any pending state the watcher might be in, regardless 1513latter will clear any pending state the watcher might be in, regardless
1418of whether it was active or not, so stopping a watcher explicitly before 1514of whether it was active or not, so stopping a watcher explicitly before
1419freeing it is often a good idea. 1515freeing it is often a good idea.
1420 1516
1421While stopped (and not pending) the watcher is essentially in the 1517While stopped (and not pending) the watcher is essentially in the
1422initialised state, that is it can be reused, moved, modified in any way 1518initialised state, that is, it can be reused, moved, modified in any way
1423you wish. 1519you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
1520it again).
1424 1521
1425=back 1522=back
1426 1523
1427=head2 WATCHER PRIORITY MODELS 1524=head2 WATCHER PRIORITY MODELS
1428 1525
1577 1674
1578But really, best use non-blocking mode. 1675But really, best use non-blocking mode.
1579 1676
1580=head3 The special problem of disappearing file descriptors 1677=head3 The special problem of disappearing file descriptors
1581 1678
1582Some backends (e.g. kqueue, epoll) need to be told about closing a file 1679Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1583descriptor (either due to calling C<close> explicitly or any other means, 1680a file descriptor (either due to calling C<close> explicitly or any other
1584such as C<dup2>). The reason is that you register interest in some file 1681means, such as C<dup2>). The reason is that you register interest in some
1585descriptor, but when it goes away, the operating system will silently drop 1682file descriptor, but when it goes away, the operating system will silently
1586this interest. If another file descriptor with the same number then is 1683drop this interest. If another file descriptor with the same number then
1587registered with libev, there is no efficient way to see that this is, in 1684is registered with libev, there is no efficient way to see that this is,
1588fact, a different file descriptor. 1685in fact, a different file descriptor.
1589 1686
1590To avoid having to explicitly tell libev about such cases, libev follows 1687To avoid having to explicitly tell libev about such cases, libev follows
1591the following policy: Each time C<ev_io_set> is being called, libev 1688the following policy: Each time C<ev_io_set> is being called, libev
1592will assume that this is potentially a new file descriptor, otherwise 1689will assume that this is potentially a new file descriptor, otherwise
1593it is assumed that the file descriptor stays the same. That means that 1690it is assumed that the file descriptor stays the same. That means that
1642when you rarely read from a file instead of from a socket, and want to 1739when you rarely read from a file instead of from a socket, and want to
1643reuse the same code path. 1740reuse the same code path.
1644 1741
1645=head3 The special problem of fork 1742=head3 The special problem of fork
1646 1743
1647Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1744Some backends (epoll, kqueue, probably linuxaio) do not support C<fork ()>
1648useless behaviour. Libev fully supports fork, but needs to be told about 1745at all or exhibit useless behaviour. Libev fully supports fork, but needs
1649it in the child if you want to continue to use it in the child. 1746to be told about it in the child if you want to continue to use it in the
1747child.
1650 1748
1651To support fork in your child processes, you have to call C<ev_loop_fork 1749To support fork in your child processes, you have to call C<ev_loop_fork
1652()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to 1750()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1653C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1751C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1654 1752
1756detecting time jumps is hard, and some inaccuracies are unavoidable (the 1854detecting time jumps is hard, and some inaccuracies are unavoidable (the
1757monotonic clock option helps a lot here). 1855monotonic clock option helps a lot here).
1758 1856
1759The callback is guaranteed to be invoked only I<after> its timeout has 1857The callback is guaranteed to be invoked only I<after> its timeout has
1760passed (not I<at>, so on systems with very low-resolution clocks this 1858passed (not I<at>, so on systems with very low-resolution clocks this
1761might introduce a small delay). If multiple timers become ready during the 1859might introduce a small delay, see "the special problem of being too
1860early", below). If multiple timers become ready during the same loop
1762same loop iteration then the ones with earlier time-out values are invoked 1861iteration then the ones with earlier time-out values are invoked before
1763before ones of the same priority with later time-out values (but this is 1862ones of the same priority with later time-out values (but this is no
1764no longer true when a callback calls C<ev_run> recursively). 1863longer true when a callback calls C<ev_run> recursively).
1765 1864
1766=head3 Be smart about timeouts 1865=head3 Be smart about timeouts
1767 1866
1768Many real-world problems involve some kind of timeout, usually for error 1867Many real-world problems involve some kind of timeout, usually for error
1769recovery. A typical example is an HTTP request - if the other side hangs, 1868recovery. A typical example is an HTTP request - if the other side hangs,
1844 1943
1845In this case, it would be more efficient to leave the C<ev_timer> alone, 1944In this case, it would be more efficient to leave the C<ev_timer> alone,
1846but remember the time of last activity, and check for a real timeout only 1945but remember the time of last activity, and check for a real timeout only
1847within the callback: 1946within the callback:
1848 1947
1948 ev_tstamp timeout = 60.;
1849 ev_tstamp last_activity; // time of last activity 1949 ev_tstamp last_activity; // time of last activity
1950 ev_timer timer;
1850 1951
1851 static void 1952 static void
1852 callback (EV_P_ ev_timer *w, int revents) 1953 callback (EV_P_ ev_timer *w, int revents)
1853 { 1954 {
1854 ev_tstamp now = ev_now (EV_A); 1955 // calculate when the timeout would happen
1855 ev_tstamp timeout = last_activity + 60.; 1956 ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1856 1957
1857 // if last_activity + 60. is older than now, we did time out 1958 // if negative, it means we the timeout already occurred
1858 if (timeout < now) 1959 if (after < 0.)
1859 { 1960 {
1860 // timeout occurred, take action 1961 // timeout occurred, take action
1861 } 1962 }
1862 else 1963 else
1863 { 1964 {
1864 // callback was invoked, but there was some activity, re-arm 1965 // callback was invoked, but there was some recent
1865 // the watcher to fire in last_activity + 60, which is 1966 // activity. simply restart the timer to time out
1866 // guaranteed to be in the future, so "again" is positive: 1967 // after "after" seconds, which is the earliest time
1867 w->repeat = timeout - now; 1968 // the timeout can occur.
1969 ev_timer_set (w, after, 0.);
1868 ev_timer_again (EV_A_ w); 1970 ev_timer_start (EV_A_ w);
1869 } 1971 }
1870 } 1972 }
1871 1973
1872To summarise the callback: first calculate the real timeout (defined 1974To summarise the callback: first calculate in how many seconds the
1873as "60 seconds after the last activity"), then check if that time has 1975timeout will occur (by calculating the absolute time when it would occur,
1874been reached, which means something I<did>, in fact, time out. Otherwise 1976C<last_activity + timeout>, and subtracting the current time, C<ev_now
1875the callback was invoked too early (C<timeout> is in the future), so 1977(EV_A)> from that).
1876re-schedule the timer to fire at that future time, to see if maybe we have
1877a timeout then.
1878 1978
1879Note how C<ev_timer_again> is used, taking advantage of the 1979If this value is negative, then we are already past the timeout, i.e. we
1880C<ev_timer_again> optimisation when the timer is already running. 1980timed out, and need to do whatever is needed in this case.
1981
1982Otherwise, we now the earliest time at which the timeout would trigger,
1983and simply start the timer with this timeout value.
1984
1985In other words, each time the callback is invoked it will check whether
1986the timeout occurred. If not, it will simply reschedule itself to check
1987again at the earliest time it could time out. Rinse. Repeat.
1881 1988
1882This scheme causes more callback invocations (about one every 60 seconds 1989This scheme causes more callback invocations (about one every 60 seconds
1883minus half the average time between activity), but virtually no calls to 1990minus half the average time between activity), but virtually no calls to
1884libev to change the timeout. 1991libev to change the timeout.
1885 1992
1886To start the timer, simply initialise the watcher and set C<last_activity> 1993To start the machinery, simply initialise the watcher and set
1887to the current time (meaning we just have some activity :), then call the 1994C<last_activity> to the current time (meaning there was some activity just
1888callback, which will "do the right thing" and start the timer: 1995now), then call the callback, which will "do the right thing" and start
1996the timer:
1889 1997
1998 last_activity = ev_now (EV_A);
1890 ev_init (timer, callback); 1999 ev_init (&timer, callback);
1891 last_activity = ev_now (loop); 2000 callback (EV_A_ &timer, 0);
1892 callback (loop, timer, EV_TIMER);
1893 2001
1894And when there is some activity, simply store the current time in 2002When there is some activity, simply store the current time in
1895C<last_activity>, no libev calls at all: 2003C<last_activity>, no libev calls at all:
1896 2004
2005 if (activity detected)
1897 last_activity = ev_now (loop); 2006 last_activity = ev_now (EV_A);
2007
2008When your timeout value changes, then the timeout can be changed by simply
2009providing a new value, stopping the timer and calling the callback, which
2010will again do the right thing (for example, time out immediately :).
2011
2012 timeout = new_value;
2013 ev_timer_stop (EV_A_ &timer);
2014 callback (EV_A_ &timer, 0);
1898 2015
1899This technique is slightly more complex, but in most cases where the 2016This technique is slightly more complex, but in most cases where the
1900time-out is unlikely to be triggered, much more efficient. 2017time-out is unlikely to be triggered, much more efficient.
1901
1902Changing the timeout is trivial as well (if it isn't hard-coded in the
1903callback :) - just change the timeout and invoke the callback, which will
1904fix things for you.
1905 2018
1906=item 4. Wee, just use a double-linked list for your timeouts. 2019=item 4. Wee, just use a double-linked list for your timeouts.
1907 2020
1908If there is not one request, but many thousands (millions...), all 2021If there is not one request, but many thousands (millions...), all
1909employing some kind of timeout with the same timeout value, then one can 2022employing some kind of timeout with the same timeout value, then one can
1936Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 2049Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1937rather complicated, but extremely efficient, something that really pays 2050rather complicated, but extremely efficient, something that really pays
1938off after the first million or so of active timers, i.e. it's usually 2051off after the first million or so of active timers, i.e. it's usually
1939overkill :) 2052overkill :)
1940 2053
2054=head3 The special problem of being too early
2055
2056If you ask a timer to call your callback after three seconds, then
2057you expect it to be invoked after three seconds - but of course, this
2058cannot be guaranteed to infinite precision. Less obviously, it cannot be
2059guaranteed to any precision by libev - imagine somebody suspending the
2060process with a STOP signal for a few hours for example.
2061
2062So, libev tries to invoke your callback as soon as possible I<after> the
2063delay has occurred, but cannot guarantee this.
2064
2065A less obvious failure mode is calling your callback too early: many event
2066loops compare timestamps with a "elapsed delay >= requested delay", but
2067this can cause your callback to be invoked much earlier than you would
2068expect.
2069
2070To see why, imagine a system with a clock that only offers full second
2071resolution (think windows if you can't come up with a broken enough OS
2072yourself). If you schedule a one-second timer at the time 500.9, then the
2073event loop will schedule your timeout to elapse at a system time of 500
2074(500.9 truncated to the resolution) + 1, or 501.
2075
2076If an event library looks at the timeout 0.1s later, it will see "501 >=
2077501" and invoke the callback 0.1s after it was started, even though a
2078one-second delay was requested - this is being "too early", despite best
2079intentions.
2080
2081This is the reason why libev will never invoke the callback if the elapsed
2082delay equals the requested delay, but only when the elapsed delay is
2083larger than the requested delay. In the example above, libev would only invoke
2084the callback at system time 502, or 1.1s after the timer was started.
2085
2086So, while libev cannot guarantee that your callback will be invoked
2087exactly when requested, it I<can> and I<does> guarantee that the requested
2088delay has actually elapsed, or in other words, it always errs on the "too
2089late" side of things.
2090
1941=head3 The special problem of time updates 2091=head3 The special problem of time updates
1942 2092
1943Establishing the current time is a costly operation (it usually takes at 2093Establishing the current time is a costly operation (it usually takes
1944least two system calls): EV therefore updates its idea of the current 2094at least one system call): EV therefore updates its idea of the current
1945time only before and after C<ev_run> collects new events, which causes a 2095time only before and after C<ev_run> collects new events, which causes a
1946growing difference between C<ev_now ()> and C<ev_time ()> when handling 2096growing difference between C<ev_now ()> and C<ev_time ()> when handling
1947lots of events in one iteration. 2097lots of events in one iteration.
1948 2098
1949The relative timeouts are calculated relative to the C<ev_now ()> 2099The relative timeouts are calculated relative to the C<ev_now ()>
1950time. This is usually the right thing as this timestamp refers to the time 2100time. This is usually the right thing as this timestamp refers to the time
1951of the event triggering whatever timeout you are modifying/starting. If 2101of the event triggering whatever timeout you are modifying/starting. If
1952you suspect event processing to be delayed and you I<need> to base the 2102you suspect event processing to be delayed and you I<need> to base the
1953timeout on the current time, use something like this to adjust for this: 2103timeout on the current time, use something like the following to adjust
2104for it:
1954 2105
1955 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2106 ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
1956 2107
1957If the event loop is suspended for a long time, you can also force an 2108If the event loop is suspended for a long time, you can also force an
1958update of the time returned by C<ev_now ()> by calling C<ev_now_update 2109update of the time returned by C<ev_now ()> by calling C<ev_now_update
1959()>. 2110()>, although that will push the event time of all outstanding events
2111further into the future.
2112
2113=head3 The special problem of unsynchronised clocks
2114
2115Modern systems have a variety of clocks - libev itself uses the normal
2116"wall clock" clock and, if available, the monotonic clock (to avoid time
2117jumps).
2118
2119Neither of these clocks is synchronised with each other or any other clock
2120on the system, so C<ev_time ()> might return a considerably different time
2121than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
2122a call to C<gettimeofday> might return a second count that is one higher
2123than a directly following call to C<time>.
2124
2125The moral of this is to only compare libev-related timestamps with
2126C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
2127a second or so.
2128
2129One more problem arises due to this lack of synchronisation: if libev uses
2130the system monotonic clock and you compare timestamps from C<ev_time>
2131or C<ev_now> from when you started your timer and when your callback is
2132invoked, you will find that sometimes the callback is a bit "early".
2133
2134This is because C<ev_timer>s work in real time, not wall clock time, so
2135libev makes sure your callback is not invoked before the delay happened,
2136I<measured according to the real time>, not the system clock.
2137
2138If your timeouts are based on a physical timescale (e.g. "time out this
2139connection after 100 seconds") then this shouldn't bother you as it is
2140exactly the right behaviour.
2141
2142If you want to compare wall clock/system timestamps to your timers, then
2143you need to use C<ev_periodic>s, as these are based on the wall clock
2144time, where your comparisons will always generate correct results.
1960 2145
1961=head3 The special problems of suspended animation 2146=head3 The special problems of suspended animation
1962 2147
1963When you leave the server world it is quite customary to hit machines that 2148When you leave the server world it is quite customary to hit machines that
1964can suspend/hibernate - what happens to the clocks during such a suspend? 2149can suspend/hibernate - what happens to the clocks during such a suspend?
1994 2179
1995=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 2180=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1996 2181
1997=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 2182=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1998 2183
1999Configure the timer to trigger after C<after> seconds. If C<repeat> 2184Configure the timer to trigger after C<after> seconds (fractional and
2000is C<0.>, then it will automatically be stopped once the timeout is 2185negative values are supported). If C<repeat> is C<0.>, then it will
2001reached. If it is positive, then the timer will automatically be 2186automatically be stopped once the timeout is reached. If it is positive,
2002configured to trigger again C<repeat> seconds later, again, and again, 2187then the timer will automatically be configured to trigger again C<repeat>
2003until stopped manually. 2188seconds later, again, and again, until stopped manually.
2004 2189
2005The timer itself will do a best-effort at avoiding drift, that is, if 2190The timer itself will do a best-effort at avoiding drift, that is, if
2006you configure a timer to trigger every 10 seconds, then it will normally 2191you configure a timer to trigger every 10 seconds, then it will normally
2007trigger at exactly 10 second intervals. If, however, your program cannot 2192trigger at exactly 10 second intervals. If, however, your program cannot
2008keep up with the timer (because it takes longer than those 10 seconds to 2193keep up with the timer (because it takes longer than those 10 seconds to
2009do stuff) the timer will not fire more than once per event loop iteration. 2194do stuff) the timer will not fire more than once per event loop iteration.
2010 2195
2011=item ev_timer_again (loop, ev_timer *) 2196=item ev_timer_again (loop, ev_timer *)
2012 2197
2013This will act as if the timer timed out and restart it again if it is 2198This will act as if the timer timed out, and restarts it again if it is
2014repeating. The exact semantics are: 2199repeating. It basically works like calling C<ev_timer_stop>, updating the
2200timeout to the C<repeat> value and calling C<ev_timer_start>.
2015 2201
2202The exact semantics are as in the following rules, all of which will be
2203applied to the watcher:
2204
2205=over 4
2206
2016If the timer is pending, its pending status is cleared. 2207=item If the timer is pending, the pending status is always cleared.
2017 2208
2018If the timer is started but non-repeating, stop it (as if it timed out). 2209=item If the timer is started but non-repeating, stop it (as if it timed
2210out, without invoking it).
2019 2211
2020If the timer is repeating, either start it if necessary (with the 2212=item If the timer is repeating, make the C<repeat> value the new timeout
2021C<repeat> value), or reset the running timer to the C<repeat> value. 2213and start the timer, if necessary.
2022 2214
2215=back
2216
2023This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2217This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2024usage example. 2218usage example.
2025 2219
2026=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2220=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2027 2221
2028Returns the remaining time until a timer fires. If the timer is active, 2222Returns the remaining time until a timer fires. If the timer is active,
2081Periodic watchers are also timers of a kind, but they are very versatile 2275Periodic watchers are also timers of a kind, but they are very versatile
2082(and unfortunately a bit complex). 2276(and unfortunately a bit complex).
2083 2277
2084Unlike C<ev_timer>, periodic watchers are not based on real time (or 2278Unlike C<ev_timer>, periodic watchers are not based on real time (or
2085relative time, the physical time that passes) but on wall clock time 2279relative time, the physical time that passes) but on wall clock time
2086(absolute time, the thing you can read on your calender or clock). The 2280(absolute time, the thing you can read on your calendar or clock). The
2087difference is that wall clock time can run faster or slower than real 2281difference is that wall clock time can run faster or slower than real
2088time, and time jumps are not uncommon (e.g. when you adjust your 2282time, and time jumps are not uncommon (e.g. when you adjust your
2089wrist-watch). 2283wrist-watch).
2090 2284
2091You can tell a periodic watcher to trigger after some specific point 2285You can tell a periodic watcher to trigger after some specific point
2096C<ev_timer>, which would still trigger roughly 10 seconds after starting 2290C<ev_timer>, which would still trigger roughly 10 seconds after starting
2097it, as it uses a relative timeout). 2291it, as it uses a relative timeout).
2098 2292
2099C<ev_periodic> watchers can also be used to implement vastly more complex 2293C<ev_periodic> watchers can also be used to implement vastly more complex
2100timers, such as triggering an event on each "midnight, local time", or 2294timers, such as triggering an event on each "midnight, local time", or
2101other complicated rules. This cannot be done with C<ev_timer> watchers, as 2295other complicated rules. This cannot easily be done with C<ev_timer>
2102those cannot react to time jumps. 2296watchers, as those cannot react to time jumps.
2103 2297
2104As with timers, the callback is guaranteed to be invoked only when the 2298As with timers, the callback is guaranteed to be invoked only when the
2105point in time where it is supposed to trigger has passed. If multiple 2299point in time where it is supposed to trigger has passed. If multiple
2106timers become ready during the same loop iteration then the ones with 2300timers become ready during the same loop iteration then the ones with
2107earlier time-out values are invoked before ones with later time-out values 2301earlier time-out values are invoked before ones with later time-out values
2148 2342
2149Another way to think about it (for the mathematically inclined) is that 2343Another way to think about it (for the mathematically inclined) is that
2150C<ev_periodic> will try to run the callback in this mode at the next possible 2344C<ev_periodic> will try to run the callback in this mode at the next possible
2151time where C<time = offset (mod interval)>, regardless of any time jumps. 2345time where C<time = offset (mod interval)>, regardless of any time jumps.
2152 2346
2153For numerical stability it is preferable that the C<offset> value is near 2347The C<interval> I<MUST> be positive, and for numerical stability, the
2154C<ev_now ()> (the current time), but there is no range requirement for 2348interval value should be higher than C<1/8192> (which is around 100
2155this value, and in fact is often specified as zero. 2349microseconds) and C<offset> should be higher than C<0> and should have
2350at most a similar magnitude as the current time (say, within a factor of
2351ten). Typical values for offset are, in fact, C<0> or something between
2352C<0> and C<interval>, which is also the recommended range.
2156 2353
2157Note also that there is an upper limit to how often a timer can fire (CPU 2354Note also that there is an upper limit to how often a timer can fire (CPU
2158speed for example), so if C<interval> is very small then timing stability 2355speed for example), so if C<interval> is very small then timing stability
2159will of course deteriorate. Libev itself tries to be exact to be about one 2356will of course deteriorate. Libev itself tries to be exact to be about one
2160millisecond (if the OS supports it and the machine is fast enough). 2357millisecond (if the OS supports it and the machine is fast enough).
2190 2387
2191NOTE: I<< This callback must always return a time that is higher than or 2388NOTE: I<< This callback must always return a time that is higher than or
2192equal to the passed C<now> value >>. 2389equal to the passed C<now> value >>.
2193 2390
2194This can be used to create very complex timers, such as a timer that 2391This can be used to create very complex timers, such as a timer that
2195triggers on "next midnight, local time". To do this, you would calculate the 2392triggers on "next midnight, local time". To do this, you would calculate
2196next midnight after C<now> and return the timestamp value for this. How 2393the next midnight after C<now> and return the timestamp value for
2197you do this is, again, up to you (but it is not trivial, which is the main 2394this. Here is a (completely untested, no error checking) example on how to
2198reason I omitted it as an example). 2395do this:
2396
2397 #include <time.h>
2398
2399 static ev_tstamp
2400 my_rescheduler (ev_periodic *w, ev_tstamp now)
2401 {
2402 time_t tnow = (time_t)now;
2403 struct tm tm;
2404 localtime_r (&tnow, &tm);
2405
2406 tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2407 ++tm.tm_mday; // midnight next day
2408
2409 return mktime (&tm);
2410 }
2411
2412Note: this code might run into trouble on days that have more then two
2413midnights (beginning and end).
2199 2414
2200=back 2415=back
2201 2416
2202=item ev_periodic_again (loop, ev_periodic *) 2417=item ev_periodic_again (loop, ev_periodic *)
2203 2418
2268 2483
2269 ev_periodic hourly_tick; 2484 ev_periodic hourly_tick;
2270 ev_periodic_init (&hourly_tick, clock_cb, 2485 ev_periodic_init (&hourly_tick, clock_cb,
2271 fmod (ev_now (loop), 3600.), 3600., 0); 2486 fmod (ev_now (loop), 3600.), 3600., 0);
2272 ev_periodic_start (loop, &hourly_tick); 2487 ev_periodic_start (loop, &hourly_tick);
2273 2488
2274 2489
2275=head2 C<ev_signal> - signal me when a signal gets signalled! 2490=head2 C<ev_signal> - signal me when a signal gets signalled!
2276 2491
2277Signal watchers will trigger an event when the process receives a specific 2492Signal watchers will trigger an event when the process receives a specific
2278signal one or more times. Even though signals are very asynchronous, libev 2493signal one or more times. Even though signals are very asynchronous, libev
2288only within the same loop, i.e. you can watch for C<SIGINT> in your 2503only within the same loop, i.e. you can watch for C<SIGINT> in your
2289default loop and for C<SIGIO> in another loop, but you cannot watch for 2504default loop and for C<SIGIO> in another loop, but you cannot watch for
2290C<SIGINT> in both the default loop and another loop at the same time. At 2505C<SIGINT> in both the default loop and another loop at the same time. At
2291the moment, C<SIGCHLD> is permanently tied to the default loop. 2506the moment, C<SIGCHLD> is permanently tied to the default loop.
2292 2507
2293When the first watcher gets started will libev actually register something 2508Only after the first watcher for a signal is started will libev actually
2294with the kernel (thus it coexists with your own signal handlers as long as 2509register something with the kernel. It thus coexists with your own signal
2295you don't register any with libev for the same signal). 2510handlers as long as you don't register any with libev for the same signal.
2296 2511
2297If possible and supported, libev will install its handlers with 2512If possible and supported, libev will install its handlers with
2298C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2513C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2299not be unduly interrupted. If you have a problem with system calls getting 2514not be unduly interrupted. If you have a problem with system calls getting
2300interrupted by signals you can block all signals in an C<ev_check> watcher 2515interrupted by signals you can block all signals in an C<ev_check> watcher
2485 2700
2486=head2 C<ev_stat> - did the file attributes just change? 2701=head2 C<ev_stat> - did the file attributes just change?
2487 2702
2488This watches a file system path for attribute changes. That is, it calls 2703This watches a file system path for attribute changes. That is, it calls
2489C<stat> on that path in regular intervals (or when the OS says it changed) 2704C<stat> on that path in regular intervals (or when the OS says it changed)
2490and sees if it changed compared to the last time, invoking the callback if 2705and sees if it changed compared to the last time, invoking the callback
2491it did. 2706if it did. Starting the watcher C<stat>'s the file, so only changes that
2707happen after the watcher has been started will be reported.
2492 2708
2493The path does not need to exist: changing from "path exists" to "path does 2709The path does not need to exist: changing from "path exists" to "path does
2494not exist" is a status change like any other. The condition "path does not 2710not exist" is a status change like any other. The condition "path does not
2495exist" (or more correctly "path cannot be stat'ed") is signified by the 2711exist" (or more correctly "path cannot be stat'ed") is signified by the
2496C<st_nlink> field being zero (which is otherwise always forced to be at 2712C<st_nlink> field being zero (which is otherwise always forced to be at
2726Apart from keeping your process non-blocking (which is a useful 2942Apart from keeping your process non-blocking (which is a useful
2727effect on its own sometimes), idle watchers are a good place to do 2943effect on its own sometimes), idle watchers are a good place to do
2728"pseudo-background processing", or delay processing stuff to after the 2944"pseudo-background processing", or delay processing stuff to after the
2729event loop has handled all outstanding events. 2945event loop has handled all outstanding events.
2730 2946
2947=head3 Abusing an C<ev_idle> watcher for its side-effect
2948
2949As long as there is at least one active idle watcher, libev will never
2950sleep unnecessarily. Or in other words, it will loop as fast as possible.
2951For this to work, the idle watcher doesn't need to be invoked at all - the
2952lowest priority will do.
2953
2954This mode of operation can be useful together with an C<ev_check> watcher,
2955to do something on each event loop iteration - for example to balance load
2956between different connections.
2957
2958See L</Abusing an ev_check watcher for its side-effect> for a longer
2959example.
2960
2731=head3 Watcher-Specific Functions and Data Members 2961=head3 Watcher-Specific Functions and Data Members
2732 2962
2733=over 4 2963=over 4
2734 2964
2735=item ev_idle_init (ev_idle *, callback) 2965=item ev_idle_init (ev_idle *, callback)
2746callback, free it. Also, use no error checking, as usual. 2976callback, free it. Also, use no error checking, as usual.
2747 2977
2748 static void 2978 static void
2749 idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 2979 idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2750 { 2980 {
2981 // stop the watcher
2982 ev_idle_stop (loop, w);
2983
2984 // now we can free it
2751 free (w); 2985 free (w);
2986
2752 // now do something you wanted to do when the program has 2987 // now do something you wanted to do when the program has
2753 // no longer anything immediate to do. 2988 // no longer anything immediate to do.
2754 } 2989 }
2755 2990
2756 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2991 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2758 ev_idle_start (loop, idle_watcher); 2993 ev_idle_start (loop, idle_watcher);
2759 2994
2760 2995
2761=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2996=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2762 2997
2763Prepare and check watchers are usually (but not always) used in pairs: 2998Prepare and check watchers are often (but not always) used in pairs:
2764prepare watchers get invoked before the process blocks and check watchers 2999prepare watchers get invoked before the process blocks and check watchers
2765afterwards. 3000afterwards.
2766 3001
2767You I<must not> call C<ev_run> or similar functions that enter 3002You I<must not> call C<ev_run> (or similar functions that enter the
2768the current event loop from either C<ev_prepare> or C<ev_check> 3003current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2769watchers. Other loops than the current one are fine, however. The 3004C<ev_check> watchers. Other loops than the current one are fine,
2770rationale behind this is that you do not need to check for recursion in 3005however. The rationale behind this is that you do not need to check
2771those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, 3006for recursion in those watchers, i.e. the sequence will always be
2772C<ev_check> so if you have one watcher of each kind they will always be 3007C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2773called in pairs bracketing the blocking call. 3008kind they will always be called in pairs bracketing the blocking call.
2774 3009
2775Their main purpose is to integrate other event mechanisms into libev and 3010Their main purpose is to integrate other event mechanisms into libev and
2776their use is somewhat advanced. They could be used, for example, to track 3011their use is somewhat advanced. They could be used, for example, to track
2777variable changes, implement your own watchers, integrate net-snmp or a 3012variable changes, implement your own watchers, integrate net-snmp or a
2778coroutine library and lots more. They are also occasionally useful if 3013coroutine library and lots more. They are also occasionally useful if
2796with priority higher than or equal to the event loop and one coroutine 3031with priority higher than or equal to the event loop and one coroutine
2797of lower priority, but only once, using idle watchers to keep the event 3032of lower priority, but only once, using idle watchers to keep the event
2798loop from blocking if lower-priority coroutines are active, thus mapping 3033loop from blocking if lower-priority coroutines are active, thus mapping
2799low-priority coroutines to idle/background tasks). 3034low-priority coroutines to idle/background tasks).
2800 3035
2801It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 3036When used for this purpose, it is recommended to give C<ev_check> watchers
2802priority, to ensure that they are being run before any other watchers 3037highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2803after the poll (this doesn't matter for C<ev_prepare> watchers). 3038any other watchers after the poll (this doesn't matter for C<ev_prepare>
3039watchers).
2804 3040
2805Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not 3041Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2806activate ("feed") events into libev. While libev fully supports this, they 3042activate ("feed") events into libev. While libev fully supports this, they
2807might get executed before other C<ev_check> watchers did their job. As 3043might get executed before other C<ev_check> watchers did their job. As
2808C<ev_check> watchers are often used to embed other (non-libev) event 3044C<ev_check> watchers are often used to embed other (non-libev) event
2809loops those other event loops might be in an unusable state until their 3045loops those other event loops might be in an unusable state until their
2810C<ev_check> watcher ran (always remind yourself to coexist peacefully with 3046C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2811others). 3047others).
3048
3049=head3 Abusing an C<ev_check> watcher for its side-effect
3050
3051C<ev_check> (and less often also C<ev_prepare>) watchers can also be
3052useful because they are called once per event loop iteration. For
3053example, if you want to handle a large number of connections fairly, you
3054normally only do a bit of work for each active connection, and if there
3055is more work to do, you wait for the next event loop iteration, so other
3056connections have a chance of making progress.
3057
3058Using an C<ev_check> watcher is almost enough: it will be called on the
3059next event loop iteration. However, that isn't as soon as possible -
3060without external events, your C<ev_check> watcher will not be invoked.
3061
3062This is where C<ev_idle> watchers come in handy - all you need is a
3063single global idle watcher that is active as long as you have one active
3064C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
3065will not sleep, and the C<ev_check> watcher makes sure a callback gets
3066invoked. Neither watcher alone can do that.
2812 3067
2813=head3 Watcher-Specific Functions and Data Members 3068=head3 Watcher-Specific Functions and Data Members
2814 3069
2815=over 4 3070=over 4
2816 3071
3017 3272
3018=over 4 3273=over 4
3019 3274
3020=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3275=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3021 3276
3022=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3277=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3023 3278
3024Configures the watcher to embed the given loop, which must be 3279Configures the watcher to embed the given loop, which must be
3025embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3280embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3026invoked automatically, otherwise it is the responsibility of the callback 3281invoked automatically, otherwise it is the responsibility of the callback
3027to invoke it (it will continue to be called until the sweep has been done, 3282to invoke it (it will continue to be called until the sweep has been done,
3048used). 3303used).
3049 3304
3050 struct ev_loop *loop_hi = ev_default_init (0); 3305 struct ev_loop *loop_hi = ev_default_init (0);
3051 struct ev_loop *loop_lo = 0; 3306 struct ev_loop *loop_lo = 0;
3052 ev_embed embed; 3307 ev_embed embed;
3053 3308
3054 // see if there is a chance of getting one that works 3309 // see if there is a chance of getting one that works
3055 // (remember that a flags value of 0 means autodetection) 3310 // (remember that a flags value of 0 means autodetection)
3056 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3311 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3057 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3312 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3058 : 0; 3313 : 0;
3072C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3327C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3073 3328
3074 struct ev_loop *loop = ev_default_init (0); 3329 struct ev_loop *loop = ev_default_init (0);
3075 struct ev_loop *loop_socket = 0; 3330 struct ev_loop *loop_socket = 0;
3076 ev_embed embed; 3331 ev_embed embed;
3077 3332
3078 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3333 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3079 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3334 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3080 { 3335 {
3081 ev_embed_init (&embed, 0, loop_socket); 3336 ev_embed_init (&embed, 0, loop_socket);
3082 ev_embed_start (loop, &embed); 3337 ev_embed_start (loop, &embed);
3090 3345
3091=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3346=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3092 3347
3093Fork watchers are called when a C<fork ()> was detected (usually because 3348Fork watchers are called when a C<fork ()> was detected (usually because
3094whoever is a good citizen cared to tell libev about it by calling 3349whoever is a good citizen cared to tell libev about it by calling
3095C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the 3350C<ev_loop_fork>). The invocation is done before the event loop blocks next
3096event loop blocks next and before C<ev_check> watchers are being called, 3351and before C<ev_check> watchers are being called, and only in the child
3097and only in the child after the fork. If whoever good citizen calling 3352after the fork. If whoever good citizen calling C<ev_default_fork> cheats
3098C<ev_default_fork> cheats and calls it in the wrong process, the fork 3353and calls it in the wrong process, the fork handlers will be invoked, too,
3099handlers will be invoked, too, of course. 3354of course.
3100 3355
3101=head3 The special problem of life after fork - how is it possible? 3356=head3 The special problem of life after fork - how is it possible?
3102 3357
3103Most uses of C<fork()> consist of forking, then some simple calls to set 3358Most uses of C<fork ()> consist of forking, then some simple calls to set
3104up/change the process environment, followed by a call to C<exec()>. This 3359up/change the process environment, followed by a call to C<exec()>. This
3105sequence should be handled by libev without any problems. 3360sequence should be handled by libev without any problems.
3106 3361
3107This changes when the application actually wants to do event handling 3362This changes when the application actually wants to do event handling
3108in the child, or both parent in child, in effect "continuing" after the 3363in the child, or both parent in child, in effect "continuing" after the
3185 atexit (program_exits); 3440 atexit (program_exits);
3186 3441
3187 3442
3188=head2 C<ev_async> - how to wake up an event loop 3443=head2 C<ev_async> - how to wake up an event loop
3189 3444
3190In general, you cannot use an C<ev_run> from multiple threads or other 3445In general, you cannot use an C<ev_loop> from multiple threads or other
3191asynchronous sources such as signal handlers (as opposed to multiple event 3446asynchronous sources such as signal handlers (as opposed to multiple event
3192loops - those are of course safe to use in different threads). 3447loops - those are of course safe to use in different threads).
3193 3448
3194Sometimes, however, you need to wake up an event loop you do not control, 3449Sometimes, however, you need to wake up an event loop you do not control,
3195for example because it belongs to another thread. This is what C<ev_async> 3450for example because it belongs to another thread. This is what C<ev_async>
3197it by calling C<ev_async_send>, which is thread- and signal safe. 3452it by calling C<ev_async_send>, which is thread- and signal safe.
3198 3453
3199This functionality is very similar to C<ev_signal> watchers, as signals, 3454This functionality is very similar to C<ev_signal> watchers, as signals,
3200too, are asynchronous in nature, and signals, too, will be compressed 3455too, are asynchronous in nature, and signals, too, will be compressed
3201(i.e. the number of callback invocations may be less than the number of 3456(i.e. the number of callback invocations may be less than the number of
3202C<ev_async_sent> calls). In fact, you could use signal watchers as a kind 3457C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3203of "global async watchers" by using a watcher on an otherwise unused 3458of "global async watchers" by using a watcher on an otherwise unused
3204signal, and C<ev_feed_signal> to signal this watcher from another thread, 3459signal, and C<ev_feed_signal> to signal this watcher from another thread,
3205even without knowing which loop owns the signal. 3460even without knowing which loop owns the signal.
3206
3207Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3208just the default loop.
3209 3461
3210=head3 Queueing 3462=head3 Queueing
3211 3463
3212C<ev_async> does not support queueing of data in any way. The reason 3464C<ev_async> does not support queueing of data in any way. The reason
3213is that the author does not know of a simple (or any) algorithm for a 3465is that the author does not know of a simple (or any) algorithm for a
3305trust me. 3557trust me.
3306 3558
3307=item ev_async_send (loop, ev_async *) 3559=item ev_async_send (loop, ev_async *)
3308 3560
3309Sends/signals/activates the given C<ev_async> watcher, that is, feeds 3561Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3310an C<EV_ASYNC> event on the watcher into the event loop. Unlike 3562an C<EV_ASYNC> event on the watcher into the event loop, and instantly
3563returns.
3564
3311C<ev_feed_event>, this call is safe to do from other threads, signal or 3565Unlike C<ev_feed_event>, this call is safe to do from other threads,
3312similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding 3566signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3313section below on what exactly this means). 3567embedding section below on what exactly this means).
3314 3568
3315Note that, as with other watchers in libev, multiple events might get 3569Note that, as with other watchers in libev, multiple events might get
3316compressed into a single callback invocation (another way to look at this 3570compressed into a single callback invocation (another way to look at
3317is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, 3571this is that C<ev_async> watchers are level-triggered: they are set on
3318reset when the event loop detects that). 3572C<ev_async_send>, reset when the event loop detects that).
3319 3573
3320This call incurs the overhead of a system call only once per event loop 3574This call incurs the overhead of at most one extra system call per event
3321iteration, so while the overhead might be noticeable, it doesn't apply to 3575loop iteration, if the event loop is blocked, and no syscall at all if
3322repeated calls to C<ev_async_send> for the same event loop. 3576the event loop (or your program) is processing events. That means that
3577repeated calls are basically free (there is no need to avoid calls for
3578performance reasons) and that the overhead becomes smaller (typically
3579zero) under load.
3323 3580
3324=item bool = ev_async_pending (ev_async *) 3581=item bool = ev_async_pending (ev_async *)
3325 3582
3326Returns a non-zero value when C<ev_async_send> has been called on the 3583Returns a non-zero value when C<ev_async_send> has been called on the
3327watcher but the event has not yet been processed (or even noted) by the 3584watcher but the event has not yet been processed (or even noted) by the
3344 3601
3345There are some other functions of possible interest. Described. Here. Now. 3602There are some other functions of possible interest. Described. Here. Now.
3346 3603
3347=over 4 3604=over 4
3348 3605
3349=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 3606=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3350 3607
3351This function combines a simple timer and an I/O watcher, calls your 3608This function combines a simple timer and an I/O watcher, calls your
3352callback on whichever event happens first and automatically stops both 3609callback on whichever event happens first and automatically stops both
3353watchers. This is useful if you want to wait for a single event on an fd 3610watchers. This is useful if you want to wait for a single event on an fd
3354or timeout without having to allocate/configure/start/stop/free one or 3611or timeout without having to allocate/configure/start/stop/free one or
3382 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3639 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3383 3640
3384=item ev_feed_fd_event (loop, int fd, int revents) 3641=item ev_feed_fd_event (loop, int fd, int revents)
3385 3642
3386Feed an event on the given fd, as if a file descriptor backend detected 3643Feed an event on the given fd, as if a file descriptor backend detected
3387the given events it. 3644the given events.
3388 3645
3389=item ev_feed_signal_event (loop, int signum) 3646=item ev_feed_signal_event (loop, int signum)
3390 3647
3391Feed an event as if the given signal occurred. See also C<ev_feed_signal>, 3648Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3392which is async-safe. 3649which is async-safe.
3466 { 3723 {
3467 struct my_biggy big = (struct my_biggy *) 3724 struct my_biggy big = (struct my_biggy *)
3468 (((char *)w) - offsetof (struct my_biggy, t2)); 3725 (((char *)w) - offsetof (struct my_biggy, t2));
3469 } 3726 }
3470 3727
3728=head2 AVOIDING FINISHING BEFORE RETURNING
3729
3730Often you have structures like this in event-based programs:
3731
3732 callback ()
3733 {
3734 free (request);
3735 }
3736
3737 request = start_new_request (..., callback);
3738
3739The intent is to start some "lengthy" operation. The C<request> could be
3740used to cancel the operation, or do other things with it.
3741
3742It's not uncommon to have code paths in C<start_new_request> that
3743immediately invoke the callback, for example, to report errors. Or you add
3744some caching layer that finds that it can skip the lengthy aspects of the
3745operation and simply invoke the callback with the result.
3746
3747The problem here is that this will happen I<before> C<start_new_request>
3748has returned, so C<request> is not set.
3749
3750Even if you pass the request by some safer means to the callback, you
3751might want to do something to the request after starting it, such as
3752canceling it, which probably isn't working so well when the callback has
3753already been invoked.
3754
3755A common way around all these issues is to make sure that
3756C<start_new_request> I<always> returns before the callback is invoked. If
3757C<start_new_request> immediately knows the result, it can artificially
3758delay invoking the callback by using a C<prepare> or C<idle> watcher for
3759example, or more sneakily, by reusing an existing (stopped) watcher and
3760pushing it into the pending queue:
3761
3762 ev_set_cb (watcher, callback);
3763 ev_feed_event (EV_A_ watcher, 0);
3764
3765This way, C<start_new_request> can safely return before the callback is
3766invoked, while not delaying callback invocation too much.
3767
3471=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS 3768=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
3472 3769
3473Often (especially in GUI toolkits) there are places where you have 3770Often (especially in GUI toolkits) there are places where you have
3474I<modal> interaction, which is most easily implemented by recursively 3771I<modal> interaction, which is most easily implemented by recursively
3475invoking C<ev_run>. 3772invoking C<ev_run>.
3476 3773
3477This brings the problem of exiting - a callback might want to finish the 3774This brings the problem of exiting - a callback might want to finish the
3478main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but 3775main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3479a modal "Are you sure?" dialog is still waiting), or just the nested one 3776a modal "Are you sure?" dialog is still waiting), or just the nested one
3480and not the main one (e.g. user clocked "Ok" in a modal dialog), or some 3777and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3481other combination: In these cases, C<ev_break> will not work alone. 3778other combination: In these cases, a simple C<ev_break> will not work.
3482 3779
3483The solution is to maintain "break this loop" variable for each C<ev_run> 3780The solution is to maintain "break this loop" variable for each C<ev_run>
3484invocation, and use a loop around C<ev_run> until the condition is 3781invocation, and use a loop around C<ev_run> until the condition is
3485triggered, using C<EVRUN_ONCE>: 3782triggered, using C<EVRUN_ONCE>:
3486 3783
3488 int exit_main_loop = 0; 3785 int exit_main_loop = 0;
3489 3786
3490 while (!exit_main_loop) 3787 while (!exit_main_loop)
3491 ev_run (EV_DEFAULT_ EVRUN_ONCE); 3788 ev_run (EV_DEFAULT_ EVRUN_ONCE);
3492 3789
3493 // in a model watcher 3790 // in a modal watcher
3494 int exit_nested_loop = 0; 3791 int exit_nested_loop = 0;
3495 3792
3496 while (!exit_nested_loop) 3793 while (!exit_nested_loop)
3497 ev_run (EV_A_ EVRUN_ONCE); 3794 ev_run (EV_A_ EVRUN_ONCE);
3498 3795
3544 // now associate this with the loop 3841 // now associate this with the loop
3545 ev_set_userdata (EV_A_ u); 3842 ev_set_userdata (EV_A_ u);
3546 ev_set_invoke_pending_cb (EV_A_ l_invoke); 3843 ev_set_invoke_pending_cb (EV_A_ l_invoke);
3547 ev_set_loop_release_cb (EV_A_ l_release, l_acquire); 3844 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3548 3845
3549 // then create the thread running ev_loop 3846 // then create the thread running ev_run
3550 pthread_create (&u->tid, 0, l_run, EV_A); 3847 pthread_create (&u->tid, 0, l_run, EV_A);
3551 } 3848 }
3552 3849
3553The callback for the C<ev_async> watcher does nothing: the watcher is used 3850The callback for the C<ev_async> watcher does nothing: the watcher is used
3554solely to wake up the event loop so it takes notice of any new watchers 3851solely to wake up the event loop so it takes notice of any new watchers
3672called): 3969called):
3673 3970
3674 void 3971 void
3675 wait_for_event (ev_watcher *w) 3972 wait_for_event (ev_watcher *w)
3676 { 3973 {
3677 ev_cb_set (w) = current_coro; 3974 ev_set_cb (w, current_coro);
3678 switch_to (libev_coro); 3975 switch_to (libev_coro);
3679 } 3976 }
3680 3977
3681That basically suspends the coroutine inside C<wait_for_event> and 3978That basically suspends the coroutine inside C<wait_for_event> and
3682continues the libev coroutine, which, when appropriate, switches back to 3979continues the libev coroutine, which, when appropriate, switches back to
3683this or any other coroutine. I am sure if you sue this your own :) 3980this or any other coroutine.
3684 3981
3685You can do similar tricks if you have, say, threads with an event queue - 3982You can do similar tricks if you have, say, threads with an event queue -
3686instead of storing a coroutine, you store the queue object and instead of 3983instead of storing a coroutine, you store the queue object and instead of
3687switching to a coroutine, you push the watcher onto the queue and notify 3984switching to a coroutine, you push the watcher onto the queue and notify
3688any waiters. 3985any waiters.
3689 3986
3690To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 3987To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3691files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 3988files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3692 3989
3693 // my_ev.h 3990 // my_ev.h
3694 #define EV_CB_DECLARE(type) struct my_coro *cb; 3991 #define EV_CB_DECLARE(type) struct my_coro *cb;
3695 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 3992 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3696 #include "../libev/ev.h" 3993 #include "../libev/ev.h"
3697 3994
3698 // my_ev.c 3995 // my_ev.c
3699 #define EV_H "my_ev.h" 3996 #define EV_H "my_ev.h"
3700 #include "../libev/ev.c" 3997 #include "../libev/ev.c"
3739 4036
3740=back 4037=back
3741 4038
3742=head1 C++ SUPPORT 4039=head1 C++ SUPPORT
3743 4040
4041=head2 C API
4042
4043The normal C API should work fine when used from C++: both ev.h and the
4044libev sources can be compiled as C++. Therefore, code that uses the C API
4045will work fine.
4046
4047Proper exception specifications might have to be added to callbacks passed
4048to libev: exceptions may be thrown only from watcher callbacks, all other
4049callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4050callbacks) must not throw exceptions, and might need a C<noexcept>
4051specification. If you have code that needs to be compiled as both C and
4052C++ you can use the C<EV_NOEXCEPT> macro for this:
4053
4054 static void
4055 fatal_error (const char *msg) EV_NOEXCEPT
4056 {
4057 perror (msg);
4058 abort ();
4059 }
4060
4061 ...
4062 ev_set_syserr_cb (fatal_error);
4063
4064The only API functions that can currently throw exceptions are C<ev_run>,
4065C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
4066because it runs cleanup watchers).
4067
4068Throwing exceptions in watcher callbacks is only supported if libev itself
4069is compiled with a C++ compiler or your C and C++ environments allow
4070throwing exceptions through C libraries (most do).
4071
4072=head2 C++ API
4073
3744Libev comes with some simplistic wrapper classes for C++ that mainly allow 4074Libev comes with some simplistic wrapper classes for C++ that mainly allow
3745you to use some convenience methods to start/stop watchers and also change 4075you to use some convenience methods to start/stop watchers and also change
3746the callback model to a model using method callbacks on objects. 4076the callback model to a model using method callbacks on objects.
3747 4077
3748To use it, 4078To use it,
3749 4079
3750 #include <ev++.h> 4080 #include <ev++.h>
3751 4081
3752This automatically includes F<ev.h> and puts all of its definitions (many 4082This automatically includes F<ev.h> and puts all of its definitions (many
3753of them macros) into the global namespace. All C++ specific things are 4083of them macros) into the global namespace. All C++ specific things are
3754put into the C<ev> namespace. It should support all the same embedding 4084put into the C<ev> namespace. It should support all the same embedding
3763with C<operator ()> can be used as callbacks. Other types should be easy 4093with C<operator ()> can be used as callbacks. Other types should be easy
3764to add as long as they only need one additional pointer for context. If 4094to add as long as they only need one additional pointer for context. If
3765you need support for other types of functors please contact the author 4095you need support for other types of functors please contact the author
3766(preferably after implementing it). 4096(preferably after implementing it).
3767 4097
4098For all this to work, your C++ compiler either has to use the same calling
4099conventions as your C compiler (for static member functions), or you have
4100to embed libev and compile libev itself as C++.
4101
3768Here is a list of things available in the C<ev> namespace: 4102Here is a list of things available in the C<ev> namespace:
3769 4103
3770=over 4 4104=over 4
3771 4105
3772=item C<ev::READ>, C<ev::WRITE> etc. 4106=item C<ev::READ>, C<ev::WRITE> etc.
3781=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. 4115=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3782 4116
3783For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of 4117For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3784the same name in the C<ev> namespace, with the exception of C<ev_signal> 4118the same name in the C<ev> namespace, with the exception of C<ev_signal>
3785which is called C<ev::sig> to avoid clashes with the C<signal> macro 4119which is called C<ev::sig> to avoid clashes with the C<signal> macro
3786defines by many implementations. 4120defined by many implementations.
3787 4121
3788All of those classes have these methods: 4122All of those classes have these methods:
3789 4123
3790=over 4 4124=over 4
3791 4125
3853 void operator() (ev::io &w, int revents) 4187 void operator() (ev::io &w, int revents)
3854 { 4188 {
3855 ... 4189 ...
3856 } 4190 }
3857 } 4191 }
3858 4192
3859 myfunctor f; 4193 myfunctor f;
3860 4194
3861 ev::io w; 4195 ev::io w;
3862 w.set (&f); 4196 w.set (&f);
3863 4197
3881Associates a different C<struct ev_loop> with this watcher. You can only 4215Associates a different C<struct ev_loop> with this watcher. You can only
3882do this when the watcher is inactive (and not pending either). 4216do this when the watcher is inactive (and not pending either).
3883 4217
3884=item w->set ([arguments]) 4218=item w->set ([arguments])
3885 4219
3886Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4220Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
3887method or a suitable start method must be called at least once. Unlike the 4221with the same arguments. Either this method or a suitable start method
3888C counterpart, an active watcher gets automatically stopped and restarted 4222must be called at least once. Unlike the C counterpart, an active watcher
3889when reconfiguring it with this method. 4223gets automatically stopped and restarted when reconfiguring it with this
4224method.
4225
4226For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4227clashing with the C<set (loop)> method.
3890 4228
3891=item w->start () 4229=item w->start ()
3892 4230
3893Starts the watcher. Note that there is no C<loop> argument, as the 4231Starts the watcher. Note that there is no C<loop> argument, as the
3894constructor already stores the event loop. 4232constructor already stores the event loop.
3924watchers in the constructor. 4262watchers in the constructor.
3925 4263
3926 class myclass 4264 class myclass
3927 { 4265 {
3928 ev::io io ; void io_cb (ev::io &w, int revents); 4266 ev::io io ; void io_cb (ev::io &w, int revents);
3929 ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4267 ev::io io2 ; void io2_cb (ev::io &w, int revents);
3930 ev::idle idle; void idle_cb (ev::idle &w, int revents); 4268 ev::idle idle; void idle_cb (ev::idle &w, int revents);
3931 4269
3932 myclass (int fd) 4270 myclass (int fd)
3933 { 4271 {
3934 io .set <myclass, &myclass::io_cb > (this); 4272 io .set <myclass, &myclass::io_cb > (this);
3985L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. 4323L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3986 4324
3987=item D 4325=item D
3988 4326
3989Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 4327Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3990be found at L<http://proj.llucax.com.ar/wiki/evd>. 4328be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3991 4329
3992=item Ocaml 4330=item Ocaml
3993 4331
3994Erkki Seppala has written Ocaml bindings for libev, to be found at 4332Erkki Seppala has written Ocaml bindings for libev, to be found at
3995L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 4333L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3998 4336
3999Brian Maher has written a partial interface to libev for lua (at the 4337Brian Maher has written a partial interface to libev for lua (at the
4000time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4338time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4001L<http://github.com/brimworks/lua-ev>. 4339L<http://github.com/brimworks/lua-ev>.
4002 4340
4341=item Javascript
4342
4343Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4344
4345=item Others
4346
4347There are others, and I stopped counting.
4348
4003=back 4349=back
4004 4350
4005 4351
4006=head1 MACRO MAGIC 4352=head1 MACRO MAGIC
4007 4353
4043suitable for use with C<EV_A>. 4389suitable for use with C<EV_A>.
4044 4390
4045=item C<EV_DEFAULT>, C<EV_DEFAULT_> 4391=item C<EV_DEFAULT>, C<EV_DEFAULT_>
4046 4392
4047Similar to the other two macros, this gives you the value of the default 4393Similar to the other two macros, this gives you the value of the default
4048loop, if multiple loops are supported ("ev loop default"). 4394loop, if multiple loops are supported ("ev loop default"). The default loop
4395will be initialised if it isn't already initialised.
4396
4397For non-multiplicity builds, these macros do nothing, so you always have
4398to initialise the loop somewhere.
4049 4399
4050=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> 4400=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
4051 4401
4052Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the 4402Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
4053default loop has been initialised (C<UC> == unchecked). Their behaviour 4403default loop has been initialised (C<UC> == unchecked). Their behaviour
4120 ev_vars.h 4470 ev_vars.h
4121 ev_wrap.h 4471 ev_wrap.h
4122 4472
4123 ev_win32.c required on win32 platforms only 4473 ev_win32.c required on win32 platforms only
4124 4474
4125 ev_select.c only when select backend is enabled (which is enabled by default) 4475 ev_select.c only when select backend is enabled
4126 ev_poll.c only when poll backend is enabled (disabled by default) 4476 ev_poll.c only when poll backend is enabled
4127 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4477 ev_epoll.c only when the epoll backend is enabled
4478 ev_linuxaio.c only when the linux aio backend is enabled
4128 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4479 ev_kqueue.c only when the kqueue backend is enabled
4129 ev_port.c only when the solaris port backend is enabled (disabled by default) 4480 ev_port.c only when the solaris port backend is enabled
4130 4481
4131F<ev.c> includes the backend files directly when enabled, so you only need 4482F<ev.c> includes the backend files directly when enabled, so you only need
4132to compile this single file. 4483to compile this single file.
4133 4484
4134=head3 LIBEVENT COMPATIBILITY API 4485=head3 LIBEVENT COMPATIBILITY API
4198supported). It will also not define any of the structs usually found in 4549supported). It will also not define any of the structs usually found in
4199F<event.h> that are not directly supported by the libev core alone. 4550F<event.h> that are not directly supported by the libev core alone.
4200 4551
4201In standalone mode, libev will still try to automatically deduce the 4552In standalone mode, libev will still try to automatically deduce the
4202configuration, but has to be more conservative. 4553configuration, but has to be more conservative.
4554
4555=item EV_USE_FLOOR
4556
4557If defined to be C<1>, libev will use the C<floor ()> function for its
4558periodic reschedule calculations, otherwise libev will fall back on a
4559portable (slower) implementation. If you enable this, you usually have to
4560link against libm or something equivalent. Enabling this when the C<floor>
4561function is not available will fail, so the safe default is to not enable
4562this.
4203 4563
4204=item EV_USE_MONOTONIC 4564=item EV_USE_MONOTONIC
4205 4565
4206If defined to be C<1>, libev will try to detect the availability of the 4566If defined to be C<1>, libev will try to detect the availability of the
4207monotonic clock option at both compile time and runtime. Otherwise no 4567monotonic clock option at both compile time and runtime. Otherwise no
4293If programs implement their own fd to handle mapping on win32, then this 4653If programs implement their own fd to handle mapping on win32, then this
4294macro can be used to override the C<close> function, useful to unregister 4654macro can be used to override the C<close> function, useful to unregister
4295file descriptors again. Note that the replacement function has to close 4655file descriptors again. Note that the replacement function has to close
4296the underlying OS handle. 4656the underlying OS handle.
4297 4657
4658=item EV_USE_WSASOCKET
4659
4660If defined to be C<1>, libev will use C<WSASocket> to create its internal
4661communication socket, which works better in some environments. Otherwise,
4662the normal C<socket> function will be used, which works better in other
4663environments.
4664
4298=item EV_USE_POLL 4665=item EV_USE_POLL
4299 4666
4300If defined to be C<1>, libev will compile in support for the C<poll>(2) 4667If defined to be C<1>, libev will compile in support for the C<poll>(2)
4301backend. Otherwise it will be enabled on non-win32 platforms. It 4668backend. Otherwise it will be enabled on non-win32 platforms. It
4302takes precedence over select. 4669takes precedence over select.
4306If defined to be C<1>, libev will compile in support for the Linux 4673If defined to be C<1>, libev will compile in support for the Linux
4307C<epoll>(7) backend. Its availability will be detected at runtime, 4674C<epoll>(7) backend. Its availability will be detected at runtime,
4308otherwise another method will be used as fallback. This is the preferred 4675otherwise another method will be used as fallback. This is the preferred
4309backend for GNU/Linux systems. If undefined, it will be enabled if the 4676backend for GNU/Linux systems. If undefined, it will be enabled if the
4310headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4677headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4678
4679=item EV_USE_LINUXAIO
4680
4681If defined to be C<1>, libev will compile in support for the Linux
4682aio backend. Due to it's currenbt limitations it has to be requested
4683explicitly. If undefined, it will be enabled on linux, otherwise
4684disabled.
4311 4685
4312=item EV_USE_KQUEUE 4686=item EV_USE_KQUEUE
4313 4687
4314If defined to be C<1>, libev will compile in support for the BSD style 4688If defined to be C<1>, libev will compile in support for the BSD style
4315C<kqueue>(2) backend. Its actual availability will be detected at runtime, 4689C<kqueue>(2) backend. Its actual availability will be detected at runtime,
4337If defined to be C<1>, libev will compile in support for the Linux inotify 4711If defined to be C<1>, libev will compile in support for the Linux inotify
4338interface to speed up C<ev_stat> watchers. Its actual availability will 4712interface to speed up C<ev_stat> watchers. Its actual availability will
4339be detected at runtime. If undefined, it will be enabled if the headers 4713be detected at runtime. If undefined, it will be enabled if the headers
4340indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4714indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4341 4715
4716=item EV_NO_SMP
4717
4718If defined to be C<1>, libev will assume that memory is always coherent
4719between threads, that is, threads can be used, but threads never run on
4720different cpus (or different cpu cores). This reduces dependencies
4721and makes libev faster.
4722
4723=item EV_NO_THREADS
4724
4725If defined to be C<1>, libev will assume that it will never be called from
4726different threads (that includes signal handlers), which is a stronger
4727assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4728libev faster.
4729
4342=item EV_ATOMIC_T 4730=item EV_ATOMIC_T
4343 4731
4344Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4732Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4345access is atomic with respect to other threads or signal contexts. No such 4733access is atomic with respect to other threads or signal contexts. No
4346type is easily found in the C language, so you can provide your own type 4734such type is easily found in the C language, so you can provide your own
4347that you know is safe for your purposes. It is used both for signal handler "locking" 4735type that you know is safe for your purposes. It is used both for signal
4348as well as for signal and thread safety in C<ev_async> watchers. 4736handler "locking" as well as for signal and thread safety in C<ev_async>
4737watchers.
4349 4738
4350In the absence of this define, libev will use C<sig_atomic_t volatile> 4739In the absence of this define, libev will use C<sig_atomic_t volatile>
4351(from F<signal.h>), which is usually good enough on most platforms. 4740(from F<signal.h>), which is usually good enough on most platforms.
4352 4741
4353=item EV_H (h) 4742=item EV_H (h)
4380will have the C<struct ev_loop *> as first argument, and you can create 4769will have the C<struct ev_loop *> as first argument, and you can create
4381additional independent event loops. Otherwise there will be no support 4770additional independent event loops. Otherwise there will be no support
4382for multiple event loops and there is no first event loop pointer 4771for multiple event loops and there is no first event loop pointer
4383argument. Instead, all functions act on the single default loop. 4772argument. Instead, all functions act on the single default loop.
4384 4773
4774Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
4775default loop when multiplicity is switched off - you always have to
4776initialise the loop manually in this case.
4777
4385=item EV_MINPRI 4778=item EV_MINPRI
4386 4779
4387=item EV_MAXPRI 4780=item EV_MAXPRI
4388 4781
4389The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to 4782The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
4425 #define EV_USE_POLL 1 4818 #define EV_USE_POLL 1
4426 #define EV_CHILD_ENABLE 1 4819 #define EV_CHILD_ENABLE 1
4427 #define EV_ASYNC_ENABLE 1 4820 #define EV_ASYNC_ENABLE 1
4428 4821
4429The actual value is a bitset, it can be a combination of the following 4822The actual value is a bitset, it can be a combination of the following
4430values: 4823values (by default, all of these are enabled):
4431 4824
4432=over 4 4825=over 4
4433 4826
4434=item C<1> - faster/larger code 4827=item C<1> - faster/larger code
4435 4828
4439code size by roughly 30% on amd64). 4832code size by roughly 30% on amd64).
4440 4833
4441When optimising for size, use of compiler flags such as C<-Os> with 4834When optimising for size, use of compiler flags such as C<-Os> with
4442gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of 4835gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4443assertions. 4836assertions.
4837
4838The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4839(e.g. gcc with C<-Os>).
4444 4840
4445=item C<2> - faster/larger data structures 4841=item C<2> - faster/larger data structures
4446 4842
4447Replaces the small 2-heap for timer management by a faster 4-heap, larger 4843Replaces the small 2-heap for timer management by a faster 4-heap, larger
4448hash table sizes and so on. This will usually further increase code size 4844hash table sizes and so on. This will usually further increase code size
4449and can additionally have an effect on the size of data structures at 4845and can additionally have an effect on the size of data structures at
4450runtime. 4846runtime.
4451 4847
4848The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4849(e.g. gcc with C<-Os>).
4850
4452=item C<4> - full API configuration 4851=item C<4> - full API configuration
4453 4852
4454This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and 4853This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4455enables multiplicity (C<EV_MULTIPLICITY>=1). 4854enables multiplicity (C<EV_MULTIPLICITY>=1).
4456 4855
4486 4885
4487With an intelligent-enough linker (gcc+binutils are intelligent enough 4886With an intelligent-enough linker (gcc+binutils are intelligent enough
4488when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by 4887when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
4489your program might be left out as well - a binary starting a timer and an 4888your program might be left out as well - a binary starting a timer and an
4490I/O watcher then might come out at only 5Kb. 4889I/O watcher then might come out at only 5Kb.
4890
4891=item EV_API_STATIC
4892
4893If this symbol is defined (by default it is not), then all identifiers
4894will have static linkage. This means that libev will not export any
4895identifiers, and you cannot link against libev anymore. This can be useful
4896when you embed libev, only want to use libev functions in a single file,
4897and do not want its identifiers to be visible.
4898
4899To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
4900wants to use libev.
4901
4902This option only works when libev is compiled with a C compiler, as C++
4903doesn't support the required declaration syntax.
4491 4904
4492=item EV_AVOID_STDIO 4905=item EV_AVOID_STDIO
4493 4906
4494If this is set to C<1> at compiletime, then libev will avoid using stdio 4907If this is set to C<1> at compiletime, then libev will avoid using stdio
4495functions (printf, scanf, perror etc.). This will increase the code size 4908functions (printf, scanf, perror etc.). This will increase the code size
4700default loop and triggering an C<ev_async> watcher from the default loop 5113default loop and triggering an C<ev_async> watcher from the default loop
4701watcher callback into the event loop interested in the signal. 5114watcher callback into the event loop interested in the signal.
4702 5115
4703=back 5116=back
4704 5117
4705See also L<THREAD LOCKING EXAMPLE>. 5118See also L</THREAD LOCKING EXAMPLE>.
4706 5119
4707=head3 COROUTINES 5120=head3 COROUTINES
4708 5121
4709Libev is very accommodating to coroutines ("cooperative threads"): 5122Libev is very accommodating to coroutines ("cooperative threads"):
4710libev fully supports nesting calls to its functions from different 5123libev fully supports nesting calls to its functions from different
4875requires, and its I/O model is fundamentally incompatible with the POSIX 5288requires, and its I/O model is fundamentally incompatible with the POSIX
4876model. Libev still offers limited functionality on this platform in 5289model. Libev still offers limited functionality on this platform in
4877the form of the C<EVBACKEND_SELECT> backend, and only supports socket 5290the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4878descriptors. This only applies when using Win32 natively, not when using 5291descriptors. This only applies when using Win32 natively, not when using
4879e.g. cygwin. Actually, it only applies to the microsofts own compilers, 5292e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4880as every compielr comes with a slightly differently broken/incompatible 5293as every compiler comes with a slightly differently broken/incompatible
4881environment. 5294environment.
4882 5295
4883Lifting these limitations would basically require the full 5296Lifting these limitations would basically require the full
4884re-implementation of the I/O system. If you are into this kind of thing, 5297re-implementation of the I/O system. If you are into this kind of thing,
4885then note that glib does exactly that for you in a very portable way (note 5298then note that glib does exactly that for you in a very portable way (note
4979structure (guaranteed by POSIX but not by ISO C for example), but it also 5392structure (guaranteed by POSIX but not by ISO C for example), but it also
4980assumes that the same (machine) code can be used to call any watcher 5393assumes that the same (machine) code can be used to call any watcher
4981callback: The watcher callbacks have different type signatures, but libev 5394callback: The watcher callbacks have different type signatures, but libev
4982calls them using an C<ev_watcher *> internally. 5395calls them using an C<ev_watcher *> internally.
4983 5396
5397=item null pointers and integer zero are represented by 0 bytes
5398
5399Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
5400relies on this setting pointers and integers to null.
5401
4984=item pointer accesses must be thread-atomic 5402=item pointer accesses must be thread-atomic
4985 5403
4986Accessing a pointer value must be atomic, it must both be readable and 5404Accessing a pointer value must be atomic, it must both be readable and
4987writable in one piece - this is the case on all current architectures. 5405writable in one piece - this is the case on all current architectures.
4988 5406
5001thread" or will block signals process-wide, both behaviours would 5419thread" or will block signals process-wide, both behaviours would
5002be compatible with libev. Interaction between C<sigprocmask> and 5420be compatible with libev. Interaction between C<sigprocmask> and
5003C<pthread_sigmask> could complicate things, however. 5421C<pthread_sigmask> could complicate things, however.
5004 5422
5005The most portable way to handle signals is to block signals in all threads 5423The most portable way to handle signals is to block signals in all threads
5006except the initial one, and run the default loop in the initial thread as 5424except the initial one, and run the signal handling loop in the initial
5007well. 5425thread as well.
5008 5426
5009=item C<long> must be large enough for common memory allocation sizes 5427=item C<long> must be large enough for common memory allocation sizes
5010 5428
5011To improve portability and simplify its API, libev uses C<long> internally 5429To improve portability and simplify its API, libev uses C<long> internally
5012instead of C<size_t> when allocating its data structures. On non-POSIX 5430instead of C<size_t> when allocating its data structures. On non-POSIX
5018 5436
5019The type C<double> is used to represent timestamps. It is required to 5437The type C<double> is used to represent timestamps. It is required to
5020have at least 51 bits of mantissa (and 9 bits of exponent), which is 5438have at least 51 bits of mantissa (and 9 bits of exponent), which is
5021good enough for at least into the year 4000 with millisecond accuracy 5439good enough for at least into the year 4000 with millisecond accuracy
5022(the design goal for libev). This requirement is overfulfilled by 5440(the design goal for libev). This requirement is overfulfilled by
5023implementations using IEEE 754, which is basically all existing ones. With 5441implementations using IEEE 754, which is basically all existing ones.
5442
5024IEEE 754 doubles, you get microsecond accuracy until at least 2200. 5443With IEEE 754 doubles, you get microsecond accuracy until at least the
5444year 2255 (and millisecond accuracy till the year 287396 - by then, libev
5445is either obsolete or somebody patched it to use C<long double> or
5446something like that, just kidding).
5025 5447
5026=back 5448=back
5027 5449
5028If you know of other additional requirements drop me a note. 5450If you know of other additional requirements drop me a note.
5029 5451
5091=item Processing ev_async_send: O(number_of_async_watchers) 5513=item Processing ev_async_send: O(number_of_async_watchers)
5092 5514
5093=item Processing signals: O(max_signal_number) 5515=item Processing signals: O(max_signal_number)
5094 5516
5095Sending involves a system call I<iff> there were no other C<ev_async_send> 5517Sending involves a system call I<iff> there were no other C<ev_async_send>
5096calls in the current loop iteration. Checking for async and signal events 5518calls in the current loop iteration and the loop is currently
5519blocked. Checking for async and signal events involves iterating over all
5097involves iterating over all running async watchers or all signal numbers. 5520running async watchers or all signal numbers.
5098 5521
5099=back 5522=back
5100 5523
5101 5524
5102=head1 PORTING FROM LIBEV 3.X TO 4.X 5525=head1 PORTING FROM LIBEV 3.X TO 4.X
5111=over 4 5534=over 4
5112 5535
5113=item C<EV_COMPAT3> backwards compatibility mechanism 5536=item C<EV_COMPAT3> backwards compatibility mechanism
5114 5537
5115The backward compatibility mechanism can be controlled by 5538The backward compatibility mechanism can be controlled by
5116C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5539C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5117section. 5540section.
5118 5541
5119=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5542=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5120 5543
5121These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5544These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5164=over 4 5587=over 4
5165 5588
5166=item active 5589=item active
5167 5590
5168A watcher is active as long as it has been started and not yet stopped. 5591A watcher is active as long as it has been started and not yet stopped.
5169See L<WATCHER STATES> for details. 5592See L</WATCHER STATES> for details.
5170 5593
5171=item application 5594=item application
5172 5595
5173In this document, an application is whatever is using libev. 5596In this document, an application is whatever is using libev.
5174 5597
5210watchers and events. 5633watchers and events.
5211 5634
5212=item pending 5635=item pending
5213 5636
5214A watcher is pending as soon as the corresponding event has been 5637A watcher is pending as soon as the corresponding event has been
5215detected. See L<WATCHER STATES> for details. 5638detected. See L</WATCHER STATES> for details.
5216 5639
5217=item real time 5640=item real time
5218 5641
5219The physical time that is observed. It is apparently strictly monotonic :) 5642The physical time that is observed. It is apparently strictly monotonic :)
5220 5643
5221=item wall-clock time 5644=item wall-clock time
5222 5645
5223The time and date as shown on clocks. Unlike real time, it can actually 5646The time and date as shown on clocks. Unlike real time, it can actually
5224be wrong and jump forwards and backwards, e.g. when the you adjust your 5647be wrong and jump forwards and backwards, e.g. when you adjust your
5225clock. 5648clock.
5226 5649
5227=item watcher 5650=item watcher
5228 5651
5229A data structure that describes interest in certain events. Watchers need 5652A data structure that describes interest in certain events. Watchers need
5232=back 5655=back
5233 5656
5234=head1 AUTHOR 5657=head1 AUTHOR
5235 5658
5236Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael 5659Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5237Magnusson and Emanuele Giaquinta. 5660Magnusson and Emanuele Giaquinta, and minor corrections by many others.
5238 5661

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines