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

Comparing libev/ev.pod (file contents):
Revision 1.371 by root, Sat Jun 4 05:25:03 2011 UTC vs.
Revision 1.459 by root, Wed Jan 22 01:50:42 2020 UTC

1=encoding utf-8
2
1=head1 NAME 3=head1 NAME
2 4
3libev - a high performance full-featured event loop written in C 5libev - a high performance full-featured event loop written in C
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
82 84
83=head1 WHAT TO READ WHEN IN A HURRY 85=head1 WHAT TO READ WHEN IN A HURRY
84 86
85This manual tries to be very detailed, but unfortunately, this also makes 87This manual tries to be very detailed, but unfortunately, this also makes
86it very long. If you just want to know the basics of libev, I suggest 88it very long. If you just want to know the basics of libev, I suggest
87reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and 89reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and
88look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and 90look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and
89C<ev_timer> sections in L<WATCHER TYPES>. 91C<ev_timer> sections in L</WATCHER TYPES>.
90 92
91=head1 ABOUT LIBEV 93=head1 ABOUT LIBEV
92 94
93Libev is an event loop: you register interest in certain events (such as a 95Libev is an event loop: you register interest in certain events (such as a
94file descriptor being readable or a timeout occurring), and it will manage 96file descriptor being readable or a timeout occurring), and it will manage
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
157When libev detects a usage error such as a negative timer interval, then 159When libev detects a usage error such as a negative timer interval, then
158it will print a diagnostic message and abort (via the C<assert> mechanism, 160it will print a diagnostic message and abort (via the C<assert> mechanism,
159so C<NDEBUG> will disable this checking): these are programming errors in 161so C<NDEBUG> will disable this checking): these are programming errors in
160the libev caller and need to be fixed there. 162the libev caller and need to be fixed there.
161 163
164Via the C<EV_FREQUENT> macro you can compile in and/or enable extensive
165consistency checking code inside libev that can be used to check for
166internal inconsistencies, suually caused by application bugs.
167
162Libev also has a few internal error-checking C<assert>ions, and also has 168Libev also has a few internal error-checking C<assert>ions. These do not
163extensive consistency checking code. These do not trigger under normal
164circumstances, as they indicate either a bug in libev or worse. 169trigger under normal circumstances, as they indicate either a bug in libev
170or worse.
165 171
166 172
167=head1 GLOBAL FUNCTIONS 173=head1 GLOBAL FUNCTIONS
168 174
169These functions can be called anytime, even before initialising the 175These functions can be called anytime, even before initialising the
174=item ev_tstamp ev_time () 180=item ev_tstamp ev_time ()
175 181
176Returns the current time as libev would use it. Please note that the 182Returns 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 183C<ev_now> function is usually faster and also often returns the timestamp
178you actually want to know. Also interesting is the combination of 184you actually want to know. Also interesting is the combination of
179C<ev_update_now> and C<ev_now>. 185C<ev_now_update> and C<ev_now>.
180 186
181=item ev_sleep (ev_tstamp interval) 187=item ev_sleep (ev_tstamp interval)
182 188
183Sleep for the given interval: The current thread will be blocked 189Sleep for the given interval: The current thread will be blocked
184until either it is interrupted or the given time interval has 190until either it is interrupted or the given time interval has
247the current system, you would need to look at C<ev_embeddable_backends () 253the current system, you would need to look at C<ev_embeddable_backends ()
248& ev_supported_backends ()>, likewise for recommended ones. 254& ev_supported_backends ()>, likewise for recommended ones.
249 255
250See the description of C<ev_embed> watchers for more info. 256See the description of C<ev_embed> watchers for more info.
251 257
252=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 258=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
253 259
254Sets the allocation function to use (the prototype is similar - the 260Sets the allocation function to use (the prototype is similar - the
255semantics are identical to the C<realloc> C89/SuS/POSIX function). It is 261semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
256used to allocate and free memory (no surprises here). If it returns zero 262used to allocate and free memory (no surprises here). If it returns zero
257when memory needs to be allocated (C<size != 0>), the library might abort 263when memory needs to be allocated (C<size != 0>), the library might abort
263 269
264You could override this function in high-availability programs to, say, 270You could override this function in high-availability programs to, say,
265free some memory if it cannot allocate memory, to use a special allocator, 271free some memory if it cannot allocate memory, to use a special allocator,
266or even to sleep a while and retry until some memory is available. 272or even to sleep a while and retry until some memory is available.
267 273
274Example: The following is the C<realloc> function that libev itself uses
275which should work with C<realloc> and C<free> functions of all kinds and
276is probably a good basis for your own implementation.
277
278 static void *
279 ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT
280 {
281 if (size)
282 return realloc (ptr, size);
283
284 free (ptr);
285 return 0;
286 }
287
268Example: Replace the libev allocator with one that waits a bit and then 288Example: Replace the libev allocator with one that waits a bit and then
269retries (example requires a standards-compliant C<realloc>). 289retries.
270 290
271 static void * 291 static void *
272 persistent_realloc (void *ptr, size_t size) 292 persistent_realloc (void *ptr, size_t size)
273 { 293 {
294 if (!size)
295 {
296 free (ptr);
297 return 0;
298 }
299
274 for (;;) 300 for (;;)
275 { 301 {
276 void *newptr = realloc (ptr, size); 302 void *newptr = realloc (ptr, size);
277 303
278 if (newptr) 304 if (newptr)
283 } 309 }
284 310
285 ... 311 ...
286 ev_set_allocator (persistent_realloc); 312 ev_set_allocator (persistent_realloc);
287 313
288=item ev_set_syserr_cb (void (*cb)(const char *msg)) 314=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
289 315
290Set the callback function to call on a retryable system call error (such 316Set the callback function to call on a retryable system call error (such
291as failed select, poll, epoll_wait). The message is a printable string 317as failed select, poll, epoll_wait). The message is a printable string
292indicating the system call or subsystem causing the problem. If this 318indicating the system call or subsystem causing the problem. If this
293callback is set, then libev will expect it to remedy the situation, no 319callback is set, then libev will expect it to remedy the situation, no
396 422
397If this flag bit is or'ed into the flag value (or the program runs setuid 423If this flag bit is or'ed into the flag value (or the program runs setuid
398or setgid) then libev will I<not> look at the environment variable 424or setgid) then libev will I<not> look at the environment variable
399C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 425C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
400override the flags completely if it is found in the environment. This is 426override the flags completely if it is found in the environment. This is
401useful to try out specific backends to test their performance, or to work 427useful to try out specific backends to test their performance, to work
402around bugs. 428around bugs, or to make libev threadsafe (accessing environment variables
429cannot be done in a threadsafe way, but usually it works if no other
430thread modifies them).
403 431
404=item C<EVFLAG_FORKCHECK> 432=item C<EVFLAG_FORKCHECK>
405 433
406Instead of calling C<ev_loop_fork> manually after a fork, you can also 434Instead of calling C<ev_loop_fork> manually after a fork, you can also
407make libev check for a fork in each iteration by enabling this flag. 435make libev check for a fork in each iteration by enabling this flag.
408 436
409This works by calling C<getpid ()> on every iteration of the loop, 437This works by calling C<getpid ()> on every iteration of the loop,
410and thus this might slow down your event loop if you do a lot of loop 438and thus this might slow down your event loop if you do a lot of loop
411iterations and little real work, but is usually not noticeable (on my 439iterations and little real work, but is usually not noticeable (on my
412GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence 440GNU/Linux system for example, C<getpid> is actually a simple 5-insn
413without a system call and thus I<very> fast, but my GNU/Linux system also has 441sequence without a system call and thus I<very> fast, but my GNU/Linux
414C<pthread_atfork> which is even faster). 442system also has C<pthread_atfork> which is even faster). (Update: glibc
443versions 2.25 apparently removed the C<getpid> optimisation again).
415 444
416The big advantage of this flag is that you can forget about fork (and 445The big advantage of this flag is that you can forget about fork (and
417forget about forgetting to tell libev about forking) when you use this 446forget about forgetting to tell libev about forking, although you still
418flag. 447have to ignore C<SIGPIPE>) when you use this flag.
419 448
420This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> 449This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
421environment variable. 450environment variable.
422 451
423=item C<EVFLAG_NOINOTIFY> 452=item C<EVFLAG_NOINOTIFY>
441example) that can't properly initialise their signal masks. 470example) that can't properly initialise their signal masks.
442 471
443=item C<EVFLAG_NOSIGMASK> 472=item C<EVFLAG_NOSIGMASK>
444 473
445When this flag is specified, then libev will avoid to modify the signal 474When this flag is specified, then libev will avoid to modify the signal
446mask. Specifically, this means you ahve to make sure signals are unblocked 475mask. Specifically, this means you have to make sure signals are unblocked
447when you want to receive them. 476when you want to receive them.
448 477
449This behaviour is useful when you want to do your own signal handling, or 478This behaviour is useful when you want to do your own signal handling, or
450want to handle signals only in specific threads and want to avoid libev 479want to handle signals only in specific threads and want to avoid libev
451unblocking the signals. 480unblocking the signals.
452 481
453It's also required by POSIX in a threaded program, as libev calls 482It's also required by POSIX in a threaded program, as libev calls
454C<sigprocmask>, whose behaviour is officially unspecified. 483C<sigprocmask>, whose behaviour is officially unspecified.
455 484
456This flag's behaviour will become the default in future versions of libev. 485=item C<EVFLAG_NOTIMERFD>
486
487When this flag is specified, the libev will avoid using a C<timerfd> to
488detect time jumps. It will still be able to detect time jumps, but takes
489longer and has a lower accuracy in doing so, but saves a file descriptor
490per loop.
491
492The current implementation only tries to use a C<timerfd> when the first
493C<ev_periodic> watcher is started and falls back on other methods if it
494cannot be created, but this behaviour might change in the future.
457 495
458=item C<EVBACKEND_SELECT> (value 1, portable select backend) 496=item C<EVBACKEND_SELECT> (value 1, portable select backend)
459 497
460This is your standard select(2) backend. Not I<completely> standard, as 498This is your standard select(2) backend. Not I<completely> standard, as
461libev tries to roll its own fd_set with no limits on the number of fds, 499libev tries to roll its own fd_set with no limits on the number of fds,
486This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and 524This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
487C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. 525C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
488 526
489=item C<EVBACKEND_EPOLL> (value 4, Linux) 527=item C<EVBACKEND_EPOLL> (value 4, Linux)
490 528
491Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 529Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9
492kernels). 530kernels).
493 531
494For few fds, this backend is a bit little slower than poll and select, but 532For few fds, this backend is a bit little slower than poll and select, but
495it scales phenomenally better. While poll and select usually scale like 533it scales phenomenally better. While poll and select usually scale like
496O(total_fds) where total_fds is the total number of fds (or the highest 534O(total_fds) where total_fds is the total number of fds (or the highest
512totally I<different> file descriptors (even already closed ones, so 550totally I<different> file descriptors (even already closed ones, so
513one cannot even remove them from the set) than registered in the set 551one cannot even remove them from the set) than registered in the set
514(especially on SMP systems). Libev tries to counter these spurious 552(especially on SMP systems). Libev tries to counter these spurious
515notifications by employing an additional generation counter and comparing 553notifications by employing an additional generation counter and comparing
516that against the events to filter out spurious ones, recreating the set 554that against the events to filter out spurious ones, recreating the set
517when required. Epoll also errornously rounds down timeouts, but gives you 555when required. Epoll also erroneously rounds down timeouts, but gives you
518no way to know when and by how much, so sometimes you have to busy-wait 556no way to know when and by how much, so sometimes you have to busy-wait
519because epoll returns immediately despite a nonzero timeout. And last 557because epoll returns immediately despite a nonzero timeout. And last
520not least, it also refuses to work with some file descriptors which work 558not least, it also refuses to work with some file descriptors which work
521perfectly fine with C<select> (files, many character devices...). 559perfectly fine with C<select> (files, many character devices...).
522 560
542All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or 580All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
543faster than epoll for maybe up to a hundred file descriptors, depending on 581faster than epoll for maybe up to a hundred file descriptors, depending on
544the usage. So sad. 582the usage. So sad.
545 583
546While nominally embeddable in other event loops, this feature is broken in 584While nominally embeddable in other event loops, this feature is broken in
547all kernel versions tested so far. 585a lot of kernel revisions, but probably(!) works in current versions.
548 586
549This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 587This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
550C<EVBACKEND_POLL>. 588C<EVBACKEND_POLL>.
551 589
590=item C<EVBACKEND_LINUXAIO> (value 64, Linux)
591
592Use the Linux-specific Linux AIO (I<not> C<< aio(7) >> but C<<
593io_submit(2) >>) event interface available in post-4.18 kernels (but libev
594only tries to use it in 4.19+).
595
596This is another Linux train wreck of an event interface.
597
598If this backend works for you (as of this writing, it was very
599experimental), it is the best event interface available on Linux and might
600be well worth enabling it - if it isn't available in your kernel this will
601be detected and this backend will be skipped.
602
603This backend can batch oneshot requests and supports a user-space ring
604buffer to receive events. It also doesn't suffer from most of the design
605problems of epoll (such as not being able to remove event sources from
606the epoll set), and generally sounds too good to be true. Because, this
607being the Linux kernel, of course it suffers from a whole new set of
608limitations, forcing you to fall back to epoll, inheriting all its design
609issues.
610
611For one, it is not easily embeddable (but probably could be done using
612an event fd at some extra overhead). It also is subject to a system wide
613limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no AIO
614requests are left, this backend will be skipped during initialisation, and
615will switch to epoll when the loop is active.
616
617Most problematic in practice, however, is that not all file descriptors
618work with it. For example, in Linux 5.1, TCP sockets, pipes, event fds,
619files, F</dev/null> and many others are supported, but ttys do not work
620properly (a known bug that the kernel developers don't care about, see
621L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
622(yet?) a generic event polling interface.
623
624Overall, it seems the Linux developers just don't want it to have a
625generic event handling mechanism other than C<select> or C<poll>.
626
627To work around all these problem, the current version of libev uses its
628epoll backend as a fallback for file descriptor types that do not work. Or
629falls back completely to epoll if the kernel acts up.
630
631This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
632C<EVBACKEND_POLL>.
633
552=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 634=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
553 635
554Kqueue deserves special mention, as at the time of this writing, it 636Kqueue deserves special mention, as at the time this backend was
555was broken on all BSDs except NetBSD (usually it doesn't work reliably 637implemented, it was broken on all BSDs except NetBSD (usually it doesn't
556with anything but sockets and pipes, except on Darwin, where of course 638work reliably with anything but sockets and pipes, except on Darwin,
557it's completely useless). Unlike epoll, however, whose brokenness 639where of course it's completely useless). Unlike epoll, however, whose
558is by design, these kqueue bugs can (and eventually will) be fixed 640brokenness is by design, these kqueue bugs can be (and mostly have been)
559without API changes to existing programs. For this reason it's not being 641fixed without API changes to existing programs. For this reason it's not
560"auto-detected" unless you explicitly specify it in the flags (i.e. using 642being "auto-detected" on all platforms unless you explicitly specify it
561C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) 643in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a
562system like NetBSD. 644known-to-be-good (-enough) system like NetBSD.
563 645
564You still can embed kqueue into a normal poll or select backend and use it 646You still can embed kqueue into a normal poll or select backend and use it
565only for sockets (after having made sure that sockets work with kqueue on 647only for sockets (after having made sure that sockets work with kqueue on
566the target platform). See C<ev_embed> watchers for more info. 648the target platform). See C<ev_embed> watchers for more info.
567 649
568It scales in the same way as the epoll backend, but the interface to the 650It scales in the same way as the epoll backend, but the interface to the
569kernel is more efficient (which says nothing about its actual speed, of 651kernel is more efficient (which says nothing about its actual speed, of
570course). While stopping, setting and starting an I/O watcher does never 652course). While stopping, setting and starting an I/O watcher does never
571cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to 653cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
572two event changes per incident. Support for C<fork ()> is very bad (but 654two event changes per incident. Support for C<fork ()> is very bad (you
573sane, unlike epoll) and it drops fds silently in similarly hard-to-detect 655might have to leak fds on fork, but it's more sane than epoll) and it
574cases 656drops fds silently in similarly hard-to-detect cases.
575 657
576This backend usually performs well under most conditions. 658This backend usually performs well under most conditions.
577 659
578While nominally embeddable in other event loops, this doesn't work 660While nominally embeddable in other event loops, this doesn't work
579everywhere, so you might need to test for this. And since it is broken 661everywhere, so you might need to test for this. And since it is broken
608among the OS-specific backends (I vastly prefer correctness over speed 690among the OS-specific backends (I vastly prefer correctness over speed
609hacks). 691hacks).
610 692
611On the negative side, the interface is I<bizarre> - so bizarre that 693On the negative side, the interface is I<bizarre> - so bizarre that
612even sun itself gets it wrong in their code examples: The event polling 694even sun itself gets it wrong in their code examples: The event polling
613function sometimes returning events to the caller even though an error 695function sometimes returns events to the caller even though an error
614occurred, but with no indication whether it has done so or not (yes, it's 696occurred, but with no indication whether it has done so or not (yes, it's
615even documented that way) - deadly for edge-triggered interfaces where 697even documented that way) - deadly for edge-triggered interfaces where you
616you absolutely have to know whether an event occurred or not because you 698absolutely have to know whether an event occurred or not because you have
617have to re-arm the watcher. 699to re-arm the watcher.
618 700
619Fortunately libev seems to be able to work around these idiocies. 701Fortunately libev seems to be able to work around these idiocies.
620 702
621This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 703This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
622C<EVBACKEND_POLL>. 704C<EVBACKEND_POLL>.
652 734
653Example: Use whatever libev has to offer, but make sure that kqueue is 735Example: Use whatever libev has to offer, but make sure that kqueue is
654used if available. 736used if available.
655 737
656 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 738 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
739
740Example: Similarly, on linux, you mgiht want to take advantage of the
741linux aio backend if possible, but fall back to something else if that
742isn't available.
743
744 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
657 745
658=item ev_loop_destroy (loop) 746=item ev_loop_destroy (loop)
659 747
660Destroys an event loop object (frees all memory and kernel state 748Destroys an event loop object (frees all memory and kernel state
661etc.). None of the active event watchers will be stopped in the normal 749etc.). None of the active event watchers will be stopped in the normal
678If you need dynamically allocated loops it is better to use C<ev_loop_new> 766If you need dynamically allocated loops it is better to use C<ev_loop_new>
679and C<ev_loop_destroy>. 767and C<ev_loop_destroy>.
680 768
681=item ev_loop_fork (loop) 769=item ev_loop_fork (loop)
682 770
683This function sets a flag that causes subsequent C<ev_run> iterations to 771This function sets a flag that causes subsequent C<ev_run> iterations
684reinitialise the kernel state for backends that have one. Despite the 772to reinitialise the kernel state for backends that have one. Despite
685name, you can call it anytime, but it makes most sense after forking, in 773the name, you can call it anytime you are allowed to start or stop
686the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the 774watchers (except inside an C<ev_prepare> callback), but it makes most
775sense after forking, in the child process. You I<must> call it (or use
687child before resuming or calling C<ev_run>. 776C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
688 777
778In addition, if you want to reuse a loop (via this function or
779C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>.
780
689Again, you I<have> to call it on I<any> loop that you want to re-use after 781Again, you I<have> to call it on I<any> loop that you want to re-use after
690a fork, I<even if you do not plan to use the loop in the parent>. This is 782a fork, I<even if you do not plan to use the loop in the parent>. This is
691because some kernel interfaces *cough* I<kqueue> *cough* do funny things 783because some kernel interfaces *cough* I<kqueue> *cough* do funny things
692during fork. 784during fork.
693 785
694On the other hand, you only need to call this function in the child 786On the other hand, you only need to call this function in the child
764 856
765This function is rarely useful, but when some event callback runs for a 857This function is rarely useful, but when some event callback runs for a
766very long time without entering the event loop, updating libev's idea of 858very long time without entering the event loop, updating libev's idea of
767the current time is a good idea. 859the current time is a good idea.
768 860
769See also L<The special problem of time updates> in the C<ev_timer> section. 861See also L</The special problem of time updates> in the C<ev_timer> section.
770 862
771=item ev_suspend (loop) 863=item ev_suspend (loop)
772 864
773=item ev_resume (loop) 865=item ev_resume (loop)
774 866
792without a previous call to C<ev_suspend>. 884without a previous call to C<ev_suspend>.
793 885
794Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the 886Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
795event loop time (see C<ev_now_update>). 887event loop time (see C<ev_now_update>).
796 888
797=item ev_run (loop, int flags) 889=item bool ev_run (loop, int flags)
798 890
799Finally, this is it, the event handler. This function usually is called 891Finally, this is it, the event handler. This function usually is called
800after you have initialised all your watchers and you want to start 892after you have initialised all your watchers and you want to start
801handling events. It will ask the operating system for any new events, call 893handling events. It will ask the operating system for any new events, call
802the watcher callbacks, an then repeat the whole process indefinitely: This 894the watcher callbacks, and then repeat the whole process indefinitely: This
803is why event loops are called I<loops>. 895is why event loops are called I<loops>.
804 896
805If the flags argument is specified as C<0>, it will keep handling events 897If the flags argument is specified as C<0>, it will keep handling events
806until either no event watchers are active anymore or C<ev_break> was 898until either no event watchers are active anymore or C<ev_break> was
807called. 899called.
900
901The return value is false if there are no more active watchers (which
902usually means "all jobs done" or "deadlock"), and true in all other cases
903(which usually means " you should call C<ev_run> again").
808 904
809Please note that an explicit C<ev_break> is usually better than 905Please note that an explicit C<ev_break> is usually better than
810relying on all watchers to be stopped when deciding when a program has 906relying on all watchers to be stopped when deciding when a program has
811finished (especially in interactive programs), but having a program 907finished (especially in interactive programs), but having a program
812that automatically loops as long as it has to and no longer by virtue 908that automatically loops as long as it has to and no longer by virtue
813of relying on its watchers stopping correctly, that is truly a thing of 909of relying on its watchers stopping correctly, that is truly a thing of
814beauty. 910beauty.
815 911
816This function is also I<mostly> exception-safe - you can break out of 912This function is I<mostly> exception-safe - you can break out of a
817a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++ 913C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
818exception and so on. This does not decrement the C<ev_depth> value, nor 914exception and so on. This does not decrement the C<ev_depth> value, nor
819will it clear any outstanding C<EVBREAK_ONE> breaks. 915will it clear any outstanding C<EVBREAK_ONE> breaks.
820 916
821A flags value of C<EVRUN_NOWAIT> will look for new events, will handle 917A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
822those events and any already outstanding ones, but will not wait and 918those events and any already outstanding ones, but will not wait and
952overhead for the actual polling but can deliver many events at once. 1048overhead for the actual polling but can deliver many events at once.
953 1049
954By setting a higher I<io collect interval> you allow libev to spend more 1050By setting a higher I<io collect interval> you allow libev to spend more
955time collecting I/O events, so you can handle more events per iteration, 1051time collecting I/O events, so you can handle more events per iteration,
956at the cost of increasing latency. Timeouts (both C<ev_periodic> and 1052at the cost of increasing latency. Timeouts (both C<ev_periodic> and
957C<ev_timer>) will be not affected. Setting this to a non-null value will 1053C<ev_timer>) will not be affected. Setting this to a non-null value will
958introduce an additional C<ev_sleep ()> call into most loop iterations. The 1054introduce an additional C<ev_sleep ()> call into most loop iterations. The
959sleep time ensures that libev will not poll for I/O events more often then 1055sleep time ensures that libev will not poll for I/O events more often then
960once per this interval, on average. 1056once per this interval, on average (as long as the host time resolution is
1057good enough).
961 1058
962Likewise, by setting a higher I<timeout collect interval> you allow libev 1059Likewise, by setting a higher I<timeout collect interval> you allow libev
963to spend more time collecting timeouts, at the expense of increased 1060to spend more time collecting timeouts, at the expense of increased
964latency/jitter/inexactness (the watcher callback will be called 1061latency/jitter/inexactness (the watcher callback will be called
965later). C<ev_io> watchers will not be affected. Setting this to a non-null 1062later). C<ev_io> watchers will not be affected. Setting this to a non-null
1011invoke the actual watchers inside another context (another thread etc.). 1108invoke the actual watchers inside another context (another thread etc.).
1012 1109
1013If you want to reset the callback, use C<ev_invoke_pending> as new 1110If you want to reset the callback, use C<ev_invoke_pending> as new
1014callback. 1111callback.
1015 1112
1016=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) 1113=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
1017 1114
1018Sometimes you want to share the same loop between multiple threads. This 1115Sometimes you want to share the same loop between multiple threads. This
1019can be done relatively simply by putting mutex_lock/unlock calls around 1116can be done relatively simply by putting mutex_lock/unlock calls around
1020each call to a libev function. 1117each call to a libev function.
1021 1118
1022However, C<ev_run> can run an indefinite time, so it is not feasible 1119However, C<ev_run> can run an indefinite time, so it is not feasible
1023to wait for it to return. One way around this is to wake up the event 1120to wait for it to return. One way around this is to wake up the event
1024loop via C<ev_break> and C<av_async_send>, another way is to set these 1121loop via C<ev_break> and C<ev_async_send>, another way is to set these
1025I<release> and I<acquire> callbacks on the loop. 1122I<release> and I<acquire> callbacks on the loop.
1026 1123
1027When set, then C<release> will be called just before the thread is 1124When set, then C<release> will be called just before the thread is
1028suspended waiting for new events, and C<acquire> is called just 1125suspended waiting for new events, and C<acquire> is called just
1029afterwards. 1126afterwards.
1169 1266
1170=item C<EV_PREPARE> 1267=item C<EV_PREPARE>
1171 1268
1172=item C<EV_CHECK> 1269=item C<EV_CHECK>
1173 1270
1174All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts 1271All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1175to gather new events, and all C<ev_check> watchers are invoked just after 1272gather new events, and all C<ev_check> watchers are queued (not invoked)
1176C<ev_run> has gathered them, but before it invokes any callbacks for any 1273just after C<ev_run> has gathered them, but before it queues any callbacks
1274for any received events. That means C<ev_prepare> watchers are the last
1275watchers invoked before the event loop sleeps or polls for new events, and
1276C<ev_check> watchers will be invoked before any other watchers of the same
1277or lower priority within an event loop iteration.
1278
1177received events. Callbacks of both watcher types can start and stop as 1279Callbacks of both watcher types can start and stop as many watchers as
1178many watchers as they want, and all of them will be taken into account 1280they want, and all of them will be taken into account (for example, a
1179(for example, a C<ev_prepare> watcher might start an idle watcher to keep 1281C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1180C<ev_run> from blocking). 1282blocking).
1181 1283
1182=item C<EV_EMBED> 1284=item C<EV_EMBED>
1183 1285
1184The embedded event loop specified in the C<ev_embed> watcher needs attention. 1286The embedded event loop specified in the C<ev_embed> watcher needs attention.
1185 1287
1308 1410
1309=item callback ev_cb (ev_TYPE *watcher) 1411=item callback ev_cb (ev_TYPE *watcher)
1310 1412
1311Returns the callback currently set on the watcher. 1413Returns the callback currently set on the watcher.
1312 1414
1313=item ev_cb_set (ev_TYPE *watcher, callback) 1415=item ev_set_cb (ev_TYPE *watcher, callback)
1314 1416
1315Change the callback. You can change the callback at virtually any time 1417Change the callback. You can change the callback at virtually any time
1316(modulo threads). 1418(modulo threads).
1317 1419
1318=item ev_set_priority (ev_TYPE *watcher, int priority) 1420=item ev_set_priority (ev_TYPE *watcher, int priority)
1336or might not have been clamped to the valid range. 1438or might not have been clamped to the valid range.
1337 1439
1338The default priority used by watchers when no priority has been set is 1440The default priority used by watchers when no priority has been set is
1339always C<0>, which is supposed to not be too high and not be too low :). 1441always C<0>, which is supposed to not be too high and not be too low :).
1340 1442
1341See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1443See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1342priorities. 1444priorities.
1343 1445
1344=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1446=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1345 1447
1346Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1448Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1371See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related 1473See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1372functions that do not need a watcher. 1474functions that do not need a watcher.
1373 1475
1374=back 1476=back
1375 1477
1376See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1478See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1377OWN COMPOSITE WATCHERS> idioms. 1479OWN COMPOSITE WATCHERS> idioms.
1378 1480
1379=head2 WATCHER STATES 1481=head2 WATCHER STATES
1380 1482
1381There are various watcher states mentioned throughout this manual - 1483There are various watcher states mentioned throughout this manual -
1383transition between them will be described in more detail - and while these 1485transition between them will be described in more detail - and while these
1384rules might look complicated, they usually do "the right thing". 1486rules might look complicated, they usually do "the right thing".
1385 1487
1386=over 4 1488=over 4
1387 1489
1388=item initialiased 1490=item initialised
1389 1491
1390Before a watcher can be registered with the event looop it has to be 1492Before a watcher can be registered with the event loop it has to be
1391initialised. This can be done with a call to C<ev_TYPE_init>, or calls to 1493initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1392C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. 1494C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1393 1495
1394In this state it is simply some block of memory that is suitable for 1496In this state it is simply some block of memory that is suitable for
1395use in an event loop. It can be moved around, freed, reused etc. at 1497use in an event loop. It can be moved around, freed, reused etc. at
1442 1544
1443Many event loops support I<watcher priorities>, which are usually small 1545Many event loops support I<watcher priorities>, which are usually small
1444integers that influence the ordering of event callback invocation 1546integers that influence the ordering of event callback invocation
1445between watchers in some way, all else being equal. 1547between watchers in some way, all else being equal.
1446 1548
1447In libev, Watcher priorities can be set using C<ev_set_priority>. See its 1549In libev, watcher priorities can be set using C<ev_set_priority>. See its
1448description for the more technical details such as the actual priority 1550description for the more technical details such as the actual priority
1449range. 1551range.
1450 1552
1451There are two common ways how these these priorities are being interpreted 1553There are two common ways how these these priorities are being interpreted
1452by event loops: 1554by event loops:
1546 1648
1547This section describes each watcher in detail, but will not repeat 1649This section describes each watcher in detail, but will not repeat
1548information given in the last section. Any initialisation/set macros, 1650information given in the last section. Any initialisation/set macros,
1549functions and members specific to the watcher type are explained. 1651functions and members specific to the watcher type are explained.
1550 1652
1551Members are additionally marked with either I<[read-only]>, meaning that, 1653Most members are additionally marked with either I<[read-only]>, meaning
1552while the watcher is active, you can look at the member and expect some 1654that, while the watcher is active, you can look at the member and expect
1553sensible content, but you must not modify it (you can modify it while the 1655some sensible content, but you must not modify it (you can modify it while
1554watcher is stopped to your hearts content), or I<[read-write]>, which 1656the watcher is stopped to your hearts content), or I<[read-write]>, which
1555means you can expect it to have some sensible content while the watcher 1657means you can expect it to have some sensible content while the watcher
1556is active, but you can also modify it. Modifying it may not do something 1658is active, but you can also modify it. Modifying it may not do something
1557sensible or take immediate effect (or do anything at all), but libev will 1659sensible or take immediate effect (or do anything at all), but libev will
1558not crash or malfunction in any way. 1660not crash or malfunction in any way.
1559 1661
1662In any case, the documentation for each member will explain what the
1663effects are, and if there are any additional access restrictions.
1560 1664
1561=head2 C<ev_io> - is this file descriptor readable or writable? 1665=head2 C<ev_io> - is this file descriptor readable or writable?
1562 1666
1563I/O watchers check whether a file descriptor is readable or writable 1667I/O watchers check whether a file descriptor is readable or writable
1564in each iteration of the event loop, or, more precisely, when reading 1668in each iteration of the event loop, or, more precisely, when reading
1591 1695
1592But really, best use non-blocking mode. 1696But really, best use non-blocking mode.
1593 1697
1594=head3 The special problem of disappearing file descriptors 1698=head3 The special problem of disappearing file descriptors
1595 1699
1596Some backends (e.g. kqueue, epoll) need to be told about closing a file 1700Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1597descriptor (either due to calling C<close> explicitly or any other means, 1701a file descriptor (either due to calling C<close> explicitly or any other
1598such as C<dup2>). The reason is that you register interest in some file 1702means, such as C<dup2>). The reason is that you register interest in some
1599descriptor, but when it goes away, the operating system will silently drop 1703file descriptor, but when it goes away, the operating system will silently
1600this interest. If another file descriptor with the same number then is 1704drop this interest. If another file descriptor with the same number then
1601registered with libev, there is no efficient way to see that this is, in 1705is registered with libev, there is no efficient way to see that this is,
1602fact, a different file descriptor. 1706in fact, a different file descriptor.
1603 1707
1604To avoid having to explicitly tell libev about such cases, libev follows 1708To avoid having to explicitly tell libev about such cases, libev follows
1605the following policy: Each time C<ev_io_set> is being called, libev 1709the following policy: Each time C<ev_io_set> is being called, libev
1606will assume that this is potentially a new file descriptor, otherwise 1710will assume that this is potentially a new file descriptor, otherwise
1607it is assumed that the file descriptor stays the same. That means that 1711it is assumed that the file descriptor stays the same. That means that
1656when you rarely read from a file instead of from a socket, and want to 1760when you rarely read from a file instead of from a socket, and want to
1657reuse the same code path. 1761reuse the same code path.
1658 1762
1659=head3 The special problem of fork 1763=head3 The special problem of fork
1660 1764
1661Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1765Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()>
1662useless behaviour. Libev fully supports fork, but needs to be told about 1766at all or exhibit useless behaviour. Libev fully supports fork, but needs
1663it in the child if you want to continue to use it in the child. 1767to be told about it in the child if you want to continue to use it in the
1768child.
1664 1769
1665To support fork in your child processes, you have to call C<ev_loop_fork 1770To support fork in your child processes, you have to call C<ev_loop_fork
1666()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to 1771()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1667C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1772C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1668 1773
1726 1831
1727Configures an C<ev_io> watcher. The C<fd> is the file descriptor to 1832Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1728receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or 1833receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or
1729C<EV_READ | EV_WRITE>, to express the desire to receive the given events. 1834C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1730 1835
1731=item int fd [read-only] 1836=item ev_io_modify (ev_io *, int events)
1732 1837
1733The file descriptor being watched. 1838Similar to C<ev_io_set>, but only changes the event mask. Using this might
1839be faster with some backends, as libev can assume that the C<fd> still
1840refers to the same underlying file description, something it cannot do
1841when using C<ev_io_set>.
1734 1842
1843=item int fd [no-modify]
1844
1845The file descriptor being watched. While it can be read at any time, you
1846must not modify this member even when the watcher is stopped - always use
1847C<ev_io_set> for that.
1848
1735=item int events [read-only] 1849=item int events [no-modify]
1736 1850
1737The events being watched. 1851The set of events being watched, among other flags. This field is a
1852bit set - to test for C<EV_READ>, use C<< w->events & EV_READ >>, and
1853similarly for C<EV_WRITE>.
1854
1855As with C<fd>, you must not modify this member even when the watcher is
1856stopped, always use C<ev_io_set> or C<ev_io_modify> for that.
1738 1857
1739=back 1858=back
1740 1859
1741=head3 Examples 1860=head3 Examples
1742 1861
1770detecting time jumps is hard, and some inaccuracies are unavoidable (the 1889detecting time jumps is hard, and some inaccuracies are unavoidable (the
1771monotonic clock option helps a lot here). 1890monotonic clock option helps a lot here).
1772 1891
1773The callback is guaranteed to be invoked only I<after> its timeout has 1892The callback is guaranteed to be invoked only I<after> its timeout has
1774passed (not I<at>, so on systems with very low-resolution clocks this 1893passed (not I<at>, so on systems with very low-resolution clocks this
1775might introduce a small delay). If multiple timers become ready during the 1894might introduce a small delay, see "the special problem of being too
1895early", below). If multiple timers become ready during the same loop
1776same loop iteration then the ones with earlier time-out values are invoked 1896iteration then the ones with earlier time-out values are invoked before
1777before ones of the same priority with later time-out values (but this is 1897ones of the same priority with later time-out values (but this is no
1778no longer true when a callback calls C<ev_run> recursively). 1898longer true when a callback calls C<ev_run> recursively).
1779 1899
1780=head3 Be smart about timeouts 1900=head3 Be smart about timeouts
1781 1901
1782Many real-world problems involve some kind of timeout, usually for error 1902Many real-world problems involve some kind of timeout, usually for error
1783recovery. A typical example is an HTTP request - if the other side hangs, 1903recovery. A typical example is an HTTP request - if the other side hangs,
1858 1978
1859In this case, it would be more efficient to leave the C<ev_timer> alone, 1979In this case, it would be more efficient to leave the C<ev_timer> alone,
1860but remember the time of last activity, and check for a real timeout only 1980but remember the time of last activity, and check for a real timeout only
1861within the callback: 1981within the callback:
1862 1982
1983 ev_tstamp timeout = 60.;
1863 ev_tstamp last_activity; // time of last activity 1984 ev_tstamp last_activity; // time of last activity
1985 ev_timer timer;
1864 1986
1865 static void 1987 static void
1866 callback (EV_P_ ev_timer *w, int revents) 1988 callback (EV_P_ ev_timer *w, int revents)
1867 { 1989 {
1868 ev_tstamp now = ev_now (EV_A); 1990 // calculate when the timeout would happen
1869 ev_tstamp timeout = last_activity + 60.; 1991 ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1870 1992
1871 // if last_activity + 60. is older than now, we did time out 1993 // if negative, it means we the timeout already occurred
1872 if (timeout < now) 1994 if (after < 0.)
1873 { 1995 {
1874 // timeout occurred, take action 1996 // timeout occurred, take action
1875 } 1997 }
1876 else 1998 else
1877 { 1999 {
1878 // callback was invoked, but there was some activity, re-arm 2000 // callback was invoked, but there was some recent
1879 // the watcher to fire in last_activity + 60, which is 2001 // activity. simply restart the timer to time out
1880 // guaranteed to be in the future, so "again" is positive: 2002 // after "after" seconds, which is the earliest time
1881 w->repeat = timeout - now; 2003 // the timeout can occur.
2004 ev_timer_set (w, after, 0.);
1882 ev_timer_again (EV_A_ w); 2005 ev_timer_start (EV_A_ w);
1883 } 2006 }
1884 } 2007 }
1885 2008
1886To summarise the callback: first calculate the real timeout (defined 2009To summarise the callback: first calculate in how many seconds the
1887as "60 seconds after the last activity"), then check if that time has 2010timeout will occur (by calculating the absolute time when it would occur,
1888been reached, which means something I<did>, in fact, time out. Otherwise 2011C<last_activity + timeout>, and subtracting the current time, C<ev_now
1889the callback was invoked too early (C<timeout> is in the future), so 2012(EV_A)> from that).
1890re-schedule the timer to fire at that future time, to see if maybe we have
1891a timeout then.
1892 2013
1893Note how C<ev_timer_again> is used, taking advantage of the 2014If this value is negative, then we are already past the timeout, i.e. we
1894C<ev_timer_again> optimisation when the timer is already running. 2015timed out, and need to do whatever is needed in this case.
2016
2017Otherwise, we now the earliest time at which the timeout would trigger,
2018and simply start the timer with this timeout value.
2019
2020In other words, each time the callback is invoked it will check whether
2021the timeout occurred. If not, it will simply reschedule itself to check
2022again at the earliest time it could time out. Rinse. Repeat.
1895 2023
1896This scheme causes more callback invocations (about one every 60 seconds 2024This scheme causes more callback invocations (about one every 60 seconds
1897minus half the average time between activity), but virtually no calls to 2025minus half the average time between activity), but virtually no calls to
1898libev to change the timeout. 2026libev to change the timeout.
1899 2027
1900To start the timer, simply initialise the watcher and set C<last_activity> 2028To start the machinery, simply initialise the watcher and set
1901to the current time (meaning we just have some activity :), then call the 2029C<last_activity> to the current time (meaning there was some activity just
1902callback, which will "do the right thing" and start the timer: 2030now), then call the callback, which will "do the right thing" and start
2031the timer:
1903 2032
2033 last_activity = ev_now (EV_A);
1904 ev_init (timer, callback); 2034 ev_init (&timer, callback);
1905 last_activity = ev_now (loop); 2035 callback (EV_A_ &timer, 0);
1906 callback (loop, timer, EV_TIMER);
1907 2036
1908And when there is some activity, simply store the current time in 2037When there is some activity, simply store the current time in
1909C<last_activity>, no libev calls at all: 2038C<last_activity>, no libev calls at all:
1910 2039
2040 if (activity detected)
1911 last_activity = ev_now (loop); 2041 last_activity = ev_now (EV_A);
2042
2043When your timeout value changes, then the timeout can be changed by simply
2044providing a new value, stopping the timer and calling the callback, which
2045will again do the right thing (for example, time out immediately :).
2046
2047 timeout = new_value;
2048 ev_timer_stop (EV_A_ &timer);
2049 callback (EV_A_ &timer, 0);
1912 2050
1913This technique is slightly more complex, but in most cases where the 2051This technique is slightly more complex, but in most cases where the
1914time-out is unlikely to be triggered, much more efficient. 2052time-out is unlikely to be triggered, much more efficient.
1915
1916Changing the timeout is trivial as well (if it isn't hard-coded in the
1917callback :) - just change the timeout and invoke the callback, which will
1918fix things for you.
1919 2053
1920=item 4. Wee, just use a double-linked list for your timeouts. 2054=item 4. Wee, just use a double-linked list for your timeouts.
1921 2055
1922If there is not one request, but many thousands (millions...), all 2056If there is not one request, but many thousands (millions...), all
1923employing some kind of timeout with the same timeout value, then one can 2057employing some kind of timeout with the same timeout value, then one can
1950Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 2084Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1951rather complicated, but extremely efficient, something that really pays 2085rather complicated, but extremely efficient, something that really pays
1952off after the first million or so of active timers, i.e. it's usually 2086off after the first million or so of active timers, i.e. it's usually
1953overkill :) 2087overkill :)
1954 2088
2089=head3 The special problem of being too early
2090
2091If you ask a timer to call your callback after three seconds, then
2092you expect it to be invoked after three seconds - but of course, this
2093cannot be guaranteed to infinite precision. Less obviously, it cannot be
2094guaranteed to any precision by libev - imagine somebody suspending the
2095process with a STOP signal for a few hours for example.
2096
2097So, libev tries to invoke your callback as soon as possible I<after> the
2098delay has occurred, but cannot guarantee this.
2099
2100A less obvious failure mode is calling your callback too early: many event
2101loops compare timestamps with a "elapsed delay >= requested delay", but
2102this can cause your callback to be invoked much earlier than you would
2103expect.
2104
2105To see why, imagine a system with a clock that only offers full second
2106resolution (think windows if you can't come up with a broken enough OS
2107yourself). If you schedule a one-second timer at the time 500.9, then the
2108event loop will schedule your timeout to elapse at a system time of 500
2109(500.9 truncated to the resolution) + 1, or 501.
2110
2111If an event library looks at the timeout 0.1s later, it will see "501 >=
2112501" and invoke the callback 0.1s after it was started, even though a
2113one-second delay was requested - this is being "too early", despite best
2114intentions.
2115
2116This is the reason why libev will never invoke the callback if the elapsed
2117delay equals the requested delay, but only when the elapsed delay is
2118larger than the requested delay. In the example above, libev would only invoke
2119the callback at system time 502, or 1.1s after the timer was started.
2120
2121So, while libev cannot guarantee that your callback will be invoked
2122exactly when requested, it I<can> and I<does> guarantee that the requested
2123delay has actually elapsed, or in other words, it always errs on the "too
2124late" side of things.
2125
1955=head3 The special problem of time updates 2126=head3 The special problem of time updates
1956 2127
1957Establishing the current time is a costly operation (it usually takes at 2128Establishing the current time is a costly operation (it usually takes
1958least two system calls): EV therefore updates its idea of the current 2129at least one system call): EV therefore updates its idea of the current
1959time only before and after C<ev_run> collects new events, which causes a 2130time only before and after C<ev_run> collects new events, which causes a
1960growing difference between C<ev_now ()> and C<ev_time ()> when handling 2131growing difference between C<ev_now ()> and C<ev_time ()> when handling
1961lots of events in one iteration. 2132lots of events in one iteration.
1962 2133
1963The relative timeouts are calculated relative to the C<ev_now ()> 2134The relative timeouts are calculated relative to the C<ev_now ()>
1964time. This is usually the right thing as this timestamp refers to the time 2135time. This is usually the right thing as this timestamp refers to the time
1965of the event triggering whatever timeout you are modifying/starting. If 2136of the event triggering whatever timeout you are modifying/starting. If
1966you suspect event processing to be delayed and you I<need> to base the 2137you suspect event processing to be delayed and you I<need> to base the
1967timeout on the current time, use something like this to adjust for this: 2138timeout on the current time, use something like the following to adjust
2139for it:
1968 2140
1969 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2141 ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
1970 2142
1971If the event loop is suspended for a long time, you can also force an 2143If the event loop is suspended for a long time, you can also force an
1972update of the time returned by C<ev_now ()> by calling C<ev_now_update 2144update of the time returned by C<ev_now ()> by calling C<ev_now_update
1973()>. 2145()>, although that will push the event time of all outstanding events
2146further into the future.
2147
2148=head3 The special problem of unsynchronised clocks
2149
2150Modern systems have a variety of clocks - libev itself uses the normal
2151"wall clock" clock and, if available, the monotonic clock (to avoid time
2152jumps).
2153
2154Neither of these clocks is synchronised with each other or any other clock
2155on the system, so C<ev_time ()> might return a considerably different time
2156than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
2157a call to C<gettimeofday> might return a second count that is one higher
2158than a directly following call to C<time>.
2159
2160The moral of this is to only compare libev-related timestamps with
2161C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
2162a second or so.
2163
2164One more problem arises due to this lack of synchronisation: if libev uses
2165the system monotonic clock and you compare timestamps from C<ev_time>
2166or C<ev_now> from when you started your timer and when your callback is
2167invoked, you will find that sometimes the callback is a bit "early".
2168
2169This is because C<ev_timer>s work in real time, not wall clock time, so
2170libev makes sure your callback is not invoked before the delay happened,
2171I<measured according to the real time>, not the system clock.
2172
2173If your timeouts are based on a physical timescale (e.g. "time out this
2174connection after 100 seconds") then this shouldn't bother you as it is
2175exactly the right behaviour.
2176
2177If you want to compare wall clock/system timestamps to your timers, then
2178you need to use C<ev_periodic>s, as these are based on the wall clock
2179time, where your comparisons will always generate correct results.
1974 2180
1975=head3 The special problems of suspended animation 2181=head3 The special problems of suspended animation
1976 2182
1977When you leave the server world it is quite customary to hit machines that 2183When you leave the server world it is quite customary to hit machines that
1978can suspend/hibernate - what happens to the clocks during such a suspend? 2184can suspend/hibernate - what happens to the clocks during such a suspend?
2008 2214
2009=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 2215=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
2010 2216
2011=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 2217=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
2012 2218
2013Configure the timer to trigger after C<after> seconds. If C<repeat> 2219Configure the timer to trigger after C<after> seconds (fractional and
2014is C<0.>, then it will automatically be stopped once the timeout is 2220negative values are supported). If C<repeat> is C<0.>, then it will
2015reached. If it is positive, then the timer will automatically be 2221automatically be stopped once the timeout is reached. If it is positive,
2016configured to trigger again C<repeat> seconds later, again, and again, 2222then the timer will automatically be configured to trigger again C<repeat>
2017until stopped manually. 2223seconds later, again, and again, until stopped manually.
2018 2224
2019The timer itself will do a best-effort at avoiding drift, that is, if 2225The timer itself will do a best-effort at avoiding drift, that is, if
2020you configure a timer to trigger every 10 seconds, then it will normally 2226you configure a timer to trigger every 10 seconds, then it will normally
2021trigger at exactly 10 second intervals. If, however, your program cannot 2227trigger at exactly 10 second intervals. If, however, your program cannot
2022keep up with the timer (because it takes longer than those 10 seconds to 2228keep up with the timer (because it takes longer than those 10 seconds to
2023do stuff) the timer will not fire more than once per event loop iteration. 2229do stuff) the timer will not fire more than once per event loop iteration.
2024 2230
2025=item ev_timer_again (loop, ev_timer *) 2231=item ev_timer_again (loop, ev_timer *)
2026 2232
2027This will act as if the timer timed out and restart it again if it is 2233This will act as if the timer timed out, and restarts it again if it is
2028repeating. The exact semantics are: 2234repeating. It basically works like calling C<ev_timer_stop>, updating the
2235timeout to the C<repeat> value and calling C<ev_timer_start>.
2029 2236
2237The exact semantics are as in the following rules, all of which will be
2238applied to the watcher:
2239
2240=over 4
2241
2030If the timer is pending, its pending status is cleared. 2242=item If the timer is pending, the pending status is always cleared.
2031 2243
2032If the timer is started but non-repeating, stop it (as if it timed out). 2244=item If the timer is started but non-repeating, stop it (as if it timed
2245out, without invoking it).
2033 2246
2034If the timer is repeating, either start it if necessary (with the 2247=item If the timer is repeating, make the C<repeat> value the new timeout
2035C<repeat> value), or reset the running timer to the C<repeat> value. 2248and start the timer, if necessary.
2036 2249
2250=back
2251
2037This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2252This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2038usage example. 2253usage example.
2039 2254
2040=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2255=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2041 2256
2042Returns the remaining time until a timer fires. If the timer is active, 2257Returns the remaining time until a timer fires. If the timer is active,
2095Periodic watchers are also timers of a kind, but they are very versatile 2310Periodic watchers are also timers of a kind, but they are very versatile
2096(and unfortunately a bit complex). 2311(and unfortunately a bit complex).
2097 2312
2098Unlike C<ev_timer>, periodic watchers are not based on real time (or 2313Unlike C<ev_timer>, periodic watchers are not based on real time (or
2099relative time, the physical time that passes) but on wall clock time 2314relative time, the physical time that passes) but on wall clock time
2100(absolute time, the thing you can read on your calender or clock). The 2315(absolute time, the thing you can read on your calendar or clock). The
2101difference is that wall clock time can run faster or slower than real 2316difference is that wall clock time can run faster or slower than real
2102time, and time jumps are not uncommon (e.g. when you adjust your 2317time, and time jumps are not uncommon (e.g. when you adjust your
2103wrist-watch). 2318wrist-watch).
2104 2319
2105You can tell a periodic watcher to trigger after some specific point 2320You can tell a periodic watcher to trigger after some specific point
2110C<ev_timer>, which would still trigger roughly 10 seconds after starting 2325C<ev_timer>, which would still trigger roughly 10 seconds after starting
2111it, as it uses a relative timeout). 2326it, as it uses a relative timeout).
2112 2327
2113C<ev_periodic> watchers can also be used to implement vastly more complex 2328C<ev_periodic> watchers can also be used to implement vastly more complex
2114timers, such as triggering an event on each "midnight, local time", or 2329timers, such as triggering an event on each "midnight, local time", or
2115other complicated rules. This cannot be done with C<ev_timer> watchers, as 2330other complicated rules. This cannot easily be done with C<ev_timer>
2116those cannot react to time jumps. 2331watchers, as those cannot react to time jumps.
2117 2332
2118As with timers, the callback is guaranteed to be invoked only when the 2333As with timers, the callback is guaranteed to be invoked only when the
2119point in time where it is supposed to trigger has passed. If multiple 2334point in time where it is supposed to trigger has passed. If multiple
2120timers become ready during the same loop iteration then the ones with 2335timers become ready during the same loop iteration then the ones with
2121earlier time-out values are invoked before ones with later time-out values 2336earlier time-out values are invoked before ones with later time-out values
2207 2422
2208NOTE: I<< This callback must always return a time that is higher than or 2423NOTE: I<< This callback must always return a time that is higher than or
2209equal to the passed C<now> value >>. 2424equal to the passed C<now> value >>.
2210 2425
2211This can be used to create very complex timers, such as a timer that 2426This can be used to create very complex timers, such as a timer that
2212triggers on "next midnight, local time". To do this, you would calculate the 2427triggers on "next midnight, local time". To do this, you would calculate
2213next midnight after C<now> and return the timestamp value for this. How 2428the next midnight after C<now> and return the timestamp value for
2214you do this is, again, up to you (but it is not trivial, which is the main 2429this. Here is a (completely untested, no error checking) example on how to
2215reason I omitted it as an example). 2430do this:
2431
2432 #include <time.h>
2433
2434 static ev_tstamp
2435 my_rescheduler (ev_periodic *w, ev_tstamp now)
2436 {
2437 time_t tnow = (time_t)now;
2438 struct tm tm;
2439 localtime_r (&tnow, &tm);
2440
2441 tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2442 ++tm.tm_mday; // midnight next day
2443
2444 return mktime (&tm);
2445 }
2446
2447Note: this code might run into trouble on days that have more then two
2448midnights (beginning and end).
2216 2449
2217=back 2450=back
2218 2451
2219=item ev_periodic_again (loop, ev_periodic *) 2452=item ev_periodic_again (loop, ev_periodic *)
2220 2453
2285 2518
2286 ev_periodic hourly_tick; 2519 ev_periodic hourly_tick;
2287 ev_periodic_init (&hourly_tick, clock_cb, 2520 ev_periodic_init (&hourly_tick, clock_cb,
2288 fmod (ev_now (loop), 3600.), 3600., 0); 2521 fmod (ev_now (loop), 3600.), 3600., 0);
2289 ev_periodic_start (loop, &hourly_tick); 2522 ev_periodic_start (loop, &hourly_tick);
2290 2523
2291 2524
2292=head2 C<ev_signal> - signal me when a signal gets signalled! 2525=head2 C<ev_signal> - signal me when a signal gets signalled!
2293 2526
2294Signal watchers will trigger an event when the process receives a specific 2527Signal watchers will trigger an event when the process receives a specific
2295signal one or more times. Even though signals are very asynchronous, libev 2528signal one or more times. Even though signals are very asynchronous, libev
2305only within the same loop, i.e. you can watch for C<SIGINT> in your 2538only within the same loop, i.e. you can watch for C<SIGINT> in your
2306default loop and for C<SIGIO> in another loop, but you cannot watch for 2539default loop and for C<SIGIO> in another loop, but you cannot watch for
2307C<SIGINT> in both the default loop and another loop at the same time. At 2540C<SIGINT> in both the default loop and another loop at the same time. At
2308the moment, C<SIGCHLD> is permanently tied to the default loop. 2541the moment, C<SIGCHLD> is permanently tied to the default loop.
2309 2542
2310When the first watcher gets started will libev actually register something 2543Only after the first watcher for a signal is started will libev actually
2311with the kernel (thus it coexists with your own signal handlers as long as 2544register something with the kernel. It thus coexists with your own signal
2312you don't register any with libev for the same signal). 2545handlers as long as you don't register any with libev for the same signal.
2313 2546
2314If possible and supported, libev will install its handlers with 2547If possible and supported, libev will install its handlers with
2315C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2548C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2316not be unduly interrupted. If you have a problem with system calls getting 2549not be unduly interrupted. If you have a problem with system calls getting
2317interrupted by signals you can block all signals in an C<ev_check> watcher 2550interrupted by signals you can block all signals in an C<ev_check> watcher
2502 2735
2503=head2 C<ev_stat> - did the file attributes just change? 2736=head2 C<ev_stat> - did the file attributes just change?
2504 2737
2505This watches a file system path for attribute changes. That is, it calls 2738This watches a file system path for attribute changes. That is, it calls
2506C<stat> on that path in regular intervals (or when the OS says it changed) 2739C<stat> on that path in regular intervals (or when the OS says it changed)
2507and sees if it changed compared to the last time, invoking the callback if 2740and sees if it changed compared to the last time, invoking the callback
2508it did. 2741if it did. Starting the watcher C<stat>'s the file, so only changes that
2742happen after the watcher has been started will be reported.
2509 2743
2510The path does not need to exist: changing from "path exists" to "path does 2744The path does not need to exist: changing from "path exists" to "path does
2511not exist" is a status change like any other. The condition "path does not 2745not exist" is a status change like any other. The condition "path does not
2512exist" (or more correctly "path cannot be stat'ed") is signified by the 2746exist" (or more correctly "path cannot be stat'ed") is signified by the
2513C<st_nlink> field being zero (which is otherwise always forced to be at 2747C<st_nlink> field being zero (which is otherwise always forced to be at
2743Apart from keeping your process non-blocking (which is a useful 2977Apart from keeping your process non-blocking (which is a useful
2744effect on its own sometimes), idle watchers are a good place to do 2978effect on its own sometimes), idle watchers are a good place to do
2745"pseudo-background processing", or delay processing stuff to after the 2979"pseudo-background processing", or delay processing stuff to after the
2746event loop has handled all outstanding events. 2980event loop has handled all outstanding events.
2747 2981
2982=head3 Abusing an C<ev_idle> watcher for its side-effect
2983
2984As long as there is at least one active idle watcher, libev will never
2985sleep unnecessarily. Or in other words, it will loop as fast as possible.
2986For this to work, the idle watcher doesn't need to be invoked at all - the
2987lowest priority will do.
2988
2989This mode of operation can be useful together with an C<ev_check> watcher,
2990to do something on each event loop iteration - for example to balance load
2991between different connections.
2992
2993See L</Abusing an ev_check watcher for its side-effect> for a longer
2994example.
2995
2748=head3 Watcher-Specific Functions and Data Members 2996=head3 Watcher-Specific Functions and Data Members
2749 2997
2750=over 4 2998=over 4
2751 2999
2752=item ev_idle_init (ev_idle *, callback) 3000=item ev_idle_init (ev_idle *, callback)
2763callback, free it. Also, use no error checking, as usual. 3011callback, free it. Also, use no error checking, as usual.
2764 3012
2765 static void 3013 static void
2766 idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 3014 idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2767 { 3015 {
3016 // stop the watcher
3017 ev_idle_stop (loop, w);
3018
3019 // now we can free it
2768 free (w); 3020 free (w);
3021
2769 // now do something you wanted to do when the program has 3022 // now do something you wanted to do when the program has
2770 // no longer anything immediate to do. 3023 // no longer anything immediate to do.
2771 } 3024 }
2772 3025
2773 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3026 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2775 ev_idle_start (loop, idle_watcher); 3028 ev_idle_start (loop, idle_watcher);
2776 3029
2777 3030
2778=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 3031=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2779 3032
2780Prepare and check watchers are usually (but not always) used in pairs: 3033Prepare and check watchers are often (but not always) used in pairs:
2781prepare watchers get invoked before the process blocks and check watchers 3034prepare watchers get invoked before the process blocks and check watchers
2782afterwards. 3035afterwards.
2783 3036
2784You I<must not> call C<ev_run> or similar functions that enter 3037You I<must not> call C<ev_run> (or similar functions that enter the
2785the current event loop from either C<ev_prepare> or C<ev_check> 3038current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2786watchers. Other loops than the current one are fine, however. The 3039C<ev_check> watchers. Other loops than the current one are fine,
2787rationale behind this is that you do not need to check for recursion in 3040however. The rationale behind this is that you do not need to check
2788those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, 3041for recursion in those watchers, i.e. the sequence will always be
2789C<ev_check> so if you have one watcher of each kind they will always be 3042C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2790called in pairs bracketing the blocking call. 3043kind they will always be called in pairs bracketing the blocking call.
2791 3044
2792Their main purpose is to integrate other event mechanisms into libev and 3045Their main purpose is to integrate other event mechanisms into libev and
2793their use is somewhat advanced. They could be used, for example, to track 3046their use is somewhat advanced. They could be used, for example, to track
2794variable changes, implement your own watchers, integrate net-snmp or a 3047variable changes, implement your own watchers, integrate net-snmp or a
2795coroutine library and lots more. They are also occasionally useful if 3048coroutine library and lots more. They are also occasionally useful if
2813with priority higher than or equal to the event loop and one coroutine 3066with priority higher than or equal to the event loop and one coroutine
2814of lower priority, but only once, using idle watchers to keep the event 3067of lower priority, but only once, using idle watchers to keep the event
2815loop from blocking if lower-priority coroutines are active, thus mapping 3068loop from blocking if lower-priority coroutines are active, thus mapping
2816low-priority coroutines to idle/background tasks). 3069low-priority coroutines to idle/background tasks).
2817 3070
2818It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 3071When used for this purpose, it is recommended to give C<ev_check> watchers
2819priority, to ensure that they are being run before any other watchers 3072highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2820after the poll (this doesn't matter for C<ev_prepare> watchers). 3073any other watchers after the poll (this doesn't matter for C<ev_prepare>
3074watchers).
2821 3075
2822Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not 3076Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2823activate ("feed") events into libev. While libev fully supports this, they 3077activate ("feed") events into libev. While libev fully supports this, they
2824might get executed before other C<ev_check> watchers did their job. As 3078might get executed before other C<ev_check> watchers did their job. As
2825C<ev_check> watchers are often used to embed other (non-libev) event 3079C<ev_check> watchers are often used to embed other (non-libev) event
2826loops those other event loops might be in an unusable state until their 3080loops those other event loops might be in an unusable state until their
2827C<ev_check> watcher ran (always remind yourself to coexist peacefully with 3081C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2828others). 3082others).
3083
3084=head3 Abusing an C<ev_check> watcher for its side-effect
3085
3086C<ev_check> (and less often also C<ev_prepare>) watchers can also be
3087useful because they are called once per event loop iteration. For
3088example, if you want to handle a large number of connections fairly, you
3089normally only do a bit of work for each active connection, and if there
3090is more work to do, you wait for the next event loop iteration, so other
3091connections have a chance of making progress.
3092
3093Using an C<ev_check> watcher is almost enough: it will be called on the
3094next event loop iteration. However, that isn't as soon as possible -
3095without external events, your C<ev_check> watcher will not be invoked.
3096
3097This is where C<ev_idle> watchers come in handy - all you need is a
3098single global idle watcher that is active as long as you have one active
3099C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
3100will not sleep, and the C<ev_check> watcher makes sure a callback gets
3101invoked. Neither watcher alone can do that.
2829 3102
2830=head3 Watcher-Specific Functions and Data Members 3103=head3 Watcher-Specific Functions and Data Members
2831 3104
2832=over 4 3105=over 4
2833 3106
3034 3307
3035=over 4 3308=over 4
3036 3309
3037=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3310=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3038 3311
3039=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3312=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3040 3313
3041Configures the watcher to embed the given loop, which must be 3314Configures the watcher to embed the given loop, which must be
3042embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3315embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3043invoked automatically, otherwise it is the responsibility of the callback 3316invoked automatically, otherwise it is the responsibility of the callback
3044to invoke it (it will continue to be called until the sweep has been done, 3317to invoke it (it will continue to be called until the sweep has been done,
3065used). 3338used).
3066 3339
3067 struct ev_loop *loop_hi = ev_default_init (0); 3340 struct ev_loop *loop_hi = ev_default_init (0);
3068 struct ev_loop *loop_lo = 0; 3341 struct ev_loop *loop_lo = 0;
3069 ev_embed embed; 3342 ev_embed embed;
3070 3343
3071 // see if there is a chance of getting one that works 3344 // see if there is a chance of getting one that works
3072 // (remember that a flags value of 0 means autodetection) 3345 // (remember that a flags value of 0 means autodetection)
3073 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3346 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3074 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3347 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3075 : 0; 3348 : 0;
3089C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3362C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3090 3363
3091 struct ev_loop *loop = ev_default_init (0); 3364 struct ev_loop *loop = ev_default_init (0);
3092 struct ev_loop *loop_socket = 0; 3365 struct ev_loop *loop_socket = 0;
3093 ev_embed embed; 3366 ev_embed embed;
3094 3367
3095 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3368 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3096 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3369 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3097 { 3370 {
3098 ev_embed_init (&embed, 0, loop_socket); 3371 ev_embed_init (&embed, 0, loop_socket);
3099 ev_embed_start (loop, &embed); 3372 ev_embed_start (loop, &embed);
3107 3380
3108=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3381=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3109 3382
3110Fork watchers are called when a C<fork ()> was detected (usually because 3383Fork watchers are called when a C<fork ()> was detected (usually because
3111whoever is a good citizen cared to tell libev about it by calling 3384whoever is a good citizen cared to tell libev about it by calling
3112C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the 3385C<ev_loop_fork>). The invocation is done before the event loop blocks next
3113event loop blocks next and before C<ev_check> watchers are being called, 3386and before C<ev_check> watchers are being called, and only in the child
3114and only in the child after the fork. If whoever good citizen calling 3387after the fork. If whoever good citizen calling C<ev_default_fork> cheats
3115C<ev_default_fork> cheats and calls it in the wrong process, the fork 3388and calls it in the wrong process, the fork handlers will be invoked, too,
3116handlers will be invoked, too, of course. 3389of course.
3117 3390
3118=head3 The special problem of life after fork - how is it possible? 3391=head3 The special problem of life after fork - how is it possible?
3119 3392
3120Most uses of C<fork()> consist of forking, then some simple calls to set 3393Most uses of C<fork ()> consist of forking, then some simple calls to set
3121up/change the process environment, followed by a call to C<exec()>. This 3394up/change the process environment, followed by a call to C<exec()>. This
3122sequence should be handled by libev without any problems. 3395sequence should be handled by libev without any problems.
3123 3396
3124This changes when the application actually wants to do event handling 3397This changes when the application actually wants to do event handling
3125in the child, or both parent in child, in effect "continuing" after the 3398in the child, or both parent in child, in effect "continuing" after the
3214it by calling C<ev_async_send>, which is thread- and signal safe. 3487it by calling C<ev_async_send>, which is thread- and signal safe.
3215 3488
3216This functionality is very similar to C<ev_signal> watchers, as signals, 3489This functionality is very similar to C<ev_signal> watchers, as signals,
3217too, are asynchronous in nature, and signals, too, will be compressed 3490too, are asynchronous in nature, and signals, too, will be compressed
3218(i.e. the number of callback invocations may be less than the number of 3491(i.e. the number of callback invocations may be less than the number of
3219C<ev_async_sent> calls). In fact, you could use signal watchers as a kind 3492C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3220of "global async watchers" by using a watcher on an otherwise unused 3493of "global async watchers" by using a watcher on an otherwise unused
3221signal, and C<ev_feed_signal> to signal this watcher from another thread, 3494signal, and C<ev_feed_signal> to signal this watcher from another thread,
3222even without knowing which loop owns the signal. 3495even without knowing which loop owns the signal.
3223
3224Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3225just the default loop.
3226 3496
3227=head3 Queueing 3497=head3 Queueing
3228 3498
3229C<ev_async> does not support queueing of data in any way. The reason 3499C<ev_async> does not support queueing of data in any way. The reason
3230is that the author does not know of a simple (or any) algorithm for a 3500is that the author does not know of a simple (or any) algorithm for a
3330Unlike C<ev_feed_event>, this call is safe to do from other threads, 3600Unlike C<ev_feed_event>, this call is safe to do from other threads,
3331signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the 3601signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3332embedding section below on what exactly this means). 3602embedding section below on what exactly this means).
3333 3603
3334Note that, as with other watchers in libev, multiple events might get 3604Note that, as with other watchers in libev, multiple events might get
3335compressed into a single callback invocation (another way to look at this 3605compressed into a single callback invocation (another way to look at
3336is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, 3606this is that C<ev_async> watchers are level-triggered: they are set on
3337reset when the event loop detects that). 3607C<ev_async_send>, reset when the event loop detects that).
3338 3608
3339This call incurs the overhead of a system call only once per event loop 3609This call incurs the overhead of at most one extra system call per event
3340iteration, so while the overhead might be noticeable, it doesn't apply to 3610loop iteration, if the event loop is blocked, and no syscall at all if
3341repeated calls to C<ev_async_send> for the same event loop. 3611the event loop (or your program) is processing events. That means that
3612repeated calls are basically free (there is no need to avoid calls for
3613performance reasons) and that the overhead becomes smaller (typically
3614zero) under load.
3342 3615
3343=item bool = ev_async_pending (ev_async *) 3616=item bool = ev_async_pending (ev_async *)
3344 3617
3345Returns a non-zero value when C<ev_async_send> has been called on the 3618Returns a non-zero value when C<ev_async_send> has been called on the
3346watcher but the event has not yet been processed (or even noted) by the 3619watcher but the event has not yet been processed (or even noted) by the
3363 3636
3364There are some other functions of possible interest. Described. Here. Now. 3637There are some other functions of possible interest. Described. Here. Now.
3365 3638
3366=over 4 3639=over 4
3367 3640
3368=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 3641=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3369 3642
3370This function combines a simple timer and an I/O watcher, calls your 3643This function combines a simple timer and an I/O watcher, calls your
3371callback on whichever event happens first and automatically stops both 3644callback on whichever event happens first and automatically stops both
3372watchers. This is useful if you want to wait for a single event on an fd 3645watchers. This is useful if you want to wait for a single event on an fd
3373or timeout without having to allocate/configure/start/stop/free one or 3646or timeout without having to allocate/configure/start/stop/free one or
3401 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3674 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3402 3675
3403=item ev_feed_fd_event (loop, int fd, int revents) 3676=item ev_feed_fd_event (loop, int fd, int revents)
3404 3677
3405Feed an event on the given fd, as if a file descriptor backend detected 3678Feed an event on the given fd, as if a file descriptor backend detected
3406the given events it. 3679the given events.
3407 3680
3408=item ev_feed_signal_event (loop, int signum) 3681=item ev_feed_signal_event (loop, int signum)
3409 3682
3410Feed an event as if the given signal occurred. See also C<ev_feed_signal>, 3683Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3411which is async-safe. 3684which is async-safe.
3485 { 3758 {
3486 struct my_biggy big = (struct my_biggy *) 3759 struct my_biggy big = (struct my_biggy *)
3487 (((char *)w) - offsetof (struct my_biggy, t2)); 3760 (((char *)w) - offsetof (struct my_biggy, t2));
3488 } 3761 }
3489 3762
3763=head2 AVOIDING FINISHING BEFORE RETURNING
3764
3765Often you have structures like this in event-based programs:
3766
3767 callback ()
3768 {
3769 free (request);
3770 }
3771
3772 request = start_new_request (..., callback);
3773
3774The intent is to start some "lengthy" operation. The C<request> could be
3775used to cancel the operation, or do other things with it.
3776
3777It's not uncommon to have code paths in C<start_new_request> that
3778immediately invoke the callback, for example, to report errors. Or you add
3779some caching layer that finds that it can skip the lengthy aspects of the
3780operation and simply invoke the callback with the result.
3781
3782The problem here is that this will happen I<before> C<start_new_request>
3783has returned, so C<request> is not set.
3784
3785Even if you pass the request by some safer means to the callback, you
3786might want to do something to the request after starting it, such as
3787canceling it, which probably isn't working so well when the callback has
3788already been invoked.
3789
3790A common way around all these issues is to make sure that
3791C<start_new_request> I<always> returns before the callback is invoked. If
3792C<start_new_request> immediately knows the result, it can artificially
3793delay invoking the callback by using a C<prepare> or C<idle> watcher for
3794example, or more sneakily, by reusing an existing (stopped) watcher and
3795pushing it into the pending queue:
3796
3797 ev_set_cb (watcher, callback);
3798 ev_feed_event (EV_A_ watcher, 0);
3799
3800This way, C<start_new_request> can safely return before the callback is
3801invoked, while not delaying callback invocation too much.
3802
3490=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS 3803=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
3491 3804
3492Often (especially in GUI toolkits) there are places where you have 3805Often (especially in GUI toolkits) there are places where you have
3493I<modal> interaction, which is most easily implemented by recursively 3806I<modal> interaction, which is most easily implemented by recursively
3494invoking C<ev_run>. 3807invoking C<ev_run>.
3495 3808
3496This brings the problem of exiting - a callback might want to finish the 3809This brings the problem of exiting - a callback might want to finish the
3497main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but 3810main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3498a modal "Are you sure?" dialog is still waiting), or just the nested one 3811a modal "Are you sure?" dialog is still waiting), or just the nested one
3499and not the main one (e.g. user clocked "Ok" in a modal dialog), or some 3812and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3500other combination: In these cases, C<ev_break> will not work alone. 3813other combination: In these cases, a simple C<ev_break> will not work.
3501 3814
3502The solution is to maintain "break this loop" variable for each C<ev_run> 3815The solution is to maintain "break this loop" variable for each C<ev_run>
3503invocation, and use a loop around C<ev_run> until the condition is 3816invocation, and use a loop around C<ev_run> until the condition is
3504triggered, using C<EVRUN_ONCE>: 3817triggered, using C<EVRUN_ONCE>:
3505 3818
3507 int exit_main_loop = 0; 3820 int exit_main_loop = 0;
3508 3821
3509 while (!exit_main_loop) 3822 while (!exit_main_loop)
3510 ev_run (EV_DEFAULT_ EVRUN_ONCE); 3823 ev_run (EV_DEFAULT_ EVRUN_ONCE);
3511 3824
3512 // in a model watcher 3825 // in a modal watcher
3513 int exit_nested_loop = 0; 3826 int exit_nested_loop = 0;
3514 3827
3515 while (!exit_nested_loop) 3828 while (!exit_nested_loop)
3516 ev_run (EV_A_ EVRUN_ONCE); 3829 ev_run (EV_A_ EVRUN_ONCE);
3517 3830
3691called): 4004called):
3692 4005
3693 void 4006 void
3694 wait_for_event (ev_watcher *w) 4007 wait_for_event (ev_watcher *w)
3695 { 4008 {
3696 ev_cb_set (w) = current_coro; 4009 ev_set_cb (w, current_coro);
3697 switch_to (libev_coro); 4010 switch_to (libev_coro);
3698 } 4011 }
3699 4012
3700That basically suspends the coroutine inside C<wait_for_event> and 4013That basically suspends the coroutine inside C<wait_for_event> and
3701continues the libev coroutine, which, when appropriate, switches back to 4014continues the libev coroutine, which, when appropriate, switches back to
3702this or any other coroutine. I am sure if you sue this your own :) 4015this or any other coroutine.
3703 4016
3704You can do similar tricks if you have, say, threads with an event queue - 4017You can do similar tricks if you have, say, threads with an event queue -
3705instead of storing a coroutine, you store the queue object and instead of 4018instead of storing a coroutine, you store the queue object and instead of
3706switching to a coroutine, you push the watcher onto the queue and notify 4019switching to a coroutine, you push the watcher onto the queue and notify
3707any waiters. 4020any waiters.
3708 4021
3709To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 4022To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3710files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 4023files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3711 4024
3712 // my_ev.h 4025 // my_ev.h
3713 #define EV_CB_DECLARE(type) struct my_coro *cb; 4026 #define EV_CB_DECLARE(type) struct my_coro *cb;
3714 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 4027 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3715 #include "../libev/ev.h" 4028 #include "../libev/ev.h"
3716 4029
3717 // my_ev.c 4030 // my_ev.c
3718 #define EV_H "my_ev.h" 4031 #define EV_H "my_ev.h"
3719 #include "../libev/ev.c" 4032 #include "../libev/ev.c"
3758 4071
3759=back 4072=back
3760 4073
3761=head1 C++ SUPPORT 4074=head1 C++ SUPPORT
3762 4075
4076=head2 C API
4077
4078The normal C API should work fine when used from C++: both ev.h and the
4079libev sources can be compiled as C++. Therefore, code that uses the C API
4080will work fine.
4081
4082Proper exception specifications might have to be added to callbacks passed
4083to libev: exceptions may be thrown only from watcher callbacks, all other
4084callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4085callbacks) must not throw exceptions, and might need a C<noexcept>
4086specification. If you have code that needs to be compiled as both C and
4087C++ you can use the C<EV_NOEXCEPT> macro for this:
4088
4089 static void
4090 fatal_error (const char *msg) EV_NOEXCEPT
4091 {
4092 perror (msg);
4093 abort ();
4094 }
4095
4096 ...
4097 ev_set_syserr_cb (fatal_error);
4098
4099The only API functions that can currently throw exceptions are C<ev_run>,
4100C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
4101because it runs cleanup watchers).
4102
4103Throwing exceptions in watcher callbacks is only supported if libev itself
4104is compiled with a C++ compiler or your C and C++ environments allow
4105throwing exceptions through C libraries (most do).
4106
4107=head2 C++ API
4108
3763Libev comes with some simplistic wrapper classes for C++ that mainly allow 4109Libev comes with some simplistic wrapper classes for C++ that mainly allow
3764you to use some convenience methods to start/stop watchers and also change 4110you to use some convenience methods to start/stop watchers and also change
3765the callback model to a model using method callbacks on objects. 4111the callback model to a model using method callbacks on objects.
3766 4112
3767To use it, 4113To use it,
3768 4114
3769 #include <ev++.h> 4115 #include <ev++.h>
3770 4116
3771This automatically includes F<ev.h> and puts all of its definitions (many 4117This automatically includes F<ev.h> and puts all of its definitions (many
3772of them macros) into the global namespace. All C++ specific things are 4118of them macros) into the global namespace. All C++ specific things are
3773put into the C<ev> namespace. It should support all the same embedding 4119put into the C<ev> namespace. It should support all the same embedding
3782with C<operator ()> can be used as callbacks. Other types should be easy 4128with C<operator ()> can be used as callbacks. Other types should be easy
3783to add as long as they only need one additional pointer for context. If 4129to add as long as they only need one additional pointer for context. If
3784you need support for other types of functors please contact the author 4130you need support for other types of functors please contact the author
3785(preferably after implementing it). 4131(preferably after implementing it).
3786 4132
4133For all this to work, your C++ compiler either has to use the same calling
4134conventions as your C compiler (for static member functions), or you have
4135to embed libev and compile libev itself as C++.
4136
3787Here is a list of things available in the C<ev> namespace: 4137Here is a list of things available in the C<ev> namespace:
3788 4138
3789=over 4 4139=over 4
3790 4140
3791=item C<ev::READ>, C<ev::WRITE> etc. 4141=item C<ev::READ>, C<ev::WRITE> etc.
3800=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. 4150=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3801 4151
3802For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of 4152For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3803the same name in the C<ev> namespace, with the exception of C<ev_signal> 4153the same name in the C<ev> namespace, with the exception of C<ev_signal>
3804which is called C<ev::sig> to avoid clashes with the C<signal> macro 4154which is called C<ev::sig> to avoid clashes with the C<signal> macro
3805defines by many implementations. 4155defined by many implementations.
3806 4156
3807All of those classes have these methods: 4157All of those classes have these methods:
3808 4158
3809=over 4 4159=over 4
3810 4160
3872 void operator() (ev::io &w, int revents) 4222 void operator() (ev::io &w, int revents)
3873 { 4223 {
3874 ... 4224 ...
3875 } 4225 }
3876 } 4226 }
3877 4227
3878 myfunctor f; 4228 myfunctor f;
3879 4229
3880 ev::io w; 4230 ev::io w;
3881 w.set (&f); 4231 w.set (&f);
3882 4232
3900Associates a different C<struct ev_loop> with this watcher. You can only 4250Associates a different C<struct ev_loop> with this watcher. You can only
3901do this when the watcher is inactive (and not pending either). 4251do this when the watcher is inactive (and not pending either).
3902 4252
3903=item w->set ([arguments]) 4253=item w->set ([arguments])
3904 4254
3905Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4255Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
3906method or a suitable start method must be called at least once. Unlike the 4256with the same arguments. Either this method or a suitable start method
3907C counterpart, an active watcher gets automatically stopped and restarted 4257must be called at least once. Unlike the C counterpart, an active watcher
3908when reconfiguring it with this method. 4258gets automatically stopped and restarted when reconfiguring it with this
4259method.
4260
4261For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4262clashing with the C<set (loop)> method.
3909 4263
3910=item w->start () 4264=item w->start ()
3911 4265
3912Starts the watcher. Note that there is no C<loop> argument, as the 4266Starts the watcher. Note that there is no C<loop> argument, as the
3913constructor already stores the event loop. 4267constructor already stores the event loop.
3943watchers in the constructor. 4297watchers in the constructor.
3944 4298
3945 class myclass 4299 class myclass
3946 { 4300 {
3947 ev::io io ; void io_cb (ev::io &w, int revents); 4301 ev::io io ; void io_cb (ev::io &w, int revents);
3948 ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4302 ev::io io2 ; void io2_cb (ev::io &w, int revents);
3949 ev::idle idle; void idle_cb (ev::idle &w, int revents); 4303 ev::idle idle; void idle_cb (ev::idle &w, int revents);
3950 4304
3951 myclass (int fd) 4305 myclass (int fd)
3952 { 4306 {
3953 io .set <myclass, &myclass::io_cb > (this); 4307 io .set <myclass, &myclass::io_cb > (this);
4004L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. 4358L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
4005 4359
4006=item D 4360=item D
4007 4361
4008Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 4362Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
4009be found at L<http://proj.llucax.com.ar/wiki/evd>. 4363be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
4010 4364
4011=item Ocaml 4365=item Ocaml
4012 4366
4013Erkki Seppala has written Ocaml bindings for libev, to be found at 4367Erkki Seppala has written Ocaml bindings for libev, to be found at
4014L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 4368L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
4017 4371
4018Brian Maher has written a partial interface to libev for lua (at the 4372Brian Maher has written a partial interface to libev for lua (at the
4019time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4373time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4020L<http://github.com/brimworks/lua-ev>. 4374L<http://github.com/brimworks/lua-ev>.
4021 4375
4376=item Javascript
4377
4378Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4379
4380=item Others
4381
4382There are others, and I stopped counting.
4383
4022=back 4384=back
4023 4385
4024 4386
4025=head1 MACRO MAGIC 4387=head1 MACRO MAGIC
4026 4388
4062suitable for use with C<EV_A>. 4424suitable for use with C<EV_A>.
4063 4425
4064=item C<EV_DEFAULT>, C<EV_DEFAULT_> 4426=item C<EV_DEFAULT>, C<EV_DEFAULT_>
4065 4427
4066Similar to the other two macros, this gives you the value of the default 4428Similar to the other two macros, this gives you the value of the default
4067loop, if multiple loops are supported ("ev loop default"). 4429loop, if multiple loops are supported ("ev loop default"). The default loop
4430will be initialised if it isn't already initialised.
4431
4432For non-multiplicity builds, these macros do nothing, so you always have
4433to initialise the loop somewhere.
4068 4434
4069=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> 4435=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
4070 4436
4071Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the 4437Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
4072default loop has been initialised (C<UC> == unchecked). Their behaviour 4438default loop has been initialised (C<UC> == unchecked). Their behaviour
4139 ev_vars.h 4505 ev_vars.h
4140 ev_wrap.h 4506 ev_wrap.h
4141 4507
4142 ev_win32.c required on win32 platforms only 4508 ev_win32.c required on win32 platforms only
4143 4509
4144 ev_select.c only when select backend is enabled (which is enabled by default) 4510 ev_select.c only when select backend is enabled
4145 ev_poll.c only when poll backend is enabled (disabled by default) 4511 ev_poll.c only when poll backend is enabled
4146 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4512 ev_epoll.c only when the epoll backend is enabled
4513 ev_linuxaio.c only when the linux aio backend is enabled
4514 ev_iouring.c only when the linux io_uring backend is enabled
4147 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4515 ev_kqueue.c only when the kqueue backend is enabled
4148 ev_port.c only when the solaris port backend is enabled (disabled by default) 4516 ev_port.c only when the solaris port backend is enabled
4149 4517
4150F<ev.c> includes the backend files directly when enabled, so you only need 4518F<ev.c> includes the backend files directly when enabled, so you only need
4151to compile this single file. 4519to compile this single file.
4152 4520
4153=head3 LIBEVENT COMPATIBILITY API 4521=head3 LIBEVENT COMPATIBILITY API
4272available and will probe for kernel support at runtime. This will improve 4640available and will probe for kernel support at runtime. This will improve
4273C<ev_signal> and C<ev_async> performance and reduce resource consumption. 4641C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4274If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc 4642If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
42752.7 or newer, otherwise disabled. 46432.7 or newer, otherwise disabled.
4276 4644
4645=item EV_USE_SIGNALFD
4646
4647If defined to be C<1>, then libev will assume that C<signalfd ()> is
4648available and will probe for kernel support at runtime. This enables
4649the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If
4650undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46512.7 or newer, otherwise disabled.
4652
4653=item EV_USE_TIMERFD
4654
4655If defined to be C<1>, then libev will assume that C<timerfd ()> is
4656available and will probe for kernel support at runtime. This allows
4657libev to detect time jumps accurately. If undefined, it will be enabled
4658if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
4659C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled.
4660
4661=item EV_USE_EVENTFD
4662
4663If defined to be C<1>, then libev will assume that C<eventfd ()> is
4664available and will probe for kernel support at runtime. This will improve
4665C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4666If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46672.7 or newer, otherwise disabled.
4668
4277=item EV_USE_SELECT 4669=item EV_USE_SELECT
4278 4670
4279If undefined or defined to be C<1>, libev will compile in support for the 4671If undefined or defined to be C<1>, libev will compile in support for the
4280C<select>(2) backend. No attempt at auto-detection will be done: if no 4672C<select>(2) backend. No attempt at auto-detection will be done: if no
4281other method takes over, select will be it. Otherwise the select backend 4673other method takes over, select will be it. Otherwise the select backend
4321If programs implement their own fd to handle mapping on win32, then this 4713If programs implement their own fd to handle mapping on win32, then this
4322macro can be used to override the C<close> function, useful to unregister 4714macro can be used to override the C<close> function, useful to unregister
4323file descriptors again. Note that the replacement function has to close 4715file descriptors again. Note that the replacement function has to close
4324the underlying OS handle. 4716the underlying OS handle.
4325 4717
4718=item EV_USE_WSASOCKET
4719
4720If defined to be C<1>, libev will use C<WSASocket> to create its internal
4721communication socket, which works better in some environments. Otherwise,
4722the normal C<socket> function will be used, which works better in other
4723environments.
4724
4326=item EV_USE_POLL 4725=item EV_USE_POLL
4327 4726
4328If defined to be C<1>, libev will compile in support for the C<poll>(2) 4727If defined to be C<1>, libev will compile in support for the C<poll>(2)
4329backend. Otherwise it will be enabled on non-win32 platforms. It 4728backend. Otherwise it will be enabled on non-win32 platforms. It
4330takes precedence over select. 4729takes precedence over select.
4334If defined to be C<1>, libev will compile in support for the Linux 4733If defined to be C<1>, libev will compile in support for the Linux
4335C<epoll>(7) backend. Its availability will be detected at runtime, 4734C<epoll>(7) backend. Its availability will be detected at runtime,
4336otherwise another method will be used as fallback. This is the preferred 4735otherwise another method will be used as fallback. This is the preferred
4337backend for GNU/Linux systems. If undefined, it will be enabled if the 4736backend for GNU/Linux systems. If undefined, it will be enabled if the
4338headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4737headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4738
4739=item EV_USE_LINUXAIO
4740
4741If defined to be C<1>, libev will compile in support for the Linux aio
4742backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be
4743enabled on linux, otherwise disabled.
4744
4745=item EV_USE_IOURING
4746
4747If defined to be C<1>, libev will compile in support for the Linux
4748io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's
4749current limitations it has to be requested explicitly. If undefined, it
4750will be enabled on linux, otherwise disabled.
4339 4751
4340=item EV_USE_KQUEUE 4752=item EV_USE_KQUEUE
4341 4753
4342If defined to be C<1>, libev will compile in support for the BSD style 4754If defined to be C<1>, libev will compile in support for the BSD style
4343C<kqueue>(2) backend. Its actual availability will be detected at runtime, 4755C<kqueue>(2) backend. Its actual availability will be detected at runtime,
4365If defined to be C<1>, libev will compile in support for the Linux inotify 4777If defined to be C<1>, libev will compile in support for the Linux inotify
4366interface to speed up C<ev_stat> watchers. Its actual availability will 4778interface to speed up C<ev_stat> watchers. Its actual availability will
4367be detected at runtime. If undefined, it will be enabled if the headers 4779be detected at runtime. If undefined, it will be enabled if the headers
4368indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4780indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4369 4781
4782=item EV_NO_SMP
4783
4784If defined to be C<1>, libev will assume that memory is always coherent
4785between threads, that is, threads can be used, but threads never run on
4786different cpus (or different cpu cores). This reduces dependencies
4787and makes libev faster.
4788
4789=item EV_NO_THREADS
4790
4791If defined to be C<1>, libev will assume that it will never be called from
4792different threads (that includes signal handlers), which is a stronger
4793assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4794libev faster.
4795
4370=item EV_ATOMIC_T 4796=item EV_ATOMIC_T
4371 4797
4372Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4798Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4373access is atomic with respect to other threads or signal contexts. No such 4799access is atomic with respect to other threads or signal contexts. No
4374type is easily found in the C language, so you can provide your own type 4800such type is easily found in the C language, so you can provide your own
4375that you know is safe for your purposes. It is used both for signal handler "locking" 4801type that you know is safe for your purposes. It is used both for signal
4376as well as for signal and thread safety in C<ev_async> watchers. 4802handler "locking" as well as for signal and thread safety in C<ev_async>
4803watchers.
4377 4804
4378In the absence of this define, libev will use C<sig_atomic_t volatile> 4805In the absence of this define, libev will use C<sig_atomic_t volatile>
4379(from F<signal.h>), which is usually good enough on most platforms. 4806(from F<signal.h>), which is usually good enough on most platforms.
4380 4807
4381=item EV_H (h) 4808=item EV_H (h)
4408will have the C<struct ev_loop *> as first argument, and you can create 4835will have the C<struct ev_loop *> as first argument, and you can create
4409additional independent event loops. Otherwise there will be no support 4836additional independent event loops. Otherwise there will be no support
4410for multiple event loops and there is no first event loop pointer 4837for multiple event loops and there is no first event loop pointer
4411argument. Instead, all functions act on the single default loop. 4838argument. Instead, all functions act on the single default loop.
4412 4839
4840Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
4841default loop when multiplicity is switched off - you always have to
4842initialise the loop manually in this case.
4843
4413=item EV_MINPRI 4844=item EV_MINPRI
4414 4845
4415=item EV_MAXPRI 4846=item EV_MAXPRI
4416 4847
4417The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to 4848The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
4453 #define EV_USE_POLL 1 4884 #define EV_USE_POLL 1
4454 #define EV_CHILD_ENABLE 1 4885 #define EV_CHILD_ENABLE 1
4455 #define EV_ASYNC_ENABLE 1 4886 #define EV_ASYNC_ENABLE 1
4456 4887
4457The actual value is a bitset, it can be a combination of the following 4888The actual value is a bitset, it can be a combination of the following
4458values: 4889values (by default, all of these are enabled):
4459 4890
4460=over 4 4891=over 4
4461 4892
4462=item C<1> - faster/larger code 4893=item C<1> - faster/larger code
4463 4894
4467code size by roughly 30% on amd64). 4898code size by roughly 30% on amd64).
4468 4899
4469When optimising for size, use of compiler flags such as C<-Os> with 4900When optimising for size, use of compiler flags such as C<-Os> with
4470gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of 4901gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4471assertions. 4902assertions.
4903
4904The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4905(e.g. gcc with C<-Os>).
4472 4906
4473=item C<2> - faster/larger data structures 4907=item C<2> - faster/larger data structures
4474 4908
4475Replaces the small 2-heap for timer management by a faster 4-heap, larger 4909Replaces the small 2-heap for timer management by a faster 4-heap, larger
4476hash table sizes and so on. This will usually further increase code size 4910hash table sizes and so on. This will usually further increase code size
4477and can additionally have an effect on the size of data structures at 4911and can additionally have an effect on the size of data structures at
4478runtime. 4912runtime.
4479 4913
4914The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4915(e.g. gcc with C<-Os>).
4916
4480=item C<4> - full API configuration 4917=item C<4> - full API configuration
4481 4918
4482This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and 4919This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4483enables multiplicity (C<EV_MULTIPLICITY>=1). 4920enables multiplicity (C<EV_MULTIPLICITY>=1).
4484 4921
4514 4951
4515With an intelligent-enough linker (gcc+binutils are intelligent enough 4952With an intelligent-enough linker (gcc+binutils are intelligent enough
4516when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by 4953when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
4517your program might be left out as well - a binary starting a timer and an 4954your program might be left out as well - a binary starting a timer and an
4518I/O watcher then might come out at only 5Kb. 4955I/O watcher then might come out at only 5Kb.
4956
4957=item EV_API_STATIC
4958
4959If this symbol is defined (by default it is not), then all identifiers
4960will have static linkage. This means that libev will not export any
4961identifiers, and you cannot link against libev anymore. This can be useful
4962when you embed libev, only want to use libev functions in a single file,
4963and do not want its identifiers to be visible.
4964
4965To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
4966wants to use libev.
4967
4968This option only works when libev is compiled with a C compiler, as C++
4969doesn't support the required declaration syntax.
4519 4970
4520=item EV_AVOID_STDIO 4971=item EV_AVOID_STDIO
4521 4972
4522If this is set to C<1> at compiletime, then libev will avoid using stdio 4973If this is set to C<1> at compiletime, then libev will avoid using stdio
4523functions (printf, scanf, perror etc.). This will increase the code size 4974functions (printf, scanf, perror etc.). This will increase the code size
4581in. If set to C<1>, then verification code will be compiled in, but not 5032in. If set to C<1>, then verification code will be compiled in, but not
4582called. If set to C<2>, then the internal verification code will be 5033called. If set to C<2>, then the internal verification code will be
4583called once per loop, which can slow down libev. If set to C<3>, then the 5034called once per loop, which can slow down libev. If set to C<3>, then the
4584verification code will be called very frequently, which will slow down 5035verification code will be called very frequently, which will slow down
4585libev considerably. 5036libev considerably.
5037
5038Verification errors are reported via C's C<assert> mechanism, so if you
5039disable that (e.g. by defining C<NDEBUG>) then no errors will be reported.
4586 5040
4587The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it 5041The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4588will be C<0>. 5042will be C<0>.
4589 5043
4590=item EV_COMMON 5044=item EV_COMMON
4728default loop and triggering an C<ev_async> watcher from the default loop 5182default loop and triggering an C<ev_async> watcher from the default loop
4729watcher callback into the event loop interested in the signal. 5183watcher callback into the event loop interested in the signal.
4730 5184
4731=back 5185=back
4732 5186
4733See also L<THREAD LOCKING EXAMPLE>. 5187See also L</THREAD LOCKING EXAMPLE>.
4734 5188
4735=head3 COROUTINES 5189=head3 COROUTINES
4736 5190
4737Libev is very accommodating to coroutines ("cooperative threads"): 5191Libev is very accommodating to coroutines ("cooperative threads"):
4738libev fully supports nesting calls to its functions from different 5192libev fully supports nesting calls to its functions from different
4903requires, and its I/O model is fundamentally incompatible with the POSIX 5357requires, and its I/O model is fundamentally incompatible with the POSIX
4904model. Libev still offers limited functionality on this platform in 5358model. Libev still offers limited functionality on this platform in
4905the form of the C<EVBACKEND_SELECT> backend, and only supports socket 5359the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4906descriptors. This only applies when using Win32 natively, not when using 5360descriptors. This only applies when using Win32 natively, not when using
4907e.g. cygwin. Actually, it only applies to the microsofts own compilers, 5361e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4908as every compielr comes with a slightly differently broken/incompatible 5362as every compiler comes with a slightly differently broken/incompatible
4909environment. 5363environment.
4910 5364
4911Lifting these limitations would basically require the full 5365Lifting these limitations would basically require the full
4912re-implementation of the I/O system. If you are into this kind of thing, 5366re-implementation of the I/O system. If you are into this kind of thing,
4913then note that glib does exactly that for you in a very portable way (note 5367then note that glib does exactly that for you in a very portable way (note
5007structure (guaranteed by POSIX but not by ISO C for example), but it also 5461structure (guaranteed by POSIX but not by ISO C for example), but it also
5008assumes that the same (machine) code can be used to call any watcher 5462assumes that the same (machine) code can be used to call any watcher
5009callback: The watcher callbacks have different type signatures, but libev 5463callback: The watcher callbacks have different type signatures, but libev
5010calls them using an C<ev_watcher *> internally. 5464calls them using an C<ev_watcher *> internally.
5011 5465
5466=item null pointers and integer zero are represented by 0 bytes
5467
5468Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
5469relies on this setting pointers and integers to null.
5470
5012=item pointer accesses must be thread-atomic 5471=item pointer accesses must be thread-atomic
5013 5472
5014Accessing a pointer value must be atomic, it must both be readable and 5473Accessing a pointer value must be atomic, it must both be readable and
5015writable in one piece - this is the case on all current architectures. 5474writable in one piece - this is the case on all current architectures.
5016 5475
5029thread" or will block signals process-wide, both behaviours would 5488thread" or will block signals process-wide, both behaviours would
5030be compatible with libev. Interaction between C<sigprocmask> and 5489be compatible with libev. Interaction between C<sigprocmask> and
5031C<pthread_sigmask> could complicate things, however. 5490C<pthread_sigmask> could complicate things, however.
5032 5491
5033The most portable way to handle signals is to block signals in all threads 5492The most portable way to handle signals is to block signals in all threads
5034except the initial one, and run the default loop in the initial thread as 5493except the initial one, and run the signal handling loop in the initial
5035well. 5494thread as well.
5036 5495
5037=item C<long> must be large enough for common memory allocation sizes 5496=item C<long> must be large enough for common memory allocation sizes
5038 5497
5039To improve portability and simplify its API, libev uses C<long> internally 5498To improve portability and simplify its API, libev uses C<long> internally
5040instead of C<size_t> when allocating its data structures. On non-POSIX 5499instead of C<size_t> when allocating its data structures. On non-POSIX
5046 5505
5047The type C<double> is used to represent timestamps. It is required to 5506The type C<double> is used to represent timestamps. It is required to
5048have at least 51 bits of mantissa (and 9 bits of exponent), which is 5507have at least 51 bits of mantissa (and 9 bits of exponent), which is
5049good enough for at least into the year 4000 with millisecond accuracy 5508good enough for at least into the year 4000 with millisecond accuracy
5050(the design goal for libev). This requirement is overfulfilled by 5509(the design goal for libev). This requirement is overfulfilled by
5051implementations using IEEE 754, which is basically all existing ones. With 5510implementations using IEEE 754, which is basically all existing ones.
5511
5052IEEE 754 doubles, you get microsecond accuracy until at least 2200. 5512With IEEE 754 doubles, you get microsecond accuracy until at least the
5513year 2255 (and millisecond accuracy till the year 287396 - by then, libev
5514is either obsolete or somebody patched it to use C<long double> or
5515something like that, just kidding).
5053 5516
5054=back 5517=back
5055 5518
5056If you know of other additional requirements drop me a note. 5519If you know of other additional requirements drop me a note.
5057 5520
5119=item Processing ev_async_send: O(number_of_async_watchers) 5582=item Processing ev_async_send: O(number_of_async_watchers)
5120 5583
5121=item Processing signals: O(max_signal_number) 5584=item Processing signals: O(max_signal_number)
5122 5585
5123Sending involves a system call I<iff> there were no other C<ev_async_send> 5586Sending involves a system call I<iff> there were no other C<ev_async_send>
5124calls in the current loop iteration. Checking for async and signal events 5587calls in the current loop iteration and the loop is currently
5588blocked. Checking for async and signal events involves iterating over all
5125involves iterating over all running async watchers or all signal numbers. 5589running async watchers or all signal numbers.
5126 5590
5127=back 5591=back
5128 5592
5129 5593
5130=head1 PORTING FROM LIBEV 3.X TO 4.X 5594=head1 PORTING FROM LIBEV 3.X TO 4.X
5139=over 4 5603=over 4
5140 5604
5141=item C<EV_COMPAT3> backwards compatibility mechanism 5605=item C<EV_COMPAT3> backwards compatibility mechanism
5142 5606
5143The backward compatibility mechanism can be controlled by 5607The backward compatibility mechanism can be controlled by
5144C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5608C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5145section. 5609section.
5146 5610
5147=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5611=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5148 5612
5149These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5613These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5192=over 4 5656=over 4
5193 5657
5194=item active 5658=item active
5195 5659
5196A watcher is active as long as it has been started and not yet stopped. 5660A watcher is active as long as it has been started and not yet stopped.
5197See L<WATCHER STATES> for details. 5661See L</WATCHER STATES> for details.
5198 5662
5199=item application 5663=item application
5200 5664
5201In this document, an application is whatever is using libev. 5665In this document, an application is whatever is using libev.
5202 5666
5238watchers and events. 5702watchers and events.
5239 5703
5240=item pending 5704=item pending
5241 5705
5242A watcher is pending as soon as the corresponding event has been 5706A watcher is pending as soon as the corresponding event has been
5243detected. See L<WATCHER STATES> for details. 5707detected. See L</WATCHER STATES> for details.
5244 5708
5245=item real time 5709=item real time
5246 5710
5247The physical time that is observed. It is apparently strictly monotonic :) 5711The physical time that is observed. It is apparently strictly monotonic :)
5248 5712

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines