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.460 by root, Wed Jan 22 02:00:13 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.
1121with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher 1218with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
1122*) >>), and you can stop watching for events at any time by calling the 1219*) >>), and you can stop watching for events at any time by calling the
1123corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>. 1220corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
1124 1221
1125As long as your watcher is active (has been started but not stopped) you 1222As long as your watcher is active (has been started but not stopped) you
1126must not touch the values stored in it. Most specifically you must never 1223must not touch the values stored in it except when explicitly documented
1127reinitialise it or call its C<ev_TYPE_set> macro. 1224otherwise. Most specifically you must never reinitialise it or call its
1225C<ev_TYPE_set> macro.
1128 1226
1129Each and every callback receives the event loop pointer as first, the 1227Each and every callback receives the event loop pointer as first, the
1130registered watcher structure as second, and a bitset of received events as 1228registered watcher structure as second, and a bitset of received events as
1131third argument. 1229third argument.
1132 1230
1169 1267
1170=item C<EV_PREPARE> 1268=item C<EV_PREPARE>
1171 1269
1172=item C<EV_CHECK> 1270=item C<EV_CHECK>
1173 1271
1174All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts 1272All 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 1273gather 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 1274just after C<ev_run> has gathered them, but before it queues any callbacks
1275for any received events. That means C<ev_prepare> watchers are the last
1276watchers invoked before the event loop sleeps or polls for new events, and
1277C<ev_check> watchers will be invoked before any other watchers of the same
1278or lower priority within an event loop iteration.
1279
1177received events. Callbacks of both watcher types can start and stop as 1280Callbacks 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 1281they 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 1282C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1180C<ev_run> from blocking). 1283blocking).
1181 1284
1182=item C<EV_EMBED> 1285=item C<EV_EMBED>
1183 1286
1184The embedded event loop specified in the C<ev_embed> watcher needs attention. 1287The embedded event loop specified in the C<ev_embed> watcher needs attention.
1185 1288
1308 1411
1309=item callback ev_cb (ev_TYPE *watcher) 1412=item callback ev_cb (ev_TYPE *watcher)
1310 1413
1311Returns the callback currently set on the watcher. 1414Returns the callback currently set on the watcher.
1312 1415
1313=item ev_cb_set (ev_TYPE *watcher, callback) 1416=item ev_set_cb (ev_TYPE *watcher, callback)
1314 1417
1315Change the callback. You can change the callback at virtually any time 1418Change the callback. You can change the callback at virtually any time
1316(modulo threads). 1419(modulo threads).
1317 1420
1318=item ev_set_priority (ev_TYPE *watcher, int priority) 1421=item ev_set_priority (ev_TYPE *watcher, int priority)
1336or might not have been clamped to the valid range. 1439or might not have been clamped to the valid range.
1337 1440
1338The default priority used by watchers when no priority has been set is 1441The 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 :). 1442always C<0>, which is supposed to not be too high and not be too low :).
1340 1443
1341See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1444See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1342priorities. 1445priorities.
1343 1446
1344=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1447=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1345 1448
1346Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1449Invoke 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 1474See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1372functions that do not need a watcher. 1475functions that do not need a watcher.
1373 1476
1374=back 1477=back
1375 1478
1376See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1479See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1377OWN COMPOSITE WATCHERS> idioms. 1480OWN COMPOSITE WATCHERS> idioms.
1378 1481
1379=head2 WATCHER STATES 1482=head2 WATCHER STATES
1380 1483
1381There are various watcher states mentioned throughout this manual - 1484There are various watcher states mentioned throughout this manual -
1383transition between them will be described in more detail - and while these 1486transition between them will be described in more detail - and while these
1384rules might look complicated, they usually do "the right thing". 1487rules might look complicated, they usually do "the right thing".
1385 1488
1386=over 4 1489=over 4
1387 1490
1388=item initialiased 1491=item initialised
1389 1492
1390Before a watcher can be registered with the event looop it has to be 1493Before 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 1494initialised. 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. 1495C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1393 1496
1394In this state it is simply some block of memory that is suitable for 1497In 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 1498use in an event loop. It can be moved around, freed, reused etc. at
1442 1545
1443Many event loops support I<watcher priorities>, which are usually small 1546Many event loops support I<watcher priorities>, which are usually small
1444integers that influence the ordering of event callback invocation 1547integers that influence the ordering of event callback invocation
1445between watchers in some way, all else being equal. 1548between watchers in some way, all else being equal.
1446 1549
1447In libev, Watcher priorities can be set using C<ev_set_priority>. See its 1550In libev, watcher priorities can be set using C<ev_set_priority>. See its
1448description for the more technical details such as the actual priority 1551description for the more technical details such as the actual priority
1449range. 1552range.
1450 1553
1451There are two common ways how these these priorities are being interpreted 1554There are two common ways how these these priorities are being interpreted
1452by event loops: 1555by event loops:
1546 1649
1547This section describes each watcher in detail, but will not repeat 1650This section describes each watcher in detail, but will not repeat
1548information given in the last section. Any initialisation/set macros, 1651information given in the last section. Any initialisation/set macros,
1549functions and members specific to the watcher type are explained. 1652functions and members specific to the watcher type are explained.
1550 1653
1551Members are additionally marked with either I<[read-only]>, meaning that, 1654Most members are additionally marked with either I<[read-only]>, meaning
1552while the watcher is active, you can look at the member and expect some 1655that, 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 1656some 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 1657the 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 1658means 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 1659is 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 1660sensible or take immediate effect (or do anything at all), but libev will
1558not crash or malfunction in any way. 1661not crash or malfunction in any way.
1559 1662
1663In any case, the documentation for each member will explain what the
1664effects are, and if there are any additional access restrictions.
1560 1665
1561=head2 C<ev_io> - is this file descriptor readable or writable? 1666=head2 C<ev_io> - is this file descriptor readable or writable?
1562 1667
1563I/O watchers check whether a file descriptor is readable or writable 1668I/O watchers check whether a file descriptor is readable or writable
1564in each iteration of the event loop, or, more precisely, when reading 1669in each iteration of the event loop, or, more precisely, when reading
1591 1696
1592But really, best use non-blocking mode. 1697But really, best use non-blocking mode.
1593 1698
1594=head3 The special problem of disappearing file descriptors 1699=head3 The special problem of disappearing file descriptors
1595 1700
1596Some backends (e.g. kqueue, epoll) need to be told about closing a file 1701Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1597descriptor (either due to calling C<close> explicitly or any other means, 1702a 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 1703means, 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 1704file descriptor, but when it goes away, the operating system will silently
1600this interest. If another file descriptor with the same number then is 1705drop 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 1706is registered with libev, there is no efficient way to see that this is,
1602fact, a different file descriptor. 1707in fact, a different file descriptor.
1603 1708
1604To avoid having to explicitly tell libev about such cases, libev follows 1709To avoid having to explicitly tell libev about such cases, libev follows
1605the following policy: Each time C<ev_io_set> is being called, libev 1710the following policy: Each time C<ev_io_set> is being called, libev
1606will assume that this is potentially a new file descriptor, otherwise 1711will assume that this is potentially a new file descriptor, otherwise
1607it is assumed that the file descriptor stays the same. That means that 1712it 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 1761when you rarely read from a file instead of from a socket, and want to
1657reuse the same code path. 1762reuse the same code path.
1658 1763
1659=head3 The special problem of fork 1764=head3 The special problem of fork
1660 1765
1661Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1766Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()>
1662useless behaviour. Libev fully supports fork, but needs to be told about 1767at 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. 1768to be told about it in the child if you want to continue to use it in the
1769child.
1664 1770
1665To support fork in your child processes, you have to call C<ev_loop_fork 1771To 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 1772()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1667C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1773C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1668 1774
1726 1832
1727Configures an C<ev_io> watcher. The C<fd> is the file descriptor to 1833Configures 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 1834receive 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. 1835C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1730 1836
1731=item int fd [read-only] 1837=item ev_io_modify (ev_io *, int events)
1732 1838
1733The file descriptor being watched. 1839Similar to C<ev_io_set>, but only changes the event mask. Using this might
1840be faster with some backends, as libev can assume that the C<fd> still
1841refers to the same underlying file description, something it cannot do
1842when using C<ev_io_set>.
1734 1843
1844=item int fd [no-modify]
1845
1846The file descriptor being watched. While it can be read at any time, you
1847must not modify this member even when the watcher is stopped - always use
1848C<ev_io_set> for that.
1849
1735=item int events [read-only] 1850=item int events [no-modify]
1736 1851
1737The events being watched. 1852The set of events the fd is being watched for, among other flags. Remember
1853that this is a bit set - to test for C<EV_READ>, use C<< w->events &
1854EV_READ >>, and similarly for C<EV_WRITE>.
1855
1856As with C<fd>, you must not modify this member even when the watcher is
1857stopped, always use C<ev_io_set> or C<ev_io_modify> for that.
1738 1858
1739=back 1859=back
1740 1860
1741=head3 Examples 1861=head3 Examples
1742 1862
1770detecting time jumps is hard, and some inaccuracies are unavoidable (the 1890detecting time jumps is hard, and some inaccuracies are unavoidable (the
1771monotonic clock option helps a lot here). 1891monotonic clock option helps a lot here).
1772 1892
1773The callback is guaranteed to be invoked only I<after> its timeout has 1893The 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 1894passed (not I<at>, so on systems with very low-resolution clocks this
1775might introduce a small delay). If multiple timers become ready during the 1895might introduce a small delay, see "the special problem of being too
1896early", below). If multiple timers become ready during the same loop
1776same loop iteration then the ones with earlier time-out values are invoked 1897iteration 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 1898ones of the same priority with later time-out values (but this is no
1778no longer true when a callback calls C<ev_run> recursively). 1899longer true when a callback calls C<ev_run> recursively).
1779 1900
1780=head3 Be smart about timeouts 1901=head3 Be smart about timeouts
1781 1902
1782Many real-world problems involve some kind of timeout, usually for error 1903Many real-world problems involve some kind of timeout, usually for error
1783recovery. A typical example is an HTTP request - if the other side hangs, 1904recovery. A typical example is an HTTP request - if the other side hangs,
1858 1979
1859In this case, it would be more efficient to leave the C<ev_timer> alone, 1980In 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 1981but remember the time of last activity, and check for a real timeout only
1861within the callback: 1982within the callback:
1862 1983
1984 ev_tstamp timeout = 60.;
1863 ev_tstamp last_activity; // time of last activity 1985 ev_tstamp last_activity; // time of last activity
1986 ev_timer timer;
1864 1987
1865 static void 1988 static void
1866 callback (EV_P_ ev_timer *w, int revents) 1989 callback (EV_P_ ev_timer *w, int revents)
1867 { 1990 {
1868 ev_tstamp now = ev_now (EV_A); 1991 // calculate when the timeout would happen
1869 ev_tstamp timeout = last_activity + 60.; 1992 ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1870 1993
1871 // if last_activity + 60. is older than now, we did time out 1994 // if negative, it means we the timeout already occurred
1872 if (timeout < now) 1995 if (after < 0.)
1873 { 1996 {
1874 // timeout occurred, take action 1997 // timeout occurred, take action
1875 } 1998 }
1876 else 1999 else
1877 { 2000 {
1878 // callback was invoked, but there was some activity, re-arm 2001 // callback was invoked, but there was some recent
1879 // the watcher to fire in last_activity + 60, which is 2002 // activity. simply restart the timer to time out
1880 // guaranteed to be in the future, so "again" is positive: 2003 // after "after" seconds, which is the earliest time
1881 w->repeat = timeout - now; 2004 // the timeout can occur.
2005 ev_timer_set (w, after, 0.);
1882 ev_timer_again (EV_A_ w); 2006 ev_timer_start (EV_A_ w);
1883 } 2007 }
1884 } 2008 }
1885 2009
1886To summarise the callback: first calculate the real timeout (defined 2010To summarise the callback: first calculate in how many seconds the
1887as "60 seconds after the last activity"), then check if that time has 2011timeout will occur (by calculating the absolute time when it would occur,
1888been reached, which means something I<did>, in fact, time out. Otherwise 2012C<last_activity + timeout>, and subtracting the current time, C<ev_now
1889the callback was invoked too early (C<timeout> is in the future), so 2013(EV_A)> from that).
1890re-schedule the timer to fire at that future time, to see if maybe we have
1891a timeout then.
1892 2014
1893Note how C<ev_timer_again> is used, taking advantage of the 2015If 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. 2016timed out, and need to do whatever is needed in this case.
2017
2018Otherwise, we now the earliest time at which the timeout would trigger,
2019and simply start the timer with this timeout value.
2020
2021In other words, each time the callback is invoked it will check whether
2022the timeout occurred. If not, it will simply reschedule itself to check
2023again at the earliest time it could time out. Rinse. Repeat.
1895 2024
1896This scheme causes more callback invocations (about one every 60 seconds 2025This scheme causes more callback invocations (about one every 60 seconds
1897minus half the average time between activity), but virtually no calls to 2026minus half the average time between activity), but virtually no calls to
1898libev to change the timeout. 2027libev to change the timeout.
1899 2028
1900To start the timer, simply initialise the watcher and set C<last_activity> 2029To start the machinery, simply initialise the watcher and set
1901to the current time (meaning we just have some activity :), then call the 2030C<last_activity> to the current time (meaning there was some activity just
1902callback, which will "do the right thing" and start the timer: 2031now), then call the callback, which will "do the right thing" and start
2032the timer:
1903 2033
2034 last_activity = ev_now (EV_A);
1904 ev_init (timer, callback); 2035 ev_init (&timer, callback);
1905 last_activity = ev_now (loop); 2036 callback (EV_A_ &timer, 0);
1906 callback (loop, timer, EV_TIMER);
1907 2037
1908And when there is some activity, simply store the current time in 2038When there is some activity, simply store the current time in
1909C<last_activity>, no libev calls at all: 2039C<last_activity>, no libev calls at all:
1910 2040
2041 if (activity detected)
1911 last_activity = ev_now (loop); 2042 last_activity = ev_now (EV_A);
2043
2044When your timeout value changes, then the timeout can be changed by simply
2045providing a new value, stopping the timer and calling the callback, which
2046will again do the right thing (for example, time out immediately :).
2047
2048 timeout = new_value;
2049 ev_timer_stop (EV_A_ &timer);
2050 callback (EV_A_ &timer, 0);
1912 2051
1913This technique is slightly more complex, but in most cases where the 2052This technique is slightly more complex, but in most cases where the
1914time-out is unlikely to be triggered, much more efficient. 2053time-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 2054
1920=item 4. Wee, just use a double-linked list for your timeouts. 2055=item 4. Wee, just use a double-linked list for your timeouts.
1921 2056
1922If there is not one request, but many thousands (millions...), all 2057If there is not one request, but many thousands (millions...), all
1923employing some kind of timeout with the same timeout value, then one can 2058employing 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 2085Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1951rather complicated, but extremely efficient, something that really pays 2086rather complicated, but extremely efficient, something that really pays
1952off after the first million or so of active timers, i.e. it's usually 2087off after the first million or so of active timers, i.e. it's usually
1953overkill :) 2088overkill :)
1954 2089
2090=head3 The special problem of being too early
2091
2092If you ask a timer to call your callback after three seconds, then
2093you expect it to be invoked after three seconds - but of course, this
2094cannot be guaranteed to infinite precision. Less obviously, it cannot be
2095guaranteed to any precision by libev - imagine somebody suspending the
2096process with a STOP signal for a few hours for example.
2097
2098So, libev tries to invoke your callback as soon as possible I<after> the
2099delay has occurred, but cannot guarantee this.
2100
2101A less obvious failure mode is calling your callback too early: many event
2102loops compare timestamps with a "elapsed delay >= requested delay", but
2103this can cause your callback to be invoked much earlier than you would
2104expect.
2105
2106To see why, imagine a system with a clock that only offers full second
2107resolution (think windows if you can't come up with a broken enough OS
2108yourself). If you schedule a one-second timer at the time 500.9, then the
2109event loop will schedule your timeout to elapse at a system time of 500
2110(500.9 truncated to the resolution) + 1, or 501.
2111
2112If an event library looks at the timeout 0.1s later, it will see "501 >=
2113501" and invoke the callback 0.1s after it was started, even though a
2114one-second delay was requested - this is being "too early", despite best
2115intentions.
2116
2117This is the reason why libev will never invoke the callback if the elapsed
2118delay equals the requested delay, but only when the elapsed delay is
2119larger than the requested delay. In the example above, libev would only invoke
2120the callback at system time 502, or 1.1s after the timer was started.
2121
2122So, while libev cannot guarantee that your callback will be invoked
2123exactly when requested, it I<can> and I<does> guarantee that the requested
2124delay has actually elapsed, or in other words, it always errs on the "too
2125late" side of things.
2126
1955=head3 The special problem of time updates 2127=head3 The special problem of time updates
1956 2128
1957Establishing the current time is a costly operation (it usually takes at 2129Establishing the current time is a costly operation (it usually takes
1958least two system calls): EV therefore updates its idea of the current 2130at 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 2131time 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 2132growing difference between C<ev_now ()> and C<ev_time ()> when handling
1961lots of events in one iteration. 2133lots of events in one iteration.
1962 2134
1963The relative timeouts are calculated relative to the C<ev_now ()> 2135The relative timeouts are calculated relative to the C<ev_now ()>
1964time. This is usually the right thing as this timestamp refers to the time 2136time. This is usually the right thing as this timestamp refers to the time
1965of the event triggering whatever timeout you are modifying/starting. If 2137of the event triggering whatever timeout you are modifying/starting. If
1966you suspect event processing to be delayed and you I<need> to base the 2138you 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: 2139timeout on the current time, use something like the following to adjust
2140for it:
1968 2141
1969 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2142 ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
1970 2143
1971If the event loop is suspended for a long time, you can also force an 2144If 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 2145update of the time returned by C<ev_now ()> by calling C<ev_now_update
1973()>. 2146()>, although that will push the event time of all outstanding events
2147further into the future.
2148
2149=head3 The special problem of unsynchronised clocks
2150
2151Modern systems have a variety of clocks - libev itself uses the normal
2152"wall clock" clock and, if available, the monotonic clock (to avoid time
2153jumps).
2154
2155Neither of these clocks is synchronised with each other or any other clock
2156on the system, so C<ev_time ()> might return a considerably different time
2157than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
2158a call to C<gettimeofday> might return a second count that is one higher
2159than a directly following call to C<time>.
2160
2161The moral of this is to only compare libev-related timestamps with
2162C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
2163a second or so.
2164
2165One more problem arises due to this lack of synchronisation: if libev uses
2166the system monotonic clock and you compare timestamps from C<ev_time>
2167or C<ev_now> from when you started your timer and when your callback is
2168invoked, you will find that sometimes the callback is a bit "early".
2169
2170This is because C<ev_timer>s work in real time, not wall clock time, so
2171libev makes sure your callback is not invoked before the delay happened,
2172I<measured according to the real time>, not the system clock.
2173
2174If your timeouts are based on a physical timescale (e.g. "time out this
2175connection after 100 seconds") then this shouldn't bother you as it is
2176exactly the right behaviour.
2177
2178If you want to compare wall clock/system timestamps to your timers, then
2179you need to use C<ev_periodic>s, as these are based on the wall clock
2180time, where your comparisons will always generate correct results.
1974 2181
1975=head3 The special problems of suspended animation 2182=head3 The special problems of suspended animation
1976 2183
1977When you leave the server world it is quite customary to hit machines that 2184When 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? 2185can suspend/hibernate - what happens to the clocks during such a suspend?
2008 2215
2009=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 2216=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
2010 2217
2011=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 2218=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
2012 2219
2013Configure the timer to trigger after C<after> seconds. If C<repeat> 2220Configure the timer to trigger after C<after> seconds (fractional and
2014is C<0.>, then it will automatically be stopped once the timeout is 2221negative values are supported). If C<repeat> is C<0.>, then it will
2015reached. If it is positive, then the timer will automatically be 2222automatically be stopped once the timeout is reached. If it is positive,
2016configured to trigger again C<repeat> seconds later, again, and again, 2223then the timer will automatically be configured to trigger again C<repeat>
2017until stopped manually. 2224seconds later, again, and again, until stopped manually.
2018 2225
2019The timer itself will do a best-effort at avoiding drift, that is, if 2226The 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 2227you configure a timer to trigger every 10 seconds, then it will normally
2021trigger at exactly 10 second intervals. If, however, your program cannot 2228trigger at exactly 10 second intervals. If, however, your program cannot
2022keep up with the timer (because it takes longer than those 10 seconds to 2229keep 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. 2230do stuff) the timer will not fire more than once per event loop iteration.
2024 2231
2025=item ev_timer_again (loop, ev_timer *) 2232=item ev_timer_again (loop, ev_timer *)
2026 2233
2027This will act as if the timer timed out and restart it again if it is 2234This will act as if the timer timed out, and restarts it again if it is
2028repeating. The exact semantics are: 2235repeating. It basically works like calling C<ev_timer_stop>, updating the
2236timeout to the C<repeat> value and calling C<ev_timer_start>.
2029 2237
2238The exact semantics are as in the following rules, all of which will be
2239applied to the watcher:
2240
2241=over 4
2242
2030If the timer is pending, its pending status is cleared. 2243=item If the timer is pending, the pending status is always cleared.
2031 2244
2032If the timer is started but non-repeating, stop it (as if it timed out). 2245=item If the timer is started but non-repeating, stop it (as if it timed
2246out, without invoking it).
2033 2247
2034If the timer is repeating, either start it if necessary (with the 2248=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. 2249and start the timer, if necessary.
2036 2250
2251=back
2252
2037This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2253This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2038usage example. 2254usage example.
2039 2255
2040=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2256=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2041 2257
2042Returns the remaining time until a timer fires. If the timer is active, 2258Returns 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 2311Periodic watchers are also timers of a kind, but they are very versatile
2096(and unfortunately a bit complex). 2312(and unfortunately a bit complex).
2097 2313
2098Unlike C<ev_timer>, periodic watchers are not based on real time (or 2314Unlike C<ev_timer>, periodic watchers are not based on real time (or
2099relative time, the physical time that passes) but on wall clock time 2315relative 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 2316(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 2317difference 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 2318time, and time jumps are not uncommon (e.g. when you adjust your
2103wrist-watch). 2319wrist-watch).
2104 2320
2105You can tell a periodic watcher to trigger after some specific point 2321You can tell a periodic watcher to trigger after some specific point
2110C<ev_timer>, which would still trigger roughly 10 seconds after starting 2326C<ev_timer>, which would still trigger roughly 10 seconds after starting
2111it, as it uses a relative timeout). 2327it, as it uses a relative timeout).
2112 2328
2113C<ev_periodic> watchers can also be used to implement vastly more complex 2329C<ev_periodic> watchers can also be used to implement vastly more complex
2114timers, such as triggering an event on each "midnight, local time", or 2330timers, such as triggering an event on each "midnight, local time", or
2115other complicated rules. This cannot be done with C<ev_timer> watchers, as 2331other complicated rules. This cannot easily be done with C<ev_timer>
2116those cannot react to time jumps. 2332watchers, as those cannot react to time jumps.
2117 2333
2118As with timers, the callback is guaranteed to be invoked only when the 2334As 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 2335point in time where it is supposed to trigger has passed. If multiple
2120timers become ready during the same loop iteration then the ones with 2336timers become ready during the same loop iteration then the ones with
2121earlier time-out values are invoked before ones with later time-out values 2337earlier time-out values are invoked before ones with later time-out values
2207 2423
2208NOTE: I<< This callback must always return a time that is higher than or 2424NOTE: I<< This callback must always return a time that is higher than or
2209equal to the passed C<now> value >>. 2425equal to the passed C<now> value >>.
2210 2426
2211This can be used to create very complex timers, such as a timer that 2427This 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 2428triggers on "next midnight, local time". To do this, you would calculate
2213next midnight after C<now> and return the timestamp value for this. How 2429the 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 2430this. Here is a (completely untested, no error checking) example on how to
2215reason I omitted it as an example). 2431do this:
2432
2433 #include <time.h>
2434
2435 static ev_tstamp
2436 my_rescheduler (ev_periodic *w, ev_tstamp now)
2437 {
2438 time_t tnow = (time_t)now;
2439 struct tm tm;
2440 localtime_r (&tnow, &tm);
2441
2442 tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2443 ++tm.tm_mday; // midnight next day
2444
2445 return mktime (&tm);
2446 }
2447
2448Note: this code might run into trouble on days that have more then two
2449midnights (beginning and end).
2216 2450
2217=back 2451=back
2218 2452
2219=item ev_periodic_again (loop, ev_periodic *) 2453=item ev_periodic_again (loop, ev_periodic *)
2220 2454
2285 2519
2286 ev_periodic hourly_tick; 2520 ev_periodic hourly_tick;
2287 ev_periodic_init (&hourly_tick, clock_cb, 2521 ev_periodic_init (&hourly_tick, clock_cb,
2288 fmod (ev_now (loop), 3600.), 3600., 0); 2522 fmod (ev_now (loop), 3600.), 3600., 0);
2289 ev_periodic_start (loop, &hourly_tick); 2523 ev_periodic_start (loop, &hourly_tick);
2290 2524
2291 2525
2292=head2 C<ev_signal> - signal me when a signal gets signalled! 2526=head2 C<ev_signal> - signal me when a signal gets signalled!
2293 2527
2294Signal watchers will trigger an event when the process receives a specific 2528Signal watchers will trigger an event when the process receives a specific
2295signal one or more times. Even though signals are very asynchronous, libev 2529signal 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 2539only 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 2540default 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 2541C<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. 2542the moment, C<SIGCHLD> is permanently tied to the default loop.
2309 2543
2310When the first watcher gets started will libev actually register something 2544Only 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 2545register something with the kernel. It thus coexists with your own signal
2312you don't register any with libev for the same signal). 2546handlers as long as you don't register any with libev for the same signal.
2313 2547
2314If possible and supported, libev will install its handlers with 2548If possible and supported, libev will install its handlers with
2315C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2549C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2316not be unduly interrupted. If you have a problem with system calls getting 2550not 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 2551interrupted by signals you can block all signals in an C<ev_check> watcher
2502 2736
2503=head2 C<ev_stat> - did the file attributes just change? 2737=head2 C<ev_stat> - did the file attributes just change?
2504 2738
2505This watches a file system path for attribute changes. That is, it calls 2739This 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) 2740C<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 2741and sees if it changed compared to the last time, invoking the callback
2508it did. 2742if it did. Starting the watcher C<stat>'s the file, so only changes that
2743happen after the watcher has been started will be reported.
2509 2744
2510The path does not need to exist: changing from "path exists" to "path does 2745The 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 2746not 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 2747exist" (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 2748C<st_nlink> field being zero (which is otherwise always forced to be at
2743Apart from keeping your process non-blocking (which is a useful 2978Apart from keeping your process non-blocking (which is a useful
2744effect on its own sometimes), idle watchers are a good place to do 2979effect on its own sometimes), idle watchers are a good place to do
2745"pseudo-background processing", or delay processing stuff to after the 2980"pseudo-background processing", or delay processing stuff to after the
2746event loop has handled all outstanding events. 2981event loop has handled all outstanding events.
2747 2982
2983=head3 Abusing an C<ev_idle> watcher for its side-effect
2984
2985As long as there is at least one active idle watcher, libev will never
2986sleep unnecessarily. Or in other words, it will loop as fast as possible.
2987For this to work, the idle watcher doesn't need to be invoked at all - the
2988lowest priority will do.
2989
2990This mode of operation can be useful together with an C<ev_check> watcher,
2991to do something on each event loop iteration - for example to balance load
2992between different connections.
2993
2994See L</Abusing an ev_check watcher for its side-effect> for a longer
2995example.
2996
2748=head3 Watcher-Specific Functions and Data Members 2997=head3 Watcher-Specific Functions and Data Members
2749 2998
2750=over 4 2999=over 4
2751 3000
2752=item ev_idle_init (ev_idle *, callback) 3001=item ev_idle_init (ev_idle *, callback)
2763callback, free it. Also, use no error checking, as usual. 3012callback, free it. Also, use no error checking, as usual.
2764 3013
2765 static void 3014 static void
2766 idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 3015 idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2767 { 3016 {
3017 // stop the watcher
3018 ev_idle_stop (loop, w);
3019
3020 // now we can free it
2768 free (w); 3021 free (w);
3022
2769 // now do something you wanted to do when the program has 3023 // now do something you wanted to do when the program has
2770 // no longer anything immediate to do. 3024 // no longer anything immediate to do.
2771 } 3025 }
2772 3026
2773 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3027 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2775 ev_idle_start (loop, idle_watcher); 3029 ev_idle_start (loop, idle_watcher);
2776 3030
2777 3031
2778=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 3032=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2779 3033
2780Prepare and check watchers are usually (but not always) used in pairs: 3034Prepare and check watchers are often (but not always) used in pairs:
2781prepare watchers get invoked before the process blocks and check watchers 3035prepare watchers get invoked before the process blocks and check watchers
2782afterwards. 3036afterwards.
2783 3037
2784You I<must not> call C<ev_run> or similar functions that enter 3038You 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> 3039current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2786watchers. Other loops than the current one are fine, however. The 3040C<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 3041however. 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, 3042for 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 3043C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2790called in pairs bracketing the blocking call. 3044kind they will always be called in pairs bracketing the blocking call.
2791 3045
2792Their main purpose is to integrate other event mechanisms into libev and 3046Their main purpose is to integrate other event mechanisms into libev and
2793their use is somewhat advanced. They could be used, for example, to track 3047their use is somewhat advanced. They could be used, for example, to track
2794variable changes, implement your own watchers, integrate net-snmp or a 3048variable changes, implement your own watchers, integrate net-snmp or a
2795coroutine library and lots more. They are also occasionally useful if 3049coroutine library and lots more. They are also occasionally useful if
2813with priority higher than or equal to the event loop and one coroutine 3067with 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 3068of lower priority, but only once, using idle watchers to keep the event
2815loop from blocking if lower-priority coroutines are active, thus mapping 3069loop from blocking if lower-priority coroutines are active, thus mapping
2816low-priority coroutines to idle/background tasks). 3070low-priority coroutines to idle/background tasks).
2817 3071
2818It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 3072When 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 3073highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2820after the poll (this doesn't matter for C<ev_prepare> watchers). 3074any other watchers after the poll (this doesn't matter for C<ev_prepare>
3075watchers).
2821 3076
2822Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not 3077Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2823activate ("feed") events into libev. While libev fully supports this, they 3078activate ("feed") events into libev. While libev fully supports this, they
2824might get executed before other C<ev_check> watchers did their job. As 3079might 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 3080C<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 3081loops those other event loops might be in an unusable state until their
2827C<ev_check> watcher ran (always remind yourself to coexist peacefully with 3082C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2828others). 3083others).
3084
3085=head3 Abusing an C<ev_check> watcher for its side-effect
3086
3087C<ev_check> (and less often also C<ev_prepare>) watchers can also be
3088useful because they are called once per event loop iteration. For
3089example, if you want to handle a large number of connections fairly, you
3090normally only do a bit of work for each active connection, and if there
3091is more work to do, you wait for the next event loop iteration, so other
3092connections have a chance of making progress.
3093
3094Using an C<ev_check> watcher is almost enough: it will be called on the
3095next event loop iteration. However, that isn't as soon as possible -
3096without external events, your C<ev_check> watcher will not be invoked.
3097
3098This is where C<ev_idle> watchers come in handy - all you need is a
3099single global idle watcher that is active as long as you have one active
3100C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
3101will not sleep, and the C<ev_check> watcher makes sure a callback gets
3102invoked. Neither watcher alone can do that.
2829 3103
2830=head3 Watcher-Specific Functions and Data Members 3104=head3 Watcher-Specific Functions and Data Members
2831 3105
2832=over 4 3106=over 4
2833 3107
3034 3308
3035=over 4 3309=over 4
3036 3310
3037=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3311=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3038 3312
3039=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3313=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3040 3314
3041Configures the watcher to embed the given loop, which must be 3315Configures the watcher to embed the given loop, which must be
3042embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3316embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3043invoked automatically, otherwise it is the responsibility of the callback 3317invoked automatically, otherwise it is the responsibility of the callback
3044to invoke it (it will continue to be called until the sweep has been done, 3318to invoke it (it will continue to be called until the sweep has been done,
3065used). 3339used).
3066 3340
3067 struct ev_loop *loop_hi = ev_default_init (0); 3341 struct ev_loop *loop_hi = ev_default_init (0);
3068 struct ev_loop *loop_lo = 0; 3342 struct ev_loop *loop_lo = 0;
3069 ev_embed embed; 3343 ev_embed embed;
3070 3344
3071 // see if there is a chance of getting one that works 3345 // see if there is a chance of getting one that works
3072 // (remember that a flags value of 0 means autodetection) 3346 // (remember that a flags value of 0 means autodetection)
3073 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3347 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3074 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3348 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3075 : 0; 3349 : 0;
3089C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3363C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3090 3364
3091 struct ev_loop *loop = ev_default_init (0); 3365 struct ev_loop *loop = ev_default_init (0);
3092 struct ev_loop *loop_socket = 0; 3366 struct ev_loop *loop_socket = 0;
3093 ev_embed embed; 3367 ev_embed embed;
3094 3368
3095 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3369 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3096 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3370 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3097 { 3371 {
3098 ev_embed_init (&embed, 0, loop_socket); 3372 ev_embed_init (&embed, 0, loop_socket);
3099 ev_embed_start (loop, &embed); 3373 ev_embed_start (loop, &embed);
3107 3381
3108=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3382=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3109 3383
3110Fork watchers are called when a C<fork ()> was detected (usually because 3384Fork watchers are called when a C<fork ()> was detected (usually because
3111whoever is a good citizen cared to tell libev about it by calling 3385whoever 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 3386C<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, 3387and 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 3388after 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 3389and calls it in the wrong process, the fork handlers will be invoked, too,
3116handlers will be invoked, too, of course. 3390of course.
3117 3391
3118=head3 The special problem of life after fork - how is it possible? 3392=head3 The special problem of life after fork - how is it possible?
3119 3393
3120Most uses of C<fork()> consist of forking, then some simple calls to set 3394Most 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 3395up/change the process environment, followed by a call to C<exec()>. This
3122sequence should be handled by libev without any problems. 3396sequence should be handled by libev without any problems.
3123 3397
3124This changes when the application actually wants to do event handling 3398This changes when the application actually wants to do event handling
3125in the child, or both parent in child, in effect "continuing" after the 3399in 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. 3488it by calling C<ev_async_send>, which is thread- and signal safe.
3215 3489
3216This functionality is very similar to C<ev_signal> watchers, as signals, 3490This functionality is very similar to C<ev_signal> watchers, as signals,
3217too, are asynchronous in nature, and signals, too, will be compressed 3491too, 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 3492(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 3493C<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 3494of "global async watchers" by using a watcher on an otherwise unused
3221signal, and C<ev_feed_signal> to signal this watcher from another thread, 3495signal, and C<ev_feed_signal> to signal this watcher from another thread,
3222even without knowing which loop owns the signal. 3496even 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 3497
3227=head3 Queueing 3498=head3 Queueing
3228 3499
3229C<ev_async> does not support queueing of data in any way. The reason 3500C<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 3501is 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, 3601Unlike 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 3602signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3332embedding section below on what exactly this means). 3603embedding section below on what exactly this means).
3333 3604
3334Note that, as with other watchers in libev, multiple events might get 3605Note that, as with other watchers in libev, multiple events might get
3335compressed into a single callback invocation (another way to look at this 3606compressed 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>, 3607this is that C<ev_async> watchers are level-triggered: they are set on
3337reset when the event loop detects that). 3608C<ev_async_send>, reset when the event loop detects that).
3338 3609
3339This call incurs the overhead of a system call only once per event loop 3610This 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 3611loop 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. 3612the event loop (or your program) is processing events. That means that
3613repeated calls are basically free (there is no need to avoid calls for
3614performance reasons) and that the overhead becomes smaller (typically
3615zero) under load.
3342 3616
3343=item bool = ev_async_pending (ev_async *) 3617=item bool = ev_async_pending (ev_async *)
3344 3618
3345Returns a non-zero value when C<ev_async_send> has been called on the 3619Returns 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 3620watcher but the event has not yet been processed (or even noted) by the
3363 3637
3364There are some other functions of possible interest. Described. Here. Now. 3638There are some other functions of possible interest. Described. Here. Now.
3365 3639
3366=over 4 3640=over 4
3367 3641
3368=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 3642=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3369 3643
3370This function combines a simple timer and an I/O watcher, calls your 3644This function combines a simple timer and an I/O watcher, calls your
3371callback on whichever event happens first and automatically stops both 3645callback 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 3646watchers. 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 3647or timeout without having to allocate/configure/start/stop/free one or
3401 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3675 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3402 3676
3403=item ev_feed_fd_event (loop, int fd, int revents) 3677=item ev_feed_fd_event (loop, int fd, int revents)
3404 3678
3405Feed an event on the given fd, as if a file descriptor backend detected 3679Feed an event on the given fd, as if a file descriptor backend detected
3406the given events it. 3680the given events.
3407 3681
3408=item ev_feed_signal_event (loop, int signum) 3682=item ev_feed_signal_event (loop, int signum)
3409 3683
3410Feed an event as if the given signal occurred. See also C<ev_feed_signal>, 3684Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3411which is async-safe. 3685which is async-safe.
3485 { 3759 {
3486 struct my_biggy big = (struct my_biggy *) 3760 struct my_biggy big = (struct my_biggy *)
3487 (((char *)w) - offsetof (struct my_biggy, t2)); 3761 (((char *)w) - offsetof (struct my_biggy, t2));
3488 } 3762 }
3489 3763
3764=head2 AVOIDING FINISHING BEFORE RETURNING
3765
3766Often you have structures like this in event-based programs:
3767
3768 callback ()
3769 {
3770 free (request);
3771 }
3772
3773 request = start_new_request (..., callback);
3774
3775The intent is to start some "lengthy" operation. The C<request> could be
3776used to cancel the operation, or do other things with it.
3777
3778It's not uncommon to have code paths in C<start_new_request> that
3779immediately invoke the callback, for example, to report errors. Or you add
3780some caching layer that finds that it can skip the lengthy aspects of the
3781operation and simply invoke the callback with the result.
3782
3783The problem here is that this will happen I<before> C<start_new_request>
3784has returned, so C<request> is not set.
3785
3786Even if you pass the request by some safer means to the callback, you
3787might want to do something to the request after starting it, such as
3788canceling it, which probably isn't working so well when the callback has
3789already been invoked.
3790
3791A common way around all these issues is to make sure that
3792C<start_new_request> I<always> returns before the callback is invoked. If
3793C<start_new_request> immediately knows the result, it can artificially
3794delay invoking the callback by using a C<prepare> or C<idle> watcher for
3795example, or more sneakily, by reusing an existing (stopped) watcher and
3796pushing it into the pending queue:
3797
3798 ev_set_cb (watcher, callback);
3799 ev_feed_event (EV_A_ watcher, 0);
3800
3801This way, C<start_new_request> can safely return before the callback is
3802invoked, while not delaying callback invocation too much.
3803
3490=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS 3804=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
3491 3805
3492Often (especially in GUI toolkits) there are places where you have 3806Often (especially in GUI toolkits) there are places where you have
3493I<modal> interaction, which is most easily implemented by recursively 3807I<modal> interaction, which is most easily implemented by recursively
3494invoking C<ev_run>. 3808invoking C<ev_run>.
3495 3809
3496This brings the problem of exiting - a callback might want to finish the 3810This 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 3811main 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 3812a 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 3813and 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. 3814other combination: In these cases, a simple C<ev_break> will not work.
3501 3815
3502The solution is to maintain "break this loop" variable for each C<ev_run> 3816The 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 3817invocation, and use a loop around C<ev_run> until the condition is
3504triggered, using C<EVRUN_ONCE>: 3818triggered, using C<EVRUN_ONCE>:
3505 3819
3507 int exit_main_loop = 0; 3821 int exit_main_loop = 0;
3508 3822
3509 while (!exit_main_loop) 3823 while (!exit_main_loop)
3510 ev_run (EV_DEFAULT_ EVRUN_ONCE); 3824 ev_run (EV_DEFAULT_ EVRUN_ONCE);
3511 3825
3512 // in a model watcher 3826 // in a modal watcher
3513 int exit_nested_loop = 0; 3827 int exit_nested_loop = 0;
3514 3828
3515 while (!exit_nested_loop) 3829 while (!exit_nested_loop)
3516 ev_run (EV_A_ EVRUN_ONCE); 3830 ev_run (EV_A_ EVRUN_ONCE);
3517 3831
3691called): 4005called):
3692 4006
3693 void 4007 void
3694 wait_for_event (ev_watcher *w) 4008 wait_for_event (ev_watcher *w)
3695 { 4009 {
3696 ev_cb_set (w) = current_coro; 4010 ev_set_cb (w, current_coro);
3697 switch_to (libev_coro); 4011 switch_to (libev_coro);
3698 } 4012 }
3699 4013
3700That basically suspends the coroutine inside C<wait_for_event> and 4014That basically suspends the coroutine inside C<wait_for_event> and
3701continues the libev coroutine, which, when appropriate, switches back to 4015continues the libev coroutine, which, when appropriate, switches back to
3702this or any other coroutine. I am sure if you sue this your own :) 4016this or any other coroutine.
3703 4017
3704You can do similar tricks if you have, say, threads with an event queue - 4018You 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 4019instead 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 4020switching to a coroutine, you push the watcher onto the queue and notify
3707any waiters. 4021any waiters.
3708 4022
3709To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 4023To 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: 4024files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3711 4025
3712 // my_ev.h 4026 // my_ev.h
3713 #define EV_CB_DECLARE(type) struct my_coro *cb; 4027 #define EV_CB_DECLARE(type) struct my_coro *cb;
3714 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 4028 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3715 #include "../libev/ev.h" 4029 #include "../libev/ev.h"
3716 4030
3717 // my_ev.c 4031 // my_ev.c
3718 #define EV_H "my_ev.h" 4032 #define EV_H "my_ev.h"
3719 #include "../libev/ev.c" 4033 #include "../libev/ev.c"
3758 4072
3759=back 4073=back
3760 4074
3761=head1 C++ SUPPORT 4075=head1 C++ SUPPORT
3762 4076
4077=head2 C API
4078
4079The normal C API should work fine when used from C++: both ev.h and the
4080libev sources can be compiled as C++. Therefore, code that uses the C API
4081will work fine.
4082
4083Proper exception specifications might have to be added to callbacks passed
4084to libev: exceptions may be thrown only from watcher callbacks, all other
4085callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4086callbacks) must not throw exceptions, and might need a C<noexcept>
4087specification. If you have code that needs to be compiled as both C and
4088C++ you can use the C<EV_NOEXCEPT> macro for this:
4089
4090 static void
4091 fatal_error (const char *msg) EV_NOEXCEPT
4092 {
4093 perror (msg);
4094 abort ();
4095 }
4096
4097 ...
4098 ev_set_syserr_cb (fatal_error);
4099
4100The only API functions that can currently throw exceptions are C<ev_run>,
4101C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
4102because it runs cleanup watchers).
4103
4104Throwing exceptions in watcher callbacks is only supported if libev itself
4105is compiled with a C++ compiler or your C and C++ environments allow
4106throwing exceptions through C libraries (most do).
4107
4108=head2 C++ API
4109
3763Libev comes with some simplistic wrapper classes for C++ that mainly allow 4110Libev comes with some simplistic wrapper classes for C++ that mainly allow
3764you to use some convenience methods to start/stop watchers and also change 4111you to use some convenience methods to start/stop watchers and also change
3765the callback model to a model using method callbacks on objects. 4112the callback model to a model using method callbacks on objects.
3766 4113
3767To use it, 4114To use it,
3768 4115
3769 #include <ev++.h> 4116 #include <ev++.h>
3770 4117
3771This automatically includes F<ev.h> and puts all of its definitions (many 4118This automatically includes F<ev.h> and puts all of its definitions (many
3772of them macros) into the global namespace. All C++ specific things are 4119of them macros) into the global namespace. All C++ specific things are
3773put into the C<ev> namespace. It should support all the same embedding 4120put 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 4129with 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 4130to 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 4131you need support for other types of functors please contact the author
3785(preferably after implementing it). 4132(preferably after implementing it).
3786 4133
4134For all this to work, your C++ compiler either has to use the same calling
4135conventions as your C compiler (for static member functions), or you have
4136to embed libev and compile libev itself as C++.
4137
3787Here is a list of things available in the C<ev> namespace: 4138Here is a list of things available in the C<ev> namespace:
3788 4139
3789=over 4 4140=over 4
3790 4141
3791=item C<ev::READ>, C<ev::WRITE> etc. 4142=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. 4151=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3801 4152
3802For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of 4153For 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> 4154the 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 4155which is called C<ev::sig> to avoid clashes with the C<signal> macro
3805defines by many implementations. 4156defined by many implementations.
3806 4157
3807All of those classes have these methods: 4158All of those classes have these methods:
3808 4159
3809=over 4 4160=over 4
3810 4161
3872 void operator() (ev::io &w, int revents) 4223 void operator() (ev::io &w, int revents)
3873 { 4224 {
3874 ... 4225 ...
3875 } 4226 }
3876 } 4227 }
3877 4228
3878 myfunctor f; 4229 myfunctor f;
3879 4230
3880 ev::io w; 4231 ev::io w;
3881 w.set (&f); 4232 w.set (&f);
3882 4233
3900Associates a different C<struct ev_loop> with this watcher. You can only 4251Associates a different C<struct ev_loop> with this watcher. You can only
3901do this when the watcher is inactive (and not pending either). 4252do this when the watcher is inactive (and not pending either).
3902 4253
3903=item w->set ([arguments]) 4254=item w->set ([arguments])
3904 4255
3905Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4256Basically 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 4257with the same arguments. Either this method or a suitable start method
3907C counterpart, an active watcher gets automatically stopped and restarted 4258must be called at least once. Unlike the C counterpart, an active watcher
3908when reconfiguring it with this method. 4259gets automatically stopped and restarted when reconfiguring it with this
4260method.
4261
4262For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4263clashing with the C<set (loop)> method.
3909 4264
3910=item w->start () 4265=item w->start ()
3911 4266
3912Starts the watcher. Note that there is no C<loop> argument, as the 4267Starts the watcher. Note that there is no C<loop> argument, as the
3913constructor already stores the event loop. 4268constructor already stores the event loop.
3943watchers in the constructor. 4298watchers in the constructor.
3944 4299
3945 class myclass 4300 class myclass
3946 { 4301 {
3947 ev::io io ; void io_cb (ev::io &w, int revents); 4302 ev::io io ; void io_cb (ev::io &w, int revents);
3948 ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4303 ev::io io2 ; void io2_cb (ev::io &w, int revents);
3949 ev::idle idle; void idle_cb (ev::idle &w, int revents); 4304 ev::idle idle; void idle_cb (ev::idle &w, int revents);
3950 4305
3951 myclass (int fd) 4306 myclass (int fd)
3952 { 4307 {
3953 io .set <myclass, &myclass::io_cb > (this); 4308 io .set <myclass, &myclass::io_cb > (this);
4004L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. 4359L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
4005 4360
4006=item D 4361=item D
4007 4362
4008Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 4363Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
4009be found at L<http://proj.llucax.com.ar/wiki/evd>. 4364be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
4010 4365
4011=item Ocaml 4366=item Ocaml
4012 4367
4013Erkki Seppala has written Ocaml bindings for libev, to be found at 4368Erkki Seppala has written Ocaml bindings for libev, to be found at
4014L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 4369L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
4017 4372
4018Brian Maher has written a partial interface to libev for lua (at the 4373Brian 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 4374time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4020L<http://github.com/brimworks/lua-ev>. 4375L<http://github.com/brimworks/lua-ev>.
4021 4376
4377=item Javascript
4378
4379Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4380
4381=item Others
4382
4383There are others, and I stopped counting.
4384
4022=back 4385=back
4023 4386
4024 4387
4025=head1 MACRO MAGIC 4388=head1 MACRO MAGIC
4026 4389
4062suitable for use with C<EV_A>. 4425suitable for use with C<EV_A>.
4063 4426
4064=item C<EV_DEFAULT>, C<EV_DEFAULT_> 4427=item C<EV_DEFAULT>, C<EV_DEFAULT_>
4065 4428
4066Similar to the other two macros, this gives you the value of the default 4429Similar to the other two macros, this gives you the value of the default
4067loop, if multiple loops are supported ("ev loop default"). 4430loop, if multiple loops are supported ("ev loop default"). The default loop
4431will be initialised if it isn't already initialised.
4432
4433For non-multiplicity builds, these macros do nothing, so you always have
4434to initialise the loop somewhere.
4068 4435
4069=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> 4436=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
4070 4437
4071Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the 4438Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
4072default loop has been initialised (C<UC> == unchecked). Their behaviour 4439default loop has been initialised (C<UC> == unchecked). Their behaviour
4139 ev_vars.h 4506 ev_vars.h
4140 ev_wrap.h 4507 ev_wrap.h
4141 4508
4142 ev_win32.c required on win32 platforms only 4509 ev_win32.c required on win32 platforms only
4143 4510
4144 ev_select.c only when select backend is enabled (which is enabled by default) 4511 ev_select.c only when select backend is enabled
4145 ev_poll.c only when poll backend is enabled (disabled by default) 4512 ev_poll.c only when poll backend is enabled
4146 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4513 ev_epoll.c only when the epoll backend is enabled
4514 ev_linuxaio.c only when the linux aio backend is enabled
4515 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) 4516 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) 4517 ev_port.c only when the solaris port backend is enabled
4149 4518
4150F<ev.c> includes the backend files directly when enabled, so you only need 4519F<ev.c> includes the backend files directly when enabled, so you only need
4151to compile this single file. 4520to compile this single file.
4152 4521
4153=head3 LIBEVENT COMPATIBILITY API 4522=head3 LIBEVENT COMPATIBILITY API
4272available and will probe for kernel support at runtime. This will improve 4641available and will probe for kernel support at runtime. This will improve
4273C<ev_signal> and C<ev_async> performance and reduce resource consumption. 4642C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4274If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc 4643If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
42752.7 or newer, otherwise disabled. 46442.7 or newer, otherwise disabled.
4276 4645
4646=item EV_USE_SIGNALFD
4647
4648If defined to be C<1>, then libev will assume that C<signalfd ()> is
4649available and will probe for kernel support at runtime. This enables
4650the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If
4651undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46522.7 or newer, otherwise disabled.
4653
4654=item EV_USE_TIMERFD
4655
4656If defined to be C<1>, then libev will assume that C<timerfd ()> is
4657available and will probe for kernel support at runtime. This allows
4658libev to detect time jumps accurately. If undefined, it will be enabled
4659if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
4660C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled.
4661
4662=item EV_USE_EVENTFD
4663
4664If defined to be C<1>, then libev will assume that C<eventfd ()> is
4665available and will probe for kernel support at runtime. This will improve
4666C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4667If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46682.7 or newer, otherwise disabled.
4669
4277=item EV_USE_SELECT 4670=item EV_USE_SELECT
4278 4671
4279If undefined or defined to be C<1>, libev will compile in support for the 4672If 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 4673C<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 4674other method takes over, select will be it. Otherwise the select backend
4321If programs implement their own fd to handle mapping on win32, then this 4714If 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 4715macro can be used to override the C<close> function, useful to unregister
4323file descriptors again. Note that the replacement function has to close 4716file descriptors again. Note that the replacement function has to close
4324the underlying OS handle. 4717the underlying OS handle.
4325 4718
4719=item EV_USE_WSASOCKET
4720
4721If defined to be C<1>, libev will use C<WSASocket> to create its internal
4722communication socket, which works better in some environments. Otherwise,
4723the normal C<socket> function will be used, which works better in other
4724environments.
4725
4326=item EV_USE_POLL 4726=item EV_USE_POLL
4327 4727
4328If defined to be C<1>, libev will compile in support for the C<poll>(2) 4728If 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 4729backend. Otherwise it will be enabled on non-win32 platforms. It
4330takes precedence over select. 4730takes precedence over select.
4334If defined to be C<1>, libev will compile in support for the Linux 4734If defined to be C<1>, libev will compile in support for the Linux
4335C<epoll>(7) backend. Its availability will be detected at runtime, 4735C<epoll>(7) backend. Its availability will be detected at runtime,
4336otherwise another method will be used as fallback. This is the preferred 4736otherwise another method will be used as fallback. This is the preferred
4337backend for GNU/Linux systems. If undefined, it will be enabled if the 4737backend for GNU/Linux systems. If undefined, it will be enabled if the
4338headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4738headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4739
4740=item EV_USE_LINUXAIO
4741
4742If defined to be C<1>, libev will compile in support for the Linux aio
4743backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be
4744enabled on linux, otherwise disabled.
4745
4746=item EV_USE_IOURING
4747
4748If defined to be C<1>, libev will compile in support for the Linux
4749io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's
4750current limitations it has to be requested explicitly. If undefined, it
4751will be enabled on linux, otherwise disabled.
4339 4752
4340=item EV_USE_KQUEUE 4753=item EV_USE_KQUEUE
4341 4754
4342If defined to be C<1>, libev will compile in support for the BSD style 4755If 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, 4756C<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 4778If 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 4779interface to speed up C<ev_stat> watchers. Its actual availability will
4367be detected at runtime. If undefined, it will be enabled if the headers 4780be detected at runtime. If undefined, it will be enabled if the headers
4368indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4781indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4369 4782
4783=item EV_NO_SMP
4784
4785If defined to be C<1>, libev will assume that memory is always coherent
4786between threads, that is, threads can be used, but threads never run on
4787different cpus (or different cpu cores). This reduces dependencies
4788and makes libev faster.
4789
4790=item EV_NO_THREADS
4791
4792If defined to be C<1>, libev will assume that it will never be called from
4793different threads (that includes signal handlers), which is a stronger
4794assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4795libev faster.
4796
4370=item EV_ATOMIC_T 4797=item EV_ATOMIC_T
4371 4798
4372Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4799Libev 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 4800access 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 4801such 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" 4802type 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. 4803handler "locking" as well as for signal and thread safety in C<ev_async>
4804watchers.
4377 4805
4378In the absence of this define, libev will use C<sig_atomic_t volatile> 4806In 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. 4807(from F<signal.h>), which is usually good enough on most platforms.
4380 4808
4381=item EV_H (h) 4809=item EV_H (h)
4408will have the C<struct ev_loop *> as first argument, and you can create 4836will have the C<struct ev_loop *> as first argument, and you can create
4409additional independent event loops. Otherwise there will be no support 4837additional independent event loops. Otherwise there will be no support
4410for multiple event loops and there is no first event loop pointer 4838for multiple event loops and there is no first event loop pointer
4411argument. Instead, all functions act on the single default loop. 4839argument. Instead, all functions act on the single default loop.
4412 4840
4841Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
4842default loop when multiplicity is switched off - you always have to
4843initialise the loop manually in this case.
4844
4413=item EV_MINPRI 4845=item EV_MINPRI
4414 4846
4415=item EV_MAXPRI 4847=item EV_MAXPRI
4416 4848
4417The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to 4849The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
4453 #define EV_USE_POLL 1 4885 #define EV_USE_POLL 1
4454 #define EV_CHILD_ENABLE 1 4886 #define EV_CHILD_ENABLE 1
4455 #define EV_ASYNC_ENABLE 1 4887 #define EV_ASYNC_ENABLE 1
4456 4888
4457The actual value is a bitset, it can be a combination of the following 4889The actual value is a bitset, it can be a combination of the following
4458values: 4890values (by default, all of these are enabled):
4459 4891
4460=over 4 4892=over 4
4461 4893
4462=item C<1> - faster/larger code 4894=item C<1> - faster/larger code
4463 4895
4467code size by roughly 30% on amd64). 4899code size by roughly 30% on amd64).
4468 4900
4469When optimising for size, use of compiler flags such as C<-Os> with 4901When 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 4902gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4471assertions. 4903assertions.
4904
4905The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4906(e.g. gcc with C<-Os>).
4472 4907
4473=item C<2> - faster/larger data structures 4908=item C<2> - faster/larger data structures
4474 4909
4475Replaces the small 2-heap for timer management by a faster 4-heap, larger 4910Replaces 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 4911hash 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 4912and can additionally have an effect on the size of data structures at
4478runtime. 4913runtime.
4479 4914
4915The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4916(e.g. gcc with C<-Os>).
4917
4480=item C<4> - full API configuration 4918=item C<4> - full API configuration
4481 4919
4482This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and 4920This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4483enables multiplicity (C<EV_MULTIPLICITY>=1). 4921enables multiplicity (C<EV_MULTIPLICITY>=1).
4484 4922
4514 4952
4515With an intelligent-enough linker (gcc+binutils are intelligent enough 4953With an intelligent-enough linker (gcc+binutils are intelligent enough
4516when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by 4954when 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 4955your program might be left out as well - a binary starting a timer and an
4518I/O watcher then might come out at only 5Kb. 4956I/O watcher then might come out at only 5Kb.
4957
4958=item EV_API_STATIC
4959
4960If this symbol is defined (by default it is not), then all identifiers
4961will have static linkage. This means that libev will not export any
4962identifiers, and you cannot link against libev anymore. This can be useful
4963when you embed libev, only want to use libev functions in a single file,
4964and do not want its identifiers to be visible.
4965
4966To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
4967wants to use libev.
4968
4969This option only works when libev is compiled with a C compiler, as C++
4970doesn't support the required declaration syntax.
4519 4971
4520=item EV_AVOID_STDIO 4972=item EV_AVOID_STDIO
4521 4973
4522If this is set to C<1> at compiletime, then libev will avoid using stdio 4974If 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 4975functions (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 5033in. 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 5034called. 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 5035called 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 5036verification code will be called very frequently, which will slow down
4585libev considerably. 5037libev considerably.
5038
5039Verification errors are reported via C's C<assert> mechanism, so if you
5040disable that (e.g. by defining C<NDEBUG>) then no errors will be reported.
4586 5041
4587The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it 5042The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4588will be C<0>. 5043will be C<0>.
4589 5044
4590=item EV_COMMON 5045=item EV_COMMON
4728default loop and triggering an C<ev_async> watcher from the default loop 5183default loop and triggering an C<ev_async> watcher from the default loop
4729watcher callback into the event loop interested in the signal. 5184watcher callback into the event loop interested in the signal.
4730 5185
4731=back 5186=back
4732 5187
4733See also L<THREAD LOCKING EXAMPLE>. 5188See also L</THREAD LOCKING EXAMPLE>.
4734 5189
4735=head3 COROUTINES 5190=head3 COROUTINES
4736 5191
4737Libev is very accommodating to coroutines ("cooperative threads"): 5192Libev is very accommodating to coroutines ("cooperative threads"):
4738libev fully supports nesting calls to its functions from different 5193libev fully supports nesting calls to its functions from different
4903requires, and its I/O model is fundamentally incompatible with the POSIX 5358requires, and its I/O model is fundamentally incompatible with the POSIX
4904model. Libev still offers limited functionality on this platform in 5359model. Libev still offers limited functionality on this platform in
4905the form of the C<EVBACKEND_SELECT> backend, and only supports socket 5360the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4906descriptors. This only applies when using Win32 natively, not when using 5361descriptors. This only applies when using Win32 natively, not when using
4907e.g. cygwin. Actually, it only applies to the microsofts own compilers, 5362e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4908as every compielr comes with a slightly differently broken/incompatible 5363as every compiler comes with a slightly differently broken/incompatible
4909environment. 5364environment.
4910 5365
4911Lifting these limitations would basically require the full 5366Lifting these limitations would basically require the full
4912re-implementation of the I/O system. If you are into this kind of thing, 5367re-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 5368then 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 5462structure (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 5463assumes that the same (machine) code can be used to call any watcher
5009callback: The watcher callbacks have different type signatures, but libev 5464callback: The watcher callbacks have different type signatures, but libev
5010calls them using an C<ev_watcher *> internally. 5465calls them using an C<ev_watcher *> internally.
5011 5466
5467=item null pointers and integer zero are represented by 0 bytes
5468
5469Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
5470relies on this setting pointers and integers to null.
5471
5012=item pointer accesses must be thread-atomic 5472=item pointer accesses must be thread-atomic
5013 5473
5014Accessing a pointer value must be atomic, it must both be readable and 5474Accessing a pointer value must be atomic, it must both be readable and
5015writable in one piece - this is the case on all current architectures. 5475writable in one piece - this is the case on all current architectures.
5016 5476
5029thread" or will block signals process-wide, both behaviours would 5489thread" or will block signals process-wide, both behaviours would
5030be compatible with libev. Interaction between C<sigprocmask> and 5490be compatible with libev. Interaction between C<sigprocmask> and
5031C<pthread_sigmask> could complicate things, however. 5491C<pthread_sigmask> could complicate things, however.
5032 5492
5033The most portable way to handle signals is to block signals in all threads 5493The 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 5494except the initial one, and run the signal handling loop in the initial
5035well. 5495thread as well.
5036 5496
5037=item C<long> must be large enough for common memory allocation sizes 5497=item C<long> must be large enough for common memory allocation sizes
5038 5498
5039To improve portability and simplify its API, libev uses C<long> internally 5499To improve portability and simplify its API, libev uses C<long> internally
5040instead of C<size_t> when allocating its data structures. On non-POSIX 5500instead of C<size_t> when allocating its data structures. On non-POSIX
5046 5506
5047The type C<double> is used to represent timestamps. It is required to 5507The 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 5508have 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 5509good enough for at least into the year 4000 with millisecond accuracy
5050(the design goal for libev). This requirement is overfulfilled by 5510(the design goal for libev). This requirement is overfulfilled by
5051implementations using IEEE 754, which is basically all existing ones. With 5511implementations using IEEE 754, which is basically all existing ones.
5512
5052IEEE 754 doubles, you get microsecond accuracy until at least 2200. 5513With IEEE 754 doubles, you get microsecond accuracy until at least the
5514year 2255 (and millisecond accuracy till the year 287396 - by then, libev
5515is either obsolete or somebody patched it to use C<long double> or
5516something like that, just kidding).
5053 5517
5054=back 5518=back
5055 5519
5056If you know of other additional requirements drop me a note. 5520If you know of other additional requirements drop me a note.
5057 5521
5119=item Processing ev_async_send: O(number_of_async_watchers) 5583=item Processing ev_async_send: O(number_of_async_watchers)
5120 5584
5121=item Processing signals: O(max_signal_number) 5585=item Processing signals: O(max_signal_number)
5122 5586
5123Sending involves a system call I<iff> there were no other C<ev_async_send> 5587Sending 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 5588calls in the current loop iteration and the loop is currently
5589blocked. Checking for async and signal events involves iterating over all
5125involves iterating over all running async watchers or all signal numbers. 5590running async watchers or all signal numbers.
5126 5591
5127=back 5592=back
5128 5593
5129 5594
5130=head1 PORTING FROM LIBEV 3.X TO 4.X 5595=head1 PORTING FROM LIBEV 3.X TO 4.X
5139=over 4 5604=over 4
5140 5605
5141=item C<EV_COMPAT3> backwards compatibility mechanism 5606=item C<EV_COMPAT3> backwards compatibility mechanism
5142 5607
5143The backward compatibility mechanism can be controlled by 5608The backward compatibility mechanism can be controlled by
5144C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5609C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5145section. 5610section.
5146 5611
5147=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5612=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5148 5613
5149These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5614These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5192=over 4 5657=over 4
5193 5658
5194=item active 5659=item active
5195 5660
5196A watcher is active as long as it has been started and not yet stopped. 5661A watcher is active as long as it has been started and not yet stopped.
5197See L<WATCHER STATES> for details. 5662See L</WATCHER STATES> for details.
5198 5663
5199=item application 5664=item application
5200 5665
5201In this document, an application is whatever is using libev. 5666In this document, an application is whatever is using libev.
5202 5667
5238watchers and events. 5703watchers and events.
5239 5704
5240=item pending 5705=item pending
5241 5706
5242A watcher is pending as soon as the corresponding event has been 5707A watcher is pending as soon as the corresponding event has been
5243detected. See L<WATCHER STATES> for details. 5708detected. See L</WATCHER STATES> for details.
5244 5709
5245=item real time 5710=item real time
5246 5711
5247The physical time that is observed. It is apparently strictly monotonic :) 5712The physical time that is observed. It is apparently strictly monotonic :)
5248 5713

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines