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

Comparing libev/ev.pod (file contents):
Revision 1.360 by root, Mon Jan 17 12:11:12 2011 UTC vs.
Revision 1.447 by root, Sat Jun 22 16:25:53 2019 UTC

1=encoding utf-8
2
1=head1 NAME 3=head1 NAME
2 4
3libev - a high performance full-featured event loop written in C 5libev - a high performance full-featured event loop written in C
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
58 ev_timer_start (loop, &timeout_watcher); 60 ev_timer_start (loop, &timeout_watcher);
59 61
60 // now wait for events to arrive 62 // now wait for events to arrive
61 ev_run (loop, 0); 63 ev_run (loop, 0);
62 64
63 // unloop was called, so exit 65 // break was called, so exit
64 return 0; 66 return 0;
65 } 67 }
66 68
67=head1 ABOUT THIS DOCUMENT 69=head1 ABOUT THIS DOCUMENT
68 70
82 84
83=head1 WHAT TO READ WHEN IN A HURRY 85=head1 WHAT TO READ WHEN IN A HURRY
84 86
85This manual tries to be very detailed, but unfortunately, this also makes 87This manual tries to be very detailed, but unfortunately, this also makes
86it very long. If you just want to know the basics of libev, I suggest 88it very long. If you just want to know the basics of libev, I suggest
87reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and 89reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and
88look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and 90look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and
89C<ev_timer> sections in L<WATCHER TYPES>. 91C<ev_timer> sections in L</WATCHER TYPES>.
90 92
91=head1 ABOUT LIBEV 93=head1 ABOUT LIBEV
92 94
93Libev is an event loop: you register interest in certain events (such as a 95Libev is an event loop: you register interest in certain events (such as a
94file descriptor being readable or a timeout occurring), and it will manage 96file descriptor being readable or a timeout occurring), and it will manage
103details of the event, and then hand it over to libev by I<starting> the 105details of the event, and then hand it over to libev by I<starting> the
104watcher. 106watcher.
105 107
106=head2 FEATURES 108=head2 FEATURES
107 109
108Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 110Libev supports C<select>, C<poll>, the Linux-specific aio and C<epoll>
109BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 111interfaces, the BSD-specific C<kqueue> and the Solaris-specific event port
110for file descriptor events (C<ev_io>), the Linux C<inotify> interface 112mechanisms for file descriptor events (C<ev_io>), the Linux C<inotify>
111(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner 113interface (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
112inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative 114inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
113timers (C<ev_timer>), absolute timers with customised rescheduling 115timers (C<ev_timer>), absolute timers with customised rescheduling
114(C<ev_periodic>), synchronous signals (C<ev_signal>), process status 116(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
115change events (C<ev_child>), and event watchers dealing with the event 117change events (C<ev_child>), and event watchers dealing with the event
116loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and 118loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
174=item ev_tstamp ev_time () 176=item ev_tstamp ev_time ()
175 177
176Returns the current time as libev would use it. Please note that the 178Returns the current time as libev would use it. Please note that the
177C<ev_now> function is usually faster and also often returns the timestamp 179C<ev_now> function is usually faster and also often returns the timestamp
178you actually want to know. Also interesting is the combination of 180you actually want to know. Also interesting is the combination of
179C<ev_update_now> and C<ev_now>. 181C<ev_now_update> and C<ev_now>.
180 182
181=item ev_sleep (ev_tstamp interval) 183=item ev_sleep (ev_tstamp interval)
182 184
183Sleep for the given interval: The current thread will be blocked until 185Sleep for the given interval: The current thread will be blocked
184either it is interrupted or the given time interval has passed. Basically 186until either it is interrupted or the given time interval has
187passed (approximately - it might return a bit earlier even if not
188interrupted). Returns immediately if C<< interval <= 0 >>.
189
185this is a sub-second-resolution C<sleep ()>. 190Basically this is a sub-second-resolution C<sleep ()>.
191
192The range of the C<interval> is limited - libev only guarantees to work
193with sleep times of up to one day (C<< interval <= 86400 >>).
186 194
187=item int ev_version_major () 195=item int ev_version_major ()
188 196
189=item int ev_version_minor () 197=item int ev_version_minor ()
190 198
241the current system, you would need to look at C<ev_embeddable_backends () 249the current system, you would need to look at C<ev_embeddable_backends ()
242& ev_supported_backends ()>, likewise for recommended ones. 250& ev_supported_backends ()>, likewise for recommended ones.
243 251
244See the description of C<ev_embed> watchers for more info. 252See the description of C<ev_embed> watchers for more info.
245 253
246=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 254=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
247 255
248Sets the allocation function to use (the prototype is similar - the 256Sets the allocation function to use (the prototype is similar - the
249semantics are identical to the C<realloc> C89/SuS/POSIX function). It is 257semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
250used to allocate and free memory (no surprises here). If it returns zero 258used to allocate and free memory (no surprises here). If it returns zero
251when memory needs to be allocated (C<size != 0>), the library might abort 259when memory needs to be allocated (C<size != 0>), the library might abort
257 265
258You could override this function in high-availability programs to, say, 266You could override this function in high-availability programs to, say,
259free some memory if it cannot allocate memory, to use a special allocator, 267free some memory if it cannot allocate memory, to use a special allocator,
260or even to sleep a while and retry until some memory is available. 268or even to sleep a while and retry until some memory is available.
261 269
270Example: The following is the C<realloc> function that libev itself uses
271which should work with C<realloc> and C<free> functions of all kinds and
272is probably a good basis for your own implementation.
273
274 static void *
275 ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT
276 {
277 if (size)
278 return realloc (ptr, size);
279
280 free (ptr);
281 return 0;
282 }
283
262Example: Replace the libev allocator with one that waits a bit and then 284Example: Replace the libev allocator with one that waits a bit and then
263retries (example requires a standards-compliant C<realloc>). 285retries.
264 286
265 static void * 287 static void *
266 persistent_realloc (void *ptr, size_t size) 288 persistent_realloc (void *ptr, size_t size)
267 { 289 {
290 if (!size)
291 {
292 free (ptr);
293 return 0;
294 }
295
268 for (;;) 296 for (;;)
269 { 297 {
270 void *newptr = realloc (ptr, size); 298 void *newptr = realloc (ptr, size);
271 299
272 if (newptr) 300 if (newptr)
277 } 305 }
278 306
279 ... 307 ...
280 ev_set_allocator (persistent_realloc); 308 ev_set_allocator (persistent_realloc);
281 309
282=item ev_set_syserr_cb (void (*cb)(const char *msg)) 310=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
283 311
284Set the callback function to call on a retryable system call error (such 312Set the callback function to call on a retryable system call error (such
285as failed select, poll, epoll_wait). The message is a printable string 313as failed select, poll, epoll_wait). The message is a printable string
286indicating the system call or subsystem causing the problem. If this 314indicating the system call or subsystem causing the problem. If this
287callback is set, then libev will expect it to remedy the situation, no 315callback is set, then libev will expect it to remedy the situation, no
390 418
391If this flag bit is or'ed into the flag value (or the program runs setuid 419If this flag bit is or'ed into the flag value (or the program runs setuid
392or setgid) then libev will I<not> look at the environment variable 420or setgid) then libev will I<not> look at the environment variable
393C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 421C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
394override the flags completely if it is found in the environment. This is 422override the flags completely if it is found in the environment. This is
395useful to try out specific backends to test their performance, or to work 423useful to try out specific backends to test their performance, to work
396around bugs. 424around bugs, or to make libev threadsafe (accessing environment variables
425cannot be done in a threadsafe way, but usually it works if no other
426thread modifies them).
397 427
398=item C<EVFLAG_FORKCHECK> 428=item C<EVFLAG_FORKCHECK>
399 429
400Instead of calling C<ev_loop_fork> manually after a fork, you can also 430Instead of calling C<ev_loop_fork> manually after a fork, you can also
401make libev check for a fork in each iteration by enabling this flag. 431make libev check for a fork in each iteration by enabling this flag.
402 432
403This works by calling C<getpid ()> on every iteration of the loop, 433This works by calling C<getpid ()> on every iteration of the loop,
404and thus this might slow down your event loop if you do a lot of loop 434and thus this might slow down your event loop if you do a lot of loop
405iterations and little real work, but is usually not noticeable (on my 435iterations and little real work, but is usually not noticeable (on my
406GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence 436GNU/Linux system for example, C<getpid> is actually a simple 5-insn
407without a system call and thus I<very> fast, but my GNU/Linux system also has 437sequence without a system call and thus I<very> fast, but my GNU/Linux
408C<pthread_atfork> which is even faster). 438system also has C<pthread_atfork> which is even faster). (Update: glibc
439versions 2.25 apparently removed the C<getpid> optimisation again).
409 440
410The big advantage of this flag is that you can forget about fork (and 441The big advantage of this flag is that you can forget about fork (and
411forget about forgetting to tell libev about forking) when you use this 442forget about forgetting to tell libev about forking, although you still
412flag. 443have to ignore C<SIGPIPE>) when you use this flag.
413 444
414This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> 445This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
415environment variable. 446environment variable.
416 447
417=item C<EVFLAG_NOINOTIFY> 448=item C<EVFLAG_NOINOTIFY>
435example) that can't properly initialise their signal masks. 466example) that can't properly initialise their signal masks.
436 467
437=item C<EVFLAG_NOSIGMASK> 468=item C<EVFLAG_NOSIGMASK>
438 469
439When this flag is specified, then libev will avoid to modify the signal 470When this flag is specified, then libev will avoid to modify the signal
440mask. Specifically, this means you ahve to make sure signals are unblocked 471mask. Specifically, this means you have to make sure signals are unblocked
441when you want to receive them. 472when you want to receive them.
442 473
443This behaviour is useful when you want to do your own signal handling, or 474This behaviour is useful when you want to do your own signal handling, or
444want to handle signals only in specific threads and want to avoid libev 475want to handle signals only in specific threads and want to avoid libev
445unblocking the signals. 476unblocking the signals.
483=item C<EVBACKEND_EPOLL> (value 4, Linux) 514=item C<EVBACKEND_EPOLL> (value 4, Linux)
484 515
485Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 516Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
486kernels). 517kernels).
487 518
488For few fds, this backend is a bit little slower than poll and select, 519For few fds, this backend is a bit little slower than poll and select, but
489but it scales phenomenally better. While poll and select usually scale 520it scales phenomenally better. While poll and select usually scale like
490like O(total_fds) where n is the total number of fds (or the highest fd), 521O(total_fds) where total_fds is the total number of fds (or the highest
491epoll scales either O(1) or O(active_fds). 522fd), epoll scales either O(1) or O(active_fds).
492 523
493The epoll mechanism deserves honorable mention as the most misdesigned 524The epoll mechanism deserves honorable mention as the most misdesigned
494of the more advanced event mechanisms: mere annoyances include silently 525of the more advanced event mechanisms: mere annoyances include silently
495dropping file descriptors, requiring a system call per change per file 526dropping file descriptors, requiring a system call per change per file
496descriptor (and unnecessary guessing of parameters), problems with dup, 527descriptor (and unnecessary guessing of parameters), problems with dup,
4990.1ms) and so on. The biggest issue is fork races, however - if a program 5300.1ms) and so on. The biggest issue is fork races, however - if a program
500forks then I<both> parent and child process have to recreate the epoll 531forks then I<both> parent and child process have to recreate the epoll
501set, which can take considerable time (one syscall per file descriptor) 532set, which can take considerable time (one syscall per file descriptor)
502and is of course hard to detect. 533and is of course hard to detect.
503 534
504Epoll is also notoriously buggy - embedding epoll fds I<should> work, but 535Epoll is also notoriously buggy - embedding epoll fds I<should> work,
505of course I<doesn't>, and epoll just loves to report events for totally 536but of course I<doesn't>, and epoll just loves to report events for
506I<different> file descriptors (even already closed ones, so one cannot 537totally I<different> file descriptors (even already closed ones, so
507even remove them from the set) than registered in the set (especially 538one cannot even remove them from the set) than registered in the set
508on SMP systems). Libev tries to counter these spurious notifications by 539(especially on SMP systems). Libev tries to counter these spurious
509employing an additional generation counter and comparing that against the 540notifications by employing an additional generation counter and comparing
510events to filter out spurious ones, recreating the set when required. Last 541that against the events to filter out spurious ones, recreating the set
542when required. Epoll also erroneously rounds down timeouts, but gives you
543no way to know when and by how much, so sometimes you have to busy-wait
544because epoll returns immediately despite a nonzero timeout. And last
511not least, it also refuses to work with some file descriptors which work 545not least, it also refuses to work with some file descriptors which work
512perfectly fine with C<select> (files, many character devices...). 546perfectly fine with C<select> (files, many character devices...).
513 547
514Epoll is truly the train wreck analog among event poll mechanisms, 548Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
515a frankenpoll, cobbled together in a hurry, no thought to design or 549cobbled together in a hurry, no thought to design or interaction with
516interaction with others. 550others. Oh, the pain, will it ever stop...
517 551
518While stopping, setting and starting an I/O watcher in the same iteration 552While stopping, setting and starting an I/O watcher in the same iteration
519will result in some caching, there is still a system call per such 553will result in some caching, there is still a system call per such
520incident (because the same I<file descriptor> could point to a different 554incident (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 555I<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 567All 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 568faster than epoll for maybe up to a hundred file descriptors, depending on
535the usage. So sad. 569the usage. So sad.
536 570
537While nominally embeddable in other event loops, this feature is broken in 571While nominally embeddable in other event loops, this feature is broken in
538all kernel versions tested so far. 572a lot of kernel revisions, but probably(!) works in current versions.
573
574This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
575C<EVBACKEND_POLL>.
576
577=item C<EVBACKEND_LINUXAIO> (value 64, Linux)
578
579Use the linux-specific linux aio (I<not> C<< aio(7) >>) event interface
580available in post-4.18 kernels.
581
582If this backend works for you (as of this writing, it was very
583experimental and only supports a subset of file types), it is the best
584event interface available on linux and might be well worth it enabling it
585- if it isn't available in your kernel this will be detected and another
586backend will be chosen.
587
588This backend can batch oneshot requests and uses a user-space ring buffer
589to receive events. It also doesn't suffer from most of the design problems
590of epoll (such as not being able to remove event sources from the epoll
591set), and generally sounds too good to be true. Because, this being the
592linux kernel, of course it suffers from a whole new set of limitations.
593
594For one, it is not easily embeddable (but probably could be done using
595an event fd at some extra overhead). It also is subject to various
596arbitrary limits that can be configured in F</proc/sys/fs/aio-max-nr>
597and F</proc/sys/fs/aio-nr>), which could lead to it being skipped during
598initialisation.
599
600Most problematic in practise, however, is that, like kqueue, it requires
601special support from drivers, and, not surprisingly, not all drivers
602implement it. For example, in linux 4.19, tcp sockets, pipes, event fds,
603files, F</dev/null> and a few others are supported, but ttys are not, so
604this is not (yet?) a generic event polling interface but is probably still
605be very useful in a web server or similar program.
539 606
540This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 607This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
541C<EVBACKEND_POLL>. 608C<EVBACKEND_POLL>.
542 609
543=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 610=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
558 625
559It scales in the same way as the epoll backend, but the interface to the 626It 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 627kernel is more efficient (which says nothing about its actual speed, of
561course). While stopping, setting and starting an I/O watcher does never 628course). 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 629cause 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 630two 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 631might have to leak fd's on fork, but it's more sane than epoll) and it
565cases 632drops fds silently in similarly hard-to-detect cases.
566 633
567This backend usually performs well under most conditions. 634This backend usually performs well under most conditions.
568 635
569While nominally embeddable in other event loops, this doesn't work 636While nominally embeddable in other event loops, this doesn't work
570everywhere, so you might need to test for this. And since it is broken 637everywhere, so you might need to test for this. And since it is broken
599among the OS-specific backends (I vastly prefer correctness over speed 666among the OS-specific backends (I vastly prefer correctness over speed
600hacks). 667hacks).
601 668
602On the negative side, the interface is I<bizarre> - so bizarre that 669On the negative side, the interface is I<bizarre> - so bizarre that
603even sun itself gets it wrong in their code examples: The event polling 670even sun itself gets it wrong in their code examples: The event polling
604function sometimes returning events to the caller even though an error 671function 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 672occurred, but with no indication whether it has done so or not (yes, it's
606even documented that way) - deadly for edge-triggered interfaces where 673even documented that way) - deadly for edge-triggered interfaces where you
607you absolutely have to know whether an event occurred or not because you 674absolutely have to know whether an event occurred or not because you have
608have to re-arm the watcher. 675to re-arm the watcher.
609 676
610Fortunately libev seems to be able to work around these idiocies. 677Fortunately libev seems to be able to work around these idiocies.
611 678
612This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 679This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
613C<EVBACKEND_POLL>. 680C<EVBACKEND_POLL>.
643 710
644Example: Use whatever libev has to offer, but make sure that kqueue is 711Example: Use whatever libev has to offer, but make sure that kqueue is
645used if available. 712used if available.
646 713
647 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 714 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
715
716Example: Similarly, on linux, you mgiht want to take advantage of the
717linux aio backend if possible, but fall back to something else if that
718isn't available.
719
720 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
648 721
649=item ev_loop_destroy (loop) 722=item ev_loop_destroy (loop)
650 723
651Destroys an event loop object (frees all memory and kernel state 724Destroys an event loop object (frees all memory and kernel state
652etc.). None of the active event watchers will be stopped in the normal 725etc.). 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> 742If you need dynamically allocated loops it is better to use C<ev_loop_new>
670and C<ev_loop_destroy>. 743and C<ev_loop_destroy>.
671 744
672=item ev_loop_fork (loop) 745=item ev_loop_fork (loop)
673 746
674This function sets a flag that causes subsequent C<ev_run> iterations to 747This function sets a flag that causes subsequent C<ev_run> iterations
675reinitialise the kernel state for backends that have one. Despite the 748to reinitialise the kernel state for backends that have one. Despite
676name, you can call it anytime, but it makes most sense after forking, in 749the 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 750watchers (except inside an C<ev_prepare> callback), but it makes most
751sense after forking, in the child process. You I<must> call it (or use
678child before resuming or calling C<ev_run>. 752C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
679 753
754In addition, if you want to reuse a loop (via this function or
755C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>.
756
680Again, you I<have> to call it on I<any> loop that you want to re-use after 757Again, 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 758a 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 759because some kernel interfaces *cough* I<kqueue> *cough* do funny things
683during fork. 760during fork.
684 761
685On the other hand, you only need to call this function in the child 762On the other hand, you only need to call this function in the child
755 832
756This function is rarely useful, but when some event callback runs for a 833This 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 834very long time without entering the event loop, updating libev's idea of
758the current time is a good idea. 835the current time is a good idea.
759 836
760See also L<The special problem of time updates> in the C<ev_timer> section. 837See also L</The special problem of time updates> in the C<ev_timer> section.
761 838
762=item ev_suspend (loop) 839=item ev_suspend (loop)
763 840
764=item ev_resume (loop) 841=item ev_resume (loop)
765 842
783without a previous call to C<ev_suspend>. 860without a previous call to C<ev_suspend>.
784 861
785Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the 862Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
786event loop time (see C<ev_now_update>). 863event loop time (see C<ev_now_update>).
787 864
788=item ev_run (loop, int flags) 865=item bool ev_run (loop, int flags)
789 866
790Finally, this is it, the event handler. This function usually is called 867Finally, this is it, the event handler. This function usually is called
791after you have initialised all your watchers and you want to start 868after you have initialised all your watchers and you want to start
792handling events. It will ask the operating system for any new events, call 869handling events. It will ask the operating system for any new events, call
793the watcher callbacks, an then repeat the whole process indefinitely: This 870the watcher callbacks, and then repeat the whole process indefinitely: This
794is why event loops are called I<loops>. 871is why event loops are called I<loops>.
795 872
796If the flags argument is specified as C<0>, it will keep handling events 873If 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 874until either no event watchers are active anymore or C<ev_break> was
798called. 875called.
876
877The return value is false if there are no more active watchers (which
878usually means "all jobs done" or "deadlock"), and true in all other cases
879(which usually means " you should call C<ev_run> again").
799 880
800Please note that an explicit C<ev_break> is usually better than 881Please note that an explicit C<ev_break> is usually better than
801relying on all watchers to be stopped when deciding when a program has 882relying on all watchers to be stopped when deciding when a program has
802finished (especially in interactive programs), but having a program 883finished (especially in interactive programs), but having a program
803that automatically loops as long as it has to and no longer by virtue 884that 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 885of relying on its watchers stopping correctly, that is truly a thing of
805beauty. 886beauty.
806 887
807This function is also I<mostly> exception-safe - you can break out of 888This 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++ 889C<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 890exception and so on. This does not decrement the C<ev_depth> value, nor
810will it clear any outstanding C<EVBREAK_ONE> breaks. 891will it clear any outstanding C<EVBREAK_ONE> breaks.
811 892
812A flags value of C<EVRUN_NOWAIT> will look for new events, will handle 893A 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 894those events and any already outstanding ones, but will not wait and
825This is useful if you are waiting for some external event in conjunction 906This is useful if you are waiting for some external event in conjunction
826with something not expressible using other libev watchers (i.e. "roll your 907with something not expressible using other libev watchers (i.e. "roll your
827own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is 908own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
828usually a better approach for this kind of thing. 909usually a better approach for this kind of thing.
829 910
830Here are the gory details of what C<ev_run> does: 911Here are the gory details of what C<ev_run> does (this is for your
912understanding, not a guarantee that things will work exactly like this in
913future versions):
831 914
832 - Increment loop depth. 915 - Increment loop depth.
833 - Reset the ev_break status. 916 - Reset the ev_break status.
834 - Before the first iteration, call any pending watchers. 917 - Before the first iteration, call any pending watchers.
835 LOOP: 918 LOOP:
868anymore. 951anymore.
869 952
870 ... queue jobs here, make sure they register event watchers as long 953 ... queue jobs here, make sure they register event watchers as long
871 ... as they still have work to do (even an idle watcher will do..) 954 ... as they still have work to do (even an idle watcher will do..)
872 ev_run (my_loop, 0); 955 ev_run (my_loop, 0);
873 ... jobs done or somebody called unloop. yeah! 956 ... jobs done or somebody called break. yeah!
874 957
875=item ev_break (loop, how) 958=item ev_break (loop, how)
876 959
877Can be used to make a call to C<ev_run> return early (but only after it 960Can be used to make a call to C<ev_run> return early (but only after it
878has processed all outstanding events). The C<how> argument must be either 961has processed all outstanding events). The C<how> argument must be either
941overhead for the actual polling but can deliver many events at once. 1024overhead for the actual polling but can deliver many events at once.
942 1025
943By setting a higher I<io collect interval> you allow libev to spend more 1026By setting a higher I<io collect interval> you allow libev to spend more
944time collecting I/O events, so you can handle more events per iteration, 1027time collecting I/O events, so you can handle more events per iteration,
945at the cost of increasing latency. Timeouts (both C<ev_periodic> and 1028at the cost of increasing latency. Timeouts (both C<ev_periodic> and
946C<ev_timer>) will be not affected. Setting this to a non-null value will 1029C<ev_timer>) will not be affected. Setting this to a non-null value will
947introduce an additional C<ev_sleep ()> call into most loop iterations. The 1030introduce an additional C<ev_sleep ()> call into most loop iterations. The
948sleep time ensures that libev will not poll for I/O events more often then 1031sleep time ensures that libev will not poll for I/O events more often then
949once per this interval, on average. 1032once per this interval, on average (as long as the host time resolution is
1033good enough).
950 1034
951Likewise, by setting a higher I<timeout collect interval> you allow libev 1035Likewise, by setting a higher I<timeout collect interval> you allow libev
952to spend more time collecting timeouts, at the expense of increased 1036to spend more time collecting timeouts, at the expense of increased
953latency/jitter/inexactness (the watcher callback will be called 1037latency/jitter/inexactness (the watcher callback will be called
954later). C<ev_io> watchers will not be affected. Setting this to a non-null 1038later). C<ev_io> watchers will not be affected. Setting this to a non-null
1000invoke the actual watchers inside another context (another thread etc.). 1084invoke the actual watchers inside another context (another thread etc.).
1001 1085
1002If you want to reset the callback, use C<ev_invoke_pending> as new 1086If you want to reset the callback, use C<ev_invoke_pending> as new
1003callback. 1087callback.
1004 1088
1005=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) 1089=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
1006 1090
1007Sometimes you want to share the same loop between multiple threads. This 1091Sometimes you want to share the same loop between multiple threads. This
1008can be done relatively simply by putting mutex_lock/unlock calls around 1092can be done relatively simply by putting mutex_lock/unlock calls around
1009each call to a libev function. 1093each call to a libev function.
1010 1094
1011However, C<ev_run> can run an indefinite time, so it is not feasible 1095However, C<ev_run> can run an indefinite time, so it is not feasible
1012to wait for it to return. One way around this is to wake up the event 1096to wait for it to return. One way around this is to wake up the event
1013loop via C<ev_break> and C<av_async_send>, another way is to set these 1097loop via C<ev_break> and C<ev_async_send>, another way is to set these
1014I<release> and I<acquire> callbacks on the loop. 1098I<release> and I<acquire> callbacks on the loop.
1015 1099
1016When set, then C<release> will be called just before the thread is 1100When set, then C<release> will be called just before the thread is
1017suspended waiting for new events, and C<acquire> is called just 1101suspended waiting for new events, and C<acquire> is called just
1018afterwards. 1102afterwards.
1158 1242
1159=item C<EV_PREPARE> 1243=item C<EV_PREPARE>
1160 1244
1161=item C<EV_CHECK> 1245=item C<EV_CHECK>
1162 1246
1163All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts 1247All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1164to gather new events, and all C<ev_check> watchers are invoked just after 1248gather new events, and all C<ev_check> watchers are queued (not invoked)
1165C<ev_run> has gathered them, but before it invokes any callbacks for any 1249just after C<ev_run> has gathered them, but before it queues any callbacks
1250for any received events. That means C<ev_prepare> watchers are the last
1251watchers invoked before the event loop sleeps or polls for new events, and
1252C<ev_check> watchers will be invoked before any other watchers of the same
1253or lower priority within an event loop iteration.
1254
1166received events. Callbacks of both watcher types can start and stop as 1255Callbacks of both watcher types can start and stop as many watchers as
1167many watchers as they want, and all of them will be taken into account 1256they want, and all of them will be taken into account (for example, a
1168(for example, a C<ev_prepare> watcher might start an idle watcher to keep 1257C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1169C<ev_run> from blocking). 1258blocking).
1170 1259
1171=item C<EV_EMBED> 1260=item C<EV_EMBED>
1172 1261
1173The embedded event loop specified in the C<ev_embed> watcher needs attention. 1262The embedded event loop specified in the C<ev_embed> watcher needs attention.
1174 1263
1297 1386
1298=item callback ev_cb (ev_TYPE *watcher) 1387=item callback ev_cb (ev_TYPE *watcher)
1299 1388
1300Returns the callback currently set on the watcher. 1389Returns the callback currently set on the watcher.
1301 1390
1302=item ev_cb_set (ev_TYPE *watcher, callback) 1391=item ev_set_cb (ev_TYPE *watcher, callback)
1303 1392
1304Change the callback. You can change the callback at virtually any time 1393Change the callback. You can change the callback at virtually any time
1305(modulo threads). 1394(modulo threads).
1306 1395
1307=item ev_set_priority (ev_TYPE *watcher, int priority) 1396=item ev_set_priority (ev_TYPE *watcher, int priority)
1325or might not have been clamped to the valid range. 1414or might not have been clamped to the valid range.
1326 1415
1327The default priority used by watchers when no priority has been set is 1416The default priority used by watchers when no priority has been set is
1328always C<0>, which is supposed to not be too high and not be too low :). 1417always C<0>, which is supposed to not be too high and not be too low :).
1329 1418
1330See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1419See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1331priorities. 1420priorities.
1332 1421
1333=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1422=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1334 1423
1335Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1424Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1360See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related 1449See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1361functions that do not need a watcher. 1450functions that do not need a watcher.
1362 1451
1363=back 1452=back
1364 1453
1365See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1454See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1366OWN COMPOSITE WATCHERS> idioms. 1455OWN COMPOSITE WATCHERS> idioms.
1367 1456
1368=head2 WATCHER STATES 1457=head2 WATCHER STATES
1369 1458
1370There are various watcher states mentioned throughout this manual - 1459There are various watcher states mentioned throughout this manual -
1372transition between them will be described in more detail - and while these 1461transition between them will be described in more detail - and while these
1373rules might look complicated, they usually do "the right thing". 1462rules might look complicated, they usually do "the right thing".
1374 1463
1375=over 4 1464=over 4
1376 1465
1377=item initialiased 1466=item initialised
1378 1467
1379Before a watcher can be registered with the event looop it has to be 1468Before a watcher can be registered with the event loop it has to be
1380initialised. This can be done with a call to C<ev_TYPE_init>, or calls to 1469initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1381C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. 1470C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1382 1471
1383In this state it is simply some block of memory that is suitable for use 1472In this state it is simply some block of memory that is suitable for
1384in an event loop. It can be moved around, freed, reused etc. at will. 1473use in an event loop. It can be moved around, freed, reused etc. at
1474will - as long as you either keep the memory contents intact, or call
1475C<ev_TYPE_init> again.
1385 1476
1386=item started/running/active 1477=item started/running/active
1387 1478
1388Once a watcher has been started with a call to C<ev_TYPE_start> it becomes 1479Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1389property of the event loop, and is actively waiting for events. While in 1480property of the event loop, and is actively waiting for events. While in
1417latter will clear any pending state the watcher might be in, regardless 1508latter will clear any pending state the watcher might be in, regardless
1418of whether it was active or not, so stopping a watcher explicitly before 1509of whether it was active or not, so stopping a watcher explicitly before
1419freeing it is often a good idea. 1510freeing it is often a good idea.
1420 1511
1421While stopped (and not pending) the watcher is essentially in the 1512While stopped (and not pending) the watcher is essentially in the
1422initialised state, that is it can be reused, moved, modified in any way 1513initialised state, that is, it can be reused, moved, modified in any way
1423you wish. 1514you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
1515it again).
1424 1516
1425=back 1517=back
1426 1518
1427=head2 WATCHER PRIORITY MODELS 1519=head2 WATCHER PRIORITY MODELS
1428 1520
1577 1669
1578But really, best use non-blocking mode. 1670But really, best use non-blocking mode.
1579 1671
1580=head3 The special problem of disappearing file descriptors 1672=head3 The special problem of disappearing file descriptors
1581 1673
1582Some backends (e.g. kqueue, epoll) need to be told about closing a file 1674Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1583descriptor (either due to calling C<close> explicitly or any other means, 1675a file descriptor (either due to calling C<close> explicitly or any other
1584such as C<dup2>). The reason is that you register interest in some file 1676means, such as C<dup2>). The reason is that you register interest in some
1585descriptor, but when it goes away, the operating system will silently drop 1677file descriptor, but when it goes away, the operating system will silently
1586this interest. If another file descriptor with the same number then is 1678drop this interest. If another file descriptor with the same number then
1587registered with libev, there is no efficient way to see that this is, in 1679is registered with libev, there is no efficient way to see that this is,
1588fact, a different file descriptor. 1680in fact, a different file descriptor.
1589 1681
1590To avoid having to explicitly tell libev about such cases, libev follows 1682To avoid having to explicitly tell libev about such cases, libev follows
1591the following policy: Each time C<ev_io_set> is being called, libev 1683the following policy: Each time C<ev_io_set> is being called, libev
1592will assume that this is potentially a new file descriptor, otherwise 1684will assume that this is potentially a new file descriptor, otherwise
1593it is assumed that the file descriptor stays the same. That means that 1685it is assumed that the file descriptor stays the same. That means that
1642when you rarely read from a file instead of from a socket, and want to 1734when you rarely read from a file instead of from a socket, and want to
1643reuse the same code path. 1735reuse the same code path.
1644 1736
1645=head3 The special problem of fork 1737=head3 The special problem of fork
1646 1738
1647Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1739Some backends (epoll, kqueue, probably linuxaio) do not support C<fork ()>
1648useless behaviour. Libev fully supports fork, but needs to be told about 1740at all or exhibit useless behaviour. Libev fully supports fork, but needs
1649it in the child if you want to continue to use it in the child. 1741to be told about it in the child if you want to continue to use it in the
1742child.
1650 1743
1651To support fork in your child processes, you have to call C<ev_loop_fork 1744To support fork in your child processes, you have to call C<ev_loop_fork
1652()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to 1745()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1653C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1746C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1654 1747
1756detecting time jumps is hard, and some inaccuracies are unavoidable (the 1849detecting time jumps is hard, and some inaccuracies are unavoidable (the
1757monotonic clock option helps a lot here). 1850monotonic clock option helps a lot here).
1758 1851
1759The callback is guaranteed to be invoked only I<after> its timeout has 1852The callback is guaranteed to be invoked only I<after> its timeout has
1760passed (not I<at>, so on systems with very low-resolution clocks this 1853passed (not I<at>, so on systems with very low-resolution clocks this
1761might introduce a small delay). If multiple timers become ready during the 1854might introduce a small delay, see "the special problem of being too
1855early", below). If multiple timers become ready during the same loop
1762same loop iteration then the ones with earlier time-out values are invoked 1856iteration then the ones with earlier time-out values are invoked before
1763before ones of the same priority with later time-out values (but this is 1857ones of the same priority with later time-out values (but this is no
1764no longer true when a callback calls C<ev_run> recursively). 1858longer true when a callback calls C<ev_run> recursively).
1765 1859
1766=head3 Be smart about timeouts 1860=head3 Be smart about timeouts
1767 1861
1768Many real-world problems involve some kind of timeout, usually for error 1862Many real-world problems involve some kind of timeout, usually for error
1769recovery. A typical example is an HTTP request - if the other side hangs, 1863recovery. A typical example is an HTTP request - if the other side hangs,
1844 1938
1845In this case, it would be more efficient to leave the C<ev_timer> alone, 1939In this case, it would be more efficient to leave the C<ev_timer> alone,
1846but remember the time of last activity, and check for a real timeout only 1940but remember the time of last activity, and check for a real timeout only
1847within the callback: 1941within the callback:
1848 1942
1943 ev_tstamp timeout = 60.;
1849 ev_tstamp last_activity; // time of last activity 1944 ev_tstamp last_activity; // time of last activity
1945 ev_timer timer;
1850 1946
1851 static void 1947 static void
1852 callback (EV_P_ ev_timer *w, int revents) 1948 callback (EV_P_ ev_timer *w, int revents)
1853 { 1949 {
1854 ev_tstamp now = ev_now (EV_A); 1950 // calculate when the timeout would happen
1855 ev_tstamp timeout = last_activity + 60.; 1951 ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1856 1952
1857 // if last_activity + 60. is older than now, we did time out 1953 // if negative, it means we the timeout already occurred
1858 if (timeout < now) 1954 if (after < 0.)
1859 { 1955 {
1860 // timeout occurred, take action 1956 // timeout occurred, take action
1861 } 1957 }
1862 else 1958 else
1863 { 1959 {
1864 // callback was invoked, but there was some activity, re-arm 1960 // callback was invoked, but there was some recent
1865 // the watcher to fire in last_activity + 60, which is 1961 // activity. simply restart the timer to time out
1866 // guaranteed to be in the future, so "again" is positive: 1962 // after "after" seconds, which is the earliest time
1867 w->repeat = timeout - now; 1963 // the timeout can occur.
1964 ev_timer_set (w, after, 0.);
1868 ev_timer_again (EV_A_ w); 1965 ev_timer_start (EV_A_ w);
1869 } 1966 }
1870 } 1967 }
1871 1968
1872To summarise the callback: first calculate the real timeout (defined 1969To summarise the callback: first calculate in how many seconds the
1873as "60 seconds after the last activity"), then check if that time has 1970timeout will occur (by calculating the absolute time when it would occur,
1874been reached, which means something I<did>, in fact, time out. Otherwise 1971C<last_activity + timeout>, and subtracting the current time, C<ev_now
1875the callback was invoked too early (C<timeout> is in the future), so 1972(EV_A)> from that).
1876re-schedule the timer to fire at that future time, to see if maybe we have
1877a timeout then.
1878 1973
1879Note how C<ev_timer_again> is used, taking advantage of the 1974If this value is negative, then we are already past the timeout, i.e. we
1880C<ev_timer_again> optimisation when the timer is already running. 1975timed out, and need to do whatever is needed in this case.
1976
1977Otherwise, we now the earliest time at which the timeout would trigger,
1978and simply start the timer with this timeout value.
1979
1980In other words, each time the callback is invoked it will check whether
1981the timeout occurred. If not, it will simply reschedule itself to check
1982again at the earliest time it could time out. Rinse. Repeat.
1881 1983
1882This scheme causes more callback invocations (about one every 60 seconds 1984This scheme causes more callback invocations (about one every 60 seconds
1883minus half the average time between activity), but virtually no calls to 1985minus half the average time between activity), but virtually no calls to
1884libev to change the timeout. 1986libev to change the timeout.
1885 1987
1886To start the timer, simply initialise the watcher and set C<last_activity> 1988To start the machinery, simply initialise the watcher and set
1887to the current time (meaning we just have some activity :), then call the 1989C<last_activity> to the current time (meaning there was some activity just
1888callback, which will "do the right thing" and start the timer: 1990now), then call the callback, which will "do the right thing" and start
1991the timer:
1889 1992
1993 last_activity = ev_now (EV_A);
1890 ev_init (timer, callback); 1994 ev_init (&timer, callback);
1891 last_activity = ev_now (loop); 1995 callback (EV_A_ &timer, 0);
1892 callback (loop, timer, EV_TIMER);
1893 1996
1894And when there is some activity, simply store the current time in 1997When there is some activity, simply store the current time in
1895C<last_activity>, no libev calls at all: 1998C<last_activity>, no libev calls at all:
1896 1999
2000 if (activity detected)
1897 last_activity = ev_now (loop); 2001 last_activity = ev_now (EV_A);
2002
2003When your timeout value changes, then the timeout can be changed by simply
2004providing a new value, stopping the timer and calling the callback, which
2005will again do the right thing (for example, time out immediately :).
2006
2007 timeout = new_value;
2008 ev_timer_stop (EV_A_ &timer);
2009 callback (EV_A_ &timer, 0);
1898 2010
1899This technique is slightly more complex, but in most cases where the 2011This technique is slightly more complex, but in most cases where the
1900time-out is unlikely to be triggered, much more efficient. 2012time-out is unlikely to be triggered, much more efficient.
1901
1902Changing the timeout is trivial as well (if it isn't hard-coded in the
1903callback :) - just change the timeout and invoke the callback, which will
1904fix things for you.
1905 2013
1906=item 4. Wee, just use a double-linked list for your timeouts. 2014=item 4. Wee, just use a double-linked list for your timeouts.
1907 2015
1908If there is not one request, but many thousands (millions...), all 2016If there is not one request, but many thousands (millions...), all
1909employing some kind of timeout with the same timeout value, then one can 2017employing some kind of timeout with the same timeout value, then one can
1936Method #1 is almost always a bad idea, and buys you nothing. Method #4 is 2044Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1937rather complicated, but extremely efficient, something that really pays 2045rather complicated, but extremely efficient, something that really pays
1938off after the first million or so of active timers, i.e. it's usually 2046off after the first million or so of active timers, i.e. it's usually
1939overkill :) 2047overkill :)
1940 2048
2049=head3 The special problem of being too early
2050
2051If you ask a timer to call your callback after three seconds, then
2052you expect it to be invoked after three seconds - but of course, this
2053cannot be guaranteed to infinite precision. Less obviously, it cannot be
2054guaranteed to any precision by libev - imagine somebody suspending the
2055process with a STOP signal for a few hours for example.
2056
2057So, libev tries to invoke your callback as soon as possible I<after> the
2058delay has occurred, but cannot guarantee this.
2059
2060A less obvious failure mode is calling your callback too early: many event
2061loops compare timestamps with a "elapsed delay >= requested delay", but
2062this can cause your callback to be invoked much earlier than you would
2063expect.
2064
2065To see why, imagine a system with a clock that only offers full second
2066resolution (think windows if you can't come up with a broken enough OS
2067yourself). If you schedule a one-second timer at the time 500.9, then the
2068event loop will schedule your timeout to elapse at a system time of 500
2069(500.9 truncated to the resolution) + 1, or 501.
2070
2071If an event library looks at the timeout 0.1s later, it will see "501 >=
2072501" and invoke the callback 0.1s after it was started, even though a
2073one-second delay was requested - this is being "too early", despite best
2074intentions.
2075
2076This is the reason why libev will never invoke the callback if the elapsed
2077delay equals the requested delay, but only when the elapsed delay is
2078larger than the requested delay. In the example above, libev would only invoke
2079the callback at system time 502, or 1.1s after the timer was started.
2080
2081So, while libev cannot guarantee that your callback will be invoked
2082exactly when requested, it I<can> and I<does> guarantee that the requested
2083delay has actually elapsed, or in other words, it always errs on the "too
2084late" side of things.
2085
1941=head3 The special problem of time updates 2086=head3 The special problem of time updates
1942 2087
1943Establishing the current time is a costly operation (it usually takes at 2088Establishing the current time is a costly operation (it usually takes
1944least two system calls): EV therefore updates its idea of the current 2089at least one system call): EV therefore updates its idea of the current
1945time only before and after C<ev_run> collects new events, which causes a 2090time only before and after C<ev_run> collects new events, which causes a
1946growing difference between C<ev_now ()> and C<ev_time ()> when handling 2091growing difference between C<ev_now ()> and C<ev_time ()> when handling
1947lots of events in one iteration. 2092lots of events in one iteration.
1948 2093
1949The relative timeouts are calculated relative to the C<ev_now ()> 2094The relative timeouts are calculated relative to the C<ev_now ()>
1950time. This is usually the right thing as this timestamp refers to the time 2095time. This is usually the right thing as this timestamp refers to the time
1951of the event triggering whatever timeout you are modifying/starting. If 2096of the event triggering whatever timeout you are modifying/starting. If
1952you suspect event processing to be delayed and you I<need> to base the 2097you suspect event processing to be delayed and you I<need> to base the
1953timeout on the current time, use something like this to adjust for this: 2098timeout on the current time, use something like the following to adjust
2099for it:
1954 2100
1955 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2101 ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
1956 2102
1957If the event loop is suspended for a long time, you can also force an 2103If the event loop is suspended for a long time, you can also force an
1958update of the time returned by C<ev_now ()> by calling C<ev_now_update 2104update of the time returned by C<ev_now ()> by calling C<ev_now_update
1959()>. 2105()>, although that will push the event time of all outstanding events
2106further into the future.
2107
2108=head3 The special problem of unsynchronised clocks
2109
2110Modern systems have a variety of clocks - libev itself uses the normal
2111"wall clock" clock and, if available, the monotonic clock (to avoid time
2112jumps).
2113
2114Neither of these clocks is synchronised with each other or any other clock
2115on the system, so C<ev_time ()> might return a considerably different time
2116than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
2117a call to C<gettimeofday> might return a second count that is one higher
2118than a directly following call to C<time>.
2119
2120The moral of this is to only compare libev-related timestamps with
2121C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
2122a second or so.
2123
2124One more problem arises due to this lack of synchronisation: if libev uses
2125the system monotonic clock and you compare timestamps from C<ev_time>
2126or C<ev_now> from when you started your timer and when your callback is
2127invoked, you will find that sometimes the callback is a bit "early".
2128
2129This is because C<ev_timer>s work in real time, not wall clock time, so
2130libev makes sure your callback is not invoked before the delay happened,
2131I<measured according to the real time>, not the system clock.
2132
2133If your timeouts are based on a physical timescale (e.g. "time out this
2134connection after 100 seconds") then this shouldn't bother you as it is
2135exactly the right behaviour.
2136
2137If you want to compare wall clock/system timestamps to your timers, then
2138you need to use C<ev_periodic>s, as these are based on the wall clock
2139time, where your comparisons will always generate correct results.
1960 2140
1961=head3 The special problems of suspended animation 2141=head3 The special problems of suspended animation
1962 2142
1963When you leave the server world it is quite customary to hit machines that 2143When you leave the server world it is quite customary to hit machines that
1964can suspend/hibernate - what happens to the clocks during such a suspend? 2144can suspend/hibernate - what happens to the clocks during such a suspend?
1994 2174
1995=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 2175=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1996 2176
1997=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 2177=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1998 2178
1999Configure the timer to trigger after C<after> seconds. If C<repeat> 2179Configure the timer to trigger after C<after> seconds (fractional and
2000is C<0.>, then it will automatically be stopped once the timeout is 2180negative values are supported). If C<repeat> is C<0.>, then it will
2001reached. If it is positive, then the timer will automatically be 2181automatically be stopped once the timeout is reached. If it is positive,
2002configured to trigger again C<repeat> seconds later, again, and again, 2182then the timer will automatically be configured to trigger again C<repeat>
2003until stopped manually. 2183seconds later, again, and again, until stopped manually.
2004 2184
2005The timer itself will do a best-effort at avoiding drift, that is, if 2185The timer itself will do a best-effort at avoiding drift, that is, if
2006you configure a timer to trigger every 10 seconds, then it will normally 2186you configure a timer to trigger every 10 seconds, then it will normally
2007trigger at exactly 10 second intervals. If, however, your program cannot 2187trigger at exactly 10 second intervals. If, however, your program cannot
2008keep up with the timer (because it takes longer than those 10 seconds to 2188keep up with the timer (because it takes longer than those 10 seconds to
2009do stuff) the timer will not fire more than once per event loop iteration. 2189do stuff) the timer will not fire more than once per event loop iteration.
2010 2190
2011=item ev_timer_again (loop, ev_timer *) 2191=item ev_timer_again (loop, ev_timer *)
2012 2192
2013This will act as if the timer timed out and restart it again if it is 2193This will act as if the timer timed out, and restarts it again if it is
2014repeating. The exact semantics are: 2194repeating. It basically works like calling C<ev_timer_stop>, updating the
2195timeout to the C<repeat> value and calling C<ev_timer_start>.
2015 2196
2197The exact semantics are as in the following rules, all of which will be
2198applied to the watcher:
2199
2200=over 4
2201
2016If the timer is pending, its pending status is cleared. 2202=item If the timer is pending, the pending status is always cleared.
2017 2203
2018If the timer is started but non-repeating, stop it (as if it timed out). 2204=item If the timer is started but non-repeating, stop it (as if it timed
2205out, without invoking it).
2019 2206
2020If the timer is repeating, either start it if necessary (with the 2207=item If the timer is repeating, make the C<repeat> value the new timeout
2021C<repeat> value), or reset the running timer to the C<repeat> value. 2208and start the timer, if necessary.
2022 2209
2210=back
2211
2023This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2212This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2024usage example. 2213usage example.
2025 2214
2026=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2215=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2027 2216
2028Returns the remaining time until a timer fires. If the timer is active, 2217Returns the remaining time until a timer fires. If the timer is active,
2081Periodic watchers are also timers of a kind, but they are very versatile 2270Periodic watchers are also timers of a kind, but they are very versatile
2082(and unfortunately a bit complex). 2271(and unfortunately a bit complex).
2083 2272
2084Unlike C<ev_timer>, periodic watchers are not based on real time (or 2273Unlike C<ev_timer>, periodic watchers are not based on real time (or
2085relative time, the physical time that passes) but on wall clock time 2274relative time, the physical time that passes) but on wall clock time
2086(absolute time, the thing you can read on your calender or clock). The 2275(absolute time, the thing you can read on your calendar or clock). The
2087difference is that wall clock time can run faster or slower than real 2276difference is that wall clock time can run faster or slower than real
2088time, and time jumps are not uncommon (e.g. when you adjust your 2277time, and time jumps are not uncommon (e.g. when you adjust your
2089wrist-watch). 2278wrist-watch).
2090 2279
2091You can tell a periodic watcher to trigger after some specific point 2280You can tell a periodic watcher to trigger after some specific point
2096C<ev_timer>, which would still trigger roughly 10 seconds after starting 2285C<ev_timer>, which would still trigger roughly 10 seconds after starting
2097it, as it uses a relative timeout). 2286it, as it uses a relative timeout).
2098 2287
2099C<ev_periodic> watchers can also be used to implement vastly more complex 2288C<ev_periodic> watchers can also be used to implement vastly more complex
2100timers, such as triggering an event on each "midnight, local time", or 2289timers, such as triggering an event on each "midnight, local time", or
2101other complicated rules. This cannot be done with C<ev_timer> watchers, as 2290other complicated rules. This cannot easily be done with C<ev_timer>
2102those cannot react to time jumps. 2291watchers, as those cannot react to time jumps.
2103 2292
2104As with timers, the callback is guaranteed to be invoked only when the 2293As with timers, the callback is guaranteed to be invoked only when the
2105point in time where it is supposed to trigger has passed. If multiple 2294point in time where it is supposed to trigger has passed. If multiple
2106timers become ready during the same loop iteration then the ones with 2295timers become ready during the same loop iteration then the ones with
2107earlier time-out values are invoked before ones with later time-out values 2296earlier time-out values are invoked before ones with later time-out values
2148 2337
2149Another way to think about it (for the mathematically inclined) is that 2338Another way to think about it (for the mathematically inclined) is that
2150C<ev_periodic> will try to run the callback in this mode at the next possible 2339C<ev_periodic> will try to run the callback in this mode at the next possible
2151time where C<time = offset (mod interval)>, regardless of any time jumps. 2340time where C<time = offset (mod interval)>, regardless of any time jumps.
2152 2341
2153For numerical stability it is preferable that the C<offset> value is near 2342The C<interval> I<MUST> be positive, and for numerical stability, the
2154C<ev_now ()> (the current time), but there is no range requirement for 2343interval value should be higher than C<1/8192> (which is around 100
2155this value, and in fact is often specified as zero. 2344microseconds) and C<offset> should be higher than C<0> and should have
2345at most a similar magnitude as the current time (say, within a factor of
2346ten). Typical values for offset are, in fact, C<0> or something between
2347C<0> and C<interval>, which is also the recommended range.
2156 2348
2157Note also that there is an upper limit to how often a timer can fire (CPU 2349Note also that there is an upper limit to how often a timer can fire (CPU
2158speed for example), so if C<interval> is very small then timing stability 2350speed for example), so if C<interval> is very small then timing stability
2159will of course deteriorate. Libev itself tries to be exact to be about one 2351will of course deteriorate. Libev itself tries to be exact to be about one
2160millisecond (if the OS supports it and the machine is fast enough). 2352millisecond (if the OS supports it and the machine is fast enough).
2190 2382
2191NOTE: I<< This callback must always return a time that is higher than or 2383NOTE: I<< This callback must always return a time that is higher than or
2192equal to the passed C<now> value >>. 2384equal to the passed C<now> value >>.
2193 2385
2194This can be used to create very complex timers, such as a timer that 2386This can be used to create very complex timers, such as a timer that
2195triggers on "next midnight, local time". To do this, you would calculate the 2387triggers on "next midnight, local time". To do this, you would calculate
2196next midnight after C<now> and return the timestamp value for this. How 2388the next midnight after C<now> and return the timestamp value for
2197you do this is, again, up to you (but it is not trivial, which is the main 2389this. Here is a (completely untested, no error checking) example on how to
2198reason I omitted it as an example). 2390do this:
2391
2392 #include <time.h>
2393
2394 static ev_tstamp
2395 my_rescheduler (ev_periodic *w, ev_tstamp now)
2396 {
2397 time_t tnow = (time_t)now;
2398 struct tm tm;
2399 localtime_r (&tnow, &tm);
2400
2401 tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2402 ++tm.tm_mday; // midnight next day
2403
2404 return mktime (&tm);
2405 }
2406
2407Note: this code might run into trouble on days that have more then two
2408midnights (beginning and end).
2199 2409
2200=back 2410=back
2201 2411
2202=item ev_periodic_again (loop, ev_periodic *) 2412=item ev_periodic_again (loop, ev_periodic *)
2203 2413
2268 2478
2269 ev_periodic hourly_tick; 2479 ev_periodic hourly_tick;
2270 ev_periodic_init (&hourly_tick, clock_cb, 2480 ev_periodic_init (&hourly_tick, clock_cb,
2271 fmod (ev_now (loop), 3600.), 3600., 0); 2481 fmod (ev_now (loop), 3600.), 3600., 0);
2272 ev_periodic_start (loop, &hourly_tick); 2482 ev_periodic_start (loop, &hourly_tick);
2273 2483
2274 2484
2275=head2 C<ev_signal> - signal me when a signal gets signalled! 2485=head2 C<ev_signal> - signal me when a signal gets signalled!
2276 2486
2277Signal watchers will trigger an event when the process receives a specific 2487Signal watchers will trigger an event when the process receives a specific
2278signal one or more times. Even though signals are very asynchronous, libev 2488signal one or more times. Even though signals are very asynchronous, libev
2288only within the same loop, i.e. you can watch for C<SIGINT> in your 2498only within the same loop, i.e. you can watch for C<SIGINT> in your
2289default loop and for C<SIGIO> in another loop, but you cannot watch for 2499default loop and for C<SIGIO> in another loop, but you cannot watch for
2290C<SIGINT> in both the default loop and another loop at the same time. At 2500C<SIGINT> in both the default loop and another loop at the same time. At
2291the moment, C<SIGCHLD> is permanently tied to the default loop. 2501the moment, C<SIGCHLD> is permanently tied to the default loop.
2292 2502
2293When the first watcher gets started will libev actually register something 2503Only after the first watcher for a signal is started will libev actually
2294with the kernel (thus it coexists with your own signal handlers as long as 2504register something with the kernel. It thus coexists with your own signal
2295you don't register any with libev for the same signal). 2505handlers as long as you don't register any with libev for the same signal.
2296 2506
2297If possible and supported, libev will install its handlers with 2507If possible and supported, libev will install its handlers with
2298C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2508C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2299not be unduly interrupted. If you have a problem with system calls getting 2509not be unduly interrupted. If you have a problem with system calls getting
2300interrupted by signals you can block all signals in an C<ev_check> watcher 2510interrupted by signals you can block all signals in an C<ev_check> watcher
2485 2695
2486=head2 C<ev_stat> - did the file attributes just change? 2696=head2 C<ev_stat> - did the file attributes just change?
2487 2697
2488This watches a file system path for attribute changes. That is, it calls 2698This watches a file system path for attribute changes. That is, it calls
2489C<stat> on that path in regular intervals (or when the OS says it changed) 2699C<stat> on that path in regular intervals (or when the OS says it changed)
2490and sees if it changed compared to the last time, invoking the callback if 2700and sees if it changed compared to the last time, invoking the callback
2491it did. 2701if it did. Starting the watcher C<stat>'s the file, so only changes that
2702happen after the watcher has been started will be reported.
2492 2703
2493The path does not need to exist: changing from "path exists" to "path does 2704The path does not need to exist: changing from "path exists" to "path does
2494not exist" is a status change like any other. The condition "path does not 2705not exist" is a status change like any other. The condition "path does not
2495exist" (or more correctly "path cannot be stat'ed") is signified by the 2706exist" (or more correctly "path cannot be stat'ed") is signified by the
2496C<st_nlink> field being zero (which is otherwise always forced to be at 2707C<st_nlink> field being zero (which is otherwise always forced to be at
2726Apart from keeping your process non-blocking (which is a useful 2937Apart from keeping your process non-blocking (which is a useful
2727effect on its own sometimes), idle watchers are a good place to do 2938effect on its own sometimes), idle watchers are a good place to do
2728"pseudo-background processing", or delay processing stuff to after the 2939"pseudo-background processing", or delay processing stuff to after the
2729event loop has handled all outstanding events. 2940event loop has handled all outstanding events.
2730 2941
2942=head3 Abusing an C<ev_idle> watcher for its side-effect
2943
2944As long as there is at least one active idle watcher, libev will never
2945sleep unnecessarily. Or in other words, it will loop as fast as possible.
2946For this to work, the idle watcher doesn't need to be invoked at all - the
2947lowest priority will do.
2948
2949This mode of operation can be useful together with an C<ev_check> watcher,
2950to do something on each event loop iteration - for example to balance load
2951between different connections.
2952
2953See L</Abusing an ev_check watcher for its side-effect> for a longer
2954example.
2955
2731=head3 Watcher-Specific Functions and Data Members 2956=head3 Watcher-Specific Functions and Data Members
2732 2957
2733=over 4 2958=over 4
2734 2959
2735=item ev_idle_init (ev_idle *, callback) 2960=item ev_idle_init (ev_idle *, callback)
2746callback, free it. Also, use no error checking, as usual. 2971callback, free it. Also, use no error checking, as usual.
2747 2972
2748 static void 2973 static void
2749 idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 2974 idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2750 { 2975 {
2976 // stop the watcher
2977 ev_idle_stop (loop, w);
2978
2979 // now we can free it
2751 free (w); 2980 free (w);
2981
2752 // now do something you wanted to do when the program has 2982 // now do something you wanted to do when the program has
2753 // no longer anything immediate to do. 2983 // no longer anything immediate to do.
2754 } 2984 }
2755 2985
2756 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2986 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2758 ev_idle_start (loop, idle_watcher); 2988 ev_idle_start (loop, idle_watcher);
2759 2989
2760 2990
2761=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2991=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2762 2992
2763Prepare and check watchers are usually (but not always) used in pairs: 2993Prepare and check watchers are often (but not always) used in pairs:
2764prepare watchers get invoked before the process blocks and check watchers 2994prepare watchers get invoked before the process blocks and check watchers
2765afterwards. 2995afterwards.
2766 2996
2767You I<must not> call C<ev_run> or similar functions that enter 2997You I<must not> call C<ev_run> (or similar functions that enter the
2768the current event loop from either C<ev_prepare> or C<ev_check> 2998current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2769watchers. Other loops than the current one are fine, however. The 2999C<ev_check> watchers. Other loops than the current one are fine,
2770rationale behind this is that you do not need to check for recursion in 3000however. The rationale behind this is that you do not need to check
2771those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, 3001for recursion in those watchers, i.e. the sequence will always be
2772C<ev_check> so if you have one watcher of each kind they will always be 3002C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2773called in pairs bracketing the blocking call. 3003kind they will always be called in pairs bracketing the blocking call.
2774 3004
2775Their main purpose is to integrate other event mechanisms into libev and 3005Their main purpose is to integrate other event mechanisms into libev and
2776their use is somewhat advanced. They could be used, for example, to track 3006their use is somewhat advanced. They could be used, for example, to track
2777variable changes, implement your own watchers, integrate net-snmp or a 3007variable changes, implement your own watchers, integrate net-snmp or a
2778coroutine library and lots more. They are also occasionally useful if 3008coroutine library and lots more. They are also occasionally useful if
2796with priority higher than or equal to the event loop and one coroutine 3026with priority higher than or equal to the event loop and one coroutine
2797of lower priority, but only once, using idle watchers to keep the event 3027of lower priority, but only once, using idle watchers to keep the event
2798loop from blocking if lower-priority coroutines are active, thus mapping 3028loop from blocking if lower-priority coroutines are active, thus mapping
2799low-priority coroutines to idle/background tasks). 3029low-priority coroutines to idle/background tasks).
2800 3030
2801It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 3031When used for this purpose, it is recommended to give C<ev_check> watchers
2802priority, to ensure that they are being run before any other watchers 3032highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2803after the poll (this doesn't matter for C<ev_prepare> watchers). 3033any other watchers after the poll (this doesn't matter for C<ev_prepare>
3034watchers).
2804 3035
2805Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not 3036Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2806activate ("feed") events into libev. While libev fully supports this, they 3037activate ("feed") events into libev. While libev fully supports this, they
2807might get executed before other C<ev_check> watchers did their job. As 3038might get executed before other C<ev_check> watchers did their job. As
2808C<ev_check> watchers are often used to embed other (non-libev) event 3039C<ev_check> watchers are often used to embed other (non-libev) event
2809loops those other event loops might be in an unusable state until their 3040loops those other event loops might be in an unusable state until their
2810C<ev_check> watcher ran (always remind yourself to coexist peacefully with 3041C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2811others). 3042others).
3043
3044=head3 Abusing an C<ev_check> watcher for its side-effect
3045
3046C<ev_check> (and less often also C<ev_prepare>) watchers can also be
3047useful because they are called once per event loop iteration. For
3048example, if you want to handle a large number of connections fairly, you
3049normally only do a bit of work for each active connection, and if there
3050is more work to do, you wait for the next event loop iteration, so other
3051connections have a chance of making progress.
3052
3053Using an C<ev_check> watcher is almost enough: it will be called on the
3054next event loop iteration. However, that isn't as soon as possible -
3055without external events, your C<ev_check> watcher will not be invoked.
3056
3057This is where C<ev_idle> watchers come in handy - all you need is a
3058single global idle watcher that is active as long as you have one active
3059C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
3060will not sleep, and the C<ev_check> watcher makes sure a callback gets
3061invoked. Neither watcher alone can do that.
2812 3062
2813=head3 Watcher-Specific Functions and Data Members 3063=head3 Watcher-Specific Functions and Data Members
2814 3064
2815=over 4 3065=over 4
2816 3066
3017 3267
3018=over 4 3268=over 4
3019 3269
3020=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3270=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3021 3271
3022=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3272=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3023 3273
3024Configures the watcher to embed the given loop, which must be 3274Configures the watcher to embed the given loop, which must be
3025embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3275embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3026invoked automatically, otherwise it is the responsibility of the callback 3276invoked automatically, otherwise it is the responsibility of the callback
3027to invoke it (it will continue to be called until the sweep has been done, 3277to invoke it (it will continue to be called until the sweep has been done,
3048used). 3298used).
3049 3299
3050 struct ev_loop *loop_hi = ev_default_init (0); 3300 struct ev_loop *loop_hi = ev_default_init (0);
3051 struct ev_loop *loop_lo = 0; 3301 struct ev_loop *loop_lo = 0;
3052 ev_embed embed; 3302 ev_embed embed;
3053 3303
3054 // see if there is a chance of getting one that works 3304 // see if there is a chance of getting one that works
3055 // (remember that a flags value of 0 means autodetection) 3305 // (remember that a flags value of 0 means autodetection)
3056 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3306 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3057 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3307 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3058 : 0; 3308 : 0;
3072C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3322C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3073 3323
3074 struct ev_loop *loop = ev_default_init (0); 3324 struct ev_loop *loop = ev_default_init (0);
3075 struct ev_loop *loop_socket = 0; 3325 struct ev_loop *loop_socket = 0;
3076 ev_embed embed; 3326 ev_embed embed;
3077 3327
3078 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3328 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3079 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3329 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3080 { 3330 {
3081 ev_embed_init (&embed, 0, loop_socket); 3331 ev_embed_init (&embed, 0, loop_socket);
3082 ev_embed_start (loop, &embed); 3332 ev_embed_start (loop, &embed);
3090 3340
3091=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3341=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3092 3342
3093Fork watchers are called when a C<fork ()> was detected (usually because 3343Fork watchers are called when a C<fork ()> was detected (usually because
3094whoever is a good citizen cared to tell libev about it by calling 3344whoever is a good citizen cared to tell libev about it by calling
3095C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the 3345C<ev_loop_fork>). The invocation is done before the event loop blocks next
3096event loop blocks next and before C<ev_check> watchers are being called, 3346and before C<ev_check> watchers are being called, and only in the child
3097and only in the child after the fork. If whoever good citizen calling 3347after the fork. If whoever good citizen calling C<ev_default_fork> cheats
3098C<ev_default_fork> cheats and calls it in the wrong process, the fork 3348and calls it in the wrong process, the fork handlers will be invoked, too,
3099handlers will be invoked, too, of course. 3349of course.
3100 3350
3101=head3 The special problem of life after fork - how is it possible? 3351=head3 The special problem of life after fork - how is it possible?
3102 3352
3103Most uses of C<fork()> consist of forking, then some simple calls to set 3353Most uses of C<fork ()> consist of forking, then some simple calls to set
3104up/change the process environment, followed by a call to C<exec()>. This 3354up/change the process environment, followed by a call to C<exec()>. This
3105sequence should be handled by libev without any problems. 3355sequence should be handled by libev without any problems.
3106 3356
3107This changes when the application actually wants to do event handling 3357This changes when the application actually wants to do event handling
3108in the child, or both parent in child, in effect "continuing" after the 3358in the child, or both parent in child, in effect "continuing" after the
3185 atexit (program_exits); 3435 atexit (program_exits);
3186 3436
3187 3437
3188=head2 C<ev_async> - how to wake up an event loop 3438=head2 C<ev_async> - how to wake up an event loop
3189 3439
3190In general, you cannot use an C<ev_run> from multiple threads or other 3440In general, you cannot use an C<ev_loop> from multiple threads or other
3191asynchronous sources such as signal handlers (as opposed to multiple event 3441asynchronous sources such as signal handlers (as opposed to multiple event
3192loops - those are of course safe to use in different threads). 3442loops - those are of course safe to use in different threads).
3193 3443
3194Sometimes, however, you need to wake up an event loop you do not control, 3444Sometimes, however, you need to wake up an event loop you do not control,
3195for example because it belongs to another thread. This is what C<ev_async> 3445for example because it belongs to another thread. This is what C<ev_async>
3197it by calling C<ev_async_send>, which is thread- and signal safe. 3447it by calling C<ev_async_send>, which is thread- and signal safe.
3198 3448
3199This functionality is very similar to C<ev_signal> watchers, as signals, 3449This functionality is very similar to C<ev_signal> watchers, as signals,
3200too, are asynchronous in nature, and signals, too, will be compressed 3450too, are asynchronous in nature, and signals, too, will be compressed
3201(i.e. the number of callback invocations may be less than the number of 3451(i.e. the number of callback invocations may be less than the number of
3202C<ev_async_sent> calls). In fact, you could use signal watchers as a kind 3452C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3203of "global async watchers" by using a watcher on an otherwise unused 3453of "global async watchers" by using a watcher on an otherwise unused
3204signal, and C<ev_feed_signal> to signal this watcher from another thread, 3454signal, and C<ev_feed_signal> to signal this watcher from another thread,
3205even without knowing which loop owns the signal. 3455even without knowing which loop owns the signal.
3206
3207Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3208just the default loop.
3209 3456
3210=head3 Queueing 3457=head3 Queueing
3211 3458
3212C<ev_async> does not support queueing of data in any way. The reason 3459C<ev_async> does not support queueing of data in any way. The reason
3213is that the author does not know of a simple (or any) algorithm for a 3460is that the author does not know of a simple (or any) algorithm for a
3305trust me. 3552trust me.
3306 3553
3307=item ev_async_send (loop, ev_async *) 3554=item ev_async_send (loop, ev_async *)
3308 3555
3309Sends/signals/activates the given C<ev_async> watcher, that is, feeds 3556Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3310an C<EV_ASYNC> event on the watcher into the event loop. Unlike 3557an C<EV_ASYNC> event on the watcher into the event loop, and instantly
3558returns.
3559
3311C<ev_feed_event>, this call is safe to do from other threads, signal or 3560Unlike C<ev_feed_event>, this call is safe to do from other threads,
3312similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding 3561signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3313section below on what exactly this means). 3562embedding section below on what exactly this means).
3314 3563
3315Note that, as with other watchers in libev, multiple events might get 3564Note that, as with other watchers in libev, multiple events might get
3316compressed into a single callback invocation (another way to look at this 3565compressed into a single callback invocation (another way to look at
3317is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, 3566this is that C<ev_async> watchers are level-triggered: they are set on
3318reset when the event loop detects that). 3567C<ev_async_send>, reset when the event loop detects that).
3319 3568
3320This call incurs the overhead of a system call only once per event loop 3569This call incurs the overhead of at most one extra system call per event
3321iteration, so while the overhead might be noticeable, it doesn't apply to 3570loop iteration, if the event loop is blocked, and no syscall at all if
3322repeated calls to C<ev_async_send> for the same event loop. 3571the event loop (or your program) is processing events. That means that
3572repeated calls are basically free (there is no need to avoid calls for
3573performance reasons) and that the overhead becomes smaller (typically
3574zero) under load.
3323 3575
3324=item bool = ev_async_pending (ev_async *) 3576=item bool = ev_async_pending (ev_async *)
3325 3577
3326Returns a non-zero value when C<ev_async_send> has been called on the 3578Returns a non-zero value when C<ev_async_send> has been called on the
3327watcher but the event has not yet been processed (or even noted) by the 3579watcher but the event has not yet been processed (or even noted) by the
3344 3596
3345There are some other functions of possible interest. Described. Here. Now. 3597There are some other functions of possible interest. Described. Here. Now.
3346 3598
3347=over 4 3599=over 4
3348 3600
3349=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 3601=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3350 3602
3351This function combines a simple timer and an I/O watcher, calls your 3603This function combines a simple timer and an I/O watcher, calls your
3352callback on whichever event happens first and automatically stops both 3604callback on whichever event happens first and automatically stops both
3353watchers. This is useful if you want to wait for a single event on an fd 3605watchers. This is useful if you want to wait for a single event on an fd
3354or timeout without having to allocate/configure/start/stop/free one or 3606or timeout without having to allocate/configure/start/stop/free one or
3382 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3634 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3383 3635
3384=item ev_feed_fd_event (loop, int fd, int revents) 3636=item ev_feed_fd_event (loop, int fd, int revents)
3385 3637
3386Feed an event on the given fd, as if a file descriptor backend detected 3638Feed an event on the given fd, as if a file descriptor backend detected
3387the given events it. 3639the given events.
3388 3640
3389=item ev_feed_signal_event (loop, int signum) 3641=item ev_feed_signal_event (loop, int signum)
3390 3642
3391Feed an event as if the given signal occurred. See also C<ev_feed_signal>, 3643Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3392which is async-safe. 3644which is async-safe.
3466 { 3718 {
3467 struct my_biggy big = (struct my_biggy *) 3719 struct my_biggy big = (struct my_biggy *)
3468 (((char *)w) - offsetof (struct my_biggy, t2)); 3720 (((char *)w) - offsetof (struct my_biggy, t2));
3469 } 3721 }
3470 3722
3723=head2 AVOIDING FINISHING BEFORE RETURNING
3724
3725Often you have structures like this in event-based programs:
3726
3727 callback ()
3728 {
3729 free (request);
3730 }
3731
3732 request = start_new_request (..., callback);
3733
3734The intent is to start some "lengthy" operation. The C<request> could be
3735used to cancel the operation, or do other things with it.
3736
3737It's not uncommon to have code paths in C<start_new_request> that
3738immediately invoke the callback, for example, to report errors. Or you add
3739some caching layer that finds that it can skip the lengthy aspects of the
3740operation and simply invoke the callback with the result.
3741
3742The problem here is that this will happen I<before> C<start_new_request>
3743has returned, so C<request> is not set.
3744
3745Even if you pass the request by some safer means to the callback, you
3746might want to do something to the request after starting it, such as
3747canceling it, which probably isn't working so well when the callback has
3748already been invoked.
3749
3750A common way around all these issues is to make sure that
3751C<start_new_request> I<always> returns before the callback is invoked. If
3752C<start_new_request> immediately knows the result, it can artificially
3753delay invoking the callback by using a C<prepare> or C<idle> watcher for
3754example, or more sneakily, by reusing an existing (stopped) watcher and
3755pushing it into the pending queue:
3756
3757 ev_set_cb (watcher, callback);
3758 ev_feed_event (EV_A_ watcher, 0);
3759
3760This way, C<start_new_request> can safely return before the callback is
3761invoked, while not delaying callback invocation too much.
3762
3471=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS 3763=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
3472 3764
3473Often (especially in GUI toolkits) there are places where you have 3765Often (especially in GUI toolkits) there are places where you have
3474I<modal> interaction, which is most easily implemented by recursively 3766I<modal> interaction, which is most easily implemented by recursively
3475invoking C<ev_run>. 3767invoking C<ev_run>.
3476 3768
3477This brings the problem of exiting - a callback might want to finish the 3769This brings the problem of exiting - a callback might want to finish the
3478main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but 3770main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3479a modal "Are you sure?" dialog is still waiting), or just the nested one 3771a modal "Are you sure?" dialog is still waiting), or just the nested one
3480and not the main one (e.g. user clocked "Ok" in a modal dialog), or some 3772and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3481other combination: In these cases, C<ev_break> will not work alone. 3773other combination: In these cases, a simple C<ev_break> will not work.
3482 3774
3483The solution is to maintain "break this loop" variable for each C<ev_run> 3775The solution is to maintain "break this loop" variable for each C<ev_run>
3484invocation, and use a loop around C<ev_run> until the condition is 3776invocation, and use a loop around C<ev_run> until the condition is
3485triggered, using C<EVRUN_ONCE>: 3777triggered, using C<EVRUN_ONCE>:
3486 3778
3488 int exit_main_loop = 0; 3780 int exit_main_loop = 0;
3489 3781
3490 while (!exit_main_loop) 3782 while (!exit_main_loop)
3491 ev_run (EV_DEFAULT_ EVRUN_ONCE); 3783 ev_run (EV_DEFAULT_ EVRUN_ONCE);
3492 3784
3493 // in a model watcher 3785 // in a modal watcher
3494 int exit_nested_loop = 0; 3786 int exit_nested_loop = 0;
3495 3787
3496 while (!exit_nested_loop) 3788 while (!exit_nested_loop)
3497 ev_run (EV_A_ EVRUN_ONCE); 3789 ev_run (EV_A_ EVRUN_ONCE);
3498 3790
3544 // now associate this with the loop 3836 // now associate this with the loop
3545 ev_set_userdata (EV_A_ u); 3837 ev_set_userdata (EV_A_ u);
3546 ev_set_invoke_pending_cb (EV_A_ l_invoke); 3838 ev_set_invoke_pending_cb (EV_A_ l_invoke);
3547 ev_set_loop_release_cb (EV_A_ l_release, l_acquire); 3839 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3548 3840
3549 // then create the thread running ev_loop 3841 // then create the thread running ev_run
3550 pthread_create (&u->tid, 0, l_run, EV_A); 3842 pthread_create (&u->tid, 0, l_run, EV_A);
3551 } 3843 }
3552 3844
3553The callback for the C<ev_async> watcher does nothing: the watcher is used 3845The callback for the C<ev_async> watcher does nothing: the watcher is used
3554solely to wake up the event loop so it takes notice of any new watchers 3846solely to wake up the event loop so it takes notice of any new watchers
3672called): 3964called):
3673 3965
3674 void 3966 void
3675 wait_for_event (ev_watcher *w) 3967 wait_for_event (ev_watcher *w)
3676 { 3968 {
3677 ev_cb_set (w) = current_coro; 3969 ev_set_cb (w, current_coro);
3678 switch_to (libev_coro); 3970 switch_to (libev_coro);
3679 } 3971 }
3680 3972
3681That basically suspends the coroutine inside C<wait_for_event> and 3973That basically suspends the coroutine inside C<wait_for_event> and
3682continues the libev coroutine, which, when appropriate, switches back to 3974continues the libev coroutine, which, when appropriate, switches back to
3683this or any other coroutine. I am sure if you sue this your own :) 3975this or any other coroutine.
3684 3976
3685You can do similar tricks if you have, say, threads with an event queue - 3977You can do similar tricks if you have, say, threads with an event queue -
3686instead of storing a coroutine, you store the queue object and instead of 3978instead of storing a coroutine, you store the queue object and instead of
3687switching to a coroutine, you push the watcher onto the queue and notify 3979switching to a coroutine, you push the watcher onto the queue and notify
3688any waiters. 3980any waiters.
3689 3981
3690To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 3982To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3691files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 3983files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3692 3984
3693 // my_ev.h 3985 // my_ev.h
3694 #define EV_CB_DECLARE(type) struct my_coro *cb; 3986 #define EV_CB_DECLARE(type) struct my_coro *cb;
3695 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 3987 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3696 #include "../libev/ev.h" 3988 #include "../libev/ev.h"
3697 3989
3698 // my_ev.c 3990 // my_ev.c
3699 #define EV_H "my_ev.h" 3991 #define EV_H "my_ev.h"
3700 #include "../libev/ev.c" 3992 #include "../libev/ev.c"
3739 4031
3740=back 4032=back
3741 4033
3742=head1 C++ SUPPORT 4034=head1 C++ SUPPORT
3743 4035
4036=head2 C API
4037
4038The normal C API should work fine when used from C++: both ev.h and the
4039libev sources can be compiled as C++. Therefore, code that uses the C API
4040will work fine.
4041
4042Proper exception specifications might have to be added to callbacks passed
4043to libev: exceptions may be thrown only from watcher callbacks, all other
4044callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4045callbacks) must not throw exceptions, and might need a C<noexcept>
4046specification. If you have code that needs to be compiled as both C and
4047C++ you can use the C<EV_NOEXCEPT> macro for this:
4048
4049 static void
4050 fatal_error (const char *msg) EV_NOEXCEPT
4051 {
4052 perror (msg);
4053 abort ();
4054 }
4055
4056 ...
4057 ev_set_syserr_cb (fatal_error);
4058
4059The only API functions that can currently throw exceptions are C<ev_run>,
4060C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
4061because it runs cleanup watchers).
4062
4063Throwing exceptions in watcher callbacks is only supported if libev itself
4064is compiled with a C++ compiler or your C and C++ environments allow
4065throwing exceptions through C libraries (most do).
4066
4067=head2 C++ API
4068
3744Libev comes with some simplistic wrapper classes for C++ that mainly allow 4069Libev comes with some simplistic wrapper classes for C++ that mainly allow
3745you to use some convenience methods to start/stop watchers and also change 4070you to use some convenience methods to start/stop watchers and also change
3746the callback model to a model using method callbacks on objects. 4071the callback model to a model using method callbacks on objects.
3747 4072
3748To use it, 4073To use it,
3749 4074
3750 #include <ev++.h> 4075 #include <ev++.h>
3751 4076
3752This automatically includes F<ev.h> and puts all of its definitions (many 4077This automatically includes F<ev.h> and puts all of its definitions (many
3753of them macros) into the global namespace. All C++ specific things are 4078of them macros) into the global namespace. All C++ specific things are
3754put into the C<ev> namespace. It should support all the same embedding 4079put into the C<ev> namespace. It should support all the same embedding
3763with C<operator ()> can be used as callbacks. Other types should be easy 4088with C<operator ()> can be used as callbacks. Other types should be easy
3764to add as long as they only need one additional pointer for context. If 4089to add as long as they only need one additional pointer for context. If
3765you need support for other types of functors please contact the author 4090you need support for other types of functors please contact the author
3766(preferably after implementing it). 4091(preferably after implementing it).
3767 4092
4093For all this to work, your C++ compiler either has to use the same calling
4094conventions as your C compiler (for static member functions), or you have
4095to embed libev and compile libev itself as C++.
4096
3768Here is a list of things available in the C<ev> namespace: 4097Here is a list of things available in the C<ev> namespace:
3769 4098
3770=over 4 4099=over 4
3771 4100
3772=item C<ev::READ>, C<ev::WRITE> etc. 4101=item C<ev::READ>, C<ev::WRITE> etc.
3781=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. 4110=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3782 4111
3783For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of 4112For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3784the same name in the C<ev> namespace, with the exception of C<ev_signal> 4113the same name in the C<ev> namespace, with the exception of C<ev_signal>
3785which is called C<ev::sig> to avoid clashes with the C<signal> macro 4114which is called C<ev::sig> to avoid clashes with the C<signal> macro
3786defines by many implementations. 4115defined by many implementations.
3787 4116
3788All of those classes have these methods: 4117All of those classes have these methods:
3789 4118
3790=over 4 4119=over 4
3791 4120
3853 void operator() (ev::io &w, int revents) 4182 void operator() (ev::io &w, int revents)
3854 { 4183 {
3855 ... 4184 ...
3856 } 4185 }
3857 } 4186 }
3858 4187
3859 myfunctor f; 4188 myfunctor f;
3860 4189
3861 ev::io w; 4190 ev::io w;
3862 w.set (&f); 4191 w.set (&f);
3863 4192
3881Associates a different C<struct ev_loop> with this watcher. You can only 4210Associates a different C<struct ev_loop> with this watcher. You can only
3882do this when the watcher is inactive (and not pending either). 4211do this when the watcher is inactive (and not pending either).
3883 4212
3884=item w->set ([arguments]) 4213=item w->set ([arguments])
3885 4214
3886Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4215Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
3887method or a suitable start method must be called at least once. Unlike the 4216with the same arguments. Either this method or a suitable start method
3888C counterpart, an active watcher gets automatically stopped and restarted 4217must be called at least once. Unlike the C counterpart, an active watcher
3889when reconfiguring it with this method. 4218gets automatically stopped and restarted when reconfiguring it with this
4219method.
4220
4221For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4222clashing with the C<set (loop)> method.
3890 4223
3891=item w->start () 4224=item w->start ()
3892 4225
3893Starts the watcher. Note that there is no C<loop> argument, as the 4226Starts the watcher. Note that there is no C<loop> argument, as the
3894constructor already stores the event loop. 4227constructor already stores the event loop.
3924watchers in the constructor. 4257watchers in the constructor.
3925 4258
3926 class myclass 4259 class myclass
3927 { 4260 {
3928 ev::io io ; void io_cb (ev::io &w, int revents); 4261 ev::io io ; void io_cb (ev::io &w, int revents);
3929 ev::io2 io2 ; void io2_cb (ev::io &w, int revents); 4262 ev::io io2 ; void io2_cb (ev::io &w, int revents);
3930 ev::idle idle; void idle_cb (ev::idle &w, int revents); 4263 ev::idle idle; void idle_cb (ev::idle &w, int revents);
3931 4264
3932 myclass (int fd) 4265 myclass (int fd)
3933 { 4266 {
3934 io .set <myclass, &myclass::io_cb > (this); 4267 io .set <myclass, &myclass::io_cb > (this);
3985L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. 4318L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3986 4319
3987=item D 4320=item D
3988 4321
3989Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 4322Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3990be found at L<http://proj.llucax.com.ar/wiki/evd>. 4323be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3991 4324
3992=item Ocaml 4325=item Ocaml
3993 4326
3994Erkki Seppala has written Ocaml bindings for libev, to be found at 4327Erkki Seppala has written Ocaml bindings for libev, to be found at
3995L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 4328L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3998 4331
3999Brian Maher has written a partial interface to libev for lua (at the 4332Brian Maher has written a partial interface to libev for lua (at the
4000time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4333time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4001L<http://github.com/brimworks/lua-ev>. 4334L<http://github.com/brimworks/lua-ev>.
4002 4335
4336=item Javascript
4337
4338Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4339
4340=item Others
4341
4342There are others, and I stopped counting.
4343
4003=back 4344=back
4004 4345
4005 4346
4006=head1 MACRO MAGIC 4347=head1 MACRO MAGIC
4007 4348
4043suitable for use with C<EV_A>. 4384suitable for use with C<EV_A>.
4044 4385
4045=item C<EV_DEFAULT>, C<EV_DEFAULT_> 4386=item C<EV_DEFAULT>, C<EV_DEFAULT_>
4046 4387
4047Similar to the other two macros, this gives you the value of the default 4388Similar to the other two macros, this gives you the value of the default
4048loop, if multiple loops are supported ("ev loop default"). 4389loop, if multiple loops are supported ("ev loop default"). The default loop
4390will be initialised if it isn't already initialised.
4391
4392For non-multiplicity builds, these macros do nothing, so you always have
4393to initialise the loop somewhere.
4049 4394
4050=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> 4395=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
4051 4396
4052Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the 4397Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
4053default loop has been initialised (C<UC> == unchecked). Their behaviour 4398default loop has been initialised (C<UC> == unchecked). Their behaviour
4120 ev_vars.h 4465 ev_vars.h
4121 ev_wrap.h 4466 ev_wrap.h
4122 4467
4123 ev_win32.c required on win32 platforms only 4468 ev_win32.c required on win32 platforms only
4124 4469
4125 ev_select.c only when select backend is enabled (which is enabled by default) 4470 ev_select.c only when select backend is enabled
4126 ev_poll.c only when poll backend is enabled (disabled by default) 4471 ev_poll.c only when poll backend is enabled
4127 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4472 ev_epoll.c only when the epoll backend is enabled
4473 ev_linuxaio.c only when the linux aio backend is enabled
4128 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4474 ev_kqueue.c only when the kqueue backend is enabled
4129 ev_port.c only when the solaris port backend is enabled (disabled by default) 4475 ev_port.c only when the solaris port backend is enabled
4130 4476
4131F<ev.c> includes the backend files directly when enabled, so you only need 4477F<ev.c> includes the backend files directly when enabled, so you only need
4132to compile this single file. 4478to compile this single file.
4133 4479
4134=head3 LIBEVENT COMPATIBILITY API 4480=head3 LIBEVENT COMPATIBILITY API
4198supported). It will also not define any of the structs usually found in 4544supported). It will also not define any of the structs usually found in
4199F<event.h> that are not directly supported by the libev core alone. 4545F<event.h> that are not directly supported by the libev core alone.
4200 4546
4201In standalone mode, libev will still try to automatically deduce the 4547In standalone mode, libev will still try to automatically deduce the
4202configuration, but has to be more conservative. 4548configuration, but has to be more conservative.
4549
4550=item EV_USE_FLOOR
4551
4552If defined to be C<1>, libev will use the C<floor ()> function for its
4553periodic reschedule calculations, otherwise libev will fall back on a
4554portable (slower) implementation. If you enable this, you usually have to
4555link against libm or something equivalent. Enabling this when the C<floor>
4556function is not available will fail, so the safe default is to not enable
4557this.
4203 4558
4204=item EV_USE_MONOTONIC 4559=item EV_USE_MONOTONIC
4205 4560
4206If defined to be C<1>, libev will try to detect the availability of the 4561If defined to be C<1>, libev will try to detect the availability of the
4207monotonic clock option at both compile time and runtime. Otherwise no 4562monotonic clock option at both compile time and runtime. Otherwise no
4293If programs implement their own fd to handle mapping on win32, then this 4648If programs implement their own fd to handle mapping on win32, then this
4294macro can be used to override the C<close> function, useful to unregister 4649macro can be used to override the C<close> function, useful to unregister
4295file descriptors again. Note that the replacement function has to close 4650file descriptors again. Note that the replacement function has to close
4296the underlying OS handle. 4651the underlying OS handle.
4297 4652
4653=item EV_USE_WSASOCKET
4654
4655If defined to be C<1>, libev will use C<WSASocket> to create its internal
4656communication socket, which works better in some environments. Otherwise,
4657the normal C<socket> function will be used, which works better in other
4658environments.
4659
4298=item EV_USE_POLL 4660=item EV_USE_POLL
4299 4661
4300If defined to be C<1>, libev will compile in support for the C<poll>(2) 4662If defined to be C<1>, libev will compile in support for the C<poll>(2)
4301backend. Otherwise it will be enabled on non-win32 platforms. It 4663backend. Otherwise it will be enabled on non-win32 platforms. It
4302takes precedence over select. 4664takes precedence over select.
4306If defined to be C<1>, libev will compile in support for the Linux 4668If defined to be C<1>, libev will compile in support for the Linux
4307C<epoll>(7) backend. Its availability will be detected at runtime, 4669C<epoll>(7) backend. Its availability will be detected at runtime,
4308otherwise another method will be used as fallback. This is the preferred 4670otherwise another method will be used as fallback. This is the preferred
4309backend for GNU/Linux systems. If undefined, it will be enabled if the 4671backend for GNU/Linux systems. If undefined, it will be enabled if the
4310headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4672headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4673
4674=item EV_USE_LINUXAIO
4675
4676If defined to be C<1>, libev will compile in support for the Linux
4677aio backend. Due to it's currenbt limitations it has to be requested
4678explicitly. If undefined, it will be enabled on linux, otherwise
4679disabled.
4311 4680
4312=item EV_USE_KQUEUE 4681=item EV_USE_KQUEUE
4313 4682
4314If defined to be C<1>, libev will compile in support for the BSD style 4683If defined to be C<1>, libev will compile in support for the BSD style
4315C<kqueue>(2) backend. Its actual availability will be detected at runtime, 4684C<kqueue>(2) backend. Its actual availability will be detected at runtime,
4337If defined to be C<1>, libev will compile in support for the Linux inotify 4706If defined to be C<1>, libev will compile in support for the Linux inotify
4338interface to speed up C<ev_stat> watchers. Its actual availability will 4707interface to speed up C<ev_stat> watchers. Its actual availability will
4339be detected at runtime. If undefined, it will be enabled if the headers 4708be detected at runtime. If undefined, it will be enabled if the headers
4340indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4709indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4341 4710
4711=item EV_NO_SMP
4712
4713If defined to be C<1>, libev will assume that memory is always coherent
4714between threads, that is, threads can be used, but threads never run on
4715different cpus (or different cpu cores). This reduces dependencies
4716and makes libev faster.
4717
4718=item EV_NO_THREADS
4719
4720If defined to be C<1>, libev will assume that it will never be called from
4721different threads (that includes signal handlers), which is a stronger
4722assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4723libev faster.
4724
4342=item EV_ATOMIC_T 4725=item EV_ATOMIC_T
4343 4726
4344Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4727Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4345access is atomic with respect to other threads or signal contexts. No such 4728access is atomic with respect to other threads or signal contexts. No
4346type is easily found in the C language, so you can provide your own type 4729such type is easily found in the C language, so you can provide your own
4347that you know is safe for your purposes. It is used both for signal handler "locking" 4730type that you know is safe for your purposes. It is used both for signal
4348as well as for signal and thread safety in C<ev_async> watchers. 4731handler "locking" as well as for signal and thread safety in C<ev_async>
4732watchers.
4349 4733
4350In the absence of this define, libev will use C<sig_atomic_t volatile> 4734In the absence of this define, libev will use C<sig_atomic_t volatile>
4351(from F<signal.h>), which is usually good enough on most platforms. 4735(from F<signal.h>), which is usually good enough on most platforms.
4352 4736
4353=item EV_H (h) 4737=item EV_H (h)
4380will have the C<struct ev_loop *> as first argument, and you can create 4764will have the C<struct ev_loop *> as first argument, and you can create
4381additional independent event loops. Otherwise there will be no support 4765additional independent event loops. Otherwise there will be no support
4382for multiple event loops and there is no first event loop pointer 4766for multiple event loops and there is no first event loop pointer
4383argument. Instead, all functions act on the single default loop. 4767argument. Instead, all functions act on the single default loop.
4384 4768
4769Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
4770default loop when multiplicity is switched off - you always have to
4771initialise the loop manually in this case.
4772
4385=item EV_MINPRI 4773=item EV_MINPRI
4386 4774
4387=item EV_MAXPRI 4775=item EV_MAXPRI
4388 4776
4389The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to 4777The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
4425 #define EV_USE_POLL 1 4813 #define EV_USE_POLL 1
4426 #define EV_CHILD_ENABLE 1 4814 #define EV_CHILD_ENABLE 1
4427 #define EV_ASYNC_ENABLE 1 4815 #define EV_ASYNC_ENABLE 1
4428 4816
4429The actual value is a bitset, it can be a combination of the following 4817The actual value is a bitset, it can be a combination of the following
4430values: 4818values (by default, all of these are enabled):
4431 4819
4432=over 4 4820=over 4
4433 4821
4434=item C<1> - faster/larger code 4822=item C<1> - faster/larger code
4435 4823
4439code size by roughly 30% on amd64). 4827code size by roughly 30% on amd64).
4440 4828
4441When optimising for size, use of compiler flags such as C<-Os> with 4829When optimising for size, use of compiler flags such as C<-Os> with
4442gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of 4830gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4443assertions. 4831assertions.
4832
4833The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4834(e.g. gcc with C<-Os>).
4444 4835
4445=item C<2> - faster/larger data structures 4836=item C<2> - faster/larger data structures
4446 4837
4447Replaces the small 2-heap for timer management by a faster 4-heap, larger 4838Replaces the small 2-heap for timer management by a faster 4-heap, larger
4448hash table sizes and so on. This will usually further increase code size 4839hash table sizes and so on. This will usually further increase code size
4449and can additionally have an effect on the size of data structures at 4840and can additionally have an effect on the size of data structures at
4450runtime. 4841runtime.
4451 4842
4843The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4844(e.g. gcc with C<-Os>).
4845
4452=item C<4> - full API configuration 4846=item C<4> - full API configuration
4453 4847
4454This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and 4848This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4455enables multiplicity (C<EV_MULTIPLICITY>=1). 4849enables multiplicity (C<EV_MULTIPLICITY>=1).
4456 4850
4486 4880
4487With an intelligent-enough linker (gcc+binutils are intelligent enough 4881With an intelligent-enough linker (gcc+binutils are intelligent enough
4488when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by 4882when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
4489your program might be left out as well - a binary starting a timer and an 4883your program might be left out as well - a binary starting a timer and an
4490I/O watcher then might come out at only 5Kb. 4884I/O watcher then might come out at only 5Kb.
4885
4886=item EV_API_STATIC
4887
4888If this symbol is defined (by default it is not), then all identifiers
4889will have static linkage. This means that libev will not export any
4890identifiers, and you cannot link against libev anymore. This can be useful
4891when you embed libev, only want to use libev functions in a single file,
4892and do not want its identifiers to be visible.
4893
4894To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
4895wants to use libev.
4896
4897This option only works when libev is compiled with a C compiler, as C++
4898doesn't support the required declaration syntax.
4491 4899
4492=item EV_AVOID_STDIO 4900=item EV_AVOID_STDIO
4493 4901
4494If this is set to C<1> at compiletime, then libev will avoid using stdio 4902If this is set to C<1> at compiletime, then libev will avoid using stdio
4495functions (printf, scanf, perror etc.). This will increase the code size 4903functions (printf, scanf, perror etc.). This will increase the code size
4700default loop and triggering an C<ev_async> watcher from the default loop 5108default loop and triggering an C<ev_async> watcher from the default loop
4701watcher callback into the event loop interested in the signal. 5109watcher callback into the event loop interested in the signal.
4702 5110
4703=back 5111=back
4704 5112
4705See also L<THREAD LOCKING EXAMPLE>. 5113See also L</THREAD LOCKING EXAMPLE>.
4706 5114
4707=head3 COROUTINES 5115=head3 COROUTINES
4708 5116
4709Libev is very accommodating to coroutines ("cooperative threads"): 5117Libev is very accommodating to coroutines ("cooperative threads"):
4710libev fully supports nesting calls to its functions from different 5118libev fully supports nesting calls to its functions from different
4875requires, and its I/O model is fundamentally incompatible with the POSIX 5283requires, and its I/O model is fundamentally incompatible with the POSIX
4876model. Libev still offers limited functionality on this platform in 5284model. Libev still offers limited functionality on this platform in
4877the form of the C<EVBACKEND_SELECT> backend, and only supports socket 5285the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4878descriptors. This only applies when using Win32 natively, not when using 5286descriptors. This only applies when using Win32 natively, not when using
4879e.g. cygwin. Actually, it only applies to the microsofts own compilers, 5287e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4880as every compielr comes with a slightly differently broken/incompatible 5288as every compiler comes with a slightly differently broken/incompatible
4881environment. 5289environment.
4882 5290
4883Lifting these limitations would basically require the full 5291Lifting these limitations would basically require the full
4884re-implementation of the I/O system. If you are into this kind of thing, 5292re-implementation of the I/O system. If you are into this kind of thing,
4885then note that glib does exactly that for you in a very portable way (note 5293then note that glib does exactly that for you in a very portable way (note
4979structure (guaranteed by POSIX but not by ISO C for example), but it also 5387structure (guaranteed by POSIX but not by ISO C for example), but it also
4980assumes that the same (machine) code can be used to call any watcher 5388assumes that the same (machine) code can be used to call any watcher
4981callback: The watcher callbacks have different type signatures, but libev 5389callback: The watcher callbacks have different type signatures, but libev
4982calls them using an C<ev_watcher *> internally. 5390calls them using an C<ev_watcher *> internally.
4983 5391
5392=item null pointers and integer zero are represented by 0 bytes
5393
5394Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
5395relies on this setting pointers and integers to null.
5396
4984=item pointer accesses must be thread-atomic 5397=item pointer accesses must be thread-atomic
4985 5398
4986Accessing a pointer value must be atomic, it must both be readable and 5399Accessing a pointer value must be atomic, it must both be readable and
4987writable in one piece - this is the case on all current architectures. 5400writable in one piece - this is the case on all current architectures.
4988 5401
5001thread" or will block signals process-wide, both behaviours would 5414thread" or will block signals process-wide, both behaviours would
5002be compatible with libev. Interaction between C<sigprocmask> and 5415be compatible with libev. Interaction between C<sigprocmask> and
5003C<pthread_sigmask> could complicate things, however. 5416C<pthread_sigmask> could complicate things, however.
5004 5417
5005The most portable way to handle signals is to block signals in all threads 5418The most portable way to handle signals is to block signals in all threads
5006except the initial one, and run the default loop in the initial thread as 5419except the initial one, and run the signal handling loop in the initial
5007well. 5420thread as well.
5008 5421
5009=item C<long> must be large enough for common memory allocation sizes 5422=item C<long> must be large enough for common memory allocation sizes
5010 5423
5011To improve portability and simplify its API, libev uses C<long> internally 5424To improve portability and simplify its API, libev uses C<long> internally
5012instead of C<size_t> when allocating its data structures. On non-POSIX 5425instead of C<size_t> when allocating its data structures. On non-POSIX
5018 5431
5019The type C<double> is used to represent timestamps. It is required to 5432The type C<double> is used to represent timestamps. It is required to
5020have at least 51 bits of mantissa (and 9 bits of exponent), which is 5433have at least 51 bits of mantissa (and 9 bits of exponent), which is
5021good enough for at least into the year 4000 with millisecond accuracy 5434good enough for at least into the year 4000 with millisecond accuracy
5022(the design goal for libev). This requirement is overfulfilled by 5435(the design goal for libev). This requirement is overfulfilled by
5023implementations using IEEE 754, which is basically all existing ones. With 5436implementations using IEEE 754, which is basically all existing ones.
5437
5024IEEE 754 doubles, you get microsecond accuracy until at least 2200. 5438With IEEE 754 doubles, you get microsecond accuracy until at least the
5439year 2255 (and millisecond accuracy till the year 287396 - by then, libev
5440is either obsolete or somebody patched it to use C<long double> or
5441something like that, just kidding).
5025 5442
5026=back 5443=back
5027 5444
5028If you know of other additional requirements drop me a note. 5445If you know of other additional requirements drop me a note.
5029 5446
5091=item Processing ev_async_send: O(number_of_async_watchers) 5508=item Processing ev_async_send: O(number_of_async_watchers)
5092 5509
5093=item Processing signals: O(max_signal_number) 5510=item Processing signals: O(max_signal_number)
5094 5511
5095Sending involves a system call I<iff> there were no other C<ev_async_send> 5512Sending involves a system call I<iff> there were no other C<ev_async_send>
5096calls in the current loop iteration. Checking for async and signal events 5513calls in the current loop iteration and the loop is currently
5514blocked. Checking for async and signal events involves iterating over all
5097involves iterating over all running async watchers or all signal numbers. 5515running async watchers or all signal numbers.
5098 5516
5099=back 5517=back
5100 5518
5101 5519
5102=head1 PORTING FROM LIBEV 3.X TO 4.X 5520=head1 PORTING FROM LIBEV 3.X TO 4.X
5111=over 4 5529=over 4
5112 5530
5113=item C<EV_COMPAT3> backwards compatibility mechanism 5531=item C<EV_COMPAT3> backwards compatibility mechanism
5114 5532
5115The backward compatibility mechanism can be controlled by 5533The backward compatibility mechanism can be controlled by
5116C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5534C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5117section. 5535section.
5118 5536
5119=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5537=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5120 5538
5121These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5539These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5164=over 4 5582=over 4
5165 5583
5166=item active 5584=item active
5167 5585
5168A watcher is active as long as it has been started and not yet stopped. 5586A watcher is active as long as it has been started and not yet stopped.
5169See L<WATCHER STATES> for details. 5587See L</WATCHER STATES> for details.
5170 5588
5171=item application 5589=item application
5172 5590
5173In this document, an application is whatever is using libev. 5591In this document, an application is whatever is using libev.
5174 5592
5210watchers and events. 5628watchers and events.
5211 5629
5212=item pending 5630=item pending
5213 5631
5214A watcher is pending as soon as the corresponding event has been 5632A watcher is pending as soon as the corresponding event has been
5215detected. See L<WATCHER STATES> for details. 5633detected. See L</WATCHER STATES> for details.
5216 5634
5217=item real time 5635=item real time
5218 5636
5219The physical time that is observed. It is apparently strictly monotonic :) 5637The physical time that is observed. It is apparently strictly monotonic :)
5220 5638
5221=item wall-clock time 5639=item wall-clock time
5222 5640
5223The time and date as shown on clocks. Unlike real time, it can actually 5641The time and date as shown on clocks. Unlike real time, it can actually
5224be wrong and jump forwards and backwards, e.g. when the you adjust your 5642be wrong and jump forwards and backwards, e.g. when you adjust your
5225clock. 5643clock.
5226 5644
5227=item watcher 5645=item watcher
5228 5646
5229A data structure that describes interest in certain events. Watchers need 5647A data structure that describes interest in certain events. Watchers need
5232=back 5650=back
5233 5651
5234=head1 AUTHOR 5652=head1 AUTHOR
5235 5653
5236Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael 5654Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5237Magnusson and Emanuele Giaquinta. 5655Magnusson and Emanuele Giaquinta, and minor corrections by many others.
5238 5656

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines