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

Comparing libev/ev.pod (file contents):
Revision 1.369 by root, Mon May 30 18:34:28 2011 UTC vs.
Revision 1.458 by root, Fri Dec 20 20:51:46 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.
446 481
447It's also required by POSIX in a threaded program, as libev calls 482It's also required by POSIX in a threaded program, as libev calls
448C<sigprocmask>, whose behaviour is officially unspecified. 483C<sigprocmask>, whose behaviour is officially unspecified.
449 484
450This flag's behaviour will become the default in future versions of libev. 485=item C<EVFLAG_NOTIMERFD>
486
487When this flag is specified, the libev will avoid using a C<timerfd> to
488detect time jumps. It will still be able to detect time jumps, but takes
489longer and has a lower accuracy in doing so, but saves a file descriptor
490per loop.
491
492The current implementation only tries to use a C<timerfd> when the first
493C<ev_periodic> watcher is started and falls back on other methods if it
494cannot be created, but this behaviour might change in the future.
451 495
452=item C<EVBACKEND_SELECT> (value 1, portable select backend) 496=item C<EVBACKEND_SELECT> (value 1, portable select backend)
453 497
454This is your standard select(2) backend. Not I<completely> standard, as 498This is your standard select(2) backend. Not I<completely> standard, as
455libev tries to roll its own fd_set with no limits on the number of fds, 499libev tries to roll its own fd_set with no limits on the number of fds,
480This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and 524This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
481C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. 525C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
482 526
483=item C<EVBACKEND_EPOLL> (value 4, Linux) 527=item C<EVBACKEND_EPOLL> (value 4, Linux)
484 528
485Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 529Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9
486kernels). 530kernels).
487 531
488For few fds, this backend is a bit little slower than poll and select, but 532For few fds, this backend is a bit little slower than poll and select, but
489it scales phenomenally better. While poll and select usually scale like 533it scales phenomenally better. While poll and select usually scale like
490O(total_fds) where total_fds is the total number of fds (or the highest 534O(total_fds) where total_fds is the total number of fds (or the highest
4990.1ms) and so on. The biggest issue is fork races, however - if a program 5430.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 544forks then I<both> parent and child process have to recreate the epoll
501set, which can take considerable time (one syscall per file descriptor) 545set, which can take considerable time (one syscall per file descriptor)
502and is of course hard to detect. 546and is of course hard to detect.
503 547
504Epoll is also notoriously buggy - embedding epoll fds I<should> work, but 548Epoll is also notoriously buggy - embedding epoll fds I<should> work,
505of course I<doesn't>, and epoll just loves to report events for totally 549but of course I<doesn't>, and epoll just loves to report events for
506I<different> file descriptors (even already closed ones, so one cannot 550totally I<different> file descriptors (even already closed ones, so
507even remove them from the set) than registered in the set (especially 551one cannot even remove them from the set) than registered in the set
508on SMP systems). Libev tries to counter these spurious notifications by 552(especially on SMP systems). Libev tries to counter these spurious
509employing an additional generation counter and comparing that against the 553notifications by employing an additional generation counter and comparing
510events to filter out spurious ones, recreating the set when required. Last 554that against the events to filter out spurious ones, recreating the set
555when required. Epoll also erroneously rounds down timeouts, but gives you
556no way to know when and by how much, so sometimes you have to busy-wait
557because epoll returns immediately despite a nonzero timeout. And last
511not least, it also refuses to work with some file descriptors which work 558not least, it also refuses to work with some file descriptors which work
512perfectly fine with C<select> (files, many character devices...). 559perfectly fine with C<select> (files, many character devices...).
513 560
514Epoll is truly the train wreck analog among event poll mechanisms, 561Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
515a frankenpoll, cobbled together in a hurry, no thought to design or 562cobbled together in a hurry, no thought to design or interaction with
516interaction with others. 563others. Oh, the pain, will it ever stop...
517 564
518While stopping, setting and starting an I/O watcher in the same iteration 565While 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 566will result in some caching, there is still a system call per such
520incident (because the same I<file descriptor> could point to a different 567incident (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 568I<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 580All 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 581faster than epoll for maybe up to a hundred file descriptors, depending on
535the usage. So sad. 582the usage. So sad.
536 583
537While nominally embeddable in other event loops, this feature is broken in 584While nominally embeddable in other event loops, this feature is broken in
538all kernel versions tested so far. 585a lot of kernel revisions, but probably(!) works in current versions.
539 586
540This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 587This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
541C<EVBACKEND_POLL>. 588C<EVBACKEND_POLL>.
542 589
590=item C<EVBACKEND_LINUXAIO> (value 64, Linux)
591
592Use the Linux-specific Linux AIO (I<not> C<< aio(7) >> but C<<
593io_submit(2) >>) event interface available in post-4.18 kernels (but libev
594only tries to use it in 4.19+).
595
596This is another Linux train wreck of an event interface.
597
598If this backend works for you (as of this writing, it was very
599experimental), it is the best event interface available on Linux and might
600be well worth enabling it - if it isn't available in your kernel this will
601be detected and this backend will be skipped.
602
603This backend can batch oneshot requests and supports a user-space ring
604buffer to receive events. It also doesn't suffer from most of the design
605problems of epoll (such as not being able to remove event sources from
606the epoll set), and generally sounds too good to be true. Because, this
607being the Linux kernel, of course it suffers from a whole new set of
608limitations, forcing you to fall back to epoll, inheriting all its design
609issues.
610
611For one, it is not easily embeddable (but probably could be done using
612an event fd at some extra overhead). It also is subject to a system wide
613limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no AIO
614requests are left, this backend will be skipped during initialisation, and
615will switch to epoll when the loop is active.
616
617Most problematic in practice, however, is that not all file descriptors
618work with it. For example, in Linux 5.1, TCP sockets, pipes, event fds,
619files, F</dev/null> and many others are supported, but ttys do not work
620properly (a known bug that the kernel developers don't care about, see
621L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
622(yet?) a generic event polling interface.
623
624Overall, it seems the Linux developers just don't want it to have a
625generic event handling mechanism other than C<select> or C<poll>.
626
627To work around all these problem, the current version of libev uses its
628epoll backend as a fallback for file descriptor types that do not work. Or
629falls back completely to epoll if the kernel acts up.
630
631This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
632C<EVBACKEND_POLL>.
633
543=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 634=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
544 635
545Kqueue deserves special mention, as at the time of this writing, it 636Kqueue deserves special mention, as at the time this backend was
546was broken on all BSDs except NetBSD (usually it doesn't work reliably 637implemented, it was broken on all BSDs except NetBSD (usually it doesn't
547with anything but sockets and pipes, except on Darwin, where of course 638work reliably with anything but sockets and pipes, except on Darwin,
548it's completely useless). Unlike epoll, however, whose brokenness 639where of course it's completely useless). Unlike epoll, however, whose
549is by design, these kqueue bugs can (and eventually will) be fixed 640brokenness 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 641fixed 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 642being "auto-detected" on all platforms unless you explicitly specify it
552C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) 643in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a
553system like NetBSD. 644known-to-be-good (-enough) system like NetBSD.
554 645
555You still can embed kqueue into a normal poll or select backend and use it 646You still can embed kqueue into a normal poll or select backend and use it
556only for sockets (after having made sure that sockets work with kqueue on 647only for sockets (after having made sure that sockets work with kqueue on
557the target platform). See C<ev_embed> watchers for more info. 648the target platform). See C<ev_embed> watchers for more info.
558 649
559It scales in the same way as the epoll backend, but the interface to the 650It scales in the same way as the epoll backend, but the interface to the
560kernel is more efficient (which says nothing about its actual speed, of 651kernel is more efficient (which says nothing about its actual speed, of
561course). While stopping, setting and starting an I/O watcher does never 652course). 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 653cause 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 654two 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 655might have to leak fds on fork, but it's more sane than epoll) and it
565cases 656drops fds silently in similarly hard-to-detect cases.
566 657
567This backend usually performs well under most conditions. 658This backend usually performs well under most conditions.
568 659
569While nominally embeddable in other event loops, this doesn't work 660While nominally embeddable in other event loops, this doesn't work
570everywhere, so you might need to test for this. And since it is broken 661everywhere, so you might need to test for this. And since it is broken
599among the OS-specific backends (I vastly prefer correctness over speed 690among the OS-specific backends (I vastly prefer correctness over speed
600hacks). 691hacks).
601 692
602On the negative side, the interface is I<bizarre> - so bizarre that 693On the negative side, the interface is I<bizarre> - so bizarre that
603even sun itself gets it wrong in their code examples: The event polling 694even sun itself gets it wrong in their code examples: The event polling
604function sometimes returning events to the caller even though an error 695function 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 696occurred, but with no indication whether it has done so or not (yes, it's
606even documented that way) - deadly for edge-triggered interfaces where 697even documented that way) - deadly for edge-triggered interfaces where you
607you absolutely have to know whether an event occurred or not because you 698absolutely have to know whether an event occurred or not because you have
608have to re-arm the watcher. 699to re-arm the watcher.
609 700
610Fortunately libev seems to be able to work around these idiocies. 701Fortunately libev seems to be able to work around these idiocies.
611 702
612This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 703This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
613C<EVBACKEND_POLL>. 704C<EVBACKEND_POLL>.
643 734
644Example: Use whatever libev has to offer, but make sure that kqueue is 735Example: Use whatever libev has to offer, but make sure that kqueue is
645used if available. 736used if available.
646 737
647 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 738 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
739
740Example: Similarly, on linux, you mgiht want to take advantage of the
741linux aio backend if possible, but fall back to something else if that
742isn't available.
743
744 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
648 745
649=item ev_loop_destroy (loop) 746=item ev_loop_destroy (loop)
650 747
651Destroys an event loop object (frees all memory and kernel state 748Destroys an event loop object (frees all memory and kernel state
652etc.). None of the active event watchers will be stopped in the normal 749etc.). None of the active event watchers will be stopped in the normal
669If you need dynamically allocated loops it is better to use C<ev_loop_new> 766If you need dynamically allocated loops it is better to use C<ev_loop_new>
670and C<ev_loop_destroy>. 767and C<ev_loop_destroy>.
671 768
672=item ev_loop_fork (loop) 769=item ev_loop_fork (loop)
673 770
674This function sets a flag that causes subsequent C<ev_run> iterations to 771This function sets a flag that causes subsequent C<ev_run> iterations
675reinitialise the kernel state for backends that have one. Despite the 772to reinitialise the kernel state for backends that have one. Despite
676name, you can call it anytime, but it makes most sense after forking, in 773the name, you can call it anytime you are allowed to start or stop
677the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the 774watchers (except inside an C<ev_prepare> callback), but it makes most
775sense after forking, in the child process. You I<must> call it (or use
678child before resuming or calling C<ev_run>. 776C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
679 777
778In addition, if you want to reuse a loop (via this function or
779C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>.
780
680Again, you I<have> to call it on I<any> loop that you want to re-use after 781Again, you I<have> to call it on I<any> loop that you want to re-use after
681a fork, I<even if you do not plan to use the loop in the parent>. This is 782a fork, I<even if you do not plan to use the loop in the parent>. This is
682because some kernel interfaces *cough* I<kqueue> *cough* do funny things 783because some kernel interfaces *cough* I<kqueue> *cough* do funny things
683during fork. 784during fork.
684 785
685On the other hand, you only need to call this function in the child 786On the other hand, you only need to call this function in the child
755 856
756This function is rarely useful, but when some event callback runs for a 857This function is rarely useful, but when some event callback runs for a
757very long time without entering the event loop, updating libev's idea of 858very long time without entering the event loop, updating libev's idea of
758the current time is a good idea. 859the current time is a good idea.
759 860
760See also L<The special problem of time updates> in the C<ev_timer> section. 861See also L</The special problem of time updates> in the C<ev_timer> section.
761 862
762=item ev_suspend (loop) 863=item ev_suspend (loop)
763 864
764=item ev_resume (loop) 865=item ev_resume (loop)
765 866
783without a previous call to C<ev_suspend>. 884without a previous call to C<ev_suspend>.
784 885
785Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the 886Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
786event loop time (see C<ev_now_update>). 887event loop time (see C<ev_now_update>).
787 888
788=item ev_run (loop, int flags) 889=item bool ev_run (loop, int flags)
789 890
790Finally, this is it, the event handler. This function usually is called 891Finally, this is it, the event handler. This function usually is called
791after you have initialised all your watchers and you want to start 892after you have initialised all your watchers and you want to start
792handling events. It will ask the operating system for any new events, call 893handling events. It will ask the operating system for any new events, call
793the watcher callbacks, an then repeat the whole process indefinitely: This 894the watcher callbacks, and then repeat the whole process indefinitely: This
794is why event loops are called I<loops>. 895is why event loops are called I<loops>.
795 896
796If the flags argument is specified as C<0>, it will keep handling events 897If the flags argument is specified as C<0>, it will keep handling events
797until either no event watchers are active anymore or C<ev_break> was 898until either no event watchers are active anymore or C<ev_break> was
798called. 899called.
900
901The return value is false if there are no more active watchers (which
902usually means "all jobs done" or "deadlock"), and true in all other cases
903(which usually means " you should call C<ev_run> again").
799 904
800Please note that an explicit C<ev_break> is usually better than 905Please note that an explicit C<ev_break> is usually better than
801relying on all watchers to be stopped when deciding when a program has 906relying on all watchers to be stopped when deciding when a program has
802finished (especially in interactive programs), but having a program 907finished (especially in interactive programs), but having a program
803that automatically loops as long as it has to and no longer by virtue 908that automatically loops as long as it has to and no longer by virtue
804of relying on its watchers stopping correctly, that is truly a thing of 909of relying on its watchers stopping correctly, that is truly a thing of
805beauty. 910beauty.
806 911
807This function is also I<mostly> exception-safe - you can break out of 912This function is I<mostly> exception-safe - you can break out of a
808a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++ 913C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
809exception and so on. This does not decrement the C<ev_depth> value, nor 914exception and so on. This does not decrement the C<ev_depth> value, nor
810will it clear any outstanding C<EVBREAK_ONE> breaks. 915will it clear any outstanding C<EVBREAK_ONE> breaks.
811 916
812A flags value of C<EVRUN_NOWAIT> will look for new events, will handle 917A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
813those events and any already outstanding ones, but will not wait and 918those events and any already outstanding ones, but will not wait and
943overhead for the actual polling but can deliver many events at once. 1048overhead for the actual polling but can deliver many events at once.
944 1049
945By setting a higher I<io collect interval> you allow libev to spend more 1050By setting a higher I<io collect interval> you allow libev to spend more
946time collecting I/O events, so you can handle more events per iteration, 1051time collecting I/O events, so you can handle more events per iteration,
947at the cost of increasing latency. Timeouts (both C<ev_periodic> and 1052at the cost of increasing latency. Timeouts (both C<ev_periodic> and
948C<ev_timer>) will be not affected. Setting this to a non-null value will 1053C<ev_timer>) will not be affected. Setting this to a non-null value will
949introduce an additional C<ev_sleep ()> call into most loop iterations. The 1054introduce an additional C<ev_sleep ()> call into most loop iterations. The
950sleep time ensures that libev will not poll for I/O events more often then 1055sleep time ensures that libev will not poll for I/O events more often then
951once per this interval, on average. 1056once per this interval, on average (as long as the host time resolution is
1057good enough).
952 1058
953Likewise, by setting a higher I<timeout collect interval> you allow libev 1059Likewise, by setting a higher I<timeout collect interval> you allow libev
954to spend more time collecting timeouts, at the expense of increased 1060to spend more time collecting timeouts, at the expense of increased
955latency/jitter/inexactness (the watcher callback will be called 1061latency/jitter/inexactness (the watcher callback will be called
956later). C<ev_io> watchers will not be affected. Setting this to a non-null 1062later). C<ev_io> watchers will not be affected. Setting this to a non-null
1002invoke the actual watchers inside another context (another thread etc.). 1108invoke the actual watchers inside another context (another thread etc.).
1003 1109
1004If you want to reset the callback, use C<ev_invoke_pending> as new 1110If you want to reset the callback, use C<ev_invoke_pending> as new
1005callback. 1111callback.
1006 1112
1007=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) 1113=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
1008 1114
1009Sometimes you want to share the same loop between multiple threads. This 1115Sometimes you want to share the same loop between multiple threads. This
1010can be done relatively simply by putting mutex_lock/unlock calls around 1116can be done relatively simply by putting mutex_lock/unlock calls around
1011each call to a libev function. 1117each call to a libev function.
1012 1118
1013However, C<ev_run> can run an indefinite time, so it is not feasible 1119However, C<ev_run> can run an indefinite time, so it is not feasible
1014to wait for it to return. One way around this is to wake up the event 1120to wait for it to return. One way around this is to wake up the event
1015loop via C<ev_break> and C<av_async_send>, another way is to set these 1121loop via C<ev_break> and C<ev_async_send>, another way is to set these
1016I<release> and I<acquire> callbacks on the loop. 1122I<release> and I<acquire> callbacks on the loop.
1017 1123
1018When set, then C<release> will be called just before the thread is 1124When set, then C<release> will be called just before the thread is
1019suspended waiting for new events, and C<acquire> is called just 1125suspended waiting for new events, and C<acquire> is called just
1020afterwards. 1126afterwards.
1160 1266
1161=item C<EV_PREPARE> 1267=item C<EV_PREPARE>
1162 1268
1163=item C<EV_CHECK> 1269=item C<EV_CHECK>
1164 1270
1165All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts 1271All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1166to gather new events, and all C<ev_check> watchers are invoked just after 1272gather new events, and all C<ev_check> watchers are queued (not invoked)
1167C<ev_run> has gathered them, but before it invokes any callbacks for any 1273just after C<ev_run> has gathered them, but before it queues any callbacks
1274for any received events. That means C<ev_prepare> watchers are the last
1275watchers invoked before the event loop sleeps or polls for new events, and
1276C<ev_check> watchers will be invoked before any other watchers of the same
1277or lower priority within an event loop iteration.
1278
1168received events. Callbacks of both watcher types can start and stop as 1279Callbacks of both watcher types can start and stop as many watchers as
1169many watchers as they want, and all of them will be taken into account 1280they want, and all of them will be taken into account (for example, a
1170(for example, a C<ev_prepare> watcher might start an idle watcher to keep 1281C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1171C<ev_run> from blocking). 1282blocking).
1172 1283
1173=item C<EV_EMBED> 1284=item C<EV_EMBED>
1174 1285
1175The embedded event loop specified in the C<ev_embed> watcher needs attention. 1286The embedded event loop specified in the C<ev_embed> watcher needs attention.
1176 1287
1299 1410
1300=item callback ev_cb (ev_TYPE *watcher) 1411=item callback ev_cb (ev_TYPE *watcher)
1301 1412
1302Returns the callback currently set on the watcher. 1413Returns the callback currently set on the watcher.
1303 1414
1304=item ev_cb_set (ev_TYPE *watcher, callback) 1415=item ev_set_cb (ev_TYPE *watcher, callback)
1305 1416
1306Change the callback. You can change the callback at virtually any time 1417Change the callback. You can change the callback at virtually any time
1307(modulo threads). 1418(modulo threads).
1308 1419
1309=item ev_set_priority (ev_TYPE *watcher, int priority) 1420=item ev_set_priority (ev_TYPE *watcher, int priority)
1327or might not have been clamped to the valid range. 1438or might not have been clamped to the valid range.
1328 1439
1329The default priority used by watchers when no priority has been set is 1440The default priority used by watchers when no priority has been set is
1330always C<0>, which is supposed to not be too high and not be too low :). 1441always C<0>, which is supposed to not be too high and not be too low :).
1331 1442
1332See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1443See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1333priorities. 1444priorities.
1334 1445
1335=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1446=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1336 1447
1337Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1448Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1362See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related 1473See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1363functions that do not need a watcher. 1474functions that do not need a watcher.
1364 1475
1365=back 1476=back
1366 1477
1367See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1478See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1368OWN COMPOSITE WATCHERS> idioms. 1479OWN COMPOSITE WATCHERS> idioms.
1369 1480
1370=head2 WATCHER STATES 1481=head2 WATCHER STATES
1371 1482
1372There are various watcher states mentioned throughout this manual - 1483There are various watcher states mentioned throughout this manual -
1374transition between them will be described in more detail - and while these 1485transition between them will be described in more detail - and while these
1375rules might look complicated, they usually do "the right thing". 1486rules might look complicated, they usually do "the right thing".
1376 1487
1377=over 4 1488=over 4
1378 1489
1379=item initialiased 1490=item initialised
1380 1491
1381Before a watcher can be registered with the event looop it has to be 1492Before a watcher can be registered with the event loop it has to be
1382initialised. This can be done with a call to C<ev_TYPE_init>, or calls to 1493initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1383C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. 1494C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1384 1495
1385In this state it is simply some block of memory that is suitable for 1496In this state it is simply some block of memory that is suitable for
1386use in an event loop. It can be moved around, freed, reused etc. at 1497use in an event loop. It can be moved around, freed, reused etc. at
1433 1544
1434Many event loops support I<watcher priorities>, which are usually small 1545Many event loops support I<watcher priorities>, which are usually small
1435integers that influence the ordering of event callback invocation 1546integers that influence the ordering of event callback invocation
1436between watchers in some way, all else being equal. 1547between watchers in some way, all else being equal.
1437 1548
1438In libev, Watcher priorities can be set using C<ev_set_priority>. See its 1549In libev, watcher priorities can be set using C<ev_set_priority>. See its
1439description for the more technical details such as the actual priority 1550description for the more technical details such as the actual priority
1440range. 1551range.
1441 1552
1442There are two common ways how these these priorities are being interpreted 1553There are two common ways how these these priorities are being interpreted
1443by event loops: 1554by event loops:
1582 1693
1583But really, best use non-blocking mode. 1694But really, best use non-blocking mode.
1584 1695
1585=head3 The special problem of disappearing file descriptors 1696=head3 The special problem of disappearing file descriptors
1586 1697
1587Some backends (e.g. kqueue, epoll) need to be told about closing a file 1698Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1588descriptor (either due to calling C<close> explicitly or any other means, 1699a file descriptor (either due to calling C<close> explicitly or any other
1589such as C<dup2>). The reason is that you register interest in some file 1700means, such as C<dup2>). The reason is that you register interest in some
1590descriptor, but when it goes away, the operating system will silently drop 1701file descriptor, but when it goes away, the operating system will silently
1591this interest. If another file descriptor with the same number then is 1702drop this interest. If another file descriptor with the same number then
1592registered with libev, there is no efficient way to see that this is, in 1703is registered with libev, there is no efficient way to see that this is,
1593fact, a different file descriptor. 1704in fact, a different file descriptor.
1594 1705
1595To avoid having to explicitly tell libev about such cases, libev follows 1706To avoid having to explicitly tell libev about such cases, libev follows
1596the following policy: Each time C<ev_io_set> is being called, libev 1707the following policy: Each time C<ev_io_set> is being called, libev
1597will assume that this is potentially a new file descriptor, otherwise 1708will assume that this is potentially a new file descriptor, otherwise
1598it is assumed that the file descriptor stays the same. That means that 1709it is assumed that the file descriptor stays the same. That means that
1647when you rarely read from a file instead of from a socket, and want to 1758when you rarely read from a file instead of from a socket, and want to
1648reuse the same code path. 1759reuse the same code path.
1649 1760
1650=head3 The special problem of fork 1761=head3 The special problem of fork
1651 1762
1652Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1763Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()>
1653useless behaviour. Libev fully supports fork, but needs to be told about 1764at all or exhibit useless behaviour. Libev fully supports fork, but needs
1654it in the child if you want to continue to use it in the child. 1765to be told about it in the child if you want to continue to use it in the
1766child.
1655 1767
1656To support fork in your child processes, you have to call C<ev_loop_fork 1768To support fork in your child processes, you have to call C<ev_loop_fork
1657()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to 1769()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1658C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1770C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1659 1771
1761detecting time jumps is hard, and some inaccuracies are unavoidable (the 1873detecting time jumps is hard, and some inaccuracies are unavoidable (the
1762monotonic clock option helps a lot here). 1874monotonic clock option helps a lot here).
1763 1875
1764The callback is guaranteed to be invoked only I<after> its timeout has 1876The callback is guaranteed to be invoked only I<after> its timeout has
1765passed (not I<at>, so on systems with very low-resolution clocks this 1877passed (not I<at>, so on systems with very low-resolution clocks this
1766might introduce a small delay). If multiple timers become ready during the 1878might introduce a small delay, see "the special problem of being too
1879early", below). If multiple timers become ready during the same loop
1767same loop iteration then the ones with earlier time-out values are invoked 1880iteration then the ones with earlier time-out values are invoked before
1768before ones of the same priority with later time-out values (but this is 1881ones of the same priority with later time-out values (but this is no
1769no longer true when a callback calls C<ev_run> recursively). 1882longer true when a callback calls C<ev_run> recursively).
1770 1883
1771=head3 Be smart about timeouts 1884=head3 Be smart about timeouts
1772 1885
1773Many real-world problems involve some kind of timeout, usually for error 1886Many real-world problems involve some kind of timeout, usually for error
1774recovery. A typical example is an HTTP request - if the other side hangs, 1887recovery. A typical example is an HTTP request - if the other side hangs,
1849 1962
1850In this case, it would be more efficient to leave the C<ev_timer> alone, 1963In this case, it would be more efficient to leave the C<ev_timer> alone,
1851but remember the time of last activity, and check for a real timeout only 1964but remember the time of last activity, and check for a real timeout only
1852within the callback: 1965within the callback:
1853 1966
1967 ev_tstamp timeout = 60.;
1854 ev_tstamp last_activity; // time of last activity 1968 ev_tstamp last_activity; // time of last activity
1969 ev_timer timer;
1855 1970
1856 static void 1971 static void
1857 callback (EV_P_ ev_timer *w, int revents) 1972 callback (EV_P_ ev_timer *w, int revents)
1858 { 1973 {
1859 ev_tstamp now = ev_now (EV_A); 1974 // calculate when the timeout would happen
1860 ev_tstamp timeout = last_activity + 60.; 1975 ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1861 1976
1862 // if last_activity + 60. is older than now, we did time out 1977 // if negative, it means we the timeout already occurred
1863 if (timeout < now) 1978 if (after < 0.)
1864 { 1979 {
1865 // timeout occurred, take action 1980 // timeout occurred, take action
1866 } 1981 }
1867 else 1982 else
1868 { 1983 {
1869 // callback was invoked, but there was some activity, re-arm 1984 // callback was invoked, but there was some recent
1870 // the watcher to fire in last_activity + 60, which is 1985 // activity. simply restart the timer to time out
1871 // guaranteed to be in the future, so "again" is positive: 1986 // after "after" seconds, which is the earliest time
1872 w->repeat = timeout - now; 1987 // the timeout can occur.
1988 ev_timer_set (w, after, 0.);
1873 ev_timer_again (EV_A_ w); 1989 ev_timer_start (EV_A_ w);
1874 } 1990 }
1875 } 1991 }
1876 1992
1877To summarise the callback: first calculate the real timeout (defined 1993To summarise the callback: first calculate in how many seconds the
1878as "60 seconds after the last activity"), then check if that time has 1994timeout will occur (by calculating the absolute time when it would occur,
1879been reached, which means something I<did>, in fact, time out. Otherwise 1995C<last_activity + timeout>, and subtracting the current time, C<ev_now
1880the callback was invoked too early (C<timeout> is in the future), so 1996(EV_A)> from that).
1881re-schedule the timer to fire at that future time, to see if maybe we have
1882a timeout then.
1883 1997
1884Note how C<ev_timer_again> is used, taking advantage of the 1998If this value is negative, then we are already past the timeout, i.e. we
1885C<ev_timer_again> optimisation when the timer is already running. 1999timed out, and need to do whatever is needed in this case.
2000
2001Otherwise, we now the earliest time at which the timeout would trigger,
2002and simply start the timer with this timeout value.
2003
2004In other words, each time the callback is invoked it will check whether
2005the timeout occurred. If not, it will simply reschedule itself to check
2006again at the earliest time it could time out. Rinse. Repeat.
1886 2007
1887This scheme causes more callback invocations (about one every 60 seconds 2008This scheme causes more callback invocations (about one every 60 seconds
1888minus half the average time between activity), but virtually no calls to 2009minus half the average time between activity), but virtually no calls to
1889libev to change the timeout. 2010libev to change the timeout.
1890 2011
1891To start the timer, simply initialise the watcher and set C<last_activity> 2012To start the machinery, simply initialise the watcher and set
1892to the current time (meaning we just have some activity :), then call the 2013C<last_activity> to the current time (meaning there was some activity just
1893callback, which will "do the right thing" and start the timer: 2014now), then call the callback, which will "do the right thing" and start
2015the timer:
1894 2016
2017 last_activity = ev_now (EV_A);
1895 ev_init (timer, callback); 2018 ev_init (&timer, callback);
1896 last_activity = ev_now (loop); 2019 callback (EV_A_ &timer, 0);
1897 callback (loop, timer, EV_TIMER);
1898 2020
1899And when there is some activity, simply store the current time in 2021When there is some activity, simply store the current time in
1900C<last_activity>, no libev calls at all: 2022C<last_activity>, no libev calls at all:
1901 2023
2024 if (activity detected)
1902 last_activity = ev_now (loop); 2025 last_activity = ev_now (EV_A);
2026
2027When your timeout value changes, then the timeout can be changed by simply
2028providing a new value, stopping the timer and calling the callback, which
2029will again do the right thing (for example, time out immediately :).
2030
2031 timeout = new_value;
2032 ev_timer_stop (EV_A_ &timer);
2033 callback (EV_A_ &timer, 0);
1903 2034
1904This technique is slightly more complex, but in most cases where the 2035This technique is slightly more complex, but in most cases where the
1905time-out is unlikely to be triggered, much more efficient. 2036time-out is unlikely to be triggered, much more efficient.
1906
1907Changing the timeout is trivial as well (if it isn't hard-coded in the
1908callback :) - just change the timeout and invoke the callback, which will
1909fix things for you.
1910 2037
1911=item 4. Wee, just use a double-linked list for your timeouts. 2038=item 4. Wee, just use a double-linked list for your timeouts.
1912 2039
1913If there is not one request, but many thousands (millions...), all 2040If there is not one request, but many thousands (millions...), all
1914employing some kind of timeout with the same timeout value, then one can 2041employing some kind of timeout with the same timeout value, then one can
1941Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 2068Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1942rather complicated, but extremely efficient, something that really pays 2069rather complicated, but extremely efficient, something that really pays
1943off after the first million or so of active timers, i.e. it's usually 2070off after the first million or so of active timers, i.e. it's usually
1944overkill :) 2071overkill :)
1945 2072
2073=head3 The special problem of being too early
2074
2075If you ask a timer to call your callback after three seconds, then
2076you expect it to be invoked after three seconds - but of course, this
2077cannot be guaranteed to infinite precision. Less obviously, it cannot be
2078guaranteed to any precision by libev - imagine somebody suspending the
2079process with a STOP signal for a few hours for example.
2080
2081So, libev tries to invoke your callback as soon as possible I<after> the
2082delay has occurred, but cannot guarantee this.
2083
2084A less obvious failure mode is calling your callback too early: many event
2085loops compare timestamps with a "elapsed delay >= requested delay", but
2086this can cause your callback to be invoked much earlier than you would
2087expect.
2088
2089To see why, imagine a system with a clock that only offers full second
2090resolution (think windows if you can't come up with a broken enough OS
2091yourself). If you schedule a one-second timer at the time 500.9, then the
2092event loop will schedule your timeout to elapse at a system time of 500
2093(500.9 truncated to the resolution) + 1, or 501.
2094
2095If an event library looks at the timeout 0.1s later, it will see "501 >=
2096501" and invoke the callback 0.1s after it was started, even though a
2097one-second delay was requested - this is being "too early", despite best
2098intentions.
2099
2100This is the reason why libev will never invoke the callback if the elapsed
2101delay equals the requested delay, but only when the elapsed delay is
2102larger than the requested delay. In the example above, libev would only invoke
2103the callback at system time 502, or 1.1s after the timer was started.
2104
2105So, while libev cannot guarantee that your callback will be invoked
2106exactly when requested, it I<can> and I<does> guarantee that the requested
2107delay has actually elapsed, or in other words, it always errs on the "too
2108late" side of things.
2109
1946=head3 The special problem of time updates 2110=head3 The special problem of time updates
1947 2111
1948Establishing the current time is a costly operation (it usually takes at 2112Establishing the current time is a costly operation (it usually takes
1949least two system calls): EV therefore updates its idea of the current 2113at least one system call): EV therefore updates its idea of the current
1950time only before and after C<ev_run> collects new events, which causes a 2114time only before and after C<ev_run> collects new events, which causes a
1951growing difference between C<ev_now ()> and C<ev_time ()> when handling 2115growing difference between C<ev_now ()> and C<ev_time ()> when handling
1952lots of events in one iteration. 2116lots of events in one iteration.
1953 2117
1954The relative timeouts are calculated relative to the C<ev_now ()> 2118The relative timeouts are calculated relative to the C<ev_now ()>
1955time. This is usually the right thing as this timestamp refers to the time 2119time. This is usually the right thing as this timestamp refers to the time
1956of the event triggering whatever timeout you are modifying/starting. If 2120of the event triggering whatever timeout you are modifying/starting. If
1957you suspect event processing to be delayed and you I<need> to base the 2121you suspect event processing to be delayed and you I<need> to base the
1958timeout on the current time, use something like this to adjust for this: 2122timeout on the current time, use something like the following to adjust
2123for it:
1959 2124
1960 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2125 ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
1961 2126
1962If the event loop is suspended for a long time, you can also force an 2127If the event loop is suspended for a long time, you can also force an
1963update of the time returned by C<ev_now ()> by calling C<ev_now_update 2128update of the time returned by C<ev_now ()> by calling C<ev_now_update
1964()>. 2129()>, although that will push the event time of all outstanding events
2130further into the future.
2131
2132=head3 The special problem of unsynchronised clocks
2133
2134Modern systems have a variety of clocks - libev itself uses the normal
2135"wall clock" clock and, if available, the monotonic clock (to avoid time
2136jumps).
2137
2138Neither of these clocks is synchronised with each other or any other clock
2139on the system, so C<ev_time ()> might return a considerably different time
2140than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
2141a call to C<gettimeofday> might return a second count that is one higher
2142than a directly following call to C<time>.
2143
2144The moral of this is to only compare libev-related timestamps with
2145C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
2146a second or so.
2147
2148One more problem arises due to this lack of synchronisation: if libev uses
2149the system monotonic clock and you compare timestamps from C<ev_time>
2150or C<ev_now> from when you started your timer and when your callback is
2151invoked, you will find that sometimes the callback is a bit "early".
2152
2153This is because C<ev_timer>s work in real time, not wall clock time, so
2154libev makes sure your callback is not invoked before the delay happened,
2155I<measured according to the real time>, not the system clock.
2156
2157If your timeouts are based on a physical timescale (e.g. "time out this
2158connection after 100 seconds") then this shouldn't bother you as it is
2159exactly the right behaviour.
2160
2161If you want to compare wall clock/system timestamps to your timers, then
2162you need to use C<ev_periodic>s, as these are based on the wall clock
2163time, where your comparisons will always generate correct results.
1965 2164
1966=head3 The special problems of suspended animation 2165=head3 The special problems of suspended animation
1967 2166
1968When you leave the server world it is quite customary to hit machines that 2167When you leave the server world it is quite customary to hit machines that
1969can suspend/hibernate - what happens to the clocks during such a suspend? 2168can suspend/hibernate - what happens to the clocks during such a suspend?
1999 2198
2000=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 2199=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
2001 2200
2002=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 2201=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
2003 2202
2004Configure the timer to trigger after C<after> seconds. If C<repeat> 2203Configure the timer to trigger after C<after> seconds (fractional and
2005is C<0.>, then it will automatically be stopped once the timeout is 2204negative values are supported). If C<repeat> is C<0.>, then it will
2006reached. If it is positive, then the timer will automatically be 2205automatically be stopped once the timeout is reached. If it is positive,
2007configured to trigger again C<repeat> seconds later, again, and again, 2206then the timer will automatically be configured to trigger again C<repeat>
2008until stopped manually. 2207seconds later, again, and again, until stopped manually.
2009 2208
2010The timer itself will do a best-effort at avoiding drift, that is, if 2209The timer itself will do a best-effort at avoiding drift, that is, if
2011you configure a timer to trigger every 10 seconds, then it will normally 2210you configure a timer to trigger every 10 seconds, then it will normally
2012trigger at exactly 10 second intervals. If, however, your program cannot 2211trigger at exactly 10 second intervals. If, however, your program cannot
2013keep up with the timer (because it takes longer than those 10 seconds to 2212keep up with the timer (because it takes longer than those 10 seconds to
2014do stuff) the timer will not fire more than once per event loop iteration. 2213do stuff) the timer will not fire more than once per event loop iteration.
2015 2214
2016=item ev_timer_again (loop, ev_timer *) 2215=item ev_timer_again (loop, ev_timer *)
2017 2216
2018This will act as if the timer timed out and restart it again if it is 2217This will act as if the timer timed out, and restarts it again if it is
2019repeating. The exact semantics are: 2218repeating. It basically works like calling C<ev_timer_stop>, updating the
2219timeout to the C<repeat> value and calling C<ev_timer_start>.
2020 2220
2221The exact semantics are as in the following rules, all of which will be
2222applied to the watcher:
2223
2224=over 4
2225
2021If the timer is pending, its pending status is cleared. 2226=item If the timer is pending, the pending status is always cleared.
2022 2227
2023If the timer is started but non-repeating, stop it (as if it timed out). 2228=item If the timer is started but non-repeating, stop it (as if it timed
2229out, without invoking it).
2024 2230
2025If the timer is repeating, either start it if necessary (with the 2231=item If the timer is repeating, make the C<repeat> value the new timeout
2026C<repeat> value), or reset the running timer to the C<repeat> value. 2232and start the timer, if necessary.
2027 2233
2234=back
2235
2028This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2236This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2029usage example. 2237usage example.
2030 2238
2031=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2239=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2032 2240
2033Returns the remaining time until a timer fires. If the timer is active, 2241Returns the remaining time until a timer fires. If the timer is active,
2086Periodic watchers are also timers of a kind, but they are very versatile 2294Periodic watchers are also timers of a kind, but they are very versatile
2087(and unfortunately a bit complex). 2295(and unfortunately a bit complex).
2088 2296
2089Unlike C<ev_timer>, periodic watchers are not based on real time (or 2297Unlike C<ev_timer>, periodic watchers are not based on real time (or
2090relative time, the physical time that passes) but on wall clock time 2298relative time, the physical time that passes) but on wall clock time
2091(absolute time, the thing you can read on your calender or clock). The 2299(absolute time, the thing you can read on your calendar or clock). The
2092difference is that wall clock time can run faster or slower than real 2300difference is that wall clock time can run faster or slower than real
2093time, and time jumps are not uncommon (e.g. when you adjust your 2301time, and time jumps are not uncommon (e.g. when you adjust your
2094wrist-watch). 2302wrist-watch).
2095 2303
2096You can tell a periodic watcher to trigger after some specific point 2304You can tell a periodic watcher to trigger after some specific point
2101C<ev_timer>, which would still trigger roughly 10 seconds after starting 2309C<ev_timer>, which would still trigger roughly 10 seconds after starting
2102it, as it uses a relative timeout). 2310it, as it uses a relative timeout).
2103 2311
2104C<ev_periodic> watchers can also be used to implement vastly more complex 2312C<ev_periodic> watchers can also be used to implement vastly more complex
2105timers, such as triggering an event on each "midnight, local time", or 2313timers, such as triggering an event on each "midnight, local time", or
2106other complicated rules. This cannot be done with C<ev_timer> watchers, as 2314other complicated rules. This cannot easily be done with C<ev_timer>
2107those cannot react to time jumps. 2315watchers, as those cannot react to time jumps.
2108 2316
2109As with timers, the callback is guaranteed to be invoked only when the 2317As with timers, the callback is guaranteed to be invoked only when the
2110point in time where it is supposed to trigger has passed. If multiple 2318point in time where it is supposed to trigger has passed. If multiple
2111timers become ready during the same loop iteration then the ones with 2319timers become ready during the same loop iteration then the ones with
2112earlier time-out values are invoked before ones with later time-out values 2320earlier time-out values are invoked before ones with later time-out values
2198 2406
2199NOTE: I<< This callback must always return a time that is higher than or 2407NOTE: I<< This callback must always return a time that is higher than or
2200equal to the passed C<now> value >>. 2408equal to the passed C<now> value >>.
2201 2409
2202This can be used to create very complex timers, such as a timer that 2410This can be used to create very complex timers, such as a timer that
2203triggers on "next midnight, local time". To do this, you would calculate the 2411triggers on "next midnight, local time". To do this, you would calculate
2204next midnight after C<now> and return the timestamp value for this. How 2412the next midnight after C<now> and return the timestamp value for
2205you do this is, again, up to you (but it is not trivial, which is the main 2413this. Here is a (completely untested, no error checking) example on how to
2206reason I omitted it as an example). 2414do this:
2415
2416 #include <time.h>
2417
2418 static ev_tstamp
2419 my_rescheduler (ev_periodic *w, ev_tstamp now)
2420 {
2421 time_t tnow = (time_t)now;
2422 struct tm tm;
2423 localtime_r (&tnow, &tm);
2424
2425 tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2426 ++tm.tm_mday; // midnight next day
2427
2428 return mktime (&tm);
2429 }
2430
2431Note: this code might run into trouble on days that have more then two
2432midnights (beginning and end).
2207 2433
2208=back 2434=back
2209 2435
2210=item ev_periodic_again (loop, ev_periodic *) 2436=item ev_periodic_again (loop, ev_periodic *)
2211 2437
2276 2502
2277 ev_periodic hourly_tick; 2503 ev_periodic hourly_tick;
2278 ev_periodic_init (&hourly_tick, clock_cb, 2504 ev_periodic_init (&hourly_tick, clock_cb,
2279 fmod (ev_now (loop), 3600.), 3600., 0); 2505 fmod (ev_now (loop), 3600.), 3600., 0);
2280 ev_periodic_start (loop, &hourly_tick); 2506 ev_periodic_start (loop, &hourly_tick);
2281 2507
2282 2508
2283=head2 C<ev_signal> - signal me when a signal gets signalled! 2509=head2 C<ev_signal> - signal me when a signal gets signalled!
2284 2510
2285Signal watchers will trigger an event when the process receives a specific 2511Signal watchers will trigger an event when the process receives a specific
2286signal one or more times. Even though signals are very asynchronous, libev 2512signal one or more times. Even though signals are very asynchronous, libev
2296only within the same loop, i.e. you can watch for C<SIGINT> in your 2522only within the same loop, i.e. you can watch for C<SIGINT> in your
2297default loop and for C<SIGIO> in another loop, but you cannot watch for 2523default loop and for C<SIGIO> in another loop, but you cannot watch for
2298C<SIGINT> in both the default loop and another loop at the same time. At 2524C<SIGINT> in both the default loop and another loop at the same time. At
2299the moment, C<SIGCHLD> is permanently tied to the default loop. 2525the moment, C<SIGCHLD> is permanently tied to the default loop.
2300 2526
2301When the first watcher gets started will libev actually register something 2527Only after the first watcher for a signal is started will libev actually
2302with the kernel (thus it coexists with your own signal handlers as long as 2528register something with the kernel. It thus coexists with your own signal
2303you don't register any with libev for the same signal). 2529handlers as long as you don't register any with libev for the same signal.
2304 2530
2305If possible and supported, libev will install its handlers with 2531If possible and supported, libev will install its handlers with
2306C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2532C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2307not be unduly interrupted. If you have a problem with system calls getting 2533not be unduly interrupted. If you have a problem with system calls getting
2308interrupted by signals you can block all signals in an C<ev_check> watcher 2534interrupted by signals you can block all signals in an C<ev_check> watcher
2493 2719
2494=head2 C<ev_stat> - did the file attributes just change? 2720=head2 C<ev_stat> - did the file attributes just change?
2495 2721
2496This watches a file system path for attribute changes. That is, it calls 2722This watches a file system path for attribute changes. That is, it calls
2497C<stat> on that path in regular intervals (or when the OS says it changed) 2723C<stat> on that path in regular intervals (or when the OS says it changed)
2498and sees if it changed compared to the last time, invoking the callback if 2724and sees if it changed compared to the last time, invoking the callback
2499it did. 2725if it did. Starting the watcher C<stat>'s the file, so only changes that
2726happen after the watcher has been started will be reported.
2500 2727
2501The path does not need to exist: changing from "path exists" to "path does 2728The path does not need to exist: changing from "path exists" to "path does
2502not exist" is a status change like any other. The condition "path does not 2729not exist" is a status change like any other. The condition "path does not
2503exist" (or more correctly "path cannot be stat'ed") is signified by the 2730exist" (or more correctly "path cannot be stat'ed") is signified by the
2504C<st_nlink> field being zero (which is otherwise always forced to be at 2731C<st_nlink> field being zero (which is otherwise always forced to be at
2734Apart from keeping your process non-blocking (which is a useful 2961Apart from keeping your process non-blocking (which is a useful
2735effect on its own sometimes), idle watchers are a good place to do 2962effect on its own sometimes), idle watchers are a good place to do
2736"pseudo-background processing", or delay processing stuff to after the 2963"pseudo-background processing", or delay processing stuff to after the
2737event loop has handled all outstanding events. 2964event loop has handled all outstanding events.
2738 2965
2966=head3 Abusing an C<ev_idle> watcher for its side-effect
2967
2968As long as there is at least one active idle watcher, libev will never
2969sleep unnecessarily. Or in other words, it will loop as fast as possible.
2970For this to work, the idle watcher doesn't need to be invoked at all - the
2971lowest priority will do.
2972
2973This mode of operation can be useful together with an C<ev_check> watcher,
2974to do something on each event loop iteration - for example to balance load
2975between different connections.
2976
2977See L</Abusing an ev_check watcher for its side-effect> for a longer
2978example.
2979
2739=head3 Watcher-Specific Functions and Data Members 2980=head3 Watcher-Specific Functions and Data Members
2740 2981
2741=over 4 2982=over 4
2742 2983
2743=item ev_idle_init (ev_idle *, callback) 2984=item ev_idle_init (ev_idle *, callback)
2754callback, free it. Also, use no error checking, as usual. 2995callback, free it. Also, use no error checking, as usual.
2755 2996
2756 static void 2997 static void
2757 idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 2998 idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2758 { 2999 {
3000 // stop the watcher
3001 ev_idle_stop (loop, w);
3002
3003 // now we can free it
2759 free (w); 3004 free (w);
3005
2760 // now do something you wanted to do when the program has 3006 // now do something you wanted to do when the program has
2761 // no longer anything immediate to do. 3007 // no longer anything immediate to do.
2762 } 3008 }
2763 3009
2764 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3010 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2766 ev_idle_start (loop, idle_watcher); 3012 ev_idle_start (loop, idle_watcher);
2767 3013
2768 3014
2769=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 3015=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2770 3016
2771Prepare and check watchers are usually (but not always) used in pairs: 3017Prepare and check watchers are often (but not always) used in pairs:
2772prepare watchers get invoked before the process blocks and check watchers 3018prepare watchers get invoked before the process blocks and check watchers
2773afterwards. 3019afterwards.
2774 3020
2775You I<must not> call C<ev_run> or similar functions that enter 3021You I<must not> call C<ev_run> (or similar functions that enter the
2776the current event loop from either C<ev_prepare> or C<ev_check> 3022current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2777watchers. Other loops than the current one are fine, however. The 3023C<ev_check> watchers. Other loops than the current one are fine,
2778rationale behind this is that you do not need to check for recursion in 3024however. The rationale behind this is that you do not need to check
2779those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, 3025for recursion in those watchers, i.e. the sequence will always be
2780C<ev_check> so if you have one watcher of each kind they will always be 3026C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2781called in pairs bracketing the blocking call. 3027kind they will always be called in pairs bracketing the blocking call.
2782 3028
2783Their main purpose is to integrate other event mechanisms into libev and 3029Their main purpose is to integrate other event mechanisms into libev and
2784their use is somewhat advanced. They could be used, for example, to track 3030their use is somewhat advanced. They could be used, for example, to track
2785variable changes, implement your own watchers, integrate net-snmp or a 3031variable changes, implement your own watchers, integrate net-snmp or a
2786coroutine library and lots more. They are also occasionally useful if 3032coroutine library and lots more. They are also occasionally useful if
2804with priority higher than or equal to the event loop and one coroutine 3050with priority higher than or equal to the event loop and one coroutine
2805of lower priority, but only once, using idle watchers to keep the event 3051of lower priority, but only once, using idle watchers to keep the event
2806loop from blocking if lower-priority coroutines are active, thus mapping 3052loop from blocking if lower-priority coroutines are active, thus mapping
2807low-priority coroutines to idle/background tasks). 3053low-priority coroutines to idle/background tasks).
2808 3054
2809It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 3055When used for this purpose, it is recommended to give C<ev_check> watchers
2810priority, to ensure that they are being run before any other watchers 3056highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2811after the poll (this doesn't matter for C<ev_prepare> watchers). 3057any other watchers after the poll (this doesn't matter for C<ev_prepare>
3058watchers).
2812 3059
2813Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not 3060Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2814activate ("feed") events into libev. While libev fully supports this, they 3061activate ("feed") events into libev. While libev fully supports this, they
2815might get executed before other C<ev_check> watchers did their job. As 3062might get executed before other C<ev_check> watchers did their job. As
2816C<ev_check> watchers are often used to embed other (non-libev) event 3063C<ev_check> watchers are often used to embed other (non-libev) event
2817loops those other event loops might be in an unusable state until their 3064loops those other event loops might be in an unusable state until their
2818C<ev_check> watcher ran (always remind yourself to coexist peacefully with 3065C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2819others). 3066others).
3067
3068=head3 Abusing an C<ev_check> watcher for its side-effect
3069
3070C<ev_check> (and less often also C<ev_prepare>) watchers can also be
3071useful because they are called once per event loop iteration. For
3072example, if you want to handle a large number of connections fairly, you
3073normally only do a bit of work for each active connection, and if there
3074is more work to do, you wait for the next event loop iteration, so other
3075connections have a chance of making progress.
3076
3077Using an C<ev_check> watcher is almost enough: it will be called on the
3078next event loop iteration. However, that isn't as soon as possible -
3079without external events, your C<ev_check> watcher will not be invoked.
3080
3081This is where C<ev_idle> watchers come in handy - all you need is a
3082single global idle watcher that is active as long as you have one active
3083C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
3084will not sleep, and the C<ev_check> watcher makes sure a callback gets
3085invoked. Neither watcher alone can do that.
2820 3086
2821=head3 Watcher-Specific Functions and Data Members 3087=head3 Watcher-Specific Functions and Data Members
2822 3088
2823=over 4 3089=over 4
2824 3090
3025 3291
3026=over 4 3292=over 4
3027 3293
3028=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3294=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3029 3295
3030=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3296=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3031 3297
3032Configures the watcher to embed the given loop, which must be 3298Configures the watcher to embed the given loop, which must be
3033embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3299embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3034invoked automatically, otherwise it is the responsibility of the callback 3300invoked automatically, otherwise it is the responsibility of the callback
3035to invoke it (it will continue to be called until the sweep has been done, 3301to invoke it (it will continue to be called until the sweep has been done,
3056used). 3322used).
3057 3323
3058 struct ev_loop *loop_hi = ev_default_init (0); 3324 struct ev_loop *loop_hi = ev_default_init (0);
3059 struct ev_loop *loop_lo = 0; 3325 struct ev_loop *loop_lo = 0;
3060 ev_embed embed; 3326 ev_embed embed;
3061 3327
3062 // see if there is a chance of getting one that works 3328 // see if there is a chance of getting one that works
3063 // (remember that a flags value of 0 means autodetection) 3329 // (remember that a flags value of 0 means autodetection)
3064 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3330 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3065 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3331 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3066 : 0; 3332 : 0;
3080C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3346C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3081 3347
3082 struct ev_loop *loop = ev_default_init (0); 3348 struct ev_loop *loop = ev_default_init (0);
3083 struct ev_loop *loop_socket = 0; 3349 struct ev_loop *loop_socket = 0;
3084 ev_embed embed; 3350 ev_embed embed;
3085 3351
3086 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3352 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3087 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3353 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3088 { 3354 {
3089 ev_embed_init (&embed, 0, loop_socket); 3355 ev_embed_init (&embed, 0, loop_socket);
3090 ev_embed_start (loop, &embed); 3356 ev_embed_start (loop, &embed);
3098 3364
3099=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3365=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3100 3366
3101Fork watchers are called when a C<fork ()> was detected (usually because 3367Fork watchers are called when a C<fork ()> was detected (usually because
3102whoever is a good citizen cared to tell libev about it by calling 3368whoever is a good citizen cared to tell libev about it by calling
3103C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the 3369C<ev_loop_fork>). The invocation is done before the event loop blocks next
3104event loop blocks next and before C<ev_check> watchers are being called, 3370and before C<ev_check> watchers are being called, and only in the child
3105and only in the child after the fork. If whoever good citizen calling 3371after the fork. If whoever good citizen calling C<ev_default_fork> cheats
3106C<ev_default_fork> cheats and calls it in the wrong process, the fork 3372and calls it in the wrong process, the fork handlers will be invoked, too,
3107handlers will be invoked, too, of course. 3373of course.
3108 3374
3109=head3 The special problem of life after fork - how is it possible? 3375=head3 The special problem of life after fork - how is it possible?
3110 3376
3111Most uses of C<fork()> consist of forking, then some simple calls to set 3377Most uses of C<fork ()> consist of forking, then some simple calls to set
3112up/change the process environment, followed by a call to C<exec()>. This 3378up/change the process environment, followed by a call to C<exec()>. This
3113sequence should be handled by libev without any problems. 3379sequence should be handled by libev without any problems.
3114 3380
3115This changes when the application actually wants to do event handling 3381This changes when the application actually wants to do event handling
3116in the child, or both parent in child, in effect "continuing" after the 3382in the child, or both parent in child, in effect "continuing" after the
3205it by calling C<ev_async_send>, which is thread- and signal safe. 3471it by calling C<ev_async_send>, which is thread- and signal safe.
3206 3472
3207This functionality is very similar to C<ev_signal> watchers, as signals, 3473This functionality is very similar to C<ev_signal> watchers, as signals,
3208too, are asynchronous in nature, and signals, too, will be compressed 3474too, are asynchronous in nature, and signals, too, will be compressed
3209(i.e. the number of callback invocations may be less than the number of 3475(i.e. the number of callback invocations may be less than the number of
3210C<ev_async_sent> calls). In fact, you could use signal watchers as a kind 3476C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3211of "global async watchers" by using a watcher on an otherwise unused 3477of "global async watchers" by using a watcher on an otherwise unused
3212signal, and C<ev_feed_signal> to signal this watcher from another thread, 3478signal, and C<ev_feed_signal> to signal this watcher from another thread,
3213even without knowing which loop owns the signal. 3479even without knowing which loop owns the signal.
3214
3215Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3216just the default loop.
3217 3480
3218=head3 Queueing 3481=head3 Queueing
3219 3482
3220C<ev_async> does not support queueing of data in any way. The reason 3483C<ev_async> does not support queueing of data in any way. The reason
3221is that the author does not know of a simple (or any) algorithm for a 3484is that the author does not know of a simple (or any) algorithm for a
3321Unlike C<ev_feed_event>, this call is safe to do from other threads, 3584Unlike C<ev_feed_event>, this call is safe to do from other threads,
3322signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the 3585signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3323embedding section below on what exactly this means). 3586embedding section below on what exactly this means).
3324 3587
3325Note that, as with other watchers in libev, multiple events might get 3588Note that, as with other watchers in libev, multiple events might get
3326compressed into a single callback invocation (another way to look at this 3589compressed into a single callback invocation (another way to look at
3327is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, 3590this is that C<ev_async> watchers are level-triggered: they are set on
3328reset when the event loop detects that). 3591C<ev_async_send>, reset when the event loop detects that).
3329 3592
3330This call incurs the overhead of a system call only once per event loop 3593This call incurs the overhead of at most one extra system call per event
3331iteration, so while the overhead might be noticeable, it doesn't apply to 3594loop iteration, if the event loop is blocked, and no syscall at all if
3332repeated calls to C<ev_async_send> for the same event loop. 3595the event loop (or your program) is processing events. That means that
3596repeated calls are basically free (there is no need to avoid calls for
3597performance reasons) and that the overhead becomes smaller (typically
3598zero) under load.
3333 3599
3334=item bool = ev_async_pending (ev_async *) 3600=item bool = ev_async_pending (ev_async *)
3335 3601
3336Returns a non-zero value when C<ev_async_send> has been called on the 3602Returns a non-zero value when C<ev_async_send> has been called on the
3337watcher but the event has not yet been processed (or even noted) by the 3603watcher but the event has not yet been processed (or even noted) by the
3354 3620
3355There are some other functions of possible interest. Described. Here. Now. 3621There are some other functions of possible interest. Described. Here. Now.
3356 3622
3357=over 4 3623=over 4
3358 3624
3359=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 3625=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3360 3626
3361This function combines a simple timer and an I/O watcher, calls your 3627This function combines a simple timer and an I/O watcher, calls your
3362callback on whichever event happens first and automatically stops both 3628callback on whichever event happens first and automatically stops both
3363watchers. This is useful if you want to wait for a single event on an fd 3629watchers. This is useful if you want to wait for a single event on an fd
3364or timeout without having to allocate/configure/start/stop/free one or 3630or timeout without having to allocate/configure/start/stop/free one or
3392 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3658 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3393 3659
3394=item ev_feed_fd_event (loop, int fd, int revents) 3660=item ev_feed_fd_event (loop, int fd, int revents)
3395 3661
3396Feed an event on the given fd, as if a file descriptor backend detected 3662Feed an event on the given fd, as if a file descriptor backend detected
3397the given events it. 3663the given events.
3398 3664
3399=item ev_feed_signal_event (loop, int signum) 3665=item ev_feed_signal_event (loop, int signum)
3400 3666
3401Feed an event as if the given signal occurred. See also C<ev_feed_signal>, 3667Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3402which is async-safe. 3668which is async-safe.
3476 { 3742 {
3477 struct my_biggy big = (struct my_biggy *) 3743 struct my_biggy big = (struct my_biggy *)
3478 (((char *)w) - offsetof (struct my_biggy, t2)); 3744 (((char *)w) - offsetof (struct my_biggy, t2));
3479 } 3745 }
3480 3746
3747=head2 AVOIDING FINISHING BEFORE RETURNING
3748
3749Often you have structures like this in event-based programs:
3750
3751 callback ()
3752 {
3753 free (request);
3754 }
3755
3756 request = start_new_request (..., callback);
3757
3758The intent is to start some "lengthy" operation. The C<request> could be
3759used to cancel the operation, or do other things with it.
3760
3761It's not uncommon to have code paths in C<start_new_request> that
3762immediately invoke the callback, for example, to report errors. Or you add
3763some caching layer that finds that it can skip the lengthy aspects of the
3764operation and simply invoke the callback with the result.
3765
3766The problem here is that this will happen I<before> C<start_new_request>
3767has returned, so C<request> is not set.
3768
3769Even if you pass the request by some safer means to the callback, you
3770might want to do something to the request after starting it, such as
3771canceling it, which probably isn't working so well when the callback has
3772already been invoked.
3773
3774A common way around all these issues is to make sure that
3775C<start_new_request> I<always> returns before the callback is invoked. If
3776C<start_new_request> immediately knows the result, it can artificially
3777delay invoking the callback by using a C<prepare> or C<idle> watcher for
3778example, or more sneakily, by reusing an existing (stopped) watcher and
3779pushing it into the pending queue:
3780
3781 ev_set_cb (watcher, callback);
3782 ev_feed_event (EV_A_ watcher, 0);
3783
3784This way, C<start_new_request> can safely return before the callback is
3785invoked, while not delaying callback invocation too much.
3786
3481=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS 3787=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
3482 3788
3483Often (especially in GUI toolkits) there are places where you have 3789Often (especially in GUI toolkits) there are places where you have
3484I<modal> interaction, which is most easily implemented by recursively 3790I<modal> interaction, which is most easily implemented by recursively
3485invoking C<ev_run>. 3791invoking C<ev_run>.
3486 3792
3487This brings the problem of exiting - a callback might want to finish the 3793This brings the problem of exiting - a callback might want to finish the
3488main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but 3794main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3489a modal "Are you sure?" dialog is still waiting), or just the nested one 3795a modal "Are you sure?" dialog is still waiting), or just the nested one
3490and not the main one (e.g. user clocked "Ok" in a modal dialog), or some 3796and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3491other combination: In these cases, C<ev_break> will not work alone. 3797other combination: In these cases, a simple C<ev_break> will not work.
3492 3798
3493The solution is to maintain "break this loop" variable for each C<ev_run> 3799The solution is to maintain "break this loop" variable for each C<ev_run>
3494invocation, and use a loop around C<ev_run> until the condition is 3800invocation, and use a loop around C<ev_run> until the condition is
3495triggered, using C<EVRUN_ONCE>: 3801triggered, using C<EVRUN_ONCE>:
3496 3802
3498 int exit_main_loop = 0; 3804 int exit_main_loop = 0;
3499 3805
3500 while (!exit_main_loop) 3806 while (!exit_main_loop)
3501 ev_run (EV_DEFAULT_ EVRUN_ONCE); 3807 ev_run (EV_DEFAULT_ EVRUN_ONCE);
3502 3808
3503 // in a model watcher 3809 // in a modal watcher
3504 int exit_nested_loop = 0; 3810 int exit_nested_loop = 0;
3505 3811
3506 while (!exit_nested_loop) 3812 while (!exit_nested_loop)
3507 ev_run (EV_A_ EVRUN_ONCE); 3813 ev_run (EV_A_ EVRUN_ONCE);
3508 3814
3682called): 3988called):
3683 3989
3684 void 3990 void
3685 wait_for_event (ev_watcher *w) 3991 wait_for_event (ev_watcher *w)
3686 { 3992 {
3687 ev_cb_set (w) = current_coro; 3993 ev_set_cb (w, current_coro);
3688 switch_to (libev_coro); 3994 switch_to (libev_coro);
3689 } 3995 }
3690 3996
3691That basically suspends the coroutine inside C<wait_for_event> and 3997That basically suspends the coroutine inside C<wait_for_event> and
3692continues the libev coroutine, which, when appropriate, switches back to 3998continues the libev coroutine, which, when appropriate, switches back to
3693this or any other coroutine. I am sure if you sue this your own :) 3999this or any other coroutine.
3694 4000
3695You can do similar tricks if you have, say, threads with an event queue - 4001You can do similar tricks if you have, say, threads with an event queue -
3696instead of storing a coroutine, you store the queue object and instead of 4002instead of storing a coroutine, you store the queue object and instead of
3697switching to a coroutine, you push the watcher onto the queue and notify 4003switching to a coroutine, you push the watcher onto the queue and notify
3698any waiters. 4004any waiters.
3699 4005
3700To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 4006To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3701files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 4007files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3702 4008
3703 // my_ev.h 4009 // my_ev.h
3704 #define EV_CB_DECLARE(type) struct my_coro *cb; 4010 #define EV_CB_DECLARE(type) struct my_coro *cb;
3705 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 4011 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3706 #include "../libev/ev.h" 4012 #include "../libev/ev.h"
3707 4013
3708 // my_ev.c 4014 // my_ev.c
3709 #define EV_H "my_ev.h" 4015 #define EV_H "my_ev.h"
3710 #include "../libev/ev.c" 4016 #include "../libev/ev.c"
3749 4055
3750=back 4056=back
3751 4057
3752=head1 C++ SUPPORT 4058=head1 C++ SUPPORT
3753 4059
4060=head2 C API
4061
4062The normal C API should work fine when used from C++: both ev.h and the
4063libev sources can be compiled as C++. Therefore, code that uses the C API
4064will work fine.
4065
4066Proper exception specifications might have to be added to callbacks passed
4067to libev: exceptions may be thrown only from watcher callbacks, all other
4068callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4069callbacks) must not throw exceptions, and might need a C<noexcept>
4070specification. If you have code that needs to be compiled as both C and
4071C++ you can use the C<EV_NOEXCEPT> macro for this:
4072
4073 static void
4074 fatal_error (const char *msg) EV_NOEXCEPT
4075 {
4076 perror (msg);
4077 abort ();
4078 }
4079
4080 ...
4081 ev_set_syserr_cb (fatal_error);
4082
4083The only API functions that can currently throw exceptions are C<ev_run>,
4084C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
4085because it runs cleanup watchers).
4086
4087Throwing exceptions in watcher callbacks is only supported if libev itself
4088is compiled with a C++ compiler or your C and C++ environments allow
4089throwing exceptions through C libraries (most do).
4090
4091=head2 C++ API
4092
3754Libev comes with some simplistic wrapper classes for C++ that mainly allow 4093Libev comes with some simplistic wrapper classes for C++ that mainly allow
3755you to use some convenience methods to start/stop watchers and also change 4094you to use some convenience methods to start/stop watchers and also change
3756the callback model to a model using method callbacks on objects. 4095the callback model to a model using method callbacks on objects.
3757 4096
3758To use it, 4097To use it,
3759 4098
3760 #include <ev++.h> 4099 #include <ev++.h>
3761 4100
3762This automatically includes F<ev.h> and puts all of its definitions (many 4101This automatically includes F<ev.h> and puts all of its definitions (many
3763of them macros) into the global namespace. All C++ specific things are 4102of them macros) into the global namespace. All C++ specific things are
3764put into the C<ev> namespace. It should support all the same embedding 4103put into the C<ev> namespace. It should support all the same embedding
3773with C<operator ()> can be used as callbacks. Other types should be easy 4112with C<operator ()> can be used as callbacks. Other types should be easy
3774to add as long as they only need one additional pointer for context. If 4113to add as long as they only need one additional pointer for context. If
3775you need support for other types of functors please contact the author 4114you need support for other types of functors please contact the author
3776(preferably after implementing it). 4115(preferably after implementing it).
3777 4116
4117For all this to work, your C++ compiler either has to use the same calling
4118conventions as your C compiler (for static member functions), or you have
4119to embed libev and compile libev itself as C++.
4120
3778Here is a list of things available in the C<ev> namespace: 4121Here is a list of things available in the C<ev> namespace:
3779 4122
3780=over 4 4123=over 4
3781 4124
3782=item C<ev::READ>, C<ev::WRITE> etc. 4125=item C<ev::READ>, C<ev::WRITE> etc.
3791=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. 4134=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3792 4135
3793For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of 4136For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3794the same name in the C<ev> namespace, with the exception of C<ev_signal> 4137the same name in the C<ev> namespace, with the exception of C<ev_signal>
3795which is called C<ev::sig> to avoid clashes with the C<signal> macro 4138which is called C<ev::sig> to avoid clashes with the C<signal> macro
3796defines by many implementations. 4139defined by many implementations.
3797 4140
3798All of those classes have these methods: 4141All of those classes have these methods:
3799 4142
3800=over 4 4143=over 4
3801 4144
3863 void operator() (ev::io &w, int revents) 4206 void operator() (ev::io &w, int revents)
3864 { 4207 {
3865 ... 4208 ...
3866 } 4209 }
3867 } 4210 }
3868 4211
3869 myfunctor f; 4212 myfunctor f;
3870 4213
3871 ev::io w; 4214 ev::io w;
3872 w.set (&f); 4215 w.set (&f);
3873 4216
3891Associates a different C<struct ev_loop> with this watcher. You can only 4234Associates a different C<struct ev_loop> with this watcher. You can only
3892do this when the watcher is inactive (and not pending either). 4235do this when the watcher is inactive (and not pending either).
3893 4236
3894=item w->set ([arguments]) 4237=item w->set ([arguments])
3895 4238
3896Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4239Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
3897method or a suitable start method must be called at least once. Unlike the 4240with the same arguments. Either this method or a suitable start method
3898C counterpart, an active watcher gets automatically stopped and restarted 4241must be called at least once. Unlike the C counterpart, an active watcher
3899when reconfiguring it with this method. 4242gets automatically stopped and restarted when reconfiguring it with this
4243method.
4244
4245For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4246clashing with the C<set (loop)> method.
3900 4247
3901=item w->start () 4248=item w->start ()
3902 4249
3903Starts the watcher. Note that there is no C<loop> argument, as the 4250Starts the watcher. Note that there is no C<loop> argument, as the
3904constructor already stores the event loop. 4251constructor already stores the event loop.
3934watchers in the constructor. 4281watchers in the constructor.
3935 4282
3936 class myclass 4283 class myclass
3937 { 4284 {
3938 ev::io io ; void io_cb (ev::io &w, int revents); 4285 ev::io io ; void io_cb (ev::io &w, int revents);
3939 ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4286 ev::io io2 ; void io2_cb (ev::io &w, int revents);
3940 ev::idle idle; void idle_cb (ev::idle &w, int revents); 4287 ev::idle idle; void idle_cb (ev::idle &w, int revents);
3941 4288
3942 myclass (int fd) 4289 myclass (int fd)
3943 { 4290 {
3944 io .set <myclass, &myclass::io_cb > (this); 4291 io .set <myclass, &myclass::io_cb > (this);
3995L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. 4342L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3996 4343
3997=item D 4344=item D
3998 4345
3999Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 4346Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
4000be found at L<http://proj.llucax.com.ar/wiki/evd>. 4347be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
4001 4348
4002=item Ocaml 4349=item Ocaml
4003 4350
4004Erkki Seppala has written Ocaml bindings for libev, to be found at 4351Erkki Seppala has written Ocaml bindings for libev, to be found at
4005L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 4352L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
4008 4355
4009Brian Maher has written a partial interface to libev for lua (at the 4356Brian Maher has written a partial interface to libev for lua (at the
4010time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4357time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4011L<http://github.com/brimworks/lua-ev>. 4358L<http://github.com/brimworks/lua-ev>.
4012 4359
4360=item Javascript
4361
4362Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4363
4364=item Others
4365
4366There are others, and I stopped counting.
4367
4013=back 4368=back
4014 4369
4015 4370
4016=head1 MACRO MAGIC 4371=head1 MACRO MAGIC
4017 4372
4053suitable for use with C<EV_A>. 4408suitable for use with C<EV_A>.
4054 4409
4055=item C<EV_DEFAULT>, C<EV_DEFAULT_> 4410=item C<EV_DEFAULT>, C<EV_DEFAULT_>
4056 4411
4057Similar to the other two macros, this gives you the value of the default 4412Similar to the other two macros, this gives you the value of the default
4058loop, if multiple loops are supported ("ev loop default"). 4413loop, if multiple loops are supported ("ev loop default"). The default loop
4414will be initialised if it isn't already initialised.
4415
4416For non-multiplicity builds, these macros do nothing, so you always have
4417to initialise the loop somewhere.
4059 4418
4060=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> 4419=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
4061 4420
4062Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the 4421Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
4063default loop has been initialised (C<UC> == unchecked). Their behaviour 4422default loop has been initialised (C<UC> == unchecked). Their behaviour
4130 ev_vars.h 4489 ev_vars.h
4131 ev_wrap.h 4490 ev_wrap.h
4132 4491
4133 ev_win32.c required on win32 platforms only 4492 ev_win32.c required on win32 platforms only
4134 4493
4135 ev_select.c only when select backend is enabled (which is enabled by default) 4494 ev_select.c only when select backend is enabled
4136 ev_poll.c only when poll backend is enabled (disabled by default) 4495 ev_poll.c only when poll backend is enabled
4137 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4496 ev_epoll.c only when the epoll backend is enabled
4497 ev_linuxaio.c only when the linux aio backend is enabled
4498 ev_iouring.c only when the linux io_uring backend is enabled
4138 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4499 ev_kqueue.c only when the kqueue backend is enabled
4139 ev_port.c only when the solaris port backend is enabled (disabled by default) 4500 ev_port.c only when the solaris port backend is enabled
4140 4501
4141F<ev.c> includes the backend files directly when enabled, so you only need 4502F<ev.c> includes the backend files directly when enabled, so you only need
4142to compile this single file. 4503to compile this single file.
4143 4504
4144=head3 LIBEVENT COMPATIBILITY API 4505=head3 LIBEVENT COMPATIBILITY API
4263available and will probe for kernel support at runtime. This will improve 4624available and will probe for kernel support at runtime. This will improve
4264C<ev_signal> and C<ev_async> performance and reduce resource consumption. 4625C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4265If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc 4626If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
42662.7 or newer, otherwise disabled. 46272.7 or newer, otherwise disabled.
4267 4628
4629=item EV_USE_SIGNALFD
4630
4631If defined to be C<1>, then libev will assume that C<signalfd ()> is
4632available and will probe for kernel support at runtime. This enables
4633the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If
4634undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46352.7 or newer, otherwise disabled.
4636
4637=item EV_USE_TIMERFD
4638
4639If defined to be C<1>, then libev will assume that C<timerfd ()> is
4640available and will probe for kernel support at runtime. This allows
4641libev to detect time jumps accurately. If undefined, it will be enabled
4642if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
4643C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled.
4644
4645=item EV_USE_EVENTFD
4646
4647If defined to be C<1>, then libev will assume that C<eventfd ()> is
4648available and will probe for kernel support at runtime. This will improve
4649C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4650If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46512.7 or newer, otherwise disabled.
4652
4268=item EV_USE_SELECT 4653=item EV_USE_SELECT
4269 4654
4270If undefined or defined to be C<1>, libev will compile in support for the 4655If undefined or defined to be C<1>, libev will compile in support for the
4271C<select>(2) backend. No attempt at auto-detection will be done: if no 4656C<select>(2) backend. No attempt at auto-detection will be done: if no
4272other method takes over, select will be it. Otherwise the select backend 4657other method takes over, select will be it. Otherwise the select backend
4312If programs implement their own fd to handle mapping on win32, then this 4697If programs implement their own fd to handle mapping on win32, then this
4313macro can be used to override the C<close> function, useful to unregister 4698macro can be used to override the C<close> function, useful to unregister
4314file descriptors again. Note that the replacement function has to close 4699file descriptors again. Note that the replacement function has to close
4315the underlying OS handle. 4700the underlying OS handle.
4316 4701
4702=item EV_USE_WSASOCKET
4703
4704If defined to be C<1>, libev will use C<WSASocket> to create its internal
4705communication socket, which works better in some environments. Otherwise,
4706the normal C<socket> function will be used, which works better in other
4707environments.
4708
4317=item EV_USE_POLL 4709=item EV_USE_POLL
4318 4710
4319If defined to be C<1>, libev will compile in support for the C<poll>(2) 4711If defined to be C<1>, libev will compile in support for the C<poll>(2)
4320backend. Otherwise it will be enabled on non-win32 platforms. It 4712backend. Otherwise it will be enabled on non-win32 platforms. It
4321takes precedence over select. 4713takes precedence over select.
4325If defined to be C<1>, libev will compile in support for the Linux 4717If defined to be C<1>, libev will compile in support for the Linux
4326C<epoll>(7) backend. Its availability will be detected at runtime, 4718C<epoll>(7) backend. Its availability will be detected at runtime,
4327otherwise another method will be used as fallback. This is the preferred 4719otherwise another method will be used as fallback. This is the preferred
4328backend for GNU/Linux systems. If undefined, it will be enabled if the 4720backend for GNU/Linux systems. If undefined, it will be enabled if the
4329headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4721headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4722
4723=item EV_USE_LINUXAIO
4724
4725If defined to be C<1>, libev will compile in support for the Linux aio
4726backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be
4727enabled on linux, otherwise disabled.
4728
4729=item EV_USE_IOURING
4730
4731If defined to be C<1>, libev will compile in support for the Linux
4732io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's
4733current limitations it has to be requested explicitly. If undefined, it
4734will be enabled on linux, otherwise disabled.
4330 4735
4331=item EV_USE_KQUEUE 4736=item EV_USE_KQUEUE
4332 4737
4333If defined to be C<1>, libev will compile in support for the BSD style 4738If defined to be C<1>, libev will compile in support for the BSD style
4334C<kqueue>(2) backend. Its actual availability will be detected at runtime, 4739C<kqueue>(2) backend. Its actual availability will be detected at runtime,
4356If defined to be C<1>, libev will compile in support for the Linux inotify 4761If defined to be C<1>, libev will compile in support for the Linux inotify
4357interface to speed up C<ev_stat> watchers. Its actual availability will 4762interface to speed up C<ev_stat> watchers. Its actual availability will
4358be detected at runtime. If undefined, it will be enabled if the headers 4763be detected at runtime. If undefined, it will be enabled if the headers
4359indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4764indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4360 4765
4766=item EV_NO_SMP
4767
4768If defined to be C<1>, libev will assume that memory is always coherent
4769between threads, that is, threads can be used, but threads never run on
4770different cpus (or different cpu cores). This reduces dependencies
4771and makes libev faster.
4772
4773=item EV_NO_THREADS
4774
4775If defined to be C<1>, libev will assume that it will never be called from
4776different threads (that includes signal handlers), which is a stronger
4777assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4778libev faster.
4779
4361=item EV_ATOMIC_T 4780=item EV_ATOMIC_T
4362 4781
4363Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4782Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4364access is atomic with respect to other threads or signal contexts. No such 4783access is atomic with respect to other threads or signal contexts. No
4365type is easily found in the C language, so you can provide your own type 4784such type is easily found in the C language, so you can provide your own
4366that you know is safe for your purposes. It is used both for signal handler "locking" 4785type that you know is safe for your purposes. It is used both for signal
4367as well as for signal and thread safety in C<ev_async> watchers. 4786handler "locking" as well as for signal and thread safety in C<ev_async>
4787watchers.
4368 4788
4369In the absence of this define, libev will use C<sig_atomic_t volatile> 4789In the absence of this define, libev will use C<sig_atomic_t volatile>
4370(from F<signal.h>), which is usually good enough on most platforms. 4790(from F<signal.h>), which is usually good enough on most platforms.
4371 4791
4372=item EV_H (h) 4792=item EV_H (h)
4399will have the C<struct ev_loop *> as first argument, and you can create 4819will have the C<struct ev_loop *> as first argument, and you can create
4400additional independent event loops. Otherwise there will be no support 4820additional independent event loops. Otherwise there will be no support
4401for multiple event loops and there is no first event loop pointer 4821for multiple event loops and there is no first event loop pointer
4402argument. Instead, all functions act on the single default loop. 4822argument. Instead, all functions act on the single default loop.
4403 4823
4824Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
4825default loop when multiplicity is switched off - you always have to
4826initialise the loop manually in this case.
4827
4404=item EV_MINPRI 4828=item EV_MINPRI
4405 4829
4406=item EV_MAXPRI 4830=item EV_MAXPRI
4407 4831
4408The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to 4832The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
4444 #define EV_USE_POLL 1 4868 #define EV_USE_POLL 1
4445 #define EV_CHILD_ENABLE 1 4869 #define EV_CHILD_ENABLE 1
4446 #define EV_ASYNC_ENABLE 1 4870 #define EV_ASYNC_ENABLE 1
4447 4871
4448The actual value is a bitset, it can be a combination of the following 4872The actual value is a bitset, it can be a combination of the following
4449values: 4873values (by default, all of these are enabled):
4450 4874
4451=over 4 4875=over 4
4452 4876
4453=item C<1> - faster/larger code 4877=item C<1> - faster/larger code
4454 4878
4458code size by roughly 30% on amd64). 4882code size by roughly 30% on amd64).
4459 4883
4460When optimising for size, use of compiler flags such as C<-Os> with 4884When optimising for size, use of compiler flags such as C<-Os> with
4461gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of 4885gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4462assertions. 4886assertions.
4887
4888The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4889(e.g. gcc with C<-Os>).
4463 4890
4464=item C<2> - faster/larger data structures 4891=item C<2> - faster/larger data structures
4465 4892
4466Replaces the small 2-heap for timer management by a faster 4-heap, larger 4893Replaces the small 2-heap for timer management by a faster 4-heap, larger
4467hash table sizes and so on. This will usually further increase code size 4894hash table sizes and so on. This will usually further increase code size
4468and can additionally have an effect on the size of data structures at 4895and can additionally have an effect on the size of data structures at
4469runtime. 4896runtime.
4470 4897
4898The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4899(e.g. gcc with C<-Os>).
4900
4471=item C<4> - full API configuration 4901=item C<4> - full API configuration
4472 4902
4473This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and 4903This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4474enables multiplicity (C<EV_MULTIPLICITY>=1). 4904enables multiplicity (C<EV_MULTIPLICITY>=1).
4475 4905
4505 4935
4506With an intelligent-enough linker (gcc+binutils are intelligent enough 4936With an intelligent-enough linker (gcc+binutils are intelligent enough
4507when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by 4937when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
4508your program might be left out as well - a binary starting a timer and an 4938your program might be left out as well - a binary starting a timer and an
4509I/O watcher then might come out at only 5Kb. 4939I/O watcher then might come out at only 5Kb.
4940
4941=item EV_API_STATIC
4942
4943If this symbol is defined (by default it is not), then all identifiers
4944will have static linkage. This means that libev will not export any
4945identifiers, and you cannot link against libev anymore. This can be useful
4946when you embed libev, only want to use libev functions in a single file,
4947and do not want its identifiers to be visible.
4948
4949To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
4950wants to use libev.
4951
4952This option only works when libev is compiled with a C compiler, as C++
4953doesn't support the required declaration syntax.
4510 4954
4511=item EV_AVOID_STDIO 4955=item EV_AVOID_STDIO
4512 4956
4513If this is set to C<1> at compiletime, then libev will avoid using stdio 4957If this is set to C<1> at compiletime, then libev will avoid using stdio
4514functions (printf, scanf, perror etc.). This will increase the code size 4958functions (printf, scanf, perror etc.). This will increase the code size
4572in. If set to C<1>, then verification code will be compiled in, but not 5016in. If set to C<1>, then verification code will be compiled in, but not
4573called. If set to C<2>, then the internal verification code will be 5017called. If set to C<2>, then the internal verification code will be
4574called once per loop, which can slow down libev. If set to C<3>, then the 5018called once per loop, which can slow down libev. If set to C<3>, then the
4575verification code will be called very frequently, which will slow down 5019verification code will be called very frequently, which will slow down
4576libev considerably. 5020libev considerably.
5021
5022Verification errors are reported via C's C<assert> mechanism, so if you
5023disable that (e.g. by defining C<NDEBUG>) then no errors will be reported.
4577 5024
4578The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it 5025The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4579will be C<0>. 5026will be C<0>.
4580 5027
4581=item EV_COMMON 5028=item EV_COMMON
4719default loop and triggering an C<ev_async> watcher from the default loop 5166default loop and triggering an C<ev_async> watcher from the default loop
4720watcher callback into the event loop interested in the signal. 5167watcher callback into the event loop interested in the signal.
4721 5168
4722=back 5169=back
4723 5170
4724See also L<THREAD LOCKING EXAMPLE>. 5171See also L</THREAD LOCKING EXAMPLE>.
4725 5172
4726=head3 COROUTINES 5173=head3 COROUTINES
4727 5174
4728Libev is very accommodating to coroutines ("cooperative threads"): 5175Libev is very accommodating to coroutines ("cooperative threads"):
4729libev fully supports nesting calls to its functions from different 5176libev fully supports nesting calls to its functions from different
4894requires, and its I/O model is fundamentally incompatible with the POSIX 5341requires, and its I/O model is fundamentally incompatible with the POSIX
4895model. Libev still offers limited functionality on this platform in 5342model. Libev still offers limited functionality on this platform in
4896the form of the C<EVBACKEND_SELECT> backend, and only supports socket 5343the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4897descriptors. This only applies when using Win32 natively, not when using 5344descriptors. This only applies when using Win32 natively, not when using
4898e.g. cygwin. Actually, it only applies to the microsofts own compilers, 5345e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4899as every compielr comes with a slightly differently broken/incompatible 5346as every compiler comes with a slightly differently broken/incompatible
4900environment. 5347environment.
4901 5348
4902Lifting these limitations would basically require the full 5349Lifting these limitations would basically require the full
4903re-implementation of the I/O system. If you are into this kind of thing, 5350re-implementation of the I/O system. If you are into this kind of thing,
4904then note that glib does exactly that for you in a very portable way (note 5351then note that glib does exactly that for you in a very portable way (note
4998structure (guaranteed by POSIX but not by ISO C for example), but it also 5445structure (guaranteed by POSIX but not by ISO C for example), but it also
4999assumes that the same (machine) code can be used to call any watcher 5446assumes that the same (machine) code can be used to call any watcher
5000callback: The watcher callbacks have different type signatures, but libev 5447callback: The watcher callbacks have different type signatures, but libev
5001calls them using an C<ev_watcher *> internally. 5448calls them using an C<ev_watcher *> internally.
5002 5449
5450=item null pointers and integer zero are represented by 0 bytes
5451
5452Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
5453relies on this setting pointers and integers to null.
5454
5003=item pointer accesses must be thread-atomic 5455=item pointer accesses must be thread-atomic
5004 5456
5005Accessing a pointer value must be atomic, it must both be readable and 5457Accessing a pointer value must be atomic, it must both be readable and
5006writable in one piece - this is the case on all current architectures. 5458writable in one piece - this is the case on all current architectures.
5007 5459
5020thread" or will block signals process-wide, both behaviours would 5472thread" or will block signals process-wide, both behaviours would
5021be compatible with libev. Interaction between C<sigprocmask> and 5473be compatible with libev. Interaction between C<sigprocmask> and
5022C<pthread_sigmask> could complicate things, however. 5474C<pthread_sigmask> could complicate things, however.
5023 5475
5024The most portable way to handle signals is to block signals in all threads 5476The most portable way to handle signals is to block signals in all threads
5025except the initial one, and run the default loop in the initial thread as 5477except the initial one, and run the signal handling loop in the initial
5026well. 5478thread as well.
5027 5479
5028=item C<long> must be large enough for common memory allocation sizes 5480=item C<long> must be large enough for common memory allocation sizes
5029 5481
5030To improve portability and simplify its API, libev uses C<long> internally 5482To improve portability and simplify its API, libev uses C<long> internally
5031instead of C<size_t> when allocating its data structures. On non-POSIX 5483instead of C<size_t> when allocating its data structures. On non-POSIX
5037 5489
5038The type C<double> is used to represent timestamps. It is required to 5490The type C<double> is used to represent timestamps. It is required to
5039have at least 51 bits of mantissa (and 9 bits of exponent), which is 5491have at least 51 bits of mantissa (and 9 bits of exponent), which is
5040good enough for at least into the year 4000 with millisecond accuracy 5492good enough for at least into the year 4000 with millisecond accuracy
5041(the design goal for libev). This requirement is overfulfilled by 5493(the design goal for libev). This requirement is overfulfilled by
5042implementations using IEEE 754, which is basically all existing ones. With 5494implementations using IEEE 754, which is basically all existing ones.
5495
5043IEEE 754 doubles, you get microsecond accuracy until at least 2200. 5496With IEEE 754 doubles, you get microsecond accuracy until at least the
5497year 2255 (and millisecond accuracy till the year 287396 - by then, libev
5498is either obsolete or somebody patched it to use C<long double> or
5499something like that, just kidding).
5044 5500
5045=back 5501=back
5046 5502
5047If you know of other additional requirements drop me a note. 5503If you know of other additional requirements drop me a note.
5048 5504
5110=item Processing ev_async_send: O(number_of_async_watchers) 5566=item Processing ev_async_send: O(number_of_async_watchers)
5111 5567
5112=item Processing signals: O(max_signal_number) 5568=item Processing signals: O(max_signal_number)
5113 5569
5114Sending involves a system call I<iff> there were no other C<ev_async_send> 5570Sending involves a system call I<iff> there were no other C<ev_async_send>
5115calls in the current loop iteration. Checking for async and signal events 5571calls in the current loop iteration and the loop is currently
5572blocked. Checking for async and signal events involves iterating over all
5116involves iterating over all running async watchers or all signal numbers. 5573running async watchers or all signal numbers.
5117 5574
5118=back 5575=back
5119 5576
5120 5577
5121=head1 PORTING FROM LIBEV 3.X TO 4.X 5578=head1 PORTING FROM LIBEV 3.X TO 4.X
5130=over 4 5587=over 4
5131 5588
5132=item C<EV_COMPAT3> backwards compatibility mechanism 5589=item C<EV_COMPAT3> backwards compatibility mechanism
5133 5590
5134The backward compatibility mechanism can be controlled by 5591The backward compatibility mechanism can be controlled by
5135C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5592C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5136section. 5593section.
5137 5594
5138=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5595=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5139 5596
5140These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5597These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5183=over 4 5640=over 4
5184 5641
5185=item active 5642=item active
5186 5643
5187A watcher is active as long as it has been started and not yet stopped. 5644A watcher is active as long as it has been started and not yet stopped.
5188See L<WATCHER STATES> for details. 5645See L</WATCHER STATES> for details.
5189 5646
5190=item application 5647=item application
5191 5648
5192In this document, an application is whatever is using libev. 5649In this document, an application is whatever is using libev.
5193 5650
5229watchers and events. 5686watchers and events.
5230 5687
5231=item pending 5688=item pending
5232 5689
5233A watcher is pending as soon as the corresponding event has been 5690A watcher is pending as soon as the corresponding event has been
5234detected. See L<WATCHER STATES> for details. 5691detected. See L</WATCHER STATES> for details.
5235 5692
5236=item real time 5693=item real time
5237 5694
5238The physical time that is observed. It is apparently strictly monotonic :) 5695The physical time that is observed. It is apparently strictly monotonic :)
5239 5696

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines