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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines