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

Comparing libev/ev.pod (file contents):
Revision 1.397 by root, Mon Feb 13 01:52:14 2012 UTC vs.
Revision 1.455 by root, Wed Jun 26 00:01:46 2019 UTC

1=encoding utf-8
2
1=head1 NAME 3=head1 NAME
2 4
3libev - a high performance full-featured event loop written in C 5libev - a high performance full-featured event loop written in C
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
82 84
83=head1 WHAT TO READ WHEN IN A HURRY 85=head1 WHAT TO READ WHEN IN A HURRY
84 86
85This manual tries to be very detailed, but unfortunately, this also makes 87This manual tries to be very detailed, but unfortunately, this also makes
86it very long. If you just want to know the basics of libev, I suggest 88it very long. If you just want to know the basics of libev, I suggest
87reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and 89reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and
88look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and 90look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and
89C<ev_timer> sections in L<WATCHER TYPES>. 91C<ev_timer> sections in L</WATCHER TYPES>.
90 92
91=head1 ABOUT LIBEV 93=head1 ABOUT LIBEV
92 94
93Libev is an event loop: you register interest in certain events (such as a 95Libev is an event loop: you register interest in certain events (such as a
94file descriptor being readable or a timeout occurring), and it will manage 96file descriptor being readable or a timeout occurring), and it will manage
103details of the event, and then hand it over to libev by I<starting> the 105details of the event, and then hand it over to libev by I<starting> the
104watcher. 106watcher.
105 107
106=head2 FEATURES 108=head2 FEATURES
107 109
108Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 110Libev supports C<select>, C<poll>, the Linux-specific aio and C<epoll>
109BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 111interfaces, the BSD-specific C<kqueue> and the Solaris-specific event port
110for file descriptor events (C<ev_io>), the Linux C<inotify> interface 112mechanisms for file descriptor events (C<ev_io>), the Linux C<inotify>
111(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner 113interface (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
112inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative 114inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
113timers (C<ev_timer>), absolute timers with customised rescheduling 115timers (C<ev_timer>), absolute timers with customised rescheduling
114(C<ev_periodic>), synchronous signals (C<ev_signal>), process status 116(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
115change events (C<ev_child>), and event watchers dealing with the event 117change events (C<ev_child>), and event watchers dealing with the event
116loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and 118loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
157When libev detects a usage error such as a negative timer interval, then 159When libev detects a usage error such as a negative timer interval, then
158it will print a diagnostic message and abort (via the C<assert> mechanism, 160it will print a diagnostic message and abort (via the C<assert> mechanism,
159so C<NDEBUG> will disable this checking): these are programming errors in 161so C<NDEBUG> will disable this checking): these are programming errors in
160the libev caller and need to be fixed there. 162the libev caller and need to be fixed there.
161 163
164Via the C<EV_FREQUENT> macro you can compile in and/or enable extensive
165consistency checking code inside libev that can be used to check for
166internal inconsistencies, suually caused by application bugs.
167
162Libev also has a few internal error-checking C<assert>ions, and also has 168Libev also has a few internal error-checking C<assert>ions. These do not
163extensive consistency checking code. These do not trigger under normal
164circumstances, as they indicate either a bug in libev or worse. 169trigger under normal circumstances, as they indicate either a bug in libev
170or worse.
165 171
166 172
167=head1 GLOBAL FUNCTIONS 173=head1 GLOBAL FUNCTIONS
168 174
169These functions can be called anytime, even before initialising the 175These functions can be called anytime, even before initialising the
247the current system, you would need to look at C<ev_embeddable_backends () 253the current system, you would need to look at C<ev_embeddable_backends ()
248& ev_supported_backends ()>, likewise for recommended ones. 254& ev_supported_backends ()>, likewise for recommended ones.
249 255
250See the description of C<ev_embed> watchers for more info. 256See the description of C<ev_embed> watchers for more info.
251 257
252=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 258=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
253 259
254Sets the allocation function to use (the prototype is similar - the 260Sets the allocation function to use (the prototype is similar - the
255semantics are identical to the C<realloc> C89/SuS/POSIX function). It is 261semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
256used to allocate and free memory (no surprises here). If it returns zero 262used to allocate and free memory (no surprises here). If it returns zero
257when memory needs to be allocated (C<size != 0>), the library might abort 263when memory needs to be allocated (C<size != 0>), the library might abort
263 269
264You could override this function in high-availability programs to, say, 270You could override this function in high-availability programs to, say,
265free some memory if it cannot allocate memory, to use a special allocator, 271free some memory if it cannot allocate memory, to use a special allocator,
266or even to sleep a while and retry until some memory is available. 272or even to sleep a while and retry until some memory is available.
267 273
274Example: The following is the C<realloc> function that libev itself uses
275which should work with C<realloc> and C<free> functions of all kinds and
276is probably a good basis for your own implementation.
277
278 static void *
279 ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT
280 {
281 if (size)
282 return realloc (ptr, size);
283
284 free (ptr);
285 return 0;
286 }
287
268Example: Replace the libev allocator with one that waits a bit and then 288Example: Replace the libev allocator with one that waits a bit and then
269retries (example requires a standards-compliant C<realloc>). 289retries.
270 290
271 static void * 291 static void *
272 persistent_realloc (void *ptr, size_t size) 292 persistent_realloc (void *ptr, size_t size)
273 { 293 {
294 if (!size)
295 {
296 free (ptr);
297 return 0;
298 }
299
274 for (;;) 300 for (;;)
275 { 301 {
276 void *newptr = realloc (ptr, size); 302 void *newptr = realloc (ptr, size);
277 303
278 if (newptr) 304 if (newptr)
283 } 309 }
284 310
285 ... 311 ...
286 ev_set_allocator (persistent_realloc); 312 ev_set_allocator (persistent_realloc);
287 313
288=item ev_set_syserr_cb (void (*cb)(const char *msg)) 314=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
289 315
290Set the callback function to call on a retryable system call error (such 316Set the callback function to call on a retryable system call error (such
291as failed select, poll, epoll_wait). The message is a printable string 317as failed select, poll, epoll_wait). The message is a printable string
292indicating the system call or subsystem causing the problem. If this 318indicating the system call or subsystem causing the problem. If this
293callback is set, then libev will expect it to remedy the situation, no 319callback is set, then libev will expect it to remedy the situation, no
396 422
397If this flag bit is or'ed into the flag value (or the program runs setuid 423If this flag bit is or'ed into the flag value (or the program runs setuid
398or setgid) then libev will I<not> look at the environment variable 424or setgid) then libev will I<not> look at the environment variable
399C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 425C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
400override the flags completely if it is found in the environment. This is 426override the flags completely if it is found in the environment. This is
401useful to try out specific backends to test their performance, or to work 427useful to try out specific backends to test their performance, to work
402around bugs. 428around bugs, or to make libev threadsafe (accessing environment variables
429cannot be done in a threadsafe way, but usually it works if no other
430thread modifies them).
403 431
404=item C<EVFLAG_FORKCHECK> 432=item C<EVFLAG_FORKCHECK>
405 433
406Instead of calling C<ev_loop_fork> manually after a fork, you can also 434Instead of calling C<ev_loop_fork> manually after a fork, you can also
407make libev check for a fork in each iteration by enabling this flag. 435make libev check for a fork in each iteration by enabling this flag.
408 436
409This works by calling C<getpid ()> on every iteration of the loop, 437This works by calling C<getpid ()> on every iteration of the loop,
410and thus this might slow down your event loop if you do a lot of loop 438and thus this might slow down your event loop if you do a lot of loop
411iterations and little real work, but is usually not noticeable (on my 439iterations and little real work, but is usually not noticeable (on my
412GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence 440GNU/Linux system for example, C<getpid> is actually a simple 5-insn
413without a system call and thus I<very> fast, but my GNU/Linux system also has 441sequence without a system call and thus I<very> fast, but my GNU/Linux
414C<pthread_atfork> which is even faster). 442system also has C<pthread_atfork> which is even faster). (Update: glibc
443versions 2.25 apparently removed the C<getpid> optimisation again).
415 444
416The big advantage of this flag is that you can forget about fork (and 445The big advantage of this flag is that you can forget about fork (and
417forget about forgetting to tell libev about forking) when you use this 446forget about forgetting to tell libev about forking, although you still
418flag. 447have to ignore C<SIGPIPE>) when you use this flag.
419 448
420This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> 449This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
421environment variable. 450environment variable.
422 451
423=item C<EVFLAG_NOINOTIFY> 452=item C<EVFLAG_NOINOTIFY>
486This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and 515This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
487C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. 516C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
488 517
489=item C<EVBACKEND_EPOLL> (value 4, Linux) 518=item C<EVBACKEND_EPOLL> (value 4, Linux)
490 519
491Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 520Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9
492kernels). 521kernels).
493 522
494For few fds, this backend is a bit little slower than poll and select, but 523For few fds, this backend is a bit little slower than poll and select, but
495it scales phenomenally better. While poll and select usually scale like 524it scales phenomenally better. While poll and select usually scale like
496O(total_fds) where total_fds is the total number of fds (or the highest 525O(total_fds) where total_fds is the total number of fds (or the highest
542All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or 571All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
543faster than epoll for maybe up to a hundred file descriptors, depending on 572faster than epoll for maybe up to a hundred file descriptors, depending on
544the usage. So sad. 573the usage. So sad.
545 574
546While nominally embeddable in other event loops, this feature is broken in 575While nominally embeddable in other event loops, this feature is broken in
547all kernel versions tested so far. 576a lot of kernel revisions, but probably(!) works in current versions.
548 577
549This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 578This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
550C<EVBACKEND_POLL>. 579C<EVBACKEND_POLL>.
551 580
581=item C<EVBACKEND_LINUXAIO> (value 64, Linux)
582
583Use the Linux-specific Linux AIO (I<not> C<< aio(7) >> but C<<
584io_submit(2) >>) event interface available in post-4.18 kernels (but libev
585only tries to use it in 4.19+).
586
587This is another Linux train wreck of an event interface.
588
589If this backend works for you (as of this writing, it was very
590experimental), it is the best event interface available on Linux and might
591be well worth enabling it - if it isn't available in your kernel this will
592be detected and this backend will be skipped.
593
594This backend can batch oneshot requests and supports a user-space ring
595buffer to receive events. It also doesn't suffer from most of the design
596problems of epoll (such as not being able to remove event sources from
597the epoll set), and generally sounds too good to be true. Because, this
598being the Linux kernel, of course it suffers from a whole new set of
599limitations, forcing you to fall back to epoll, inheriting all its design
600issues.
601
602For one, it is not easily embeddable (but probably could be done using
603an event fd at some extra overhead). It also is subject to a system wide
604limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no AIO
605requests are left, this backend will be skipped during initialisation, and
606will switch to epoll when the loop is active.
607
608Most problematic in practice, however, is that not all file descriptors
609work with it. For example, in Linux 5.1, TCP sockets, pipes, event fds,
610files, F</dev/null> and many others are supported, but ttys do not work
611properly (a known bug that the kernel developers don't care about, see
612L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
613(yet?) a generic event polling interface.
614
615Overall, it seems the Linux developers just don't want it to have a
616generic event handling mechanism other than C<select> or C<poll>.
617
618To work around all these problem, the current version of libev uses its
619epoll backend as a fallback for file descriptor types that do not work. Or
620falls back completely to epoll if the kernel acts up.
621
622This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
623C<EVBACKEND_POLL>.
624
552=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 625=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
553 626
554Kqueue deserves special mention, as at the time of this writing, it 627Kqueue deserves special mention, as at the time this backend was
555was broken on all BSDs except NetBSD (usually it doesn't work reliably 628implemented, it was broken on all BSDs except NetBSD (usually it doesn't
556with anything but sockets and pipes, except on Darwin, where of course 629work reliably with anything but sockets and pipes, except on Darwin,
557it's completely useless). Unlike epoll, however, whose brokenness 630where of course it's completely useless). Unlike epoll, however, whose
558is by design, these kqueue bugs can (and eventually will) be fixed 631brokenness is by design, these kqueue bugs can be (and mostly have been)
559without API changes to existing programs. For this reason it's not being 632fixed without API changes to existing programs. For this reason it's not
560"auto-detected" unless you explicitly specify it in the flags (i.e. using 633being "auto-detected" on all platforms unless you explicitly specify it
561C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) 634in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a
562system like NetBSD. 635known-to-be-good (-enough) system like NetBSD.
563 636
564You still can embed kqueue into a normal poll or select backend and use it 637You still can embed kqueue into a normal poll or select backend and use it
565only for sockets (after having made sure that sockets work with kqueue on 638only for sockets (after having made sure that sockets work with kqueue on
566the target platform). See C<ev_embed> watchers for more info. 639the target platform). See C<ev_embed> watchers for more info.
567 640
568It scales in the same way as the epoll backend, but the interface to the 641It scales in the same way as the epoll backend, but the interface to the
569kernel is more efficient (which says nothing about its actual speed, of 642kernel is more efficient (which says nothing about its actual speed, of
570course). While stopping, setting and starting an I/O watcher does never 643course). While stopping, setting and starting an I/O watcher does never
571cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to 644cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
572two event changes per incident. Support for C<fork ()> is very bad (but 645two event changes per incident. Support for C<fork ()> is very bad (you
573sane, unlike epoll) and it drops fds silently in similarly hard-to-detect 646might have to leak fds on fork, but it's more sane than epoll) and it
574cases 647drops fds silently in similarly hard-to-detect cases.
575 648
576This backend usually performs well under most conditions. 649This backend usually performs well under most conditions.
577 650
578While nominally embeddable in other event loops, this doesn't work 651While nominally embeddable in other event loops, this doesn't work
579everywhere, so you might need to test for this. And since it is broken 652everywhere, so you might need to test for this. And since it is broken
653Example: Use whatever libev has to offer, but make sure that kqueue is 726Example: Use whatever libev has to offer, but make sure that kqueue is
654used if available. 727used if available.
655 728
656 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 729 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
657 730
731Example: Similarly, on linux, you mgiht want to take advantage of the
732linux aio backend if possible, but fall back to something else if that
733isn't available.
734
735 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
736
658=item ev_loop_destroy (loop) 737=item ev_loop_destroy (loop)
659 738
660Destroys an event loop object (frees all memory and kernel state 739Destroys an event loop object (frees all memory and kernel state
661etc.). None of the active event watchers will be stopped in the normal 740etc.). None of the active event watchers will be stopped in the normal
662sense, so e.g. C<ev_is_active> might still return true. It is your 741sense, so e.g. C<ev_is_active> might still return true. It is your
678If you need dynamically allocated loops it is better to use C<ev_loop_new> 757If you need dynamically allocated loops it is better to use C<ev_loop_new>
679and C<ev_loop_destroy>. 758and C<ev_loop_destroy>.
680 759
681=item ev_loop_fork (loop) 760=item ev_loop_fork (loop)
682 761
683This function sets a flag that causes subsequent C<ev_run> iterations to 762This function sets a flag that causes subsequent C<ev_run> iterations
684reinitialise the kernel state for backends that have one. Despite the 763to reinitialise the kernel state for backends that have one. Despite
685name, you can call it anytime, but it makes most sense after forking, in 764the name, you can call it anytime you are allowed to start or stop
686the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the 765watchers (except inside an C<ev_prepare> callback), but it makes most
766sense after forking, in the child process. You I<must> call it (or use
687child before resuming or calling C<ev_run>. 767C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
688 768
769In addition, if you want to reuse a loop (via this function or
770C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>.
771
689Again, you I<have> to call it on I<any> loop that you want to re-use after 772Again, you I<have> to call it on I<any> loop that you want to re-use after
690a fork, I<even if you do not plan to use the loop in the parent>. This is 773a fork, I<even if you do not plan to use the loop in the parent>. This is
691because some kernel interfaces *cough* I<kqueue> *cough* do funny things 774because some kernel interfaces *cough* I<kqueue> *cough* do funny things
692during fork. 775during fork.
693 776
694On the other hand, you only need to call this function in the child 777On the other hand, you only need to call this function in the child
764 847
765This function is rarely useful, but when some event callback runs for a 848This function is rarely useful, but when some event callback runs for a
766very long time without entering the event loop, updating libev's idea of 849very long time without entering the event loop, updating libev's idea of
767the current time is a good idea. 850the current time is a good idea.
768 851
769See also L<The special problem of time updates> in the C<ev_timer> section. 852See also L</The special problem of time updates> in the C<ev_timer> section.
770 853
771=item ev_suspend (loop) 854=item ev_suspend (loop)
772 855
773=item ev_resume (loop) 856=item ev_resume (loop)
774 857
792without a previous call to C<ev_suspend>. 875without a previous call to C<ev_suspend>.
793 876
794Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the 877Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
795event loop time (see C<ev_now_update>). 878event loop time (see C<ev_now_update>).
796 879
797=item ev_run (loop, int flags) 880=item bool ev_run (loop, int flags)
798 881
799Finally, this is it, the event handler. This function usually is called 882Finally, this is it, the event handler. This function usually is called
800after you have initialised all your watchers and you want to start 883after you have initialised all your watchers and you want to start
801handling events. It will ask the operating system for any new events, call 884handling events. It will ask the operating system for any new events, call
802the watcher callbacks, an then repeat the whole process indefinitely: This 885the watcher callbacks, and then repeat the whole process indefinitely: This
803is why event loops are called I<loops>. 886is why event loops are called I<loops>.
804 887
805If the flags argument is specified as C<0>, it will keep handling events 888If the flags argument is specified as C<0>, it will keep handling events
806until either no event watchers are active anymore or C<ev_break> was 889until either no event watchers are active anymore or C<ev_break> was
807called. 890called.
891
892The return value is false if there are no more active watchers (which
893usually means "all jobs done" or "deadlock"), and true in all other cases
894(which usually means " you should call C<ev_run> again").
808 895
809Please note that an explicit C<ev_break> is usually better than 896Please note that an explicit C<ev_break> is usually better than
810relying on all watchers to be stopped when deciding when a program has 897relying on all watchers to be stopped when deciding when a program has
811finished (especially in interactive programs), but having a program 898finished (especially in interactive programs), but having a program
812that automatically loops as long as it has to and no longer by virtue 899that automatically loops as long as it has to and no longer by virtue
813of relying on its watchers stopping correctly, that is truly a thing of 900of relying on its watchers stopping correctly, that is truly a thing of
814beauty. 901beauty.
815 902
816This function is also I<mostly> exception-safe - you can break out of 903This function is I<mostly> exception-safe - you can break out of a
817a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++ 904C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
818exception and so on. This does not decrement the C<ev_depth> value, nor 905exception and so on. This does not decrement the C<ev_depth> value, nor
819will it clear any outstanding C<EVBREAK_ONE> breaks. 906will it clear any outstanding C<EVBREAK_ONE> breaks.
820 907
821A flags value of C<EVRUN_NOWAIT> will look for new events, will handle 908A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
822those events and any already outstanding ones, but will not wait and 909those events and any already outstanding ones, but will not wait and
1012invoke the actual watchers inside another context (another thread etc.). 1099invoke the actual watchers inside another context (another thread etc.).
1013 1100
1014If you want to reset the callback, use C<ev_invoke_pending> as new 1101If you want to reset the callback, use C<ev_invoke_pending> as new
1015callback. 1102callback.
1016 1103
1017=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) 1104=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
1018 1105
1019Sometimes you want to share the same loop between multiple threads. This 1106Sometimes you want to share the same loop between multiple threads. This
1020can be done relatively simply by putting mutex_lock/unlock calls around 1107can be done relatively simply by putting mutex_lock/unlock calls around
1021each call to a libev function. 1108each call to a libev function.
1022 1109
1170 1257
1171=item C<EV_PREPARE> 1258=item C<EV_PREPARE>
1172 1259
1173=item C<EV_CHECK> 1260=item C<EV_CHECK>
1174 1261
1175All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts 1262All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1176to gather new events, and all C<ev_check> watchers are invoked just after 1263gather new events, and all C<ev_check> watchers are queued (not invoked)
1177C<ev_run> has gathered them, but before it invokes any callbacks for any 1264just after C<ev_run> has gathered them, but before it queues any callbacks
1265for any received events. That means C<ev_prepare> watchers are the last
1266watchers invoked before the event loop sleeps or polls for new events, and
1267C<ev_check> watchers will be invoked before any other watchers of the same
1268or lower priority within an event loop iteration.
1269
1178received events. Callbacks of both watcher types can start and stop as 1270Callbacks of both watcher types can start and stop as many watchers as
1179many watchers as they want, and all of them will be taken into account 1271they want, and all of them will be taken into account (for example, a
1180(for example, a C<ev_prepare> watcher might start an idle watcher to keep 1272C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1181C<ev_run> from blocking). 1273blocking).
1182 1274
1183=item C<EV_EMBED> 1275=item C<EV_EMBED>
1184 1276
1185The embedded event loop specified in the C<ev_embed> watcher needs attention. 1277The embedded event loop specified in the C<ev_embed> watcher needs attention.
1186 1278
1309 1401
1310=item callback ev_cb (ev_TYPE *watcher) 1402=item callback ev_cb (ev_TYPE *watcher)
1311 1403
1312Returns the callback currently set on the watcher. 1404Returns the callback currently set on the watcher.
1313 1405
1314=item ev_cb_set (ev_TYPE *watcher, callback) 1406=item ev_set_cb (ev_TYPE *watcher, callback)
1315 1407
1316Change the callback. You can change the callback at virtually any time 1408Change the callback. You can change the callback at virtually any time
1317(modulo threads). 1409(modulo threads).
1318 1410
1319=item ev_set_priority (ev_TYPE *watcher, int priority) 1411=item ev_set_priority (ev_TYPE *watcher, int priority)
1337or might not have been clamped to the valid range. 1429or might not have been clamped to the valid range.
1338 1430
1339The default priority used by watchers when no priority has been set is 1431The default priority used by watchers when no priority has been set is
1340always C<0>, which is supposed to not be too high and not be too low :). 1432always C<0>, which is supposed to not be too high and not be too low :).
1341 1433
1342See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1434See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1343priorities. 1435priorities.
1344 1436
1345=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1437=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1346 1438
1347Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1439Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1372See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related 1464See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1373functions that do not need a watcher. 1465functions that do not need a watcher.
1374 1466
1375=back 1467=back
1376 1468
1377See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1469See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1378OWN COMPOSITE WATCHERS> idioms. 1470OWN COMPOSITE WATCHERS> idioms.
1379 1471
1380=head2 WATCHER STATES 1472=head2 WATCHER STATES
1381 1473
1382There are various watcher states mentioned throughout this manual - 1474There are various watcher states mentioned throughout this manual -
1384transition between them will be described in more detail - and while these 1476transition between them will be described in more detail - and while these
1385rules might look complicated, they usually do "the right thing". 1477rules might look complicated, they usually do "the right thing".
1386 1478
1387=over 4 1479=over 4
1388 1480
1389=item initialiased 1481=item initialised
1390 1482
1391Before a watcher can be registered with the event loop it has to be 1483Before a watcher can be registered with the event loop it has to be
1392initialised. This can be done with a call to C<ev_TYPE_init>, or calls to 1484initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1393C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. 1485C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1394 1486
1592 1684
1593But really, best use non-blocking mode. 1685But really, best use non-blocking mode.
1594 1686
1595=head3 The special problem of disappearing file descriptors 1687=head3 The special problem of disappearing file descriptors
1596 1688
1597Some backends (e.g. kqueue, epoll) need to be told about closing a file 1689Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1598descriptor (either due to calling C<close> explicitly or any other means, 1690a file descriptor (either due to calling C<close> explicitly or any other
1599such as C<dup2>). The reason is that you register interest in some file 1691means, such as C<dup2>). The reason is that you register interest in some
1600descriptor, but when it goes away, the operating system will silently drop 1692file descriptor, but when it goes away, the operating system will silently
1601this interest. If another file descriptor with the same number then is 1693drop this interest. If another file descriptor with the same number then
1602registered with libev, there is no efficient way to see that this is, in 1694is registered with libev, there is no efficient way to see that this is,
1603fact, a different file descriptor. 1695in fact, a different file descriptor.
1604 1696
1605To avoid having to explicitly tell libev about such cases, libev follows 1697To avoid having to explicitly tell libev about such cases, libev follows
1606the following policy: Each time C<ev_io_set> is being called, libev 1698the following policy: Each time C<ev_io_set> is being called, libev
1607will assume that this is potentially a new file descriptor, otherwise 1699will assume that this is potentially a new file descriptor, otherwise
1608it is assumed that the file descriptor stays the same. That means that 1700it is assumed that the file descriptor stays the same. That means that
1657when you rarely read from a file instead of from a socket, and want to 1749when you rarely read from a file instead of from a socket, and want to
1658reuse the same code path. 1750reuse the same code path.
1659 1751
1660=head3 The special problem of fork 1752=head3 The special problem of fork
1661 1753
1662Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1754Some backends (epoll, kqueue, probably linuxaio) do not support C<fork ()>
1663useless behaviour. Libev fully supports fork, but needs to be told about 1755at all or exhibit useless behaviour. Libev fully supports fork, but needs
1664it in the child if you want to continue to use it in the child. 1756to be told about it in the child if you want to continue to use it in the
1757child.
1665 1758
1666To support fork in your child processes, you have to call C<ev_loop_fork 1759To support fork in your child processes, you have to call C<ev_loop_fork
1667()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to 1760()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1668C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1761C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1669 1762
1870 callback (EV_P_ ev_timer *w, int revents) 1963 callback (EV_P_ ev_timer *w, int revents)
1871 { 1964 {
1872 // calculate when the timeout would happen 1965 // calculate when the timeout would happen
1873 ev_tstamp after = last_activity - ev_now (EV_A) + timeout; 1966 ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1874 1967
1875 // if negative, it means we the timeout already occured 1968 // if negative, it means we the timeout already occurred
1876 if (after < 0.) 1969 if (after < 0.)
1877 { 1970 {
1878 // timeout occurred, take action 1971 // timeout occurred, take action
1879 } 1972 }
1880 else 1973 else
1898 1991
1899Otherwise, we now the earliest time at which the timeout would trigger, 1992Otherwise, we now the earliest time at which the timeout would trigger,
1900and simply start the timer with this timeout value. 1993and simply start the timer with this timeout value.
1901 1994
1902In other words, each time the callback is invoked it will check whether 1995In other words, each time the callback is invoked it will check whether
1903the timeout cocured. If not, it will simply reschedule itself to check 1996the timeout occurred. If not, it will simply reschedule itself to check
1904again at the earliest time it could time out. Rinse. Repeat. 1997again at the earliest time it could time out. Rinse. Repeat.
1905 1998
1906This scheme causes more callback invocations (about one every 60 seconds 1999This scheme causes more callback invocations (about one every 60 seconds
1907minus half the average time between activity), but virtually no calls to 2000minus half the average time between activity), but virtually no calls to
1908libev to change the timeout. 2001libev to change the timeout.
1922 if (activity detected) 2015 if (activity detected)
1923 last_activity = ev_now (EV_A); 2016 last_activity = ev_now (EV_A);
1924 2017
1925When your timeout value changes, then the timeout can be changed by simply 2018When your timeout value changes, then the timeout can be changed by simply
1926providing a new value, stopping the timer and calling the callback, which 2019providing a new value, stopping the timer and calling the callback, which
1927will agaion do the right thing (for example, time out immediately :). 2020will again do the right thing (for example, time out immediately :).
1928 2021
1929 timeout = new_value; 2022 timeout = new_value;
1930 ev_timer_stop (EV_A_ &timer); 2023 ev_timer_stop (EV_A_ &timer);
1931 callback (EV_A_ &timer, 0); 2024 callback (EV_A_ &timer, 0);
1932 2025
2015 2108
2016The relative timeouts are calculated relative to the C<ev_now ()> 2109The relative timeouts are calculated relative to the C<ev_now ()>
2017time. This is usually the right thing as this timestamp refers to the time 2110time. This is usually the right thing as this timestamp refers to the time
2018of the event triggering whatever timeout you are modifying/starting. If 2111of the event triggering whatever timeout you are modifying/starting. If
2019you suspect event processing to be delayed and you I<need> to base the 2112you suspect event processing to be delayed and you I<need> to base the
2020timeout on the current time, use something like this to adjust for this: 2113timeout on the current time, use something like the following to adjust
2114for it:
2021 2115
2022 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2116 ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
2023 2117
2024If the event loop is suspended for a long time, you can also force an 2118If the event loop is suspended for a long time, you can also force an
2025update of the time returned by C<ev_now ()> by calling C<ev_now_update 2119update of the time returned by C<ev_now ()> by calling C<ev_now_update
2026()>. 2120()>, although that will push the event time of all outstanding events
2121further into the future.
2027 2122
2028=head3 The special problem of unsynchronised clocks 2123=head3 The special problem of unsynchronised clocks
2029 2124
2030Modern systems have a variety of clocks - libev itself uses the normal 2125Modern systems have a variety of clocks - libev itself uses the normal
2031"wall clock" clock and, if available, the monotonic clock (to avoid time 2126"wall clock" clock and, if available, the monotonic clock (to avoid time
2094 2189
2095=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 2190=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
2096 2191
2097=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 2192=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
2098 2193
2099Configure the timer to trigger after C<after> seconds. If C<repeat> 2194Configure the timer to trigger after C<after> seconds (fractional and
2100is C<0.>, then it will automatically be stopped once the timeout is 2195negative values are supported). If C<repeat> is C<0.>, then it will
2101reached. If it is positive, then the timer will automatically be 2196automatically be stopped once the timeout is reached. If it is positive,
2102configured to trigger again C<repeat> seconds later, again, and again, 2197then the timer will automatically be configured to trigger again C<repeat>
2103until stopped manually. 2198seconds later, again, and again, until stopped manually.
2104 2199
2105The timer itself will do a best-effort at avoiding drift, that is, if 2200The timer itself will do a best-effort at avoiding drift, that is, if
2106you configure a timer to trigger every 10 seconds, then it will normally 2201you configure a timer to trigger every 10 seconds, then it will normally
2107trigger at exactly 10 second intervals. If, however, your program cannot 2202trigger at exactly 10 second intervals. If, however, your program cannot
2108keep up with the timer (because it takes longer than those 10 seconds to 2203keep up with the timer (because it takes longer than those 10 seconds to
2127=item If the timer is repeating, make the C<repeat> value the new timeout 2222=item If the timer is repeating, make the C<repeat> value the new timeout
2128and start the timer, if necessary. 2223and start the timer, if necessary.
2129 2224
2130=back 2225=back
2131 2226
2132This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2227This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2133usage example. 2228usage example.
2134 2229
2135=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2230=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2136 2231
2137Returns the remaining time until a timer fires. If the timer is active, 2232Returns the remaining time until a timer fires. If the timer is active,
2190Periodic watchers are also timers of a kind, but they are very versatile 2285Periodic watchers are also timers of a kind, but they are very versatile
2191(and unfortunately a bit complex). 2286(and unfortunately a bit complex).
2192 2287
2193Unlike C<ev_timer>, periodic watchers are not based on real time (or 2288Unlike C<ev_timer>, periodic watchers are not based on real time (or
2194relative time, the physical time that passes) but on wall clock time 2289relative time, the physical time that passes) but on wall clock time
2195(absolute time, the thing you can read on your calender or clock). The 2290(absolute time, the thing you can read on your calendar or clock). The
2196difference is that wall clock time can run faster or slower than real 2291difference is that wall clock time can run faster or slower than real
2197time, and time jumps are not uncommon (e.g. when you adjust your 2292time, and time jumps are not uncommon (e.g. when you adjust your
2198wrist-watch). 2293wrist-watch).
2199 2294
2200You can tell a periodic watcher to trigger after some specific point 2295You can tell a periodic watcher to trigger after some specific point
2205C<ev_timer>, which would still trigger roughly 10 seconds after starting 2300C<ev_timer>, which would still trigger roughly 10 seconds after starting
2206it, as it uses a relative timeout). 2301it, as it uses a relative timeout).
2207 2302
2208C<ev_periodic> watchers can also be used to implement vastly more complex 2303C<ev_periodic> watchers can also be used to implement vastly more complex
2209timers, such as triggering an event on each "midnight, local time", or 2304timers, such as triggering an event on each "midnight, local time", or
2210other complicated rules. This cannot be done with C<ev_timer> watchers, as 2305other complicated rules. This cannot easily be done with C<ev_timer>
2211those cannot react to time jumps. 2306watchers, as those cannot react to time jumps.
2212 2307
2213As with timers, the callback is guaranteed to be invoked only when the 2308As with timers, the callback is guaranteed to be invoked only when the
2214point in time where it is supposed to trigger has passed. If multiple 2309point in time where it is supposed to trigger has passed. If multiple
2215timers become ready during the same loop iteration then the ones with 2310timers become ready during the same loop iteration then the ones with
2216earlier time-out values are invoked before ones with later time-out values 2311earlier time-out values are invoked before ones with later time-out values
2302 2397
2303NOTE: I<< This callback must always return a time that is higher than or 2398NOTE: I<< This callback must always return a time that is higher than or
2304equal to the passed C<now> value >>. 2399equal to the passed C<now> value >>.
2305 2400
2306This can be used to create very complex timers, such as a timer that 2401This can be used to create very complex timers, such as a timer that
2307triggers on "next midnight, local time". To do this, you would calculate the 2402triggers on "next midnight, local time". To do this, you would calculate
2308next midnight after C<now> and return the timestamp value for this. How 2403the next midnight after C<now> and return the timestamp value for
2309you do this is, again, up to you (but it is not trivial, which is the main 2404this. Here is a (completely untested, no error checking) example on how to
2310reason I omitted it as an example). 2405do this:
2406
2407 #include <time.h>
2408
2409 static ev_tstamp
2410 my_rescheduler (ev_periodic *w, ev_tstamp now)
2411 {
2412 time_t tnow = (time_t)now;
2413 struct tm tm;
2414 localtime_r (&tnow, &tm);
2415
2416 tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2417 ++tm.tm_mday; // midnight next day
2418
2419 return mktime (&tm);
2420 }
2421
2422Note: this code might run into trouble on days that have more then two
2423midnights (beginning and end).
2311 2424
2312=back 2425=back
2313 2426
2314=item ev_periodic_again (loop, ev_periodic *) 2427=item ev_periodic_again (loop, ev_periodic *)
2315 2428
2380 2493
2381 ev_periodic hourly_tick; 2494 ev_periodic hourly_tick;
2382 ev_periodic_init (&hourly_tick, clock_cb, 2495 ev_periodic_init (&hourly_tick, clock_cb,
2383 fmod (ev_now (loop), 3600.), 3600., 0); 2496 fmod (ev_now (loop), 3600.), 3600., 0);
2384 ev_periodic_start (loop, &hourly_tick); 2497 ev_periodic_start (loop, &hourly_tick);
2385 2498
2386 2499
2387=head2 C<ev_signal> - signal me when a signal gets signalled! 2500=head2 C<ev_signal> - signal me when a signal gets signalled!
2388 2501
2389Signal watchers will trigger an event when the process receives a specific 2502Signal watchers will trigger an event when the process receives a specific
2390signal one or more times. Even though signals are very asynchronous, libev 2503signal one or more times. Even though signals are very asynchronous, libev
2400only within the same loop, i.e. you can watch for C<SIGINT> in your 2513only within the same loop, i.e. you can watch for C<SIGINT> in your
2401default loop and for C<SIGIO> in another loop, but you cannot watch for 2514default loop and for C<SIGIO> in another loop, but you cannot watch for
2402C<SIGINT> in both the default loop and another loop at the same time. At 2515C<SIGINT> in both the default loop and another loop at the same time. At
2403the moment, C<SIGCHLD> is permanently tied to the default loop. 2516the moment, C<SIGCHLD> is permanently tied to the default loop.
2404 2517
2405When the first watcher gets started will libev actually register something 2518Only after the first watcher for a signal is started will libev actually
2406with the kernel (thus it coexists with your own signal handlers as long as 2519register something with the kernel. It thus coexists with your own signal
2407you don't register any with libev for the same signal). 2520handlers as long as you don't register any with libev for the same signal.
2408 2521
2409If possible and supported, libev will install its handlers with 2522If possible and supported, libev will install its handlers with
2410C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2523C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2411not be unduly interrupted. If you have a problem with system calls getting 2524not be unduly interrupted. If you have a problem with system calls getting
2412interrupted by signals you can block all signals in an C<ev_check> watcher 2525interrupted by signals you can block all signals in an C<ev_check> watcher
2597 2710
2598=head2 C<ev_stat> - did the file attributes just change? 2711=head2 C<ev_stat> - did the file attributes just change?
2599 2712
2600This watches a file system path for attribute changes. That is, it calls 2713This watches a file system path for attribute changes. That is, it calls
2601C<stat> on that path in regular intervals (or when the OS says it changed) 2714C<stat> on that path in regular intervals (or when the OS says it changed)
2602and sees if it changed compared to the last time, invoking the callback if 2715and sees if it changed compared to the last time, invoking the callback
2603it did. 2716if it did. Starting the watcher C<stat>'s the file, so only changes that
2717happen after the watcher has been started will be reported.
2604 2718
2605The path does not need to exist: changing from "path exists" to "path does 2719The path does not need to exist: changing from "path exists" to "path does
2606not exist" is a status change like any other. The condition "path does not 2720not exist" is a status change like any other. The condition "path does not
2607exist" (or more correctly "path cannot be stat'ed") is signified by the 2721exist" (or more correctly "path cannot be stat'ed") is signified by the
2608C<st_nlink> field being zero (which is otherwise always forced to be at 2722C<st_nlink> field being zero (which is otherwise always forced to be at
2838Apart from keeping your process non-blocking (which is a useful 2952Apart from keeping your process non-blocking (which is a useful
2839effect on its own sometimes), idle watchers are a good place to do 2953effect on its own sometimes), idle watchers are a good place to do
2840"pseudo-background processing", or delay processing stuff to after the 2954"pseudo-background processing", or delay processing stuff to after the
2841event loop has handled all outstanding events. 2955event loop has handled all outstanding events.
2842 2956
2957=head3 Abusing an C<ev_idle> watcher for its side-effect
2958
2959As long as there is at least one active idle watcher, libev will never
2960sleep unnecessarily. Or in other words, it will loop as fast as possible.
2961For this to work, the idle watcher doesn't need to be invoked at all - the
2962lowest priority will do.
2963
2964This mode of operation can be useful together with an C<ev_check> watcher,
2965to do something on each event loop iteration - for example to balance load
2966between different connections.
2967
2968See L</Abusing an ev_check watcher for its side-effect> for a longer
2969example.
2970
2843=head3 Watcher-Specific Functions and Data Members 2971=head3 Watcher-Specific Functions and Data Members
2844 2972
2845=over 4 2973=over 4
2846 2974
2847=item ev_idle_init (ev_idle *, callback) 2975=item ev_idle_init (ev_idle *, callback)
2858callback, free it. Also, use no error checking, as usual. 2986callback, free it. Also, use no error checking, as usual.
2859 2987
2860 static void 2988 static void
2861 idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 2989 idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2862 { 2990 {
2991 // stop the watcher
2992 ev_idle_stop (loop, w);
2993
2994 // now we can free it
2863 free (w); 2995 free (w);
2996
2864 // now do something you wanted to do when the program has 2997 // now do something you wanted to do when the program has
2865 // no longer anything immediate to do. 2998 // no longer anything immediate to do.
2866 } 2999 }
2867 3000
2868 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3001 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2870 ev_idle_start (loop, idle_watcher); 3003 ev_idle_start (loop, idle_watcher);
2871 3004
2872 3005
2873=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 3006=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2874 3007
2875Prepare and check watchers are usually (but not always) used in pairs: 3008Prepare and check watchers are often (but not always) used in pairs:
2876prepare watchers get invoked before the process blocks and check watchers 3009prepare watchers get invoked before the process blocks and check watchers
2877afterwards. 3010afterwards.
2878 3011
2879You I<must not> call C<ev_run> or similar functions that enter 3012You I<must not> call C<ev_run> (or similar functions that enter the
2880the current event loop from either C<ev_prepare> or C<ev_check> 3013current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2881watchers. Other loops than the current one are fine, however. The 3014C<ev_check> watchers. Other loops than the current one are fine,
2882rationale behind this is that you do not need to check for recursion in 3015however. The rationale behind this is that you do not need to check
2883those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, 3016for recursion in those watchers, i.e. the sequence will always be
2884C<ev_check> so if you have one watcher of each kind they will always be 3017C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2885called in pairs bracketing the blocking call. 3018kind they will always be called in pairs bracketing the blocking call.
2886 3019
2887Their main purpose is to integrate other event mechanisms into libev and 3020Their main purpose is to integrate other event mechanisms into libev and
2888their use is somewhat advanced. They could be used, for example, to track 3021their use is somewhat advanced. They could be used, for example, to track
2889variable changes, implement your own watchers, integrate net-snmp or a 3022variable changes, implement your own watchers, integrate net-snmp or a
2890coroutine library and lots more. They are also occasionally useful if 3023coroutine library and lots more. They are also occasionally useful if
2908with priority higher than or equal to the event loop and one coroutine 3041with priority higher than or equal to the event loop and one coroutine
2909of lower priority, but only once, using idle watchers to keep the event 3042of lower priority, but only once, using idle watchers to keep the event
2910loop from blocking if lower-priority coroutines are active, thus mapping 3043loop from blocking if lower-priority coroutines are active, thus mapping
2911low-priority coroutines to idle/background tasks). 3044low-priority coroutines to idle/background tasks).
2912 3045
2913It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 3046When used for this purpose, it is recommended to give C<ev_check> watchers
2914priority, to ensure that they are being run before any other watchers 3047highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2915after the poll (this doesn't matter for C<ev_prepare> watchers). 3048any other watchers after the poll (this doesn't matter for C<ev_prepare>
3049watchers).
2916 3050
2917Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not 3051Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2918activate ("feed") events into libev. While libev fully supports this, they 3052activate ("feed") events into libev. While libev fully supports this, they
2919might get executed before other C<ev_check> watchers did their job. As 3053might get executed before other C<ev_check> watchers did their job. As
2920C<ev_check> watchers are often used to embed other (non-libev) event 3054C<ev_check> watchers are often used to embed other (non-libev) event
2921loops those other event loops might be in an unusable state until their 3055loops those other event loops might be in an unusable state until their
2922C<ev_check> watcher ran (always remind yourself to coexist peacefully with 3056C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2923others). 3057others).
3058
3059=head3 Abusing an C<ev_check> watcher for its side-effect
3060
3061C<ev_check> (and less often also C<ev_prepare>) watchers can also be
3062useful because they are called once per event loop iteration. For
3063example, if you want to handle a large number of connections fairly, you
3064normally only do a bit of work for each active connection, and if there
3065is more work to do, you wait for the next event loop iteration, so other
3066connections have a chance of making progress.
3067
3068Using an C<ev_check> watcher is almost enough: it will be called on the
3069next event loop iteration. However, that isn't as soon as possible -
3070without external events, your C<ev_check> watcher will not be invoked.
3071
3072This is where C<ev_idle> watchers come in handy - all you need is a
3073single global idle watcher that is active as long as you have one active
3074C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
3075will not sleep, and the C<ev_check> watcher makes sure a callback gets
3076invoked. Neither watcher alone can do that.
2924 3077
2925=head3 Watcher-Specific Functions and Data Members 3078=head3 Watcher-Specific Functions and Data Members
2926 3079
2927=over 4 3080=over 4
2928 3081
3129 3282
3130=over 4 3283=over 4
3131 3284
3132=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3285=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3133 3286
3134=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3287=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3135 3288
3136Configures the watcher to embed the given loop, which must be 3289Configures the watcher to embed the given loop, which must be
3137embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3290embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3138invoked automatically, otherwise it is the responsibility of the callback 3291invoked automatically, otherwise it is the responsibility of the callback
3139to invoke it (it will continue to be called until the sweep has been done, 3292to invoke it (it will continue to be called until the sweep has been done,
3160used). 3313used).
3161 3314
3162 struct ev_loop *loop_hi = ev_default_init (0); 3315 struct ev_loop *loop_hi = ev_default_init (0);
3163 struct ev_loop *loop_lo = 0; 3316 struct ev_loop *loop_lo = 0;
3164 ev_embed embed; 3317 ev_embed embed;
3165 3318
3166 // see if there is a chance of getting one that works 3319 // see if there is a chance of getting one that works
3167 // (remember that a flags value of 0 means autodetection) 3320 // (remember that a flags value of 0 means autodetection)
3168 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3321 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3169 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3322 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3170 : 0; 3323 : 0;
3184C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3337C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3185 3338
3186 struct ev_loop *loop = ev_default_init (0); 3339 struct ev_loop *loop = ev_default_init (0);
3187 struct ev_loop *loop_socket = 0; 3340 struct ev_loop *loop_socket = 0;
3188 ev_embed embed; 3341 ev_embed embed;
3189 3342
3190 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3343 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3191 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3344 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3192 { 3345 {
3193 ev_embed_init (&embed, 0, loop_socket); 3346 ev_embed_init (&embed, 0, loop_socket);
3194 ev_embed_start (loop, &embed); 3347 ev_embed_start (loop, &embed);
3202 3355
3203=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3356=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3204 3357
3205Fork watchers are called when a C<fork ()> was detected (usually because 3358Fork watchers are called when a C<fork ()> was detected (usually because
3206whoever is a good citizen cared to tell libev about it by calling 3359whoever is a good citizen cared to tell libev about it by calling
3207C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the 3360C<ev_loop_fork>). The invocation is done before the event loop blocks next
3208event loop blocks next and before C<ev_check> watchers are being called, 3361and before C<ev_check> watchers are being called, and only in the child
3209and only in the child after the fork. If whoever good citizen calling 3362after the fork. If whoever good citizen calling C<ev_default_fork> cheats
3210C<ev_default_fork> cheats and calls it in the wrong process, the fork 3363and calls it in the wrong process, the fork handlers will be invoked, too,
3211handlers will be invoked, too, of course. 3364of course.
3212 3365
3213=head3 The special problem of life after fork - how is it possible? 3366=head3 The special problem of life after fork - how is it possible?
3214 3367
3215Most uses of C<fork()> consist of forking, then some simple calls to set 3368Most uses of C<fork ()> consist of forking, then some simple calls to set
3216up/change the process environment, followed by a call to C<exec()>. This 3369up/change the process environment, followed by a call to C<exec()>. This
3217sequence should be handled by libev without any problems. 3370sequence should be handled by libev without any problems.
3218 3371
3219This changes when the application actually wants to do event handling 3372This changes when the application actually wants to do event handling
3220in the child, or both parent in child, in effect "continuing" after the 3373in the child, or both parent in child, in effect "continuing" after the
3309it by calling C<ev_async_send>, which is thread- and signal safe. 3462it by calling C<ev_async_send>, which is thread- and signal safe.
3310 3463
3311This functionality is very similar to C<ev_signal> watchers, as signals, 3464This functionality is very similar to C<ev_signal> watchers, as signals,
3312too, are asynchronous in nature, and signals, too, will be compressed 3465too, are asynchronous in nature, and signals, too, will be compressed
3313(i.e. the number of callback invocations may be less than the number of 3466(i.e. the number of callback invocations may be less than the number of
3314C<ev_async_sent> calls). In fact, you could use signal watchers as a kind 3467C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3315of "global async watchers" by using a watcher on an otherwise unused 3468of "global async watchers" by using a watcher on an otherwise unused
3316signal, and C<ev_feed_signal> to signal this watcher from another thread, 3469signal, and C<ev_feed_signal> to signal this watcher from another thread,
3317even without knowing which loop owns the signal. 3470even without knowing which loop owns the signal.
3318 3471
3319=head3 Queueing 3472=head3 Queueing
3458 3611
3459There are some other functions of possible interest. Described. Here. Now. 3612There are some other functions of possible interest. Described. Here. Now.
3460 3613
3461=over 4 3614=over 4
3462 3615
3463=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 3616=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3464 3617
3465This function combines a simple timer and an I/O watcher, calls your 3618This function combines a simple timer and an I/O watcher, calls your
3466callback on whichever event happens first and automatically stops both 3619callback on whichever event happens first and automatically stops both
3467watchers. This is useful if you want to wait for a single event on an fd 3620watchers. This is useful if you want to wait for a single event on an fd
3468or timeout without having to allocate/configure/start/stop/free one or 3621or timeout without having to allocate/configure/start/stop/free one or
3610already been invoked. 3763already been invoked.
3611 3764
3612A common way around all these issues is to make sure that 3765A common way around all these issues is to make sure that
3613C<start_new_request> I<always> returns before the callback is invoked. If 3766C<start_new_request> I<always> returns before the callback is invoked. If
3614C<start_new_request> immediately knows the result, it can artificially 3767C<start_new_request> immediately knows the result, it can artificially
3615delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher 3768delay invoking the callback by using a C<prepare> or C<idle> watcher for
3616for example, or more sneakily, by reusing an existing (stopped) watcher 3769example, or more sneakily, by reusing an existing (stopped) watcher and
3617and pushing it into the pending queue: 3770pushing it into the pending queue:
3618 3771
3619 ev_set_cb (watcher, callback); 3772 ev_set_cb (watcher, callback);
3620 ev_feed_event (EV_A_ watcher, 0); 3773 ev_feed_event (EV_A_ watcher, 0);
3621 3774
3622This way, C<start_new_request> can safely return before the callback is 3775This way, C<start_new_request> can safely return before the callback is
3630 3783
3631This brings the problem of exiting - a callback might want to finish the 3784This brings the problem of exiting - a callback might want to finish the
3632main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but 3785main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3633a modal "Are you sure?" dialog is still waiting), or just the nested one 3786a modal "Are you sure?" dialog is still waiting), or just the nested one
3634and not the main one (e.g. user clocked "Ok" in a modal dialog), or some 3787and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3635other combination: In these cases, C<ev_break> will not work alone. 3788other combination: In these cases, a simple C<ev_break> will not work.
3636 3789
3637The solution is to maintain "break this loop" variable for each C<ev_run> 3790The solution is to maintain "break this loop" variable for each C<ev_run>
3638invocation, and use a loop around C<ev_run> until the condition is 3791invocation, and use a loop around C<ev_run> until the condition is
3639triggered, using C<EVRUN_ONCE>: 3792triggered, using C<EVRUN_ONCE>:
3640 3793
3826called): 3979called):
3827 3980
3828 void 3981 void
3829 wait_for_event (ev_watcher *w) 3982 wait_for_event (ev_watcher *w)
3830 { 3983 {
3831 ev_cb_set (w) = current_coro; 3984 ev_set_cb (w, current_coro);
3832 switch_to (libev_coro); 3985 switch_to (libev_coro);
3833 } 3986 }
3834 3987
3835That basically suspends the coroutine inside C<wait_for_event> and 3988That basically suspends the coroutine inside C<wait_for_event> and
3836continues the libev coroutine, which, when appropriate, switches back to 3989continues the libev coroutine, which, when appropriate, switches back to
3839You can do similar tricks if you have, say, threads with an event queue - 3992You can do similar tricks if you have, say, threads with an event queue -
3840instead of storing a coroutine, you store the queue object and instead of 3993instead of storing a coroutine, you store the queue object and instead of
3841switching to a coroutine, you push the watcher onto the queue and notify 3994switching to a coroutine, you push the watcher onto the queue and notify
3842any waiters. 3995any waiters.
3843 3996
3844To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 3997To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3845files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 3998files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3846 3999
3847 // my_ev.h 4000 // my_ev.h
3848 #define EV_CB_DECLARE(type) struct my_coro *cb; 4001 #define EV_CB_DECLARE(type) struct my_coro *cb;
3849 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 4002 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3850 #include "../libev/ev.h" 4003 #include "../libev/ev.h"
3851 4004
3852 // my_ev.c 4005 // my_ev.c
3853 #define EV_H "my_ev.h" 4006 #define EV_H "my_ev.h"
3854 #include "../libev/ev.c" 4007 #include "../libev/ev.c"
3893 4046
3894=back 4047=back
3895 4048
3896=head1 C++ SUPPORT 4049=head1 C++ SUPPORT
3897 4050
4051=head2 C API
4052
4053The normal C API should work fine when used from C++: both ev.h and the
4054libev sources can be compiled as C++. Therefore, code that uses the C API
4055will work fine.
4056
4057Proper exception specifications might have to be added to callbacks passed
4058to libev: exceptions may be thrown only from watcher callbacks, all other
4059callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4060callbacks) must not throw exceptions, and might need a C<noexcept>
4061specification. If you have code that needs to be compiled as both C and
4062C++ you can use the C<EV_NOEXCEPT> macro for this:
4063
4064 static void
4065 fatal_error (const char *msg) EV_NOEXCEPT
4066 {
4067 perror (msg);
4068 abort ();
4069 }
4070
4071 ...
4072 ev_set_syserr_cb (fatal_error);
4073
4074The only API functions that can currently throw exceptions are C<ev_run>,
4075C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
4076because it runs cleanup watchers).
4077
4078Throwing exceptions in watcher callbacks is only supported if libev itself
4079is compiled with a C++ compiler or your C and C++ environments allow
4080throwing exceptions through C libraries (most do).
4081
4082=head2 C++ API
4083
3898Libev comes with some simplistic wrapper classes for C++ that mainly allow 4084Libev comes with some simplistic wrapper classes for C++ that mainly allow
3899you to use some convenience methods to start/stop watchers and also change 4085you to use some convenience methods to start/stop watchers and also change
3900the callback model to a model using method callbacks on objects. 4086the callback model to a model using method callbacks on objects.
3901 4087
3902To use it, 4088To use it,
3903 4089
3904 #include <ev++.h> 4090 #include <ev++.h>
3905 4091
3906This automatically includes F<ev.h> and puts all of its definitions (many 4092This automatically includes F<ev.h> and puts all of its definitions (many
3907of them macros) into the global namespace. All C++ specific things are 4093of them macros) into the global namespace. All C++ specific things are
3908put into the C<ev> namespace. It should support all the same embedding 4094put into the C<ev> namespace. It should support all the same embedding
4011 void operator() (ev::io &w, int revents) 4197 void operator() (ev::io &w, int revents)
4012 { 4198 {
4013 ... 4199 ...
4014 } 4200 }
4015 } 4201 }
4016 4202
4017 myfunctor f; 4203 myfunctor f;
4018 4204
4019 ev::io w; 4205 ev::io w;
4020 w.set (&f); 4206 w.set (&f);
4021 4207
4039Associates a different C<struct ev_loop> with this watcher. You can only 4225Associates a different C<struct ev_loop> with this watcher. You can only
4040do this when the watcher is inactive (and not pending either). 4226do this when the watcher is inactive (and not pending either).
4041 4227
4042=item w->set ([arguments]) 4228=item w->set ([arguments])
4043 4229
4044Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4230Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
4045method or a suitable start method must be called at least once. Unlike the 4231with the same arguments. Either this method or a suitable start method
4046C counterpart, an active watcher gets automatically stopped and restarted 4232must be called at least once. Unlike the C counterpart, an active watcher
4047when reconfiguring it with this method. 4233gets automatically stopped and restarted when reconfiguring it with this
4234method.
4235
4236For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4237clashing with the C<set (loop)> method.
4048 4238
4049=item w->start () 4239=item w->start ()
4050 4240
4051Starts the watcher. Note that there is no C<loop> argument, as the 4241Starts the watcher. Note that there is no C<loop> argument, as the
4052constructor already stores the event loop. 4242constructor already stores the event loop.
4156 4346
4157Brian Maher has written a partial interface to libev for lua (at the 4347Brian Maher has written a partial interface to libev for lua (at the
4158time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4348time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4159L<http://github.com/brimworks/lua-ev>. 4349L<http://github.com/brimworks/lua-ev>.
4160 4350
4351=item Javascript
4352
4353Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4354
4355=item Others
4356
4357There are others, and I stopped counting.
4358
4161=back 4359=back
4162 4360
4163 4361
4164=head1 MACRO MAGIC 4362=head1 MACRO MAGIC
4165 4363
4282 ev_vars.h 4480 ev_vars.h
4283 ev_wrap.h 4481 ev_wrap.h
4284 4482
4285 ev_win32.c required on win32 platforms only 4483 ev_win32.c required on win32 platforms only
4286 4484
4287 ev_select.c only when select backend is enabled (which is enabled by default) 4485 ev_select.c only when select backend is enabled
4288 ev_poll.c only when poll backend is enabled (disabled by default) 4486 ev_poll.c only when poll backend is enabled
4289 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4487 ev_epoll.c only when the epoll backend is enabled
4488 ev_linuxaio.c only when the linux aio backend is enabled
4290 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4489 ev_kqueue.c only when the kqueue backend is enabled
4291 ev_port.c only when the solaris port backend is enabled (disabled by default) 4490 ev_port.c only when the solaris port backend is enabled
4292 4491
4293F<ev.c> includes the backend files directly when enabled, so you only need 4492F<ev.c> includes the backend files directly when enabled, so you only need
4294to compile this single file. 4493to compile this single file.
4295 4494
4296=head3 LIBEVENT COMPATIBILITY API 4495=head3 LIBEVENT COMPATIBILITY API
4464If programs implement their own fd to handle mapping on win32, then this 4663If programs implement their own fd to handle mapping on win32, then this
4465macro can be used to override the C<close> function, useful to unregister 4664macro can be used to override the C<close> function, useful to unregister
4466file descriptors again. Note that the replacement function has to close 4665file descriptors again. Note that the replacement function has to close
4467the underlying OS handle. 4666the underlying OS handle.
4468 4667
4668=item EV_USE_WSASOCKET
4669
4670If defined to be C<1>, libev will use C<WSASocket> to create its internal
4671communication socket, which works better in some environments. Otherwise,
4672the normal C<socket> function will be used, which works better in other
4673environments.
4674
4469=item EV_USE_POLL 4675=item EV_USE_POLL
4470 4676
4471If defined to be C<1>, libev will compile in support for the C<poll>(2) 4677If defined to be C<1>, libev will compile in support for the C<poll>(2)
4472backend. Otherwise it will be enabled on non-win32 platforms. It 4678backend. Otherwise it will be enabled on non-win32 platforms. It
4473takes precedence over select. 4679takes precedence over select.
4477If defined to be C<1>, libev will compile in support for the Linux 4683If defined to be C<1>, libev will compile in support for the Linux
4478C<epoll>(7) backend. Its availability will be detected at runtime, 4684C<epoll>(7) backend. Its availability will be detected at runtime,
4479otherwise another method will be used as fallback. This is the preferred 4685otherwise another method will be used as fallback. This is the preferred
4480backend for GNU/Linux systems. If undefined, it will be enabled if the 4686backend for GNU/Linux systems. If undefined, it will be enabled if the
4481headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4687headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4688
4689=item EV_USE_LINUXAIO
4690
4691If defined to be C<1>, libev will compile in support for the Linux
4692aio backend. Due to it's currenbt limitations it has to be requested
4693explicitly. If undefined, it will be enabled on linux, otherwise
4694disabled.
4482 4695
4483=item EV_USE_KQUEUE 4696=item EV_USE_KQUEUE
4484 4697
4485If defined to be C<1>, libev will compile in support for the BSD style 4698If defined to be C<1>, libev will compile in support for the BSD style
4486C<kqueue>(2) backend. Its actual availability will be detected at runtime, 4699C<kqueue>(2) backend. Its actual availability will be detected at runtime,
4517different cpus (or different cpu cores). This reduces dependencies 4730different cpus (or different cpu cores). This reduces dependencies
4518and makes libev faster. 4731and makes libev faster.
4519 4732
4520=item EV_NO_THREADS 4733=item EV_NO_THREADS
4521 4734
4522If defined to be C<1>, libev will assume that it will never be called 4735If defined to be C<1>, libev will assume that it will never be called from
4523from different threads, which is a stronger assumption than C<EV_NO_SMP>, 4736different threads (that includes signal handlers), which is a stronger
4524above. This reduces dependencies and makes libev faster. 4737assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4738libev faster.
4525 4739
4526=item EV_ATOMIC_T 4740=item EV_ATOMIC_T
4527 4741
4528Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4742Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4529access is atomic and serialised with respect to other threads or signal 4743access is atomic with respect to other threads or signal contexts. No
4530contexts. No such type is easily found in the C language, so you can 4744such type is easily found in the C language, so you can provide your own
4531provide your own type that you know is safe for your purposes. It is used 4745type that you know is safe for your purposes. It is used both for signal
4532both for signal handler "locking" as well as for signal and thread safety 4746handler "locking" as well as for signal and thread safety in C<ev_async>
4533in C<ev_async> watchers. 4747watchers.
4534 4748
4535In the absence of this define, libev will use C<sig_atomic_t volatile> 4749In the absence of this define, libev will use C<sig_atomic_t volatile>
4536(from F<signal.h>), which is usually good enough on most platforms, 4750(from F<signal.h>), which is usually good enough on most platforms.
4537although strictly speaking using a type that also implies a memory fence
4538is required.
4539 4751
4540=item EV_H (h) 4752=item EV_H (h)
4541 4753
4542The name of the F<ev.h> header file used to include it. The default if 4754The name of the F<ev.h> header file used to include it. The default if
4543undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 4755undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
4616 #define EV_USE_POLL 1 4828 #define EV_USE_POLL 1
4617 #define EV_CHILD_ENABLE 1 4829 #define EV_CHILD_ENABLE 1
4618 #define EV_ASYNC_ENABLE 1 4830 #define EV_ASYNC_ENABLE 1
4619 4831
4620The actual value is a bitset, it can be a combination of the following 4832The actual value is a bitset, it can be a combination of the following
4621values: 4833values (by default, all of these are enabled):
4622 4834
4623=over 4 4835=over 4
4624 4836
4625=item C<1> - faster/larger code 4837=item C<1> - faster/larger code
4626 4838
4630code size by roughly 30% on amd64). 4842code size by roughly 30% on amd64).
4631 4843
4632When optimising for size, use of compiler flags such as C<-Os> with 4844When optimising for size, use of compiler flags such as C<-Os> with
4633gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of 4845gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4634assertions. 4846assertions.
4847
4848The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4849(e.g. gcc with C<-Os>).
4635 4850
4636=item C<2> - faster/larger data structures 4851=item C<2> - faster/larger data structures
4637 4852
4638Replaces the small 2-heap for timer management by a faster 4-heap, larger 4853Replaces the small 2-heap for timer management by a faster 4-heap, larger
4639hash table sizes and so on. This will usually further increase code size 4854hash table sizes and so on. This will usually further increase code size
4640and can additionally have an effect on the size of data structures at 4855and can additionally have an effect on the size of data structures at
4641runtime. 4856runtime.
4857
4858The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4859(e.g. gcc with C<-Os>).
4642 4860
4643=item C<4> - full API configuration 4861=item C<4> - full API configuration
4644 4862
4645This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and 4863This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4646enables multiplicity (C<EV_MULTIPLICITY>=1). 4864enables multiplicity (C<EV_MULTIPLICITY>=1).
4758in. If set to C<1>, then verification code will be compiled in, but not 4976in. If set to C<1>, then verification code will be compiled in, but not
4759called. If set to C<2>, then the internal verification code will be 4977called. If set to C<2>, then the internal verification code will be
4760called once per loop, which can slow down libev. If set to C<3>, then the 4978called once per loop, which can slow down libev. If set to C<3>, then the
4761verification code will be called very frequently, which will slow down 4979verification code will be called very frequently, which will slow down
4762libev considerably. 4980libev considerably.
4981
4982Verification errors are reported via C's C<assert> mechanism, so if you
4983disable that (e.g. by defining C<NDEBUG>) then no errors will be reported.
4763 4984
4764The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it 4985The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4765will be C<0>. 4986will be C<0>.
4766 4987
4767=item EV_COMMON 4988=item EV_COMMON
4905default loop and triggering an C<ev_async> watcher from the default loop 5126default loop and triggering an C<ev_async> watcher from the default loop
4906watcher callback into the event loop interested in the signal. 5127watcher callback into the event loop interested in the signal.
4907 5128
4908=back 5129=back
4909 5130
4910See also L<THREAD LOCKING EXAMPLE>. 5131See also L</THREAD LOCKING EXAMPLE>.
4911 5132
4912=head3 COROUTINES 5133=head3 COROUTINES
4913 5134
4914Libev is very accommodating to coroutines ("cooperative threads"): 5135Libev is very accommodating to coroutines ("cooperative threads"):
4915libev fully supports nesting calls to its functions from different 5136libev fully supports nesting calls to its functions from different
5184structure (guaranteed by POSIX but not by ISO C for example), but it also 5405structure (guaranteed by POSIX but not by ISO C for example), but it also
5185assumes that the same (machine) code can be used to call any watcher 5406assumes that the same (machine) code can be used to call any watcher
5186callback: The watcher callbacks have different type signatures, but libev 5407callback: The watcher callbacks have different type signatures, but libev
5187calls them using an C<ev_watcher *> internally. 5408calls them using an C<ev_watcher *> internally.
5188 5409
5410=item null pointers and integer zero are represented by 0 bytes
5411
5412Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
5413relies on this setting pointers and integers to null.
5414
5189=item pointer accesses must be thread-atomic 5415=item pointer accesses must be thread-atomic
5190 5416
5191Accessing a pointer value must be atomic, it must both be readable and 5417Accessing a pointer value must be atomic, it must both be readable and
5192writable in one piece - this is the case on all current architectures. 5418writable in one piece - this is the case on all current architectures.
5193 5419
5206thread" or will block signals process-wide, both behaviours would 5432thread" or will block signals process-wide, both behaviours would
5207be compatible with libev. Interaction between C<sigprocmask> and 5433be compatible with libev. Interaction between C<sigprocmask> and
5208C<pthread_sigmask> could complicate things, however. 5434C<pthread_sigmask> could complicate things, however.
5209 5435
5210The most portable way to handle signals is to block signals in all threads 5436The most portable way to handle signals is to block signals in all threads
5211except the initial one, and run the default loop in the initial thread as 5437except the initial one, and run the signal handling loop in the initial
5212well. 5438thread as well.
5213 5439
5214=item C<long> must be large enough for common memory allocation sizes 5440=item C<long> must be large enough for common memory allocation sizes
5215 5441
5216To improve portability and simplify its API, libev uses C<long> internally 5442To improve portability and simplify its API, libev uses C<long> internally
5217instead of C<size_t> when allocating its data structures. On non-POSIX 5443instead of C<size_t> when allocating its data structures. On non-POSIX
5321=over 4 5547=over 4
5322 5548
5323=item C<EV_COMPAT3> backwards compatibility mechanism 5549=item C<EV_COMPAT3> backwards compatibility mechanism
5324 5550
5325The backward compatibility mechanism can be controlled by 5551The backward compatibility mechanism can be controlled by
5326C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5552C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5327section. 5553section.
5328 5554
5329=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5555=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5330 5556
5331These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5557These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5374=over 4 5600=over 4
5375 5601
5376=item active 5602=item active
5377 5603
5378A watcher is active as long as it has been started and not yet stopped. 5604A watcher is active as long as it has been started and not yet stopped.
5379See L<WATCHER STATES> for details. 5605See L</WATCHER STATES> for details.
5380 5606
5381=item application 5607=item application
5382 5608
5383In this document, an application is whatever is using libev. 5609In this document, an application is whatever is using libev.
5384 5610
5420watchers and events. 5646watchers and events.
5421 5647
5422=item pending 5648=item pending
5423 5649
5424A watcher is pending as soon as the corresponding event has been 5650A watcher is pending as soon as the corresponding event has been
5425detected. See L<WATCHER STATES> for details. 5651detected. See L</WATCHER STATES> for details.
5426 5652
5427=item real time 5653=item real time
5428 5654
5429The physical time that is observed. It is apparently strictly monotonic :) 5655The physical time that is observed. It is apparently strictly monotonic :)
5430 5656

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines