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

Comparing libev/ev.pod (file contents):
Revision 1.366 by sf-exg, Thu Feb 3 16:21:08 2011 UTC vs.
Revision 1.456 by root, Tue Jul 2 06:07:54 2019 UTC

1=encoding utf-8
2
1=head1 NAME 3=head1 NAME
2 4
3libev - a high performance full-featured event loop written in C 5libev - a high performance full-featured event loop written in C
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
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 until 189Sleep for the given interval: The current thread will be blocked
184either it is interrupted or the given time interval has passed. Basically 190until either it is interrupted or the given time interval has
191passed (approximately - it might return a bit earlier even if not
192interrupted). Returns immediately if C<< interval <= 0 >>.
193
185this is a sub-second-resolution C<sleep ()>. 194Basically this is a sub-second-resolution C<sleep ()>.
195
196The range of the C<interval> is limited - libev only guarantees to work
197with sleep times of up to one day (C<< interval <= 86400 >>).
186 198
187=item int ev_version_major () 199=item int ev_version_major ()
188 200
189=item int ev_version_minor () 201=item int ev_version_minor ()
190 202
241the 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 ()
242& ev_supported_backends ()>, likewise for recommended ones. 254& ev_supported_backends ()>, likewise for recommended ones.
243 255
244See the description of C<ev_embed> watchers for more info. 256See the description of C<ev_embed> watchers for more info.
245 257
246=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 258=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
247 259
248Sets the allocation function to use (the prototype is similar - the 260Sets the allocation function to use (the prototype is similar - the
249semantics 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
250used 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
251when 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
257 269
258You could override this function in high-availability programs to, say, 270You could override this function in high-availability programs to, say,
259free 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,
260or 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.
261 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
262Example: 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
263retries (example requires a standards-compliant C<realloc>). 289retries.
264 290
265 static void * 291 static void *
266 persistent_realloc (void *ptr, size_t size) 292 persistent_realloc (void *ptr, size_t size)
267 { 293 {
294 if (!size)
295 {
296 free (ptr);
297 return 0;
298 }
299
268 for (;;) 300 for (;;)
269 { 301 {
270 void *newptr = realloc (ptr, size); 302 void *newptr = realloc (ptr, size);
271 303
272 if (newptr) 304 if (newptr)
277 } 309 }
278 310
279 ... 311 ...
280 ev_set_allocator (persistent_realloc); 312 ev_set_allocator (persistent_realloc);
281 313
282=item ev_set_syserr_cb (void (*cb)(const char *msg)) 314=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
283 315
284Set 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
285as failed select, poll, epoll_wait). The message is a printable string 317as failed select, poll, epoll_wait). The message is a printable string
286indicating the system call or subsystem causing the problem. If this 318indicating the system call or subsystem causing the problem. If this
287callback 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
390 422
391If 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
392or setgid) then libev will I<not> look at the environment variable 424or setgid) then libev will I<not> look at the environment variable
393C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 425C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
394override 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
395useful to try out specific backends to test their performance, or to work 427useful to try out specific backends to test their performance, to work
396around 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).
397 431
398=item C<EVFLAG_FORKCHECK> 432=item C<EVFLAG_FORKCHECK>
399 433
400Instead 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
401make 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.
402 436
403This works by calling C<getpid ()> on every iteration of the loop, 437This works by calling C<getpid ()> on every iteration of the loop,
404and thus this might slow down your event loop if you do a lot of loop 438and thus this might slow down your event loop if you do a lot of loop
405iterations and little real work, but is usually not noticeable (on my 439iterations and little real work, but is usually not noticeable (on my
406GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence 440GNU/Linux system for example, C<getpid> is actually a simple 5-insn
407without a system call and thus I<very> fast, but my GNU/Linux system also has 441sequence without a system call and thus I<very> fast, but my GNU/Linux
408C<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).
409 444
410The 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
411forget about forgetting to tell libev about forking) when you use this 446forget about forgetting to tell libev about forking, although you still
412flag. 447have to ignore C<SIGPIPE>) when you use this flag.
413 448
414This 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>
415environment variable. 450environment variable.
416 451
417=item C<EVFLAG_NOINOTIFY> 452=item C<EVFLAG_NOINOTIFY>
435example) that can't properly initialise their signal masks. 470example) that can't properly initialise their signal masks.
436 471
437=item C<EVFLAG_NOSIGMASK> 472=item C<EVFLAG_NOSIGMASK>
438 473
439When 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
440mask. Specifically, this means you ahve to make sure signals are unblocked 475mask. Specifically, this means you have to make sure signals are unblocked
441when you want to receive them. 476when you want to receive them.
442 477
443This 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
444want 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
445unblocking the signals. 480unblocking the signals.
480This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and 515This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
481C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. 516C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
482 517
483=item C<EVBACKEND_EPOLL> (value 4, Linux) 518=item C<EVBACKEND_EPOLL> (value 4, Linux)
484 519
485Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 520Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9
486kernels). 521kernels).
487 522
488For few fds, this backend is a bit little slower than poll and select, 523For few fds, this backend is a bit little slower than poll and select, but
489but it scales phenomenally better. While poll and select usually scale 524it scales phenomenally better. While poll and select usually scale like
490like O(total_fds) where n is the total number of fds (or the highest fd), 525O(total_fds) where total_fds is the total number of fds (or the highest
491epoll scales either O(1) or O(active_fds). 526fd), epoll scales either O(1) or O(active_fds).
492 527
493The epoll mechanism deserves honorable mention as the most misdesigned 528The epoll mechanism deserves honorable mention as the most misdesigned
494of the more advanced event mechanisms: mere annoyances include silently 529of the more advanced event mechanisms: mere annoyances include silently
495dropping file descriptors, requiring a system call per change per file 530dropping file descriptors, requiring a system call per change per file
496descriptor (and unnecessary guessing of parameters), problems with dup, 531descriptor (and unnecessary guessing of parameters), problems with dup,
4990.1ms) and so on. The biggest issue is fork races, however - if a program 5340.1ms) and so on. The biggest issue is fork races, however - if a program
500forks then I<both> parent and child process have to recreate the epoll 535forks then I<both> parent and child process have to recreate the epoll
501set, which can take considerable time (one syscall per file descriptor) 536set, which can take considerable time (one syscall per file descriptor)
502and is of course hard to detect. 537and is of course hard to detect.
503 538
504Epoll is also notoriously buggy - embedding epoll fds I<should> work, but 539Epoll is also notoriously buggy - embedding epoll fds I<should> work,
505of course I<doesn't>, and epoll just loves to report events for totally 540but of course I<doesn't>, and epoll just loves to report events for
506I<different> file descriptors (even already closed ones, so one cannot 541totally I<different> file descriptors (even already closed ones, so
507even remove them from the set) than registered in the set (especially 542one cannot even remove them from the set) than registered in the set
508on SMP systems). Libev tries to counter these spurious notifications by 543(especially on SMP systems). Libev tries to counter these spurious
509employing an additional generation counter and comparing that against the 544notifications by employing an additional generation counter and comparing
510events to filter out spurious ones, recreating the set when required. Last 545that against the events to filter out spurious ones, recreating the set
546when required. Epoll also erroneously rounds down timeouts, but gives you
547no way to know when and by how much, so sometimes you have to busy-wait
548because epoll returns immediately despite a nonzero timeout. And last
511not least, it also refuses to work with some file descriptors which work 549not least, it also refuses to work with some file descriptors which work
512perfectly fine with C<select> (files, many character devices...). 550perfectly fine with C<select> (files, many character devices...).
513 551
514Epoll is truly the train wreck analog among event poll mechanisms, 552Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
515a frankenpoll, cobbled together in a hurry, no thought to design or 553cobbled together in a hurry, no thought to design or interaction with
516interaction with others. 554others. Oh, the pain, will it ever stop...
517 555
518While stopping, setting and starting an I/O watcher in the same iteration 556While stopping, setting and starting an I/O watcher in the same iteration
519will result in some caching, there is still a system call per such 557will result in some caching, there is still a system call per such
520incident (because the same I<file descriptor> could point to a different 558incident (because the same I<file descriptor> could point to a different
521I<file description> now), so its best to avoid that. Also, C<dup ()>'ed 559I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
533All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or 571All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
534faster than epoll for maybe up to a hundred file descriptors, depending on 572faster than epoll for maybe up to a hundred file descriptors, depending on
535the usage. So sad. 573the usage. So sad.
536 574
537While nominally embeddable in other event loops, this feature is broken in 575While nominally embeddable in other event loops, this feature is broken in
538all kernel versions tested so far. 576a lot of kernel revisions, but probably(!) works in current versions.
539 577
540This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 578This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
541C<EVBACKEND_POLL>. 579C<EVBACKEND_POLL>.
542 580
581=item C<EVBACKEND_LINUXAIO> (value 64, Linux)
582
583Use the Linux-specific Linux AIO (I<not> C<< aio(7) >> but C<<
584io_submit(2) >>) event interface available in post-4.18 kernels (but libev
585only tries to use it in 4.19+).
586
587This is another Linux train wreck of an event interface.
588
589If this backend works for you (as of this writing, it was very
590experimental), it is the best event interface available on Linux and might
591be well worth enabling it - if it isn't available in your kernel this will
592be detected and this backend will be skipped.
593
594This backend can batch oneshot requests and supports a user-space ring
595buffer to receive events. It also doesn't suffer from most of the design
596problems of epoll (such as not being able to remove event sources from
597the epoll set), and generally sounds too good to be true. Because, this
598being the Linux kernel, of course it suffers from a whole new set of
599limitations, forcing you to fall back to epoll, inheriting all its design
600issues.
601
602For one, it is not easily embeddable (but probably could be done using
603an event fd at some extra overhead). It also is subject to a system wide
604limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no AIO
605requests are left, this backend will be skipped during initialisation, and
606will switch to epoll when the loop is active.
607
608Most problematic in practice, however, is that not all file descriptors
609work with it. For example, in Linux 5.1, TCP sockets, pipes, event fds,
610files, F</dev/null> and many others are supported, but ttys do not work
611properly (a known bug that the kernel developers don't care about, see
612L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
613(yet?) a generic event polling interface.
614
615Overall, it seems the Linux developers just don't want it to have a
616generic event handling mechanism other than C<select> or C<poll>.
617
618To work around all these problem, the current version of libev uses its
619epoll backend as a fallback for file descriptor types that do not work. Or
620falls back completely to epoll if the kernel acts up.
621
622This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
623C<EVBACKEND_POLL>.
624
543=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 625=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
544 626
545Kqueue deserves special mention, as at the time of this writing, it 627Kqueue deserves special mention, as at the time this backend was
546was broken on all BSDs except NetBSD (usually it doesn't work reliably 628implemented, it was broken on all BSDs except NetBSD (usually it doesn't
547with anything but sockets and pipes, except on Darwin, where of course 629work reliably with anything but sockets and pipes, except on Darwin,
548it's completely useless). Unlike epoll, however, whose brokenness 630where of course it's completely useless). Unlike epoll, however, whose
549is by design, these kqueue bugs can (and eventually will) be fixed 631brokenness is by design, these kqueue bugs can be (and mostly have been)
550without API changes to existing programs. For this reason it's not being 632fixed without API changes to existing programs. For this reason it's not
551"auto-detected" unless you explicitly specify it in the flags (i.e. using 633being "auto-detected" on all platforms unless you explicitly specify it
552C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) 634in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a
553system like NetBSD. 635known-to-be-good (-enough) system like NetBSD.
554 636
555You still can embed kqueue into a normal poll or select backend and use it 637You still can embed kqueue into a normal poll or select backend and use it
556only for sockets (after having made sure that sockets work with kqueue on 638only for sockets (after having made sure that sockets work with kqueue on
557the target platform). See C<ev_embed> watchers for more info. 639the target platform). See C<ev_embed> watchers for more info.
558 640
559It scales in the same way as the epoll backend, but the interface to the 641It scales in the same way as the epoll backend, but the interface to the
560kernel is more efficient (which says nothing about its actual speed, of 642kernel is more efficient (which says nothing about its actual speed, of
561course). While stopping, setting and starting an I/O watcher does never 643course). While stopping, setting and starting an I/O watcher does never
562cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to 644cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
563two event changes per incident. Support for C<fork ()> is very bad (but 645two event changes per incident. Support for C<fork ()> is very bad (you
564sane, unlike epoll) and it drops fds silently in similarly hard-to-detect 646might have to leak fds on fork, but it's more sane than epoll) and it
565cases 647drops fds silently in similarly hard-to-detect cases.
566 648
567This backend usually performs well under most conditions. 649This backend usually performs well under most conditions.
568 650
569While nominally embeddable in other event loops, this doesn't work 651While nominally embeddable in other event loops, this doesn't work
570everywhere, so you might need to test for this. And since it is broken 652everywhere, so you might need to test for this. And since it is broken
599among the OS-specific backends (I vastly prefer correctness over speed 681among the OS-specific backends (I vastly prefer correctness over speed
600hacks). 682hacks).
601 683
602On the negative side, the interface is I<bizarre> - so bizarre that 684On the negative side, the interface is I<bizarre> - so bizarre that
603even sun itself gets it wrong in their code examples: The event polling 685even sun itself gets it wrong in their code examples: The event polling
604function sometimes returning events to the caller even though an error 686function sometimes returns events to the caller even though an error
605occurred, but with no indication whether it has done so or not (yes, it's 687occurred, but with no indication whether it has done so or not (yes, it's
606even documented that way) - deadly for edge-triggered interfaces where 688even documented that way) - deadly for edge-triggered interfaces where you
607you absolutely have to know whether an event occurred or not because you 689absolutely have to know whether an event occurred or not because you have
608have to re-arm the watcher. 690to re-arm the watcher.
609 691
610Fortunately libev seems to be able to work around these idiocies. 692Fortunately libev seems to be able to work around these idiocies.
611 693
612This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 694This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
613C<EVBACKEND_POLL>. 695C<EVBACKEND_POLL>.
643 725
644Example: Use whatever libev has to offer, but make sure that kqueue is 726Example: Use whatever libev has to offer, but make sure that kqueue is
645used if available. 727used if available.
646 728
647 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 729 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
730
731Example: Similarly, on linux, you mgiht want to take advantage of the
732linux aio backend if possible, but fall back to something else if that
733isn't available.
734
735 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
648 736
649=item ev_loop_destroy (loop) 737=item ev_loop_destroy (loop)
650 738
651Destroys an event loop object (frees all memory and kernel state 739Destroys an event loop object (frees all memory and kernel state
652etc.). None of the active event watchers will be stopped in the normal 740etc.). None of the active event watchers will be stopped in the normal
669If you need dynamically allocated loops it is better to use C<ev_loop_new> 757If you need dynamically allocated loops it is better to use C<ev_loop_new>
670and C<ev_loop_destroy>. 758and C<ev_loop_destroy>.
671 759
672=item ev_loop_fork (loop) 760=item ev_loop_fork (loop)
673 761
674This function sets a flag that causes subsequent C<ev_run> iterations to 762This function sets a flag that causes subsequent C<ev_run> iterations
675reinitialise the kernel state for backends that have one. Despite the 763to reinitialise the kernel state for backends that have one. Despite
676name, you can call it anytime, but it makes most sense after forking, in 764the name, you can call it anytime you are allowed to start or stop
677the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the 765watchers (except inside an C<ev_prepare> callback), but it makes most
766sense after forking, in the child process. You I<must> call it (or use
678child before resuming or calling C<ev_run>. 767C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
679 768
769In addition, if you want to reuse a loop (via this function or
770C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>.
771
680Again, you I<have> to call it on I<any> loop that you want to re-use after 772Again, you I<have> to call it on I<any> loop that you want to re-use after
681a fork, I<even if you do not plan to use the loop in the parent>. This is 773a fork, I<even if you do not plan to use the loop in the parent>. This is
682because some kernel interfaces *cough* I<kqueue> *cough* do funny things 774because some kernel interfaces *cough* I<kqueue> *cough* do funny things
683during fork. 775during fork.
684 776
685On the other hand, you only need to call this function in the child 777On the other hand, you only need to call this function in the child
755 847
756This function is rarely useful, but when some event callback runs for a 848This function is rarely useful, but when some event callback runs for a
757very long time without entering the event loop, updating libev's idea of 849very long time without entering the event loop, updating libev's idea of
758the current time is a good idea. 850the current time is a good idea.
759 851
760See also L<The special problem of time updates> in the C<ev_timer> section. 852See also L</The special problem of time updates> in the C<ev_timer> section.
761 853
762=item ev_suspend (loop) 854=item ev_suspend (loop)
763 855
764=item ev_resume (loop) 856=item ev_resume (loop)
765 857
783without a previous call to C<ev_suspend>. 875without a previous call to C<ev_suspend>.
784 876
785Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the 877Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
786event loop time (see C<ev_now_update>). 878event loop time (see C<ev_now_update>).
787 879
788=item ev_run (loop, int flags) 880=item bool ev_run (loop, int flags)
789 881
790Finally, this is it, the event handler. This function usually is called 882Finally, this is it, the event handler. This function usually is called
791after you have initialised all your watchers and you want to start 883after you have initialised all your watchers and you want to start
792handling events. It will ask the operating system for any new events, call 884handling events. It will ask the operating system for any new events, call
793the watcher callbacks, an then repeat the whole process indefinitely: This 885the watcher callbacks, and then repeat the whole process indefinitely: This
794is why event loops are called I<loops>. 886is why event loops are called I<loops>.
795 887
796If the flags argument is specified as C<0>, it will keep handling events 888If the flags argument is specified as C<0>, it will keep handling events
797until either no event watchers are active anymore or C<ev_break> was 889until either no event watchers are active anymore or C<ev_break> was
798called. 890called.
891
892The return value is false if there are no more active watchers (which
893usually means "all jobs done" or "deadlock"), and true in all other cases
894(which usually means " you should call C<ev_run> again").
799 895
800Please note that an explicit C<ev_break> is usually better than 896Please note that an explicit C<ev_break> is usually better than
801relying on all watchers to be stopped when deciding when a program has 897relying on all watchers to be stopped when deciding when a program has
802finished (especially in interactive programs), but having a program 898finished (especially in interactive programs), but having a program
803that automatically loops as long as it has to and no longer by virtue 899that automatically loops as long as it has to and no longer by virtue
804of relying on its watchers stopping correctly, that is truly a thing of 900of relying on its watchers stopping correctly, that is truly a thing of
805beauty. 901beauty.
806 902
807This function is also I<mostly> exception-safe - you can break out of 903This function is I<mostly> exception-safe - you can break out of a
808a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++ 904C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
809exception and so on. This does not decrement the C<ev_depth> value, nor 905exception and so on. This does not decrement the C<ev_depth> value, nor
810will it clear any outstanding C<EVBREAK_ONE> breaks. 906will it clear any outstanding C<EVBREAK_ONE> breaks.
811 907
812A flags value of C<EVRUN_NOWAIT> will look for new events, will handle 908A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
813those events and any already outstanding ones, but will not wait and 909those events and any already outstanding ones, but will not wait and
825This is useful if you are waiting for some external event in conjunction 921This is useful if you are waiting for some external event in conjunction
826with something not expressible using other libev watchers (i.e. "roll your 922with something not expressible using other libev watchers (i.e. "roll your
827own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is 923own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
828usually a better approach for this kind of thing. 924usually a better approach for this kind of thing.
829 925
830Here are the gory details of what C<ev_run> does: 926Here are the gory details of what C<ev_run> does (this is for your
927understanding, not a guarantee that things will work exactly like this in
928future versions):
831 929
832 - Increment loop depth. 930 - Increment loop depth.
833 - Reset the ev_break status. 931 - Reset the ev_break status.
834 - Before the first iteration, call any pending watchers. 932 - Before the first iteration, call any pending watchers.
835 LOOP: 933 LOOP:
941overhead for the actual polling but can deliver many events at once. 1039overhead for the actual polling but can deliver many events at once.
942 1040
943By setting a higher I<io collect interval> you allow libev to spend more 1041By setting a higher I<io collect interval> you allow libev to spend more
944time collecting I/O events, so you can handle more events per iteration, 1042time collecting I/O events, so you can handle more events per iteration,
945at the cost of increasing latency. Timeouts (both C<ev_periodic> and 1043at the cost of increasing latency. Timeouts (both C<ev_periodic> and
946C<ev_timer>) will be not affected. Setting this to a non-null value will 1044C<ev_timer>) will not be affected. Setting this to a non-null value will
947introduce an additional C<ev_sleep ()> call into most loop iterations. The 1045introduce an additional C<ev_sleep ()> call into most loop iterations. The
948sleep time ensures that libev will not poll for I/O events more often then 1046sleep time ensures that libev will not poll for I/O events more often then
949once per this interval, on average. 1047once per this interval, on average (as long as the host time resolution is
1048good enough).
950 1049
951Likewise, by setting a higher I<timeout collect interval> you allow libev 1050Likewise, by setting a higher I<timeout collect interval> you allow libev
952to spend more time collecting timeouts, at the expense of increased 1051to spend more time collecting timeouts, at the expense of increased
953latency/jitter/inexactness (the watcher callback will be called 1052latency/jitter/inexactness (the watcher callback will be called
954later). C<ev_io> watchers will not be affected. Setting this to a non-null 1053later). C<ev_io> watchers will not be affected. Setting this to a non-null
1000invoke the actual watchers inside another context (another thread etc.). 1099invoke the actual watchers inside another context (another thread etc.).
1001 1100
1002If you want to reset the callback, use C<ev_invoke_pending> as new 1101If you want to reset the callback, use C<ev_invoke_pending> as new
1003callback. 1102callback.
1004 1103
1005=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) 1104=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
1006 1105
1007Sometimes you want to share the same loop between multiple threads. This 1106Sometimes you want to share the same loop between multiple threads. This
1008can be done relatively simply by putting mutex_lock/unlock calls around 1107can be done relatively simply by putting mutex_lock/unlock calls around
1009each call to a libev function. 1108each call to a libev function.
1010 1109
1011However, C<ev_run> can run an indefinite time, so it is not feasible 1110However, C<ev_run> can run an indefinite time, so it is not feasible
1012to wait for it to return. One way around this is to wake up the event 1111to wait for it to return. One way around this is to wake up the event
1013loop via C<ev_break> and C<av_async_send>, another way is to set these 1112loop via C<ev_break> and C<ev_async_send>, another way is to set these
1014I<release> and I<acquire> callbacks on the loop. 1113I<release> and I<acquire> callbacks on the loop.
1015 1114
1016When set, then C<release> will be called just before the thread is 1115When set, then C<release> will be called just before the thread is
1017suspended waiting for new events, and C<acquire> is called just 1116suspended waiting for new events, and C<acquire> is called just
1018afterwards. 1117afterwards.
1158 1257
1159=item C<EV_PREPARE> 1258=item C<EV_PREPARE>
1160 1259
1161=item C<EV_CHECK> 1260=item C<EV_CHECK>
1162 1261
1163All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts 1262All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1164to gather new events, and all C<ev_check> watchers are invoked just after 1263gather new events, and all C<ev_check> watchers are queued (not invoked)
1165C<ev_run> has gathered them, but before it invokes any callbacks for any 1264just after C<ev_run> has gathered them, but before it queues any callbacks
1265for any received events. That means C<ev_prepare> watchers are the last
1266watchers invoked before the event loop sleeps or polls for new events, and
1267C<ev_check> watchers will be invoked before any other watchers of the same
1268or lower priority within an event loop iteration.
1269
1166received events. Callbacks of both watcher types can start and stop as 1270Callbacks of both watcher types can start and stop as many watchers as
1167many watchers as they want, and all of them will be taken into account 1271they want, and all of them will be taken into account (for example, a
1168(for example, a C<ev_prepare> watcher might start an idle watcher to keep 1272C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1169C<ev_run> from blocking). 1273blocking).
1170 1274
1171=item C<EV_EMBED> 1275=item C<EV_EMBED>
1172 1276
1173The embedded event loop specified in the C<ev_embed> watcher needs attention. 1277The embedded event loop specified in the C<ev_embed> watcher needs attention.
1174 1278
1297 1401
1298=item callback ev_cb (ev_TYPE *watcher) 1402=item callback ev_cb (ev_TYPE *watcher)
1299 1403
1300Returns the callback currently set on the watcher. 1404Returns the callback currently set on the watcher.
1301 1405
1302=item ev_cb_set (ev_TYPE *watcher, callback) 1406=item ev_set_cb (ev_TYPE *watcher, callback)
1303 1407
1304Change the callback. You can change the callback at virtually any time 1408Change the callback. You can change the callback at virtually any time
1305(modulo threads). 1409(modulo threads).
1306 1410
1307=item ev_set_priority (ev_TYPE *watcher, int priority) 1411=item ev_set_priority (ev_TYPE *watcher, int priority)
1325or might not have been clamped to the valid range. 1429or might not have been clamped to the valid range.
1326 1430
1327The default priority used by watchers when no priority has been set is 1431The default priority used by watchers when no priority has been set is
1328always C<0>, which is supposed to not be too high and not be too low :). 1432always C<0>, which is supposed to not be too high and not be too low :).
1329 1433
1330See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1434See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1331priorities. 1435priorities.
1332 1436
1333=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1437=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1334 1438
1335Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1439Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1360See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related 1464See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1361functions that do not need a watcher. 1465functions that do not need a watcher.
1362 1466
1363=back 1467=back
1364 1468
1365See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1469See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1366OWN COMPOSITE WATCHERS> idioms. 1470OWN COMPOSITE WATCHERS> idioms.
1367 1471
1368=head2 WATCHER STATES 1472=head2 WATCHER STATES
1369 1473
1370There are various watcher states mentioned throughout this manual - 1474There are various watcher states mentioned throughout this manual -
1372transition between them will be described in more detail - and while these 1476transition between them will be described in more detail - and while these
1373rules might look complicated, they usually do "the right thing". 1477rules might look complicated, they usually do "the right thing".
1374 1478
1375=over 4 1479=over 4
1376 1480
1377=item initialiased 1481=item initialised
1378 1482
1379Before a watcher can be registered with the event looop it has to be 1483Before a watcher can be registered with the event loop it has to be
1380initialised. This can be done with a call to C<ev_TYPE_init>, or calls to 1484initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1381C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. 1485C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1382 1486
1383In this state it is simply some block of memory that is suitable for 1487In this state it is simply some block of memory that is suitable for
1384use in an event loop. It can be moved around, freed, reused etc. at 1488use in an event loop. It can be moved around, freed, reused etc. at
1580 1684
1581But really, best use non-blocking mode. 1685But really, best use non-blocking mode.
1582 1686
1583=head3 The special problem of disappearing file descriptors 1687=head3 The special problem of disappearing file descriptors
1584 1688
1585Some backends (e.g. kqueue, epoll) need to be told about closing a file 1689Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1586descriptor (either due to calling C<close> explicitly or any other means, 1690a file descriptor (either due to calling C<close> explicitly or any other
1587such as C<dup2>). The reason is that you register interest in some file 1691means, such as C<dup2>). The reason is that you register interest in some
1588descriptor, but when it goes away, the operating system will silently drop 1692file descriptor, but when it goes away, the operating system will silently
1589this interest. If another file descriptor with the same number then is 1693drop this interest. If another file descriptor with the same number then
1590registered with libev, there is no efficient way to see that this is, in 1694is registered with libev, there is no efficient way to see that this is,
1591fact, a different file descriptor. 1695in fact, a different file descriptor.
1592 1696
1593To avoid having to explicitly tell libev about such cases, libev follows 1697To avoid having to explicitly tell libev about such cases, libev follows
1594the following policy: Each time C<ev_io_set> is being called, libev 1698the following policy: Each time C<ev_io_set> is being called, libev
1595will assume that this is potentially a new file descriptor, otherwise 1699will assume that this is potentially a new file descriptor, otherwise
1596it is assumed that the file descriptor stays the same. That means that 1700it is assumed that the file descriptor stays the same. That means that
1645when you rarely read from a file instead of from a socket, and want to 1749when you rarely read from a file instead of from a socket, and want to
1646reuse the same code path. 1750reuse the same code path.
1647 1751
1648=head3 The special problem of fork 1752=head3 The special problem of fork
1649 1753
1650Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1754Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()>
1651useless behaviour. Libev fully supports fork, but needs to be told about 1755at all or exhibit useless behaviour. Libev fully supports fork, but needs
1652it in the child if you want to continue to use it in the child. 1756to be told about it in the child if you want to continue to use it in the
1757child.
1653 1758
1654To support fork in your child processes, you have to call C<ev_loop_fork 1759To support fork in your child processes, you have to call C<ev_loop_fork
1655()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to 1760()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1656C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1761C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1657 1762
1759detecting time jumps is hard, and some inaccuracies are unavoidable (the 1864detecting time jumps is hard, and some inaccuracies are unavoidable (the
1760monotonic clock option helps a lot here). 1865monotonic clock option helps a lot here).
1761 1866
1762The callback is guaranteed to be invoked only I<after> its timeout has 1867The callback is guaranteed to be invoked only I<after> its timeout has
1763passed (not I<at>, so on systems with very low-resolution clocks this 1868passed (not I<at>, so on systems with very low-resolution clocks this
1764might introduce a small delay). If multiple timers become ready during the 1869might introduce a small delay, see "the special problem of being too
1870early", below). If multiple timers become ready during the same loop
1765same loop iteration then the ones with earlier time-out values are invoked 1871iteration then the ones with earlier time-out values are invoked before
1766before ones of the same priority with later time-out values (but this is 1872ones of the same priority with later time-out values (but this is no
1767no longer true when a callback calls C<ev_run> recursively). 1873longer true when a callback calls C<ev_run> recursively).
1768 1874
1769=head3 Be smart about timeouts 1875=head3 Be smart about timeouts
1770 1876
1771Many real-world problems involve some kind of timeout, usually for error 1877Many real-world problems involve some kind of timeout, usually for error
1772recovery. A typical example is an HTTP request - if the other side hangs, 1878recovery. A typical example is an HTTP request - if the other side hangs,
1847 1953
1848In this case, it would be more efficient to leave the C<ev_timer> alone, 1954In this case, it would be more efficient to leave the C<ev_timer> alone,
1849but remember the time of last activity, and check for a real timeout only 1955but remember the time of last activity, and check for a real timeout only
1850within the callback: 1956within the callback:
1851 1957
1958 ev_tstamp timeout = 60.;
1852 ev_tstamp last_activity; // time of last activity 1959 ev_tstamp last_activity; // time of last activity
1960 ev_timer timer;
1853 1961
1854 static void 1962 static void
1855 callback (EV_P_ ev_timer *w, int revents) 1963 callback (EV_P_ ev_timer *w, int revents)
1856 { 1964 {
1857 ev_tstamp now = ev_now (EV_A); 1965 // calculate when the timeout would happen
1858 ev_tstamp timeout = last_activity + 60.; 1966 ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1859 1967
1860 // if last_activity + 60. is older than now, we did time out 1968 // if negative, it means we the timeout already occurred
1861 if (timeout < now) 1969 if (after < 0.)
1862 { 1970 {
1863 // timeout occurred, take action 1971 // timeout occurred, take action
1864 } 1972 }
1865 else 1973 else
1866 { 1974 {
1867 // callback was invoked, but there was some activity, re-arm 1975 // callback was invoked, but there was some recent
1868 // the watcher to fire in last_activity + 60, which is 1976 // activity. simply restart the timer to time out
1869 // guaranteed to be in the future, so "again" is positive: 1977 // after "after" seconds, which is the earliest time
1870 w->repeat = timeout - now; 1978 // the timeout can occur.
1979 ev_timer_set (w, after, 0.);
1871 ev_timer_again (EV_A_ w); 1980 ev_timer_start (EV_A_ w);
1872 } 1981 }
1873 } 1982 }
1874 1983
1875To summarise the callback: first calculate the real timeout (defined 1984To summarise the callback: first calculate in how many seconds the
1876as "60 seconds after the last activity"), then check if that time has 1985timeout will occur (by calculating the absolute time when it would occur,
1877been reached, which means something I<did>, in fact, time out. Otherwise 1986C<last_activity + timeout>, and subtracting the current time, C<ev_now
1878the callback was invoked too early (C<timeout> is in the future), so 1987(EV_A)> from that).
1879re-schedule the timer to fire at that future time, to see if maybe we have
1880a timeout then.
1881 1988
1882Note how C<ev_timer_again> is used, taking advantage of the 1989If this value is negative, then we are already past the timeout, i.e. we
1883C<ev_timer_again> optimisation when the timer is already running. 1990timed out, and need to do whatever is needed in this case.
1991
1992Otherwise, we now the earliest time at which the timeout would trigger,
1993and simply start the timer with this timeout value.
1994
1995In other words, each time the callback is invoked it will check whether
1996the timeout occurred. If not, it will simply reschedule itself to check
1997again at the earliest time it could time out. Rinse. Repeat.
1884 1998
1885This scheme causes more callback invocations (about one every 60 seconds 1999This scheme causes more callback invocations (about one every 60 seconds
1886minus half the average time between activity), but virtually no calls to 2000minus half the average time between activity), but virtually no calls to
1887libev to change the timeout. 2001libev to change the timeout.
1888 2002
1889To start the timer, simply initialise the watcher and set C<last_activity> 2003To start the machinery, simply initialise the watcher and set
1890to the current time (meaning we just have some activity :), then call the 2004C<last_activity> to the current time (meaning there was some activity just
1891callback, which will "do the right thing" and start the timer: 2005now), then call the callback, which will "do the right thing" and start
2006the timer:
1892 2007
2008 last_activity = ev_now (EV_A);
1893 ev_init (timer, callback); 2009 ev_init (&timer, callback);
1894 last_activity = ev_now (loop); 2010 callback (EV_A_ &timer, 0);
1895 callback (loop, timer, EV_TIMER);
1896 2011
1897And when there is some activity, simply store the current time in 2012When there is some activity, simply store the current time in
1898C<last_activity>, no libev calls at all: 2013C<last_activity>, no libev calls at all:
1899 2014
2015 if (activity detected)
1900 last_activity = ev_now (loop); 2016 last_activity = ev_now (EV_A);
2017
2018When your timeout value changes, then the timeout can be changed by simply
2019providing a new value, stopping the timer and calling the callback, which
2020will again do the right thing (for example, time out immediately :).
2021
2022 timeout = new_value;
2023 ev_timer_stop (EV_A_ &timer);
2024 callback (EV_A_ &timer, 0);
1901 2025
1902This technique is slightly more complex, but in most cases where the 2026This technique is slightly more complex, but in most cases where the
1903time-out is unlikely to be triggered, much more efficient. 2027time-out is unlikely to be triggered, much more efficient.
1904
1905Changing the timeout is trivial as well (if it isn't hard-coded in the
1906callback :) - just change the timeout and invoke the callback, which will
1907fix things for you.
1908 2028
1909=item 4. Wee, just use a double-linked list for your timeouts. 2029=item 4. Wee, just use a double-linked list for your timeouts.
1910 2030
1911If there is not one request, but many thousands (millions...), all 2031If there is not one request, but many thousands (millions...), all
1912employing some kind of timeout with the same timeout value, then one can 2032employing some kind of timeout with the same timeout value, then one can
1939Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 2059Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1940rather complicated, but extremely efficient, something that really pays 2060rather complicated, but extremely efficient, something that really pays
1941off after the first million or so of active timers, i.e. it's usually 2061off after the first million or so of active timers, i.e. it's usually
1942overkill :) 2062overkill :)
1943 2063
2064=head3 The special problem of being too early
2065
2066If you ask a timer to call your callback after three seconds, then
2067you expect it to be invoked after three seconds - but of course, this
2068cannot be guaranteed to infinite precision. Less obviously, it cannot be
2069guaranteed to any precision by libev - imagine somebody suspending the
2070process with a STOP signal for a few hours for example.
2071
2072So, libev tries to invoke your callback as soon as possible I<after> the
2073delay has occurred, but cannot guarantee this.
2074
2075A less obvious failure mode is calling your callback too early: many event
2076loops compare timestamps with a "elapsed delay >= requested delay", but
2077this can cause your callback to be invoked much earlier than you would
2078expect.
2079
2080To see why, imagine a system with a clock that only offers full second
2081resolution (think windows if you can't come up with a broken enough OS
2082yourself). If you schedule a one-second timer at the time 500.9, then the
2083event loop will schedule your timeout to elapse at a system time of 500
2084(500.9 truncated to the resolution) + 1, or 501.
2085
2086If an event library looks at the timeout 0.1s later, it will see "501 >=
2087501" and invoke the callback 0.1s after it was started, even though a
2088one-second delay was requested - this is being "too early", despite best
2089intentions.
2090
2091This is the reason why libev will never invoke the callback if the elapsed
2092delay equals the requested delay, but only when the elapsed delay is
2093larger than the requested delay. In the example above, libev would only invoke
2094the callback at system time 502, or 1.1s after the timer was started.
2095
2096So, while libev cannot guarantee that your callback will be invoked
2097exactly when requested, it I<can> and I<does> guarantee that the requested
2098delay has actually elapsed, or in other words, it always errs on the "too
2099late" side of things.
2100
1944=head3 The special problem of time updates 2101=head3 The special problem of time updates
1945 2102
1946Establishing the current time is a costly operation (it usually takes at 2103Establishing the current time is a costly operation (it usually takes
1947least two system calls): EV therefore updates its idea of the current 2104at least one system call): EV therefore updates its idea of the current
1948time only before and after C<ev_run> collects new events, which causes a 2105time only before and after C<ev_run> collects new events, which causes a
1949growing difference between C<ev_now ()> and C<ev_time ()> when handling 2106growing difference between C<ev_now ()> and C<ev_time ()> when handling
1950lots of events in one iteration. 2107lots of events in one iteration.
1951 2108
1952The relative timeouts are calculated relative to the C<ev_now ()> 2109The relative timeouts are calculated relative to the C<ev_now ()>
1953time. This is usually the right thing as this timestamp refers to the time 2110time. This is usually the right thing as this timestamp refers to the time
1954of the event triggering whatever timeout you are modifying/starting. If 2111of the event triggering whatever timeout you are modifying/starting. If
1955you suspect event processing to be delayed and you I<need> to base the 2112you suspect event processing to be delayed and you I<need> to base the
1956timeout on the current time, use something like this to adjust for this: 2113timeout on the current time, use something like the following to adjust
2114for it:
1957 2115
1958 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2116 ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
1959 2117
1960If the event loop is suspended for a long time, you can also force an 2118If the event loop is suspended for a long time, you can also force an
1961update of the time returned by C<ev_now ()> by calling C<ev_now_update 2119update of the time returned by C<ev_now ()> by calling C<ev_now_update
1962()>. 2120()>, although that will push the event time of all outstanding events
2121further into the future.
2122
2123=head3 The special problem of unsynchronised clocks
2124
2125Modern systems have a variety of clocks - libev itself uses the normal
2126"wall clock" clock and, if available, the monotonic clock (to avoid time
2127jumps).
2128
2129Neither of these clocks is synchronised with each other or any other clock
2130on the system, so C<ev_time ()> might return a considerably different time
2131than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
2132a call to C<gettimeofday> might return a second count that is one higher
2133than a directly following call to C<time>.
2134
2135The moral of this is to only compare libev-related timestamps with
2136C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
2137a second or so.
2138
2139One more problem arises due to this lack of synchronisation: if libev uses
2140the system monotonic clock and you compare timestamps from C<ev_time>
2141or C<ev_now> from when you started your timer and when your callback is
2142invoked, you will find that sometimes the callback is a bit "early".
2143
2144This is because C<ev_timer>s work in real time, not wall clock time, so
2145libev makes sure your callback is not invoked before the delay happened,
2146I<measured according to the real time>, not the system clock.
2147
2148If your timeouts are based on a physical timescale (e.g. "time out this
2149connection after 100 seconds") then this shouldn't bother you as it is
2150exactly the right behaviour.
2151
2152If you want to compare wall clock/system timestamps to your timers, then
2153you need to use C<ev_periodic>s, as these are based on the wall clock
2154time, where your comparisons will always generate correct results.
1963 2155
1964=head3 The special problems of suspended animation 2156=head3 The special problems of suspended animation
1965 2157
1966When you leave the server world it is quite customary to hit machines that 2158When you leave the server world it is quite customary to hit machines that
1967can suspend/hibernate - what happens to the clocks during such a suspend? 2159can suspend/hibernate - what happens to the clocks during such a suspend?
1997 2189
1998=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 2190=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1999 2191
2000=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 2192=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
2001 2193
2002Configure the timer to trigger after C<after> seconds. If C<repeat> 2194Configure the timer to trigger after C<after> seconds (fractional and
2003is C<0.>, then it will automatically be stopped once the timeout is 2195negative values are supported). If C<repeat> is C<0.>, then it will
2004reached. If it is positive, then the timer will automatically be 2196automatically be stopped once the timeout is reached. If it is positive,
2005configured to trigger again C<repeat> seconds later, again, and again, 2197then the timer will automatically be configured to trigger again C<repeat>
2006until stopped manually. 2198seconds later, again, and again, until stopped manually.
2007 2199
2008The timer itself will do a best-effort at avoiding drift, that is, if 2200The timer itself will do a best-effort at avoiding drift, that is, if
2009you configure a timer to trigger every 10 seconds, then it will normally 2201you configure a timer to trigger every 10 seconds, then it will normally
2010trigger at exactly 10 second intervals. If, however, your program cannot 2202trigger at exactly 10 second intervals. If, however, your program cannot
2011keep up with the timer (because it takes longer than those 10 seconds to 2203keep up with the timer (because it takes longer than those 10 seconds to
2012do stuff) the timer will not fire more than once per event loop iteration. 2204do stuff) the timer will not fire more than once per event loop iteration.
2013 2205
2014=item ev_timer_again (loop, ev_timer *) 2206=item ev_timer_again (loop, ev_timer *)
2015 2207
2016This will act as if the timer timed out and restart it again if it is 2208This will act as if the timer timed out, and restarts it again if it is
2017repeating. The exact semantics are: 2209repeating. It basically works like calling C<ev_timer_stop>, updating the
2210timeout to the C<repeat> value and calling C<ev_timer_start>.
2018 2211
2212The exact semantics are as in the following rules, all of which will be
2213applied to the watcher:
2214
2215=over 4
2216
2019If the timer is pending, its pending status is cleared. 2217=item If the timer is pending, the pending status is always cleared.
2020 2218
2021If the timer is started but non-repeating, stop it (as if it timed out). 2219=item If the timer is started but non-repeating, stop it (as if it timed
2220out, without invoking it).
2022 2221
2023If the timer is repeating, either start it if necessary (with the 2222=item If the timer is repeating, make the C<repeat> value the new timeout
2024C<repeat> value), or reset the running timer to the C<repeat> value. 2223and start the timer, if necessary.
2025 2224
2225=back
2226
2026This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2227This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2027usage example. 2228usage example.
2028 2229
2029=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2230=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2030 2231
2031Returns the remaining time until a timer fires. If the timer is active, 2232Returns the remaining time until a timer fires. If the timer is active,
2084Periodic watchers are also timers of a kind, but they are very versatile 2285Periodic watchers are also timers of a kind, but they are very versatile
2085(and unfortunately a bit complex). 2286(and unfortunately a bit complex).
2086 2287
2087Unlike C<ev_timer>, periodic watchers are not based on real time (or 2288Unlike C<ev_timer>, periodic watchers are not based on real time (or
2088relative time, the physical time that passes) but on wall clock time 2289relative time, the physical time that passes) but on wall clock time
2089(absolute time, the thing you can read on your calender or clock). The 2290(absolute time, the thing you can read on your calendar or clock). The
2090difference is that wall clock time can run faster or slower than real 2291difference is that wall clock time can run faster or slower than real
2091time, and time jumps are not uncommon (e.g. when you adjust your 2292time, and time jumps are not uncommon (e.g. when you adjust your
2092wrist-watch). 2293wrist-watch).
2093 2294
2094You can tell a periodic watcher to trigger after some specific point 2295You can tell a periodic watcher to trigger after some specific point
2099C<ev_timer>, which would still trigger roughly 10 seconds after starting 2300C<ev_timer>, which would still trigger roughly 10 seconds after starting
2100it, as it uses a relative timeout). 2301it, as it uses a relative timeout).
2101 2302
2102C<ev_periodic> watchers can also be used to implement vastly more complex 2303C<ev_periodic> watchers can also be used to implement vastly more complex
2103timers, such as triggering an event on each "midnight, local time", or 2304timers, such as triggering an event on each "midnight, local time", or
2104other complicated rules. This cannot be done with C<ev_timer> watchers, as 2305other complicated rules. This cannot easily be done with C<ev_timer>
2105those cannot react to time jumps. 2306watchers, as those cannot react to time jumps.
2106 2307
2107As with timers, the callback is guaranteed to be invoked only when the 2308As with timers, the callback is guaranteed to be invoked only when the
2108point in time where it is supposed to trigger has passed. If multiple 2309point in time where it is supposed to trigger has passed. If multiple
2109timers become ready during the same loop iteration then the ones with 2310timers become ready during the same loop iteration then the ones with
2110earlier time-out values are invoked before ones with later time-out values 2311earlier time-out values are invoked before ones with later time-out values
2151 2352
2152Another way to think about it (for the mathematically inclined) is that 2353Another way to think about it (for the mathematically inclined) is that
2153C<ev_periodic> will try to run the callback in this mode at the next possible 2354C<ev_periodic> will try to run the callback in this mode at the next possible
2154time where C<time = offset (mod interval)>, regardless of any time jumps. 2355time where C<time = offset (mod interval)>, regardless of any time jumps.
2155 2356
2156For numerical stability it is preferable that the C<offset> value is near 2357The C<interval> I<MUST> be positive, and for numerical stability, the
2157C<ev_now ()> (the current time), but there is no range requirement for 2358interval value should be higher than C<1/8192> (which is around 100
2158this value, and in fact is often specified as zero. 2359microseconds) and C<offset> should be higher than C<0> and should have
2360at most a similar magnitude as the current time (say, within a factor of
2361ten). Typical values for offset are, in fact, C<0> or something between
2362C<0> and C<interval>, which is also the recommended range.
2159 2363
2160Note also that there is an upper limit to how often a timer can fire (CPU 2364Note also that there is an upper limit to how often a timer can fire (CPU
2161speed for example), so if C<interval> is very small then timing stability 2365speed for example), so if C<interval> is very small then timing stability
2162will of course deteriorate. Libev itself tries to be exact to be about one 2366will of course deteriorate. Libev itself tries to be exact to be about one
2163millisecond (if the OS supports it and the machine is fast enough). 2367millisecond (if the OS supports it and the machine is fast enough).
2193 2397
2194NOTE: I<< This callback must always return a time that is higher than or 2398NOTE: I<< This callback must always return a time that is higher than or
2195equal to the passed C<now> value >>. 2399equal to the passed C<now> value >>.
2196 2400
2197This can be used to create very complex timers, such as a timer that 2401This can be used to create very complex timers, such as a timer that
2198triggers on "next midnight, local time". To do this, you would calculate the 2402triggers on "next midnight, local time". To do this, you would calculate
2199next midnight after C<now> and return the timestamp value for this. How 2403the next midnight after C<now> and return the timestamp value for
2200you do this is, again, up to you (but it is not trivial, which is the main 2404this. Here is a (completely untested, no error checking) example on how to
2201reason I omitted it as an example). 2405do this:
2406
2407 #include <time.h>
2408
2409 static ev_tstamp
2410 my_rescheduler (ev_periodic *w, ev_tstamp now)
2411 {
2412 time_t tnow = (time_t)now;
2413 struct tm tm;
2414 localtime_r (&tnow, &tm);
2415
2416 tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2417 ++tm.tm_mday; // midnight next day
2418
2419 return mktime (&tm);
2420 }
2421
2422Note: this code might run into trouble on days that have more then two
2423midnights (beginning and end).
2202 2424
2203=back 2425=back
2204 2426
2205=item ev_periodic_again (loop, ev_periodic *) 2427=item ev_periodic_again (loop, ev_periodic *)
2206 2428
2271 2493
2272 ev_periodic hourly_tick; 2494 ev_periodic hourly_tick;
2273 ev_periodic_init (&hourly_tick, clock_cb, 2495 ev_periodic_init (&hourly_tick, clock_cb,
2274 fmod (ev_now (loop), 3600.), 3600., 0); 2496 fmod (ev_now (loop), 3600.), 3600., 0);
2275 ev_periodic_start (loop, &hourly_tick); 2497 ev_periodic_start (loop, &hourly_tick);
2276 2498
2277 2499
2278=head2 C<ev_signal> - signal me when a signal gets signalled! 2500=head2 C<ev_signal> - signal me when a signal gets signalled!
2279 2501
2280Signal watchers will trigger an event when the process receives a specific 2502Signal watchers will trigger an event when the process receives a specific
2281signal one or more times. Even though signals are very asynchronous, libev 2503signal one or more times. Even though signals are very asynchronous, libev
2291only within the same loop, i.e. you can watch for C<SIGINT> in your 2513only within the same loop, i.e. you can watch for C<SIGINT> in your
2292default loop and for C<SIGIO> in another loop, but you cannot watch for 2514default loop and for C<SIGIO> in another loop, but you cannot watch for
2293C<SIGINT> in both the default loop and another loop at the same time. At 2515C<SIGINT> in both the default loop and another loop at the same time. At
2294the moment, C<SIGCHLD> is permanently tied to the default loop. 2516the moment, C<SIGCHLD> is permanently tied to the default loop.
2295 2517
2296When the first watcher gets started will libev actually register something 2518Only after the first watcher for a signal is started will libev actually
2297with the kernel (thus it coexists with your own signal handlers as long as 2519register something with the kernel. It thus coexists with your own signal
2298you don't register any with libev for the same signal). 2520handlers as long as you don't register any with libev for the same signal.
2299 2521
2300If possible and supported, libev will install its handlers with 2522If possible and supported, libev will install its handlers with
2301C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2523C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2302not be unduly interrupted. If you have a problem with system calls getting 2524not be unduly interrupted. If you have a problem with system calls getting
2303interrupted by signals you can block all signals in an C<ev_check> watcher 2525interrupted by signals you can block all signals in an C<ev_check> watcher
2488 2710
2489=head2 C<ev_stat> - did the file attributes just change? 2711=head2 C<ev_stat> - did the file attributes just change?
2490 2712
2491This watches a file system path for attribute changes. That is, it calls 2713This watches a file system path for attribute changes. That is, it calls
2492C<stat> on that path in regular intervals (or when the OS says it changed) 2714C<stat> on that path in regular intervals (or when the OS says it changed)
2493and sees if it changed compared to the last time, invoking the callback if 2715and sees if it changed compared to the last time, invoking the callback
2494it did. 2716if it did. Starting the watcher C<stat>'s the file, so only changes that
2717happen after the watcher has been started will be reported.
2495 2718
2496The path does not need to exist: changing from "path exists" to "path does 2719The path does not need to exist: changing from "path exists" to "path does
2497not exist" is a status change like any other. The condition "path does not 2720not exist" is a status change like any other. The condition "path does not
2498exist" (or more correctly "path cannot be stat'ed") is signified by the 2721exist" (or more correctly "path cannot be stat'ed") is signified by the
2499C<st_nlink> field being zero (which is otherwise always forced to be at 2722C<st_nlink> field being zero (which is otherwise always forced to be at
2729Apart from keeping your process non-blocking (which is a useful 2952Apart from keeping your process non-blocking (which is a useful
2730effect on its own sometimes), idle watchers are a good place to do 2953effect on its own sometimes), idle watchers are a good place to do
2731"pseudo-background processing", or delay processing stuff to after the 2954"pseudo-background processing", or delay processing stuff to after the
2732event loop has handled all outstanding events. 2955event loop has handled all outstanding events.
2733 2956
2957=head3 Abusing an C<ev_idle> watcher for its side-effect
2958
2959As long as there is at least one active idle watcher, libev will never
2960sleep unnecessarily. Or in other words, it will loop as fast as possible.
2961For this to work, the idle watcher doesn't need to be invoked at all - the
2962lowest priority will do.
2963
2964This mode of operation can be useful together with an C<ev_check> watcher,
2965to do something on each event loop iteration - for example to balance load
2966between different connections.
2967
2968See L</Abusing an ev_check watcher for its side-effect> for a longer
2969example.
2970
2734=head3 Watcher-Specific Functions and Data Members 2971=head3 Watcher-Specific Functions and Data Members
2735 2972
2736=over 4 2973=over 4
2737 2974
2738=item ev_idle_init (ev_idle *, callback) 2975=item ev_idle_init (ev_idle *, callback)
2749callback, free it. Also, use no error checking, as usual. 2986callback, free it. Also, use no error checking, as usual.
2750 2987
2751 static void 2988 static void
2752 idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 2989 idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2753 { 2990 {
2991 // stop the watcher
2992 ev_idle_stop (loop, w);
2993
2994 // now we can free it
2754 free (w); 2995 free (w);
2996
2755 // now do something you wanted to do when the program has 2997 // now do something you wanted to do when the program has
2756 // no longer anything immediate to do. 2998 // no longer anything immediate to do.
2757 } 2999 }
2758 3000
2759 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3001 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2761 ev_idle_start (loop, idle_watcher); 3003 ev_idle_start (loop, idle_watcher);
2762 3004
2763 3005
2764=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 3006=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2765 3007
2766Prepare and check watchers are usually (but not always) used in pairs: 3008Prepare and check watchers are often (but not always) used in pairs:
2767prepare watchers get invoked before the process blocks and check watchers 3009prepare watchers get invoked before the process blocks and check watchers
2768afterwards. 3010afterwards.
2769 3011
2770You I<must not> call C<ev_run> or similar functions that enter 3012You I<must not> call C<ev_run> (or similar functions that enter the
2771the current event loop from either C<ev_prepare> or C<ev_check> 3013current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2772watchers. Other loops than the current one are fine, however. The 3014C<ev_check> watchers. Other loops than the current one are fine,
2773rationale behind this is that you do not need to check for recursion in 3015however. The rationale behind this is that you do not need to check
2774those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, 3016for recursion in those watchers, i.e. the sequence will always be
2775C<ev_check> so if you have one watcher of each kind they will always be 3017C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2776called in pairs bracketing the blocking call. 3018kind they will always be called in pairs bracketing the blocking call.
2777 3019
2778Their main purpose is to integrate other event mechanisms into libev and 3020Their main purpose is to integrate other event mechanisms into libev and
2779their use is somewhat advanced. They could be used, for example, to track 3021their use is somewhat advanced. They could be used, for example, to track
2780variable changes, implement your own watchers, integrate net-snmp or a 3022variable changes, implement your own watchers, integrate net-snmp or a
2781coroutine library and lots more. They are also occasionally useful if 3023coroutine library and lots more. They are also occasionally useful if
2799with priority higher than or equal to the event loop and one coroutine 3041with priority higher than or equal to the event loop and one coroutine
2800of lower priority, but only once, using idle watchers to keep the event 3042of lower priority, but only once, using idle watchers to keep the event
2801loop from blocking if lower-priority coroutines are active, thus mapping 3043loop from blocking if lower-priority coroutines are active, thus mapping
2802low-priority coroutines to idle/background tasks). 3044low-priority coroutines to idle/background tasks).
2803 3045
2804It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 3046When used for this purpose, it is recommended to give C<ev_check> watchers
2805priority, to ensure that they are being run before any other watchers 3047highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2806after the poll (this doesn't matter for C<ev_prepare> watchers). 3048any other watchers after the poll (this doesn't matter for C<ev_prepare>
3049watchers).
2807 3050
2808Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not 3051Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2809activate ("feed") events into libev. While libev fully supports this, they 3052activate ("feed") events into libev. While libev fully supports this, they
2810might get executed before other C<ev_check> watchers did their job. As 3053might get executed before other C<ev_check> watchers did their job. As
2811C<ev_check> watchers are often used to embed other (non-libev) event 3054C<ev_check> watchers are often used to embed other (non-libev) event
2812loops those other event loops might be in an unusable state until their 3055loops those other event loops might be in an unusable state until their
2813C<ev_check> watcher ran (always remind yourself to coexist peacefully with 3056C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2814others). 3057others).
3058
3059=head3 Abusing an C<ev_check> watcher for its side-effect
3060
3061C<ev_check> (and less often also C<ev_prepare>) watchers can also be
3062useful because they are called once per event loop iteration. For
3063example, if you want to handle a large number of connections fairly, you
3064normally only do a bit of work for each active connection, and if there
3065is more work to do, you wait for the next event loop iteration, so other
3066connections have a chance of making progress.
3067
3068Using an C<ev_check> watcher is almost enough: it will be called on the
3069next event loop iteration. However, that isn't as soon as possible -
3070without external events, your C<ev_check> watcher will not be invoked.
3071
3072This is where C<ev_idle> watchers come in handy - all you need is a
3073single global idle watcher that is active as long as you have one active
3074C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
3075will not sleep, and the C<ev_check> watcher makes sure a callback gets
3076invoked. Neither watcher alone can do that.
2815 3077
2816=head3 Watcher-Specific Functions and Data Members 3078=head3 Watcher-Specific Functions and Data Members
2817 3079
2818=over 4 3080=over 4
2819 3081
3020 3282
3021=over 4 3283=over 4
3022 3284
3023=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3285=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3024 3286
3025=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3287=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3026 3288
3027Configures the watcher to embed the given loop, which must be 3289Configures the watcher to embed the given loop, which must be
3028embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3290embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3029invoked automatically, otherwise it is the responsibility of the callback 3291invoked automatically, otherwise it is the responsibility of the callback
3030to invoke it (it will continue to be called until the sweep has been done, 3292to invoke it (it will continue to be called until the sweep has been done,
3051used). 3313used).
3052 3314
3053 struct ev_loop *loop_hi = ev_default_init (0); 3315 struct ev_loop *loop_hi = ev_default_init (0);
3054 struct ev_loop *loop_lo = 0; 3316 struct ev_loop *loop_lo = 0;
3055 ev_embed embed; 3317 ev_embed embed;
3056 3318
3057 // see if there is a chance of getting one that works 3319 // see if there is a chance of getting one that works
3058 // (remember that a flags value of 0 means autodetection) 3320 // (remember that a flags value of 0 means autodetection)
3059 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3321 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3060 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3322 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3061 : 0; 3323 : 0;
3075C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3337C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3076 3338
3077 struct ev_loop *loop = ev_default_init (0); 3339 struct ev_loop *loop = ev_default_init (0);
3078 struct ev_loop *loop_socket = 0; 3340 struct ev_loop *loop_socket = 0;
3079 ev_embed embed; 3341 ev_embed embed;
3080 3342
3081 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3343 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3082 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3344 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3083 { 3345 {
3084 ev_embed_init (&embed, 0, loop_socket); 3346 ev_embed_init (&embed, 0, loop_socket);
3085 ev_embed_start (loop, &embed); 3347 ev_embed_start (loop, &embed);
3093 3355
3094=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3356=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3095 3357
3096Fork watchers are called when a C<fork ()> was detected (usually because 3358Fork watchers are called when a C<fork ()> was detected (usually because
3097whoever is a good citizen cared to tell libev about it by calling 3359whoever is a good citizen cared to tell libev about it by calling
3098C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the 3360C<ev_loop_fork>). The invocation is done before the event loop blocks next
3099event loop blocks next and before C<ev_check> watchers are being called, 3361and before C<ev_check> watchers are being called, and only in the child
3100and only in the child after the fork. If whoever good citizen calling 3362after the fork. If whoever good citizen calling C<ev_default_fork> cheats
3101C<ev_default_fork> cheats and calls it in the wrong process, the fork 3363and calls it in the wrong process, the fork handlers will be invoked, too,
3102handlers will be invoked, too, of course. 3364of course.
3103 3365
3104=head3 The special problem of life after fork - how is it possible? 3366=head3 The special problem of life after fork - how is it possible?
3105 3367
3106Most uses of C<fork()> consist of forking, then some simple calls to set 3368Most uses of C<fork ()> consist of forking, then some simple calls to set
3107up/change the process environment, followed by a call to C<exec()>. This 3369up/change the process environment, followed by a call to C<exec()>. This
3108sequence should be handled by libev without any problems. 3370sequence should be handled by libev without any problems.
3109 3371
3110This changes when the application actually wants to do event handling 3372This changes when the application actually wants to do event handling
3111in the child, or both parent in child, in effect "continuing" after the 3373in the child, or both parent in child, in effect "continuing" after the
3200it by calling C<ev_async_send>, which is thread- and signal safe. 3462it by calling C<ev_async_send>, which is thread- and signal safe.
3201 3463
3202This functionality is very similar to C<ev_signal> watchers, as signals, 3464This functionality is very similar to C<ev_signal> watchers, as signals,
3203too, are asynchronous in nature, and signals, too, will be compressed 3465too, are asynchronous in nature, and signals, too, will be compressed
3204(i.e. the number of callback invocations may be less than the number of 3466(i.e. the number of callback invocations may be less than the number of
3205C<ev_async_sent> calls). In fact, you could use signal watchers as a kind 3467C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3206of "global async watchers" by using a watcher on an otherwise unused 3468of "global async watchers" by using a watcher on an otherwise unused
3207signal, and C<ev_feed_signal> to signal this watcher from another thread, 3469signal, and C<ev_feed_signal> to signal this watcher from another thread,
3208even without knowing which loop owns the signal. 3470even without knowing which loop owns the signal.
3209
3210Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3211just the default loop.
3212 3471
3213=head3 Queueing 3472=head3 Queueing
3214 3473
3215C<ev_async> does not support queueing of data in any way. The reason 3474C<ev_async> does not support queueing of data in any way. The reason
3216is that the author does not know of a simple (or any) algorithm for a 3475is that the author does not know of a simple (or any) algorithm for a
3316Unlike C<ev_feed_event>, this call is safe to do from other threads, 3575Unlike C<ev_feed_event>, this call is safe to do from other threads,
3317signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the 3576signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3318embedding section below on what exactly this means). 3577embedding section below on what exactly this means).
3319 3578
3320Note that, as with other watchers in libev, multiple events might get 3579Note that, as with other watchers in libev, multiple events might get
3321compressed into a single callback invocation (another way to look at this 3580compressed into a single callback invocation (another way to look at
3322is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, 3581this is that C<ev_async> watchers are level-triggered: they are set on
3323reset when the event loop detects that). 3582C<ev_async_send>, reset when the event loop detects that).
3324 3583
3325This call incurs the overhead of a system call only once per event loop 3584This call incurs the overhead of at most one extra system call per event
3326iteration, so while the overhead might be noticeable, it doesn't apply to 3585loop iteration, if the event loop is blocked, and no syscall at all if
3327repeated calls to C<ev_async_send> for the same event loop. 3586the event loop (or your program) is processing events. That means that
3587repeated calls are basically free (there is no need to avoid calls for
3588performance reasons) and that the overhead becomes smaller (typically
3589zero) under load.
3328 3590
3329=item bool = ev_async_pending (ev_async *) 3591=item bool = ev_async_pending (ev_async *)
3330 3592
3331Returns a non-zero value when C<ev_async_send> has been called on the 3593Returns a non-zero value when C<ev_async_send> has been called on the
3332watcher but the event has not yet been processed (or even noted) by the 3594watcher but the event has not yet been processed (or even noted) by the
3349 3611
3350There are some other functions of possible interest. Described. Here. Now. 3612There are some other functions of possible interest. Described. Here. Now.
3351 3613
3352=over 4 3614=over 4
3353 3615
3354=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 3616=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3355 3617
3356This function combines a simple timer and an I/O watcher, calls your 3618This function combines a simple timer and an I/O watcher, calls your
3357callback on whichever event happens first and automatically stops both 3619callback on whichever event happens first and automatically stops both
3358watchers. This is useful if you want to wait for a single event on an fd 3620watchers. This is useful if you want to wait for a single event on an fd
3359or timeout without having to allocate/configure/start/stop/free one or 3621or timeout without having to allocate/configure/start/stop/free one or
3387 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3649 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3388 3650
3389=item ev_feed_fd_event (loop, int fd, int revents) 3651=item ev_feed_fd_event (loop, int fd, int revents)
3390 3652
3391Feed an event on the given fd, as if a file descriptor backend detected 3653Feed an event on the given fd, as if a file descriptor backend detected
3392the given events it. 3654the given events.
3393 3655
3394=item ev_feed_signal_event (loop, int signum) 3656=item ev_feed_signal_event (loop, int signum)
3395 3657
3396Feed an event as if the given signal occurred. See also C<ev_feed_signal>, 3658Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3397which is async-safe. 3659which is async-safe.
3471 { 3733 {
3472 struct my_biggy big = (struct my_biggy *) 3734 struct my_biggy big = (struct my_biggy *)
3473 (((char *)w) - offsetof (struct my_biggy, t2)); 3735 (((char *)w) - offsetof (struct my_biggy, t2));
3474 } 3736 }
3475 3737
3738=head2 AVOIDING FINISHING BEFORE RETURNING
3739
3740Often you have structures like this in event-based programs:
3741
3742 callback ()
3743 {
3744 free (request);
3745 }
3746
3747 request = start_new_request (..., callback);
3748
3749The intent is to start some "lengthy" operation. The C<request> could be
3750used to cancel the operation, or do other things with it.
3751
3752It's not uncommon to have code paths in C<start_new_request> that
3753immediately invoke the callback, for example, to report errors. Or you add
3754some caching layer that finds that it can skip the lengthy aspects of the
3755operation and simply invoke the callback with the result.
3756
3757The problem here is that this will happen I<before> C<start_new_request>
3758has returned, so C<request> is not set.
3759
3760Even if you pass the request by some safer means to the callback, you
3761might want to do something to the request after starting it, such as
3762canceling it, which probably isn't working so well when the callback has
3763already been invoked.
3764
3765A common way around all these issues is to make sure that
3766C<start_new_request> I<always> returns before the callback is invoked. If
3767C<start_new_request> immediately knows the result, it can artificially
3768delay invoking the callback by using a C<prepare> or C<idle> watcher for
3769example, or more sneakily, by reusing an existing (stopped) watcher and
3770pushing it into the pending queue:
3771
3772 ev_set_cb (watcher, callback);
3773 ev_feed_event (EV_A_ watcher, 0);
3774
3775This way, C<start_new_request> can safely return before the callback is
3776invoked, while not delaying callback invocation too much.
3777
3476=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS 3778=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
3477 3779
3478Often (especially in GUI toolkits) there are places where you have 3780Often (especially in GUI toolkits) there are places where you have
3479I<modal> interaction, which is most easily implemented by recursively 3781I<modal> interaction, which is most easily implemented by recursively
3480invoking C<ev_run>. 3782invoking C<ev_run>.
3481 3783
3482This brings the problem of exiting - a callback might want to finish the 3784This brings the problem of exiting - a callback might want to finish the
3483main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but 3785main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3484a modal "Are you sure?" dialog is still waiting), or just the nested one 3786a modal "Are you sure?" dialog is still waiting), or just the nested one
3485and not the main one (e.g. user clocked "Ok" in a modal dialog), or some 3787and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3486other combination: In these cases, C<ev_break> will not work alone. 3788other combination: In these cases, a simple C<ev_break> will not work.
3487 3789
3488The solution is to maintain "break this loop" variable for each C<ev_run> 3790The solution is to maintain "break this loop" variable for each C<ev_run>
3489invocation, and use a loop around C<ev_run> until the condition is 3791invocation, and use a loop around C<ev_run> until the condition is
3490triggered, using C<EVRUN_ONCE>: 3792triggered, using C<EVRUN_ONCE>:
3491 3793
3493 int exit_main_loop = 0; 3795 int exit_main_loop = 0;
3494 3796
3495 while (!exit_main_loop) 3797 while (!exit_main_loop)
3496 ev_run (EV_DEFAULT_ EVRUN_ONCE); 3798 ev_run (EV_DEFAULT_ EVRUN_ONCE);
3497 3799
3498 // in a model watcher 3800 // in a modal watcher
3499 int exit_nested_loop = 0; 3801 int exit_nested_loop = 0;
3500 3802
3501 while (!exit_nested_loop) 3803 while (!exit_nested_loop)
3502 ev_run (EV_A_ EVRUN_ONCE); 3804 ev_run (EV_A_ EVRUN_ONCE);
3503 3805
3677called): 3979called):
3678 3980
3679 void 3981 void
3680 wait_for_event (ev_watcher *w) 3982 wait_for_event (ev_watcher *w)
3681 { 3983 {
3682 ev_cb_set (w) = current_coro; 3984 ev_set_cb (w, current_coro);
3683 switch_to (libev_coro); 3985 switch_to (libev_coro);
3684 } 3986 }
3685 3987
3686That basically suspends the coroutine inside C<wait_for_event> and 3988That basically suspends the coroutine inside C<wait_for_event> and
3687continues the libev coroutine, which, when appropriate, switches back to 3989continues the libev coroutine, which, when appropriate, switches back to
3688this or any other coroutine. I am sure if you sue this your own :) 3990this or any other coroutine.
3689 3991
3690You can do similar tricks if you have, say, threads with an event queue - 3992You can do similar tricks if you have, say, threads with an event queue -
3691instead of storing a coroutine, you store the queue object and instead of 3993instead of storing a coroutine, you store the queue object and instead of
3692switching to a coroutine, you push the watcher onto the queue and notify 3994switching to a coroutine, you push the watcher onto the queue and notify
3693any waiters. 3995any waiters.
3694 3996
3695To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 3997To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3696files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 3998files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3697 3999
3698 // my_ev.h 4000 // my_ev.h
3699 #define EV_CB_DECLARE(type) struct my_coro *cb; 4001 #define EV_CB_DECLARE(type) struct my_coro *cb;
3700 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 4002 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3701 #include "../libev/ev.h" 4003 #include "../libev/ev.h"
3702 4004
3703 // my_ev.c 4005 // my_ev.c
3704 #define EV_H "my_ev.h" 4006 #define EV_H "my_ev.h"
3705 #include "../libev/ev.c" 4007 #include "../libev/ev.c"
3744 4046
3745=back 4047=back
3746 4048
3747=head1 C++ SUPPORT 4049=head1 C++ SUPPORT
3748 4050
4051=head2 C API
4052
4053The normal C API should work fine when used from C++: both ev.h and the
4054libev sources can be compiled as C++. Therefore, code that uses the C API
4055will work fine.
4056
4057Proper exception specifications might have to be added to callbacks passed
4058to libev: exceptions may be thrown only from watcher callbacks, all other
4059callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4060callbacks) must not throw exceptions, and might need a C<noexcept>
4061specification. If you have code that needs to be compiled as both C and
4062C++ you can use the C<EV_NOEXCEPT> macro for this:
4063
4064 static void
4065 fatal_error (const char *msg) EV_NOEXCEPT
4066 {
4067 perror (msg);
4068 abort ();
4069 }
4070
4071 ...
4072 ev_set_syserr_cb (fatal_error);
4073
4074The only API functions that can currently throw exceptions are C<ev_run>,
4075C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
4076because it runs cleanup watchers).
4077
4078Throwing exceptions in watcher callbacks is only supported if libev itself
4079is compiled with a C++ compiler or your C and C++ environments allow
4080throwing exceptions through C libraries (most do).
4081
4082=head2 C++ API
4083
3749Libev comes with some simplistic wrapper classes for C++ that mainly allow 4084Libev comes with some simplistic wrapper classes for C++ that mainly allow
3750you to use some convenience methods to start/stop watchers and also change 4085you to use some convenience methods to start/stop watchers and also change
3751the callback model to a model using method callbacks on objects. 4086the callback model to a model using method callbacks on objects.
3752 4087
3753To use it, 4088To use it,
3754 4089
3755 #include <ev++.h> 4090 #include <ev++.h>
3756 4091
3757This automatically includes F<ev.h> and puts all of its definitions (many 4092This automatically includes F<ev.h> and puts all of its definitions (many
3758of them macros) into the global namespace. All C++ specific things are 4093of them macros) into the global namespace. All C++ specific things are
3759put into the C<ev> namespace. It should support all the same embedding 4094put into the C<ev> namespace. It should support all the same embedding
3768with C<operator ()> can be used as callbacks. Other types should be easy 4103with C<operator ()> can be used as callbacks. Other types should be easy
3769to add as long as they only need one additional pointer for context. If 4104to add as long as they only need one additional pointer for context. If
3770you need support for other types of functors please contact the author 4105you need support for other types of functors please contact the author
3771(preferably after implementing it). 4106(preferably after implementing it).
3772 4107
4108For all this to work, your C++ compiler either has to use the same calling
4109conventions as your C compiler (for static member functions), or you have
4110to embed libev and compile libev itself as C++.
4111
3773Here is a list of things available in the C<ev> namespace: 4112Here is a list of things available in the C<ev> namespace:
3774 4113
3775=over 4 4114=over 4
3776 4115
3777=item C<ev::READ>, C<ev::WRITE> etc. 4116=item C<ev::READ>, C<ev::WRITE> etc.
3786=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. 4125=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3787 4126
3788For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of 4127For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3789the same name in the C<ev> namespace, with the exception of C<ev_signal> 4128the same name in the C<ev> namespace, with the exception of C<ev_signal>
3790which is called C<ev::sig> to avoid clashes with the C<signal> macro 4129which is called C<ev::sig> to avoid clashes with the C<signal> macro
3791defines by many implementations. 4130defined by many implementations.
3792 4131
3793All of those classes have these methods: 4132All of those classes have these methods:
3794 4133
3795=over 4 4134=over 4
3796 4135
3858 void operator() (ev::io &w, int revents) 4197 void operator() (ev::io &w, int revents)
3859 { 4198 {
3860 ... 4199 ...
3861 } 4200 }
3862 } 4201 }
3863 4202
3864 myfunctor f; 4203 myfunctor f;
3865 4204
3866 ev::io w; 4205 ev::io w;
3867 w.set (&f); 4206 w.set (&f);
3868 4207
3886Associates a different C<struct ev_loop> with this watcher. You can only 4225Associates a different C<struct ev_loop> with this watcher. You can only
3887do this when the watcher is inactive (and not pending either). 4226do this when the watcher is inactive (and not pending either).
3888 4227
3889=item w->set ([arguments]) 4228=item w->set ([arguments])
3890 4229
3891Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4230Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
3892method or a suitable start method must be called at least once. Unlike the 4231with the same arguments. Either this method or a suitable start method
3893C counterpart, an active watcher gets automatically stopped and restarted 4232must be called at least once. Unlike the C counterpart, an active watcher
3894when reconfiguring it with this method. 4233gets automatically stopped and restarted when reconfiguring it with this
4234method.
4235
4236For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4237clashing with the C<set (loop)> method.
3895 4238
3896=item w->start () 4239=item w->start ()
3897 4240
3898Starts the watcher. Note that there is no C<loop> argument, as the 4241Starts the watcher. Note that there is no C<loop> argument, as the
3899constructor already stores the event loop. 4242constructor already stores the event loop.
3929watchers in the constructor. 4272watchers in the constructor.
3930 4273
3931 class myclass 4274 class myclass
3932 { 4275 {
3933 ev::io io ; void io_cb (ev::io &w, int revents); 4276 ev::io io ; void io_cb (ev::io &w, int revents);
3934 ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4277 ev::io io2 ; void io2_cb (ev::io &w, int revents);
3935 ev::idle idle; void idle_cb (ev::idle &w, int revents); 4278 ev::idle idle; void idle_cb (ev::idle &w, int revents);
3936 4279
3937 myclass (int fd) 4280 myclass (int fd)
3938 { 4281 {
3939 io .set <myclass, &myclass::io_cb > (this); 4282 io .set <myclass, &myclass::io_cb > (this);
3990L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. 4333L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3991 4334
3992=item D 4335=item D
3993 4336
3994Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 4337Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3995be found at L<http://proj.llucax.com.ar/wiki/evd>. 4338be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3996 4339
3997=item Ocaml 4340=item Ocaml
3998 4341
3999Erkki Seppala has written Ocaml bindings for libev, to be found at 4342Erkki Seppala has written Ocaml bindings for libev, to be found at
4000L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 4343L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
4003 4346
4004Brian Maher has written a partial interface to libev for lua (at the 4347Brian Maher has written a partial interface to libev for lua (at the
4005time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4348time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4006L<http://github.com/brimworks/lua-ev>. 4349L<http://github.com/brimworks/lua-ev>.
4007 4350
4351=item Javascript
4352
4353Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4354
4355=item Others
4356
4357There are others, and I stopped counting.
4358
4008=back 4359=back
4009 4360
4010 4361
4011=head1 MACRO MAGIC 4362=head1 MACRO MAGIC
4012 4363
4048suitable for use with C<EV_A>. 4399suitable for use with C<EV_A>.
4049 4400
4050=item C<EV_DEFAULT>, C<EV_DEFAULT_> 4401=item C<EV_DEFAULT>, C<EV_DEFAULT_>
4051 4402
4052Similar to the other two macros, this gives you the value of the default 4403Similar to the other two macros, this gives you the value of the default
4053loop, if multiple loops are supported ("ev loop default"). 4404loop, if multiple loops are supported ("ev loop default"). The default loop
4405will be initialised if it isn't already initialised.
4406
4407For non-multiplicity builds, these macros do nothing, so you always have
4408to initialise the loop somewhere.
4054 4409
4055=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> 4410=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
4056 4411
4057Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the 4412Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
4058default loop has been initialised (C<UC> == unchecked). Their behaviour 4413default loop has been initialised (C<UC> == unchecked). Their behaviour
4125 ev_vars.h 4480 ev_vars.h
4126 ev_wrap.h 4481 ev_wrap.h
4127 4482
4128 ev_win32.c required on win32 platforms only 4483 ev_win32.c required on win32 platforms only
4129 4484
4130 ev_select.c only when select backend is enabled (which is enabled by default) 4485 ev_select.c only when select backend is enabled
4131 ev_poll.c only when poll backend is enabled (disabled by default) 4486 ev_poll.c only when poll backend is enabled
4132 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4487 ev_epoll.c only when the epoll backend is enabled
4488 ev_linuxaio.c only when the linux aio backend is enabled
4489 ev_iouring.c only when the linux io_uring backend is enabled
4133 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4490 ev_kqueue.c only when the kqueue backend is enabled
4134 ev_port.c only when the solaris port backend is enabled (disabled by default) 4491 ev_port.c only when the solaris port backend is enabled
4135 4492
4136F<ev.c> includes the backend files directly when enabled, so you only need 4493F<ev.c> includes the backend files directly when enabled, so you only need
4137to compile this single file. 4494to compile this single file.
4138 4495
4139=head3 LIBEVENT COMPATIBILITY API 4496=head3 LIBEVENT COMPATIBILITY API
4203supported). It will also not define any of the structs usually found in 4560supported). It will also not define any of the structs usually found in
4204F<event.h> that are not directly supported by the libev core alone. 4561F<event.h> that are not directly supported by the libev core alone.
4205 4562
4206In standalone mode, libev will still try to automatically deduce the 4563In standalone mode, libev will still try to automatically deduce the
4207configuration, but has to be more conservative. 4564configuration, but has to be more conservative.
4565
4566=item EV_USE_FLOOR
4567
4568If defined to be C<1>, libev will use the C<floor ()> function for its
4569periodic reschedule calculations, otherwise libev will fall back on a
4570portable (slower) implementation. If you enable this, you usually have to
4571link against libm or something equivalent. Enabling this when the C<floor>
4572function is not available will fail, so the safe default is to not enable
4573this.
4208 4574
4209=item EV_USE_MONOTONIC 4575=item EV_USE_MONOTONIC
4210 4576
4211If defined to be C<1>, libev will try to detect the availability of the 4577If defined to be C<1>, libev will try to detect the availability of the
4212monotonic clock option at both compile time and runtime. Otherwise no 4578monotonic clock option at both compile time and runtime. Otherwise no
4298If programs implement their own fd to handle mapping on win32, then this 4664If programs implement their own fd to handle mapping on win32, then this
4299macro can be used to override the C<close> function, useful to unregister 4665macro can be used to override the C<close> function, useful to unregister
4300file descriptors again. Note that the replacement function has to close 4666file descriptors again. Note that the replacement function has to close
4301the underlying OS handle. 4667the underlying OS handle.
4302 4668
4669=item EV_USE_WSASOCKET
4670
4671If defined to be C<1>, libev will use C<WSASocket> to create its internal
4672communication socket, which works better in some environments. Otherwise,
4673the normal C<socket> function will be used, which works better in other
4674environments.
4675
4303=item EV_USE_POLL 4676=item EV_USE_POLL
4304 4677
4305If defined to be C<1>, libev will compile in support for the C<poll>(2) 4678If defined to be C<1>, libev will compile in support for the C<poll>(2)
4306backend. Otherwise it will be enabled on non-win32 platforms. It 4679backend. Otherwise it will be enabled on non-win32 platforms. It
4307takes precedence over select. 4680takes precedence over select.
4311If defined to be C<1>, libev will compile in support for the Linux 4684If defined to be C<1>, libev will compile in support for the Linux
4312C<epoll>(7) backend. Its availability will be detected at runtime, 4685C<epoll>(7) backend. Its availability will be detected at runtime,
4313otherwise another method will be used as fallback. This is the preferred 4686otherwise another method will be used as fallback. This is the preferred
4314backend for GNU/Linux systems. If undefined, it will be enabled if the 4687backend for GNU/Linux systems. If undefined, it will be enabled if the
4315headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4688headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4689
4690=item EV_USE_LINUXAIO
4691
4692If defined to be C<1>, libev will compile in support for the Linux aio
4693backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be
4694enabled on linux, otherwise disabled.
4695
4696=item EV_USE_IOURING
4697
4698If defined to be C<1>, libev will compile in support for the Linux
4699io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's
4700current limitations it has to be requested explicitly. If undefined, it
4701will be enabled on linux, otherwise disabled.
4316 4702
4317=item EV_USE_KQUEUE 4703=item EV_USE_KQUEUE
4318 4704
4319If defined to be C<1>, libev will compile in support for the BSD style 4705If defined to be C<1>, libev will compile in support for the BSD style
4320C<kqueue>(2) backend. Its actual availability will be detected at runtime, 4706C<kqueue>(2) backend. Its actual availability will be detected at runtime,
4342If defined to be C<1>, libev will compile in support for the Linux inotify 4728If defined to be C<1>, libev will compile in support for the Linux inotify
4343interface to speed up C<ev_stat> watchers. Its actual availability will 4729interface to speed up C<ev_stat> watchers. Its actual availability will
4344be detected at runtime. If undefined, it will be enabled if the headers 4730be detected at runtime. If undefined, it will be enabled if the headers
4345indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4731indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4346 4732
4733=item EV_NO_SMP
4734
4735If defined to be C<1>, libev will assume that memory is always coherent
4736between threads, that is, threads can be used, but threads never run on
4737different cpus (or different cpu cores). This reduces dependencies
4738and makes libev faster.
4739
4740=item EV_NO_THREADS
4741
4742If defined to be C<1>, libev will assume that it will never be called from
4743different threads (that includes signal handlers), which is a stronger
4744assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4745libev faster.
4746
4347=item EV_ATOMIC_T 4747=item EV_ATOMIC_T
4348 4748
4349Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4749Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4350access is atomic with respect to other threads or signal contexts. No such 4750access is atomic with respect to other threads or signal contexts. No
4351type is easily found in the C language, so you can provide your own type 4751such type is easily found in the C language, so you can provide your own
4352that you know is safe for your purposes. It is used both for signal handler "locking" 4752type that you know is safe for your purposes. It is used both for signal
4353as well as for signal and thread safety in C<ev_async> watchers. 4753handler "locking" as well as for signal and thread safety in C<ev_async>
4754watchers.
4354 4755
4355In the absence of this define, libev will use C<sig_atomic_t volatile> 4756In the absence of this define, libev will use C<sig_atomic_t volatile>
4356(from F<signal.h>), which is usually good enough on most platforms. 4757(from F<signal.h>), which is usually good enough on most platforms.
4357 4758
4358=item EV_H (h) 4759=item EV_H (h)
4385will have the C<struct ev_loop *> as first argument, and you can create 4786will have the C<struct ev_loop *> as first argument, and you can create
4386additional independent event loops. Otherwise there will be no support 4787additional independent event loops. Otherwise there will be no support
4387for multiple event loops and there is no first event loop pointer 4788for multiple event loops and there is no first event loop pointer
4388argument. Instead, all functions act on the single default loop. 4789argument. Instead, all functions act on the single default loop.
4389 4790
4791Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
4792default loop when multiplicity is switched off - you always have to
4793initialise the loop manually in this case.
4794
4390=item EV_MINPRI 4795=item EV_MINPRI
4391 4796
4392=item EV_MAXPRI 4797=item EV_MAXPRI
4393 4798
4394The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to 4799The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
4430 #define EV_USE_POLL 1 4835 #define EV_USE_POLL 1
4431 #define EV_CHILD_ENABLE 1 4836 #define EV_CHILD_ENABLE 1
4432 #define EV_ASYNC_ENABLE 1 4837 #define EV_ASYNC_ENABLE 1
4433 4838
4434The actual value is a bitset, it can be a combination of the following 4839The actual value is a bitset, it can be a combination of the following
4435values: 4840values (by default, all of these are enabled):
4436 4841
4437=over 4 4842=over 4
4438 4843
4439=item C<1> - faster/larger code 4844=item C<1> - faster/larger code
4440 4845
4444code size by roughly 30% on amd64). 4849code size by roughly 30% on amd64).
4445 4850
4446When optimising for size, use of compiler flags such as C<-Os> with 4851When optimising for size, use of compiler flags such as C<-Os> with
4447gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of 4852gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4448assertions. 4853assertions.
4854
4855The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4856(e.g. gcc with C<-Os>).
4449 4857
4450=item C<2> - faster/larger data structures 4858=item C<2> - faster/larger data structures
4451 4859
4452Replaces the small 2-heap for timer management by a faster 4-heap, larger 4860Replaces the small 2-heap for timer management by a faster 4-heap, larger
4453hash table sizes and so on. This will usually further increase code size 4861hash table sizes and so on. This will usually further increase code size
4454and can additionally have an effect on the size of data structures at 4862and can additionally have an effect on the size of data structures at
4455runtime. 4863runtime.
4456 4864
4865The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4866(e.g. gcc with C<-Os>).
4867
4457=item C<4> - full API configuration 4868=item C<4> - full API configuration
4458 4869
4459This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and 4870This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4460enables multiplicity (C<EV_MULTIPLICITY>=1). 4871enables multiplicity (C<EV_MULTIPLICITY>=1).
4461 4872
4491 4902
4492With an intelligent-enough linker (gcc+binutils are intelligent enough 4903With an intelligent-enough linker (gcc+binutils are intelligent enough
4493when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by 4904when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
4494your program might be left out as well - a binary starting a timer and an 4905your program might be left out as well - a binary starting a timer and an
4495I/O watcher then might come out at only 5Kb. 4906I/O watcher then might come out at only 5Kb.
4907
4908=item EV_API_STATIC
4909
4910If this symbol is defined (by default it is not), then all identifiers
4911will have static linkage. This means that libev will not export any
4912identifiers, and you cannot link against libev anymore. This can be useful
4913when you embed libev, only want to use libev functions in a single file,
4914and do not want its identifiers to be visible.
4915
4916To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
4917wants to use libev.
4918
4919This option only works when libev is compiled with a C compiler, as C++
4920doesn't support the required declaration syntax.
4496 4921
4497=item EV_AVOID_STDIO 4922=item EV_AVOID_STDIO
4498 4923
4499If this is set to C<1> at compiletime, then libev will avoid using stdio 4924If this is set to C<1> at compiletime, then libev will avoid using stdio
4500functions (printf, scanf, perror etc.). This will increase the code size 4925functions (printf, scanf, perror etc.). This will increase the code size
4558in. If set to C<1>, then verification code will be compiled in, but not 4983in. If set to C<1>, then verification code will be compiled in, but not
4559called. If set to C<2>, then the internal verification code will be 4984called. If set to C<2>, then the internal verification code will be
4560called once per loop, which can slow down libev. If set to C<3>, then the 4985called once per loop, which can slow down libev. If set to C<3>, then the
4561verification code will be called very frequently, which will slow down 4986verification code will be called very frequently, which will slow down
4562libev considerably. 4987libev considerably.
4988
4989Verification errors are reported via C's C<assert> mechanism, so if you
4990disable that (e.g. by defining C<NDEBUG>) then no errors will be reported.
4563 4991
4564The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it 4992The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4565will be C<0>. 4993will be C<0>.
4566 4994
4567=item EV_COMMON 4995=item EV_COMMON
4705default loop and triggering an C<ev_async> watcher from the default loop 5133default loop and triggering an C<ev_async> watcher from the default loop
4706watcher callback into the event loop interested in the signal. 5134watcher callback into the event loop interested in the signal.
4707 5135
4708=back 5136=back
4709 5137
4710See also L<THREAD LOCKING EXAMPLE>. 5138See also L</THREAD LOCKING EXAMPLE>.
4711 5139
4712=head3 COROUTINES 5140=head3 COROUTINES
4713 5141
4714Libev is very accommodating to coroutines ("cooperative threads"): 5142Libev is very accommodating to coroutines ("cooperative threads"):
4715libev fully supports nesting calls to its functions from different 5143libev fully supports nesting calls to its functions from different
4880requires, and its I/O model is fundamentally incompatible with the POSIX 5308requires, and its I/O model is fundamentally incompatible with the POSIX
4881model. Libev still offers limited functionality on this platform in 5309model. Libev still offers limited functionality on this platform in
4882the form of the C<EVBACKEND_SELECT> backend, and only supports socket 5310the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4883descriptors. This only applies when using Win32 natively, not when using 5311descriptors. This only applies when using Win32 natively, not when using
4884e.g. cygwin. Actually, it only applies to the microsofts own compilers, 5312e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4885as every compielr comes with a slightly differently broken/incompatible 5313as every compiler comes with a slightly differently broken/incompatible
4886environment. 5314environment.
4887 5315
4888Lifting these limitations would basically require the full 5316Lifting these limitations would basically require the full
4889re-implementation of the I/O system. If you are into this kind of thing, 5317re-implementation of the I/O system. If you are into this kind of thing,
4890then note that glib does exactly that for you in a very portable way (note 5318then note that glib does exactly that for you in a very portable way (note
4984structure (guaranteed by POSIX but not by ISO C for example), but it also 5412structure (guaranteed by POSIX but not by ISO C for example), but it also
4985assumes that the same (machine) code can be used to call any watcher 5413assumes that the same (machine) code can be used to call any watcher
4986callback: The watcher callbacks have different type signatures, but libev 5414callback: The watcher callbacks have different type signatures, but libev
4987calls them using an C<ev_watcher *> internally. 5415calls them using an C<ev_watcher *> internally.
4988 5416
5417=item null pointers and integer zero are represented by 0 bytes
5418
5419Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
5420relies on this setting pointers and integers to null.
5421
4989=item pointer accesses must be thread-atomic 5422=item pointer accesses must be thread-atomic
4990 5423
4991Accessing a pointer value must be atomic, it must both be readable and 5424Accessing a pointer value must be atomic, it must both be readable and
4992writable in one piece - this is the case on all current architectures. 5425writable in one piece - this is the case on all current architectures.
4993 5426
5006thread" or will block signals process-wide, both behaviours would 5439thread" or will block signals process-wide, both behaviours would
5007be compatible with libev. Interaction between C<sigprocmask> and 5440be compatible with libev. Interaction between C<sigprocmask> and
5008C<pthread_sigmask> could complicate things, however. 5441C<pthread_sigmask> could complicate things, however.
5009 5442
5010The most portable way to handle signals is to block signals in all threads 5443The most portable way to handle signals is to block signals in all threads
5011except the initial one, and run the default loop in the initial thread as 5444except the initial one, and run the signal handling loop in the initial
5012well. 5445thread as well.
5013 5446
5014=item C<long> must be large enough for common memory allocation sizes 5447=item C<long> must be large enough for common memory allocation sizes
5015 5448
5016To improve portability and simplify its API, libev uses C<long> internally 5449To improve portability and simplify its API, libev uses C<long> internally
5017instead of C<size_t> when allocating its data structures. On non-POSIX 5450instead of C<size_t> when allocating its data structures. On non-POSIX
5023 5456
5024The type C<double> is used to represent timestamps. It is required to 5457The type C<double> is used to represent timestamps. It is required to
5025have at least 51 bits of mantissa (and 9 bits of exponent), which is 5458have at least 51 bits of mantissa (and 9 bits of exponent), which is
5026good enough for at least into the year 4000 with millisecond accuracy 5459good enough for at least into the year 4000 with millisecond accuracy
5027(the design goal for libev). This requirement is overfulfilled by 5460(the design goal for libev). This requirement is overfulfilled by
5028implementations using IEEE 754, which is basically all existing ones. With 5461implementations using IEEE 754, which is basically all existing ones.
5462
5029IEEE 754 doubles, you get microsecond accuracy until at least 2200. 5463With IEEE 754 doubles, you get microsecond accuracy until at least the
5464year 2255 (and millisecond accuracy till the year 287396 - by then, libev
5465is either obsolete or somebody patched it to use C<long double> or
5466something like that, just kidding).
5030 5467
5031=back 5468=back
5032 5469
5033If you know of other additional requirements drop me a note. 5470If you know of other additional requirements drop me a note.
5034 5471
5096=item Processing ev_async_send: O(number_of_async_watchers) 5533=item Processing ev_async_send: O(number_of_async_watchers)
5097 5534
5098=item Processing signals: O(max_signal_number) 5535=item Processing signals: O(max_signal_number)
5099 5536
5100Sending involves a system call I<iff> there were no other C<ev_async_send> 5537Sending involves a system call I<iff> there were no other C<ev_async_send>
5101calls in the current loop iteration. Checking for async and signal events 5538calls in the current loop iteration and the loop is currently
5539blocked. Checking for async and signal events involves iterating over all
5102involves iterating over all running async watchers or all signal numbers. 5540running async watchers or all signal numbers.
5103 5541
5104=back 5542=back
5105 5543
5106 5544
5107=head1 PORTING FROM LIBEV 3.X TO 4.X 5545=head1 PORTING FROM LIBEV 3.X TO 4.X
5116=over 4 5554=over 4
5117 5555
5118=item C<EV_COMPAT3> backwards compatibility mechanism 5556=item C<EV_COMPAT3> backwards compatibility mechanism
5119 5557
5120The backward compatibility mechanism can be controlled by 5558The backward compatibility mechanism can be controlled by
5121C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5559C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5122section. 5560section.
5123 5561
5124=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5562=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5125 5563
5126These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5564These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5169=over 4 5607=over 4
5170 5608
5171=item active 5609=item active
5172 5610
5173A watcher is active as long as it has been started and not yet stopped. 5611A watcher is active as long as it has been started and not yet stopped.
5174See L<WATCHER STATES> for details. 5612See L</WATCHER STATES> for details.
5175 5613
5176=item application 5614=item application
5177 5615
5178In this document, an application is whatever is using libev. 5616In this document, an application is whatever is using libev.
5179 5617
5215watchers and events. 5653watchers and events.
5216 5654
5217=item pending 5655=item pending
5218 5656
5219A watcher is pending as soon as the corresponding event has been 5657A watcher is pending as soon as the corresponding event has been
5220detected. See L<WATCHER STATES> for details. 5658detected. See L</WATCHER STATES> for details.
5221 5659
5222=item real time 5660=item real time
5223 5661
5224The physical time that is observed. It is apparently strictly monotonic :) 5662The physical time that is observed. It is apparently strictly monotonic :)
5225 5663

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines