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

Comparing libev/ev.pod (file contents):
Revision 1.359 by root, Tue Jan 11 10:56:01 2011 UTC vs.
Revision 1.451 by root, Mon Jun 24 00:19:26 2019 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines