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

Comparing libev/ev.pod (file contents):
Revision 1.388 by root, Tue Dec 20 04:08:35 2011 UTC vs.
Revision 1.449 by root, Sun Jun 23 02:02:30 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
247the 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 ()
248& ev_supported_backends ()>, likewise for recommended ones. 250& ev_supported_backends ()>, likewise for recommended ones.
249 251
250See the description of C<ev_embed> watchers for more info. 252See the description of C<ev_embed> watchers for more info.
251 253
252=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 254=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
253 255
254Sets the allocation function to use (the prototype is similar - the 256Sets the allocation function to use (the prototype is similar - the
255semantics 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
256used 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
257when 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
263 265
264You could override this function in high-availability programs to, say, 266You could override this function in high-availability programs to, say,
265free 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,
266or 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.
267 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
268Example: 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
269retries (example requires a standards-compliant C<realloc>). 285retries.
270 286
271 static void * 287 static void *
272 persistent_realloc (void *ptr, size_t size) 288 persistent_realloc (void *ptr, size_t size)
273 { 289 {
290 if (!size)
291 {
292 free (ptr);
293 return 0;
294 }
295
274 for (;;) 296 for (;;)
275 { 297 {
276 void *newptr = realloc (ptr, size); 298 void *newptr = realloc (ptr, size);
277 299
278 if (newptr) 300 if (newptr)
283 } 305 }
284 306
285 ... 307 ...
286 ev_set_allocator (persistent_realloc); 308 ev_set_allocator (persistent_realloc);
287 309
288=item ev_set_syserr_cb (void (*cb)(const char *msg)) 310=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
289 311
290Set 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
291as failed select, poll, epoll_wait). The message is a printable string 313as failed select, poll, epoll_wait). The message is a printable string
292indicating the system call or subsystem causing the problem. If this 314indicating the system call or subsystem causing the problem. If this
293callback 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
396 418
397If 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
398or setgid) then libev will I<not> look at the environment variable 420or setgid) then libev will I<not> look at the environment variable
399C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 421C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
400override 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
401useful to try out specific backends to test their performance, or to work 423useful to try out specific backends to test their performance, to work
402around 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).
403 427
404=item C<EVFLAG_FORKCHECK> 428=item C<EVFLAG_FORKCHECK>
405 429
406Instead 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
407make 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.
408 432
409This works by calling C<getpid ()> on every iteration of the loop, 433This 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 434and 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 435iterations 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 436GNU/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 437sequence without a system call and thus I<very> fast, but my GNU/Linux
414C<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).
415 440
416The 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
417forget about forgetting to tell libev about forking) when you use this 442forget about forgetting to tell libev about forking, although you still
418flag. 443have to ignore C<SIGPIPE>) when you use this flag.
419 444
420This 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>
421environment variable. 446environment variable.
422 447
423=item C<EVFLAG_NOINOTIFY> 448=item C<EVFLAG_NOINOTIFY>
542All 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
543faster 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
544the usage. So sad. 569the usage. So sad.
545 570
546While nominally embeddable in other event loops, this feature is broken in 571While nominally embeddable in other event loops, this feature is broken in
547all 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) >> but C<<
580io_submit(2) >>) event interface available in post-4.18 kernels.
581
582If this backend works for you (as of this writing, it was very
583experimental), it is the best event interface available on linux and might
584be well worth enabling it - if it isn't available in your kernel this will
585be detected and this backend will be skipped.
586
587This backend can batch oneshot requests and supports a user-space ring
588buffer to receive events. It also doesn't suffer from most of the design
589problems of epoll (such as not being able to remove event sources from
590the epoll set), and generally sounds too good to be true. Because, this
591being the linux kernel, of course it suffers from a whole new set of
592limitations.
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 a system wide
596limit that can be configured in F</proc/sys/fs/aio-max-nr> - each loop
597currently requires C<61> of this number. If no aio requests are left, this
598backend will be skipped during initialisation.
599
600Most problematic in practise, however, is that not all file descriptors
601work with it. For example, in linux 5.1, tcp sockets, pipes, event fds,
602files, F</dev/null> and a few others are supported, but ttys do not work
603(probably because of a bug), so this is not (yet?) a generic event polling
604interface.
605
606To work around this latter problem, the current version of libev uses
607epoll as a fallback for file deescriptor types that do not work. Epoll
608is used in, kind of, slow mode that hopefully avoids most of its design
609problems and requires 1-3 extra syscalls per active fd every iteration.
548 610
549This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 611This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
550C<EVBACKEND_POLL>. 612C<EVBACKEND_POLL>.
551 613
552=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 614=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
567 629
568It scales in the same way as the epoll backend, but the interface to the 630It 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 631kernel is more efficient (which says nothing about its actual speed, of
570course). While stopping, setting and starting an I/O watcher does never 632course). 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 633cause 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 634two 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 635might have to leak fd's on fork, but it's more sane than epoll) and it
574cases 636drops fds silently in similarly hard-to-detect cases.
575 637
576This backend usually performs well under most conditions. 638This backend usually performs well under most conditions.
577 639
578While nominally embeddable in other event loops, this doesn't work 640While nominally embeddable in other event loops, this doesn't work
579everywhere, so you might need to test for this. And since it is broken 641everywhere, 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 715Example: Use whatever libev has to offer, but make sure that kqueue is
654used if available. 716used if available.
655 717
656 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 718 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
657 719
720Example: Similarly, on linux, you mgiht want to take advantage of the
721linux aio backend if possible, but fall back to something else if that
722isn't available.
723
724 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
725
658=item ev_loop_destroy (loop) 726=item ev_loop_destroy (loop)
659 727
660Destroys an event loop object (frees all memory and kernel state 728Destroys an event loop object (frees all memory and kernel state
661etc.). None of the active event watchers will be stopped in the normal 729etc.). 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 730sense, 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> 746If you need dynamically allocated loops it is better to use C<ev_loop_new>
679and C<ev_loop_destroy>. 747and C<ev_loop_destroy>.
680 748
681=item ev_loop_fork (loop) 749=item ev_loop_fork (loop)
682 750
683This function sets a flag that causes subsequent C<ev_run> iterations to 751This function sets a flag that causes subsequent C<ev_run> iterations
684reinitialise the kernel state for backends that have one. Despite the 752to reinitialise the kernel state for backends that have one. Despite
685name, you can call it anytime, but it makes most sense after forking, in 753the 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 754watchers (except inside an C<ev_prepare> callback), but it makes most
755sense after forking, in the child process. You I<must> call it (or use
687child before resuming or calling C<ev_run>. 756C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
688 757
758In addition, if you want to reuse a loop (via this function or
759C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>.
760
689Again, you I<have> to call it on I<any> loop that you want to re-use after 761Again, 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 762a 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 763because some kernel interfaces *cough* I<kqueue> *cough* do funny things
692during fork. 764during fork.
693 765
694On the other hand, you only need to call this function in the child 766On the other hand, you only need to call this function in the child
764 836
765This function is rarely useful, but when some event callback runs for a 837This 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 838very long time without entering the event loop, updating libev's idea of
767the current time is a good idea. 839the current time is a good idea.
768 840
769See also L<The special problem of time updates> in the C<ev_timer> section. 841See also L</The special problem of time updates> in the C<ev_timer> section.
770 842
771=item ev_suspend (loop) 843=item ev_suspend (loop)
772 844
773=item ev_resume (loop) 845=item ev_resume (loop)
774 846
792without a previous call to C<ev_suspend>. 864without a previous call to C<ev_suspend>.
793 865
794Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the 866Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
795event loop time (see C<ev_now_update>). 867event loop time (see C<ev_now_update>).
796 868
797=item ev_run (loop, int flags) 869=item bool ev_run (loop, int flags)
798 870
799Finally, this is it, the event handler. This function usually is called 871Finally, this is it, the event handler. This function usually is called
800after you have initialised all your watchers and you want to start 872after you have initialised all your watchers and you want to start
801handling events. It will ask the operating system for any new events, call 873handling events. It will ask the operating system for any new events, call
802the watcher callbacks, an then repeat the whole process indefinitely: This 874the watcher callbacks, and then repeat the whole process indefinitely: This
803is why event loops are called I<loops>. 875is why event loops are called I<loops>.
804 876
805If the flags argument is specified as C<0>, it will keep handling events 877If 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 878until either no event watchers are active anymore or C<ev_break> was
807called. 879called.
880
881The return value is false if there are no more active watchers (which
882usually means "all jobs done" or "deadlock"), and true in all other cases
883(which usually means " you should call C<ev_run> again").
808 884
809Please note that an explicit C<ev_break> is usually better than 885Please note that an explicit C<ev_break> is usually better than
810relying on all watchers to be stopped when deciding when a program has 886relying on all watchers to be stopped when deciding when a program has
811finished (especially in interactive programs), but having a program 887finished (especially in interactive programs), but having a program
812that automatically loops as long as it has to and no longer by virtue 888that 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 889of relying on its watchers stopping correctly, that is truly a thing of
814beauty. 890beauty.
815 891
816This function is also I<mostly> exception-safe - you can break out of 892This 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++ 893C<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 894exception and so on. This does not decrement the C<ev_depth> value, nor
819will it clear any outstanding C<EVBREAK_ONE> breaks. 895will it clear any outstanding C<EVBREAK_ONE> breaks.
820 896
821A flags value of C<EVRUN_NOWAIT> will look for new events, will handle 897A 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 898those events and any already outstanding ones, but will not wait and
1012invoke the actual watchers inside another context (another thread etc.). 1088invoke the actual watchers inside another context (another thread etc.).
1013 1089
1014If you want to reset the callback, use C<ev_invoke_pending> as new 1090If you want to reset the callback, use C<ev_invoke_pending> as new
1015callback. 1091callback.
1016 1092
1017=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) 1093=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
1018 1094
1019Sometimes you want to share the same loop between multiple threads. This 1095Sometimes you want to share the same loop between multiple threads. This
1020can be done relatively simply by putting mutex_lock/unlock calls around 1096can be done relatively simply by putting mutex_lock/unlock calls around
1021each call to a libev function. 1097each call to a libev function.
1022 1098
1170 1246
1171=item C<EV_PREPARE> 1247=item C<EV_PREPARE>
1172 1248
1173=item C<EV_CHECK> 1249=item C<EV_CHECK>
1174 1250
1175All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts 1251All 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 1252gather 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 1253just after C<ev_run> has gathered them, but before it queues any callbacks
1254for any received events. That means C<ev_prepare> watchers are the last
1255watchers invoked before the event loop sleeps or polls for new events, and
1256C<ev_check> watchers will be invoked before any other watchers of the same
1257or lower priority within an event loop iteration.
1258
1178received events. Callbacks of both watcher types can start and stop as 1259Callbacks 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 1260they 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 1261C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1181C<ev_run> from blocking). 1262blocking).
1182 1263
1183=item C<EV_EMBED> 1264=item C<EV_EMBED>
1184 1265
1185The embedded event loop specified in the C<ev_embed> watcher needs attention. 1266The embedded event loop specified in the C<ev_embed> watcher needs attention.
1186 1267
1309 1390
1310=item callback ev_cb (ev_TYPE *watcher) 1391=item callback ev_cb (ev_TYPE *watcher)
1311 1392
1312Returns the callback currently set on the watcher. 1393Returns the callback currently set on the watcher.
1313 1394
1314=item ev_cb_set (ev_TYPE *watcher, callback) 1395=item ev_set_cb (ev_TYPE *watcher, callback)
1315 1396
1316Change the callback. You can change the callback at virtually any time 1397Change the callback. You can change the callback at virtually any time
1317(modulo threads). 1398(modulo threads).
1318 1399
1319=item ev_set_priority (ev_TYPE *watcher, int priority) 1400=item ev_set_priority (ev_TYPE *watcher, int priority)
1337or might not have been clamped to the valid range. 1418or might not have been clamped to the valid range.
1338 1419
1339The default priority used by watchers when no priority has been set is 1420The 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 :). 1421always C<0>, which is supposed to not be too high and not be too low :).
1341 1422
1342See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1423See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1343priorities. 1424priorities.
1344 1425
1345=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1426=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1346 1427
1347Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1428Invoke 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 1453See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1373functions that do not need a watcher. 1454functions that do not need a watcher.
1374 1455
1375=back 1456=back
1376 1457
1377See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1458See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1378OWN COMPOSITE WATCHERS> idioms. 1459OWN COMPOSITE WATCHERS> idioms.
1379 1460
1380=head2 WATCHER STATES 1461=head2 WATCHER STATES
1381 1462
1382There are various watcher states mentioned throughout this manual - 1463There are various watcher states mentioned throughout this manual -
1384transition between them will be described in more detail - and while these 1465transition between them will be described in more detail - and while these
1385rules might look complicated, they usually do "the right thing". 1466rules might look complicated, they usually do "the right thing".
1386 1467
1387=over 4 1468=over 4
1388 1469
1389=item initialiased 1470=item initialised
1390 1471
1391Before a watcher can be registered with the event loop it has to be 1472Before 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 1473initialised. 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. 1474C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1394 1475
1592 1673
1593But really, best use non-blocking mode. 1674But really, best use non-blocking mode.
1594 1675
1595=head3 The special problem of disappearing file descriptors 1676=head3 The special problem of disappearing file descriptors
1596 1677
1597Some backends (e.g. kqueue, epoll) need to be told about closing a file 1678Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1598descriptor (either due to calling C<close> explicitly or any other means, 1679a 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 1680means, 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 1681file descriptor, but when it goes away, the operating system will silently
1601this interest. If another file descriptor with the same number then is 1682drop 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 1683is registered with libev, there is no efficient way to see that this is,
1603fact, a different file descriptor. 1684in fact, a different file descriptor.
1604 1685
1605To avoid having to explicitly tell libev about such cases, libev follows 1686To avoid having to explicitly tell libev about such cases, libev follows
1606the following policy: Each time C<ev_io_set> is being called, libev 1687the following policy: Each time C<ev_io_set> is being called, libev
1607will assume that this is potentially a new file descriptor, otherwise 1688will assume that this is potentially a new file descriptor, otherwise
1608it is assumed that the file descriptor stays the same. That means that 1689it 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 1738when you rarely read from a file instead of from a socket, and want to
1658reuse the same code path. 1739reuse the same code path.
1659 1740
1660=head3 The special problem of fork 1741=head3 The special problem of fork
1661 1742
1662Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1743Some backends (epoll, kqueue, probably linuxaio) do not support C<fork ()>
1663useless behaviour. Libev fully supports fork, but needs to be told about 1744at 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. 1745to be told about it in the child if you want to continue to use it in the
1746child.
1665 1747
1666To support fork in your child processes, you have to call C<ev_loop_fork 1748To 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 1749()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1668C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1750C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1669 1751
1870 callback (EV_P_ ev_timer *w, int revents) 1952 callback (EV_P_ ev_timer *w, int revents)
1871 { 1953 {
1872 // calculate when the timeout would happen 1954 // calculate when the timeout would happen
1873 ev_tstamp after = last_activity - ev_now (EV_A) + timeout; 1955 ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1874 1956
1875 // if negative, it means we the timeout already occured 1957 // if negative, it means we the timeout already occurred
1876 if (after < 0.) 1958 if (after < 0.)
1877 { 1959 {
1878 // timeout occurred, take action 1960 // timeout occurred, take action
1879 } 1961 }
1880 else 1962 else
1881 { 1963 {
1882 // callback was invoked, but there was some recent 1964 // callback was invoked, but there was some recent
1883 // activity. simply restart the timer to time out 1965 // activity. simply restart the timer to time out
1884 // after "after" seconds, which is the earliest time 1966 // after "after" seconds, which is the earliest time
1885 // the timeout can occur. 1967 // the timeout can occur.
1886 ev_timer_set (w, after, 0.); 1968 ev_timer_set (w, after, 0.);
1887 ev_timer_start (EV_A_ w); 1969 ev_timer_start (EV_A_ w);
1888 } 1970 }
1898 1980
1899Otherwise, we now the earliest time at which the timeout would trigger, 1981Otherwise, we now the earliest time at which the timeout would trigger,
1900and simply start the timer with this timeout value. 1982and simply start the timer with this timeout value.
1901 1983
1902In other words, each time the callback is invoked it will check whether 1984In other words, each time the callback is invoked it will check whether
1903the timeout cocured. If not, it will simply reschedule itself to check 1985the timeout occurred. If not, it will simply reschedule itself to check
1904again at the earliest time it could time out. Rinse. Repeat. 1986again at the earliest time it could time out. Rinse. Repeat.
1905 1987
1906This scheme causes more callback invocations (about one every 60 seconds 1988This scheme causes more callback invocations (about one every 60 seconds
1907minus half the average time between activity), but virtually no calls to 1989minus half the average time between activity), but virtually no calls to
1908libev to change the timeout. 1990libev to change the timeout.
1922 if (activity detected) 2004 if (activity detected)
1923 last_activity = ev_now (EV_A); 2005 last_activity = ev_now (EV_A);
1924 2006
1925When your timeout value changes, then the timeout can be changed by simply 2007When your timeout value changes, then the timeout can be changed by simply
1926providing a new value, stopping the timer and calling the callback, which 2008providing a new value, stopping the timer and calling the callback, which
1927will agaion do the right thing (for example, time out immediately :). 2009will again do the right thing (for example, time out immediately :).
1928 2010
1929 timeout = new_value; 2011 timeout = new_value;
1930 ev_timer_stop (EV_A_ &timer); 2012 ev_timer_stop (EV_A_ &timer);
1931 callback (EV_A_ &timer, 0); 2013 callback (EV_A_ &timer, 0);
1932 2014
2015 2097
2016The relative timeouts are calculated relative to the C<ev_now ()> 2098The relative timeouts are calculated relative to the C<ev_now ()>
2017time. This is usually the right thing as this timestamp refers to the time 2099time. This is usually the right thing as this timestamp refers to the time
2018of the event triggering whatever timeout you are modifying/starting. If 2100of the event triggering whatever timeout you are modifying/starting. If
2019you suspect event processing to be delayed and you I<need> to base the 2101you 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: 2102timeout on the current time, use something like the following to adjust
2103for it:
2021 2104
2022 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2105 ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
2023 2106
2024If the event loop is suspended for a long time, you can also force an 2107If 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 2108update of the time returned by C<ev_now ()> by calling C<ev_now_update
2026()>. 2109()>, although that will push the event time of all outstanding events
2110further into the future.
2027 2111
2028=head3 The special problem of unsynchronised clocks 2112=head3 The special problem of unsynchronised clocks
2029 2113
2030Modern systems have a variety of clocks - libev itself uses the normal 2114Modern systems have a variety of clocks - libev itself uses the normal
2031"wall clock" clock and, if available, the monotonic clock (to avoid time 2115"wall clock" clock and, if available, the monotonic clock (to avoid time
2094 2178
2095=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 2179=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
2096 2180
2097=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 2181=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
2098 2182
2099Configure the timer to trigger after C<after> seconds. If C<repeat> 2183Configure the timer to trigger after C<after> seconds (fractional and
2100is C<0.>, then it will automatically be stopped once the timeout is 2184negative values are supported). If C<repeat> is C<0.>, then it will
2101reached. If it is positive, then the timer will automatically be 2185automatically be stopped once the timeout is reached. If it is positive,
2102configured to trigger again C<repeat> seconds later, again, and again, 2186then the timer will automatically be configured to trigger again C<repeat>
2103until stopped manually. 2187seconds later, again, and again, until stopped manually.
2104 2188
2105The timer itself will do a best-effort at avoiding drift, that is, if 2189The 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 2190you configure a timer to trigger every 10 seconds, then it will normally
2107trigger at exactly 10 second intervals. If, however, your program cannot 2191trigger at exactly 10 second intervals. If, however, your program cannot
2108keep up with the timer (because it takes longer than those 10 seconds to 2192keep up with the timer (because it takes longer than those 10 seconds to
2109do stuff) the timer will not fire more than once per event loop iteration. 2193do stuff) the timer will not fire more than once per event loop iteration.
2110 2194
2111=item ev_timer_again (loop, ev_timer *) 2195=item ev_timer_again (loop, ev_timer *)
2112 2196
2113This will act as if the timer timed out and restarts it again if it is 2197This will act as if the timer timed out, and restarts it again if it is
2114repeating. The exact semantics are: 2198repeating. It basically works like calling C<ev_timer_stop>, updating the
2199timeout to the C<repeat> value and calling C<ev_timer_start>.
2115 2200
2201The exact semantics are as in the following rules, all of which will be
2202applied to the watcher:
2203
2204=over 4
2205
2116If the timer is pending, its pending status is cleared. 2206=item If the timer is pending, the pending status is always cleared.
2117 2207
2118If the timer is started but non-repeating, stop it (as if it timed out). 2208=item If the timer is started but non-repeating, stop it (as if it timed
2209out, without invoking it).
2119 2210
2120If the timer is repeating, either start it if necessary (with the 2211=item If the timer is repeating, make the C<repeat> value the new timeout
2121C<repeat> value), or reset the running timer to the C<repeat> value. 2212and start the timer, if necessary.
2122 2213
2214=back
2215
2123This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2216This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2124usage example. 2217usage example.
2125 2218
2126=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2219=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2127 2220
2128Returns the remaining time until a timer fires. If the timer is active, 2221Returns the remaining time until a timer fires. If the timer is active,
2181Periodic watchers are also timers of a kind, but they are very versatile 2274Periodic watchers are also timers of a kind, but they are very versatile
2182(and unfortunately a bit complex). 2275(and unfortunately a bit complex).
2183 2276
2184Unlike C<ev_timer>, periodic watchers are not based on real time (or 2277Unlike C<ev_timer>, periodic watchers are not based on real time (or
2185relative time, the physical time that passes) but on wall clock time 2278relative time, the physical time that passes) but on wall clock time
2186(absolute time, the thing you can read on your calender or clock). The 2279(absolute time, the thing you can read on your calendar or clock). The
2187difference is that wall clock time can run faster or slower than real 2280difference is that wall clock time can run faster or slower than real
2188time, and time jumps are not uncommon (e.g. when you adjust your 2281time, and time jumps are not uncommon (e.g. when you adjust your
2189wrist-watch). 2282wrist-watch).
2190 2283
2191You can tell a periodic watcher to trigger after some specific point 2284You can tell a periodic watcher to trigger after some specific point
2196C<ev_timer>, which would still trigger roughly 10 seconds after starting 2289C<ev_timer>, which would still trigger roughly 10 seconds after starting
2197it, as it uses a relative timeout). 2290it, as it uses a relative timeout).
2198 2291
2199C<ev_periodic> watchers can also be used to implement vastly more complex 2292C<ev_periodic> watchers can also be used to implement vastly more complex
2200timers, such as triggering an event on each "midnight, local time", or 2293timers, such as triggering an event on each "midnight, local time", or
2201other complicated rules. This cannot be done with C<ev_timer> watchers, as 2294other complicated rules. This cannot easily be done with C<ev_timer>
2202those cannot react to time jumps. 2295watchers, as those cannot react to time jumps.
2203 2296
2204As with timers, the callback is guaranteed to be invoked only when the 2297As with timers, the callback is guaranteed to be invoked only when the
2205point in time where it is supposed to trigger has passed. If multiple 2298point in time where it is supposed to trigger has passed. If multiple
2206timers become ready during the same loop iteration then the ones with 2299timers become ready during the same loop iteration then the ones with
2207earlier time-out values are invoked before ones with later time-out values 2300earlier time-out values are invoked before ones with later time-out values
2293 2386
2294NOTE: I<< This callback must always return a time that is higher than or 2387NOTE: I<< This callback must always return a time that is higher than or
2295equal to the passed C<now> value >>. 2388equal to the passed C<now> value >>.
2296 2389
2297This can be used to create very complex timers, such as a timer that 2390This can be used to create very complex timers, such as a timer that
2298triggers on "next midnight, local time". To do this, you would calculate the 2391triggers on "next midnight, local time". To do this, you would calculate
2299next midnight after C<now> and return the timestamp value for this. How 2392the next midnight after C<now> and return the timestamp value for
2300you do this is, again, up to you (but it is not trivial, which is the main 2393this. Here is a (completely untested, no error checking) example on how to
2301reason I omitted it as an example). 2394do this:
2395
2396 #include <time.h>
2397
2398 static ev_tstamp
2399 my_rescheduler (ev_periodic *w, ev_tstamp now)
2400 {
2401 time_t tnow = (time_t)now;
2402 struct tm tm;
2403 localtime_r (&tnow, &tm);
2404
2405 tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2406 ++tm.tm_mday; // midnight next day
2407
2408 return mktime (&tm);
2409 }
2410
2411Note: this code might run into trouble on days that have more then two
2412midnights (beginning and end).
2302 2413
2303=back 2414=back
2304 2415
2305=item ev_periodic_again (loop, ev_periodic *) 2416=item ev_periodic_again (loop, ev_periodic *)
2306 2417
2371 2482
2372 ev_periodic hourly_tick; 2483 ev_periodic hourly_tick;
2373 ev_periodic_init (&hourly_tick, clock_cb, 2484 ev_periodic_init (&hourly_tick, clock_cb,
2374 fmod (ev_now (loop), 3600.), 3600., 0); 2485 fmod (ev_now (loop), 3600.), 3600., 0);
2375 ev_periodic_start (loop, &hourly_tick); 2486 ev_periodic_start (loop, &hourly_tick);
2376 2487
2377 2488
2378=head2 C<ev_signal> - signal me when a signal gets signalled! 2489=head2 C<ev_signal> - signal me when a signal gets signalled!
2379 2490
2380Signal watchers will trigger an event when the process receives a specific 2491Signal watchers will trigger an event when the process receives a specific
2381signal one or more times. Even though signals are very asynchronous, libev 2492signal one or more times. Even though signals are very asynchronous, libev
2391only within the same loop, i.e. you can watch for C<SIGINT> in your 2502only within the same loop, i.e. you can watch for C<SIGINT> in your
2392default loop and for C<SIGIO> in another loop, but you cannot watch for 2503default loop and for C<SIGIO> in another loop, but you cannot watch for
2393C<SIGINT> in both the default loop and another loop at the same time. At 2504C<SIGINT> in both the default loop and another loop at the same time. At
2394the moment, C<SIGCHLD> is permanently tied to the default loop. 2505the moment, C<SIGCHLD> is permanently tied to the default loop.
2395 2506
2396When the first watcher gets started will libev actually register something 2507Only after the first watcher for a signal is started will libev actually
2397with the kernel (thus it coexists with your own signal handlers as long as 2508register something with the kernel. It thus coexists with your own signal
2398you don't register any with libev for the same signal). 2509handlers as long as you don't register any with libev for the same signal.
2399 2510
2400If possible and supported, libev will install its handlers with 2511If possible and supported, libev will install its handlers with
2401C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2512C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2402not be unduly interrupted. If you have a problem with system calls getting 2513not be unduly interrupted. If you have a problem with system calls getting
2403interrupted by signals you can block all signals in an C<ev_check> watcher 2514interrupted by signals you can block all signals in an C<ev_check> watcher
2588 2699
2589=head2 C<ev_stat> - did the file attributes just change? 2700=head2 C<ev_stat> - did the file attributes just change?
2590 2701
2591This watches a file system path for attribute changes. That is, it calls 2702This watches a file system path for attribute changes. That is, it calls
2592C<stat> on that path in regular intervals (or when the OS says it changed) 2703C<stat> on that path in regular intervals (or when the OS says it changed)
2593and sees if it changed compared to the last time, invoking the callback if 2704and sees if it changed compared to the last time, invoking the callback
2594it did. 2705if it did. Starting the watcher C<stat>'s the file, so only changes that
2706happen after the watcher has been started will be reported.
2595 2707
2596The path does not need to exist: changing from "path exists" to "path does 2708The path does not need to exist: changing from "path exists" to "path does
2597not exist" is a status change like any other. The condition "path does not 2709not exist" is a status change like any other. The condition "path does not
2598exist" (or more correctly "path cannot be stat'ed") is signified by the 2710exist" (or more correctly "path cannot be stat'ed") is signified by the
2599C<st_nlink> field being zero (which is otherwise always forced to be at 2711C<st_nlink> field being zero (which is otherwise always forced to be at
2829Apart from keeping your process non-blocking (which is a useful 2941Apart from keeping your process non-blocking (which is a useful
2830effect on its own sometimes), idle watchers are a good place to do 2942effect on its own sometimes), idle watchers are a good place to do
2831"pseudo-background processing", or delay processing stuff to after the 2943"pseudo-background processing", or delay processing stuff to after the
2832event loop has handled all outstanding events. 2944event loop has handled all outstanding events.
2833 2945
2946=head3 Abusing an C<ev_idle> watcher for its side-effect
2947
2948As long as there is at least one active idle watcher, libev will never
2949sleep unnecessarily. Or in other words, it will loop as fast as possible.
2950For this to work, the idle watcher doesn't need to be invoked at all - the
2951lowest priority will do.
2952
2953This mode of operation can be useful together with an C<ev_check> watcher,
2954to do something on each event loop iteration - for example to balance load
2955between different connections.
2956
2957See L</Abusing an ev_check watcher for its side-effect> for a longer
2958example.
2959
2834=head3 Watcher-Specific Functions and Data Members 2960=head3 Watcher-Specific Functions and Data Members
2835 2961
2836=over 4 2962=over 4
2837 2963
2838=item ev_idle_init (ev_idle *, callback) 2964=item ev_idle_init (ev_idle *, callback)
2849callback, free it. Also, use no error checking, as usual. 2975callback, free it. Also, use no error checking, as usual.
2850 2976
2851 static void 2977 static void
2852 idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 2978 idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2853 { 2979 {
2980 // stop the watcher
2981 ev_idle_stop (loop, w);
2982
2983 // now we can free it
2854 free (w); 2984 free (w);
2985
2855 // now do something you wanted to do when the program has 2986 // now do something you wanted to do when the program has
2856 // no longer anything immediate to do. 2987 // no longer anything immediate to do.
2857 } 2988 }
2858 2989
2859 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2990 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2861 ev_idle_start (loop, idle_watcher); 2992 ev_idle_start (loop, idle_watcher);
2862 2993
2863 2994
2864=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2995=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2865 2996
2866Prepare and check watchers are usually (but not always) used in pairs: 2997Prepare and check watchers are often (but not always) used in pairs:
2867prepare watchers get invoked before the process blocks and check watchers 2998prepare watchers get invoked before the process blocks and check watchers
2868afterwards. 2999afterwards.
2869 3000
2870You I<must not> call C<ev_run> or similar functions that enter 3001You I<must not> call C<ev_run> (or similar functions that enter the
2871the current event loop from either C<ev_prepare> or C<ev_check> 3002current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2872watchers. Other loops than the current one are fine, however. The 3003C<ev_check> watchers. Other loops than the current one are fine,
2873rationale behind this is that you do not need to check for recursion in 3004however. The rationale behind this is that you do not need to check
2874those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, 3005for recursion in those watchers, i.e. the sequence will always be
2875C<ev_check> so if you have one watcher of each kind they will always be 3006C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2876called in pairs bracketing the blocking call. 3007kind they will always be called in pairs bracketing the blocking call.
2877 3008
2878Their main purpose is to integrate other event mechanisms into libev and 3009Their main purpose is to integrate other event mechanisms into libev and
2879their use is somewhat advanced. They could be used, for example, to track 3010their use is somewhat advanced. They could be used, for example, to track
2880variable changes, implement your own watchers, integrate net-snmp or a 3011variable changes, implement your own watchers, integrate net-snmp or a
2881coroutine library and lots more. They are also occasionally useful if 3012coroutine library and lots more. They are also occasionally useful if
2899with priority higher than or equal to the event loop and one coroutine 3030with priority higher than or equal to the event loop and one coroutine
2900of lower priority, but only once, using idle watchers to keep the event 3031of lower priority, but only once, using idle watchers to keep the event
2901loop from blocking if lower-priority coroutines are active, thus mapping 3032loop from blocking if lower-priority coroutines are active, thus mapping
2902low-priority coroutines to idle/background tasks). 3033low-priority coroutines to idle/background tasks).
2903 3034
2904It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 3035When used for this purpose, it is recommended to give C<ev_check> watchers
2905priority, to ensure that they are being run before any other watchers 3036highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2906after the poll (this doesn't matter for C<ev_prepare> watchers). 3037any other watchers after the poll (this doesn't matter for C<ev_prepare>
3038watchers).
2907 3039
2908Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not 3040Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2909activate ("feed") events into libev. While libev fully supports this, they 3041activate ("feed") events into libev. While libev fully supports this, they
2910might get executed before other C<ev_check> watchers did their job. As 3042might get executed before other C<ev_check> watchers did their job. As
2911C<ev_check> watchers are often used to embed other (non-libev) event 3043C<ev_check> watchers are often used to embed other (non-libev) event
2912loops those other event loops might be in an unusable state until their 3044loops those other event loops might be in an unusable state until their
2913C<ev_check> watcher ran (always remind yourself to coexist peacefully with 3045C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2914others). 3046others).
3047
3048=head3 Abusing an C<ev_check> watcher for its side-effect
3049
3050C<ev_check> (and less often also C<ev_prepare>) watchers can also be
3051useful because they are called once per event loop iteration. For
3052example, if you want to handle a large number of connections fairly, you
3053normally only do a bit of work for each active connection, and if there
3054is more work to do, you wait for the next event loop iteration, so other
3055connections have a chance of making progress.
3056
3057Using an C<ev_check> watcher is almost enough: it will be called on the
3058next event loop iteration. However, that isn't as soon as possible -
3059without external events, your C<ev_check> watcher will not be invoked.
3060
3061This is where C<ev_idle> watchers come in handy - all you need is a
3062single global idle watcher that is active as long as you have one active
3063C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
3064will not sleep, and the C<ev_check> watcher makes sure a callback gets
3065invoked. Neither watcher alone can do that.
2915 3066
2916=head3 Watcher-Specific Functions and Data Members 3067=head3 Watcher-Specific Functions and Data Members
2917 3068
2918=over 4 3069=over 4
2919 3070
3120 3271
3121=over 4 3272=over 4
3122 3273
3123=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3274=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3124 3275
3125=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3276=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3126 3277
3127Configures the watcher to embed the given loop, which must be 3278Configures the watcher to embed the given loop, which must be
3128embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3279embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3129invoked automatically, otherwise it is the responsibility of the callback 3280invoked automatically, otherwise it is the responsibility of the callback
3130to invoke it (it will continue to be called until the sweep has been done, 3281to invoke it (it will continue to be called until the sweep has been done,
3151used). 3302used).
3152 3303
3153 struct ev_loop *loop_hi = ev_default_init (0); 3304 struct ev_loop *loop_hi = ev_default_init (0);
3154 struct ev_loop *loop_lo = 0; 3305 struct ev_loop *loop_lo = 0;
3155 ev_embed embed; 3306 ev_embed embed;
3156 3307
3157 // see if there is a chance of getting one that works 3308 // see if there is a chance of getting one that works
3158 // (remember that a flags value of 0 means autodetection) 3309 // (remember that a flags value of 0 means autodetection)
3159 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3310 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3160 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3311 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3161 : 0; 3312 : 0;
3175C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3326C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3176 3327
3177 struct ev_loop *loop = ev_default_init (0); 3328 struct ev_loop *loop = ev_default_init (0);
3178 struct ev_loop *loop_socket = 0; 3329 struct ev_loop *loop_socket = 0;
3179 ev_embed embed; 3330 ev_embed embed;
3180 3331
3181 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3332 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3182 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3333 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3183 { 3334 {
3184 ev_embed_init (&embed, 0, loop_socket); 3335 ev_embed_init (&embed, 0, loop_socket);
3185 ev_embed_start (loop, &embed); 3336 ev_embed_start (loop, &embed);
3193 3344
3194=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3345=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3195 3346
3196Fork watchers are called when a C<fork ()> was detected (usually because 3347Fork watchers are called when a C<fork ()> was detected (usually because
3197whoever is a good citizen cared to tell libev about it by calling 3348whoever is a good citizen cared to tell libev about it by calling
3198C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the 3349C<ev_loop_fork>). The invocation is done before the event loop blocks next
3199event loop blocks next and before C<ev_check> watchers are being called, 3350and before C<ev_check> watchers are being called, and only in the child
3200and only in the child after the fork. If whoever good citizen calling 3351after the fork. If whoever good citizen calling C<ev_default_fork> cheats
3201C<ev_default_fork> cheats and calls it in the wrong process, the fork 3352and calls it in the wrong process, the fork handlers will be invoked, too,
3202handlers will be invoked, too, of course. 3353of course.
3203 3354
3204=head3 The special problem of life after fork - how is it possible? 3355=head3 The special problem of life after fork - how is it possible?
3205 3356
3206Most uses of C<fork()> consist of forking, then some simple calls to set 3357Most uses of C<fork ()> consist of forking, then some simple calls to set
3207up/change the process environment, followed by a call to C<exec()>. This 3358up/change the process environment, followed by a call to C<exec()>. This
3208sequence should be handled by libev without any problems. 3359sequence should be handled by libev without any problems.
3209 3360
3210This changes when the application actually wants to do event handling 3361This changes when the application actually wants to do event handling
3211in the child, or both parent in child, in effect "continuing" after the 3362in the child, or both parent in child, in effect "continuing" after the
3300it by calling C<ev_async_send>, which is thread- and signal safe. 3451it by calling C<ev_async_send>, which is thread- and signal safe.
3301 3452
3302This functionality is very similar to C<ev_signal> watchers, as signals, 3453This functionality is very similar to C<ev_signal> watchers, as signals,
3303too, are asynchronous in nature, and signals, too, will be compressed 3454too, are asynchronous in nature, and signals, too, will be compressed
3304(i.e. the number of callback invocations may be less than the number of 3455(i.e. the number of callback invocations may be less than the number of
3305C<ev_async_sent> calls). In fact, you could use signal watchers as a kind 3456C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3306of "global async watchers" by using a watcher on an otherwise unused 3457of "global async watchers" by using a watcher on an otherwise unused
3307signal, and C<ev_feed_signal> to signal this watcher from another thread, 3458signal, and C<ev_feed_signal> to signal this watcher from another thread,
3308even without knowing which loop owns the signal. 3459even without knowing which loop owns the signal.
3309 3460
3310=head3 Queueing 3461=head3 Queueing
3449 3600
3450There are some other functions of possible interest. Described. Here. Now. 3601There are some other functions of possible interest. Described. Here. Now.
3451 3602
3452=over 4 3603=over 4
3453 3604
3454=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 3605=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3455 3606
3456This function combines a simple timer and an I/O watcher, calls your 3607This function combines a simple timer and an I/O watcher, calls your
3457callback on whichever event happens first and automatically stops both 3608callback on whichever event happens first and automatically stops both
3458watchers. This is useful if you want to wait for a single event on an fd 3609watchers. This is useful if you want to wait for a single event on an fd
3459or timeout without having to allocate/configure/start/stop/free one or 3610or timeout without having to allocate/configure/start/stop/free one or
3601already been invoked. 3752already been invoked.
3602 3753
3603A common way around all these issues is to make sure that 3754A common way around all these issues is to make sure that
3604C<start_new_request> I<always> returns before the callback is invoked. If 3755C<start_new_request> I<always> returns before the callback is invoked. If
3605C<start_new_request> immediately knows the result, it can artificially 3756C<start_new_request> immediately knows the result, it can artificially
3606delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher 3757delay invoking the callback by using a C<prepare> or C<idle> watcher for
3607for example, or more sneakily, by reusing an existing (stopped) watcher 3758example, or more sneakily, by reusing an existing (stopped) watcher and
3608and pushing it into the pending queue: 3759pushing it into the pending queue:
3609 3760
3610 ev_set_cb (watcher, callback); 3761 ev_set_cb (watcher, callback);
3611 ev_feed_event (EV_A_ watcher, 0); 3762 ev_feed_event (EV_A_ watcher, 0);
3612 3763
3613This way, C<start_new_request> can safely return before the callback is 3764This way, C<start_new_request> can safely return before the callback is
3621 3772
3622This brings the problem of exiting - a callback might want to finish the 3773This brings the problem of exiting - a callback might want to finish the
3623main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but 3774main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3624a modal "Are you sure?" dialog is still waiting), or just the nested one 3775a modal "Are you sure?" dialog is still waiting), or just the nested one
3625and not the main one (e.g. user clocked "Ok" in a modal dialog), or some 3776and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3626other combination: In these cases, C<ev_break> will not work alone. 3777other combination: In these cases, a simple C<ev_break> will not work.
3627 3778
3628The solution is to maintain "break this loop" variable for each C<ev_run> 3779The solution is to maintain "break this loop" variable for each C<ev_run>
3629invocation, and use a loop around C<ev_run> until the condition is 3780invocation, and use a loop around C<ev_run> until the condition is
3630triggered, using C<EVRUN_ONCE>: 3781triggered, using C<EVRUN_ONCE>:
3631 3782
3633 int exit_main_loop = 0; 3784 int exit_main_loop = 0;
3634 3785
3635 while (!exit_main_loop) 3786 while (!exit_main_loop)
3636 ev_run (EV_DEFAULT_ EVRUN_ONCE); 3787 ev_run (EV_DEFAULT_ EVRUN_ONCE);
3637 3788
3638 // in a model watcher 3789 // in a modal watcher
3639 int exit_nested_loop = 0; 3790 int exit_nested_loop = 0;
3640 3791
3641 while (!exit_nested_loop) 3792 while (!exit_nested_loop)
3642 ev_run (EV_A_ EVRUN_ONCE); 3793 ev_run (EV_A_ EVRUN_ONCE);
3643 3794
3817called): 3968called):
3818 3969
3819 void 3970 void
3820 wait_for_event (ev_watcher *w) 3971 wait_for_event (ev_watcher *w)
3821 { 3972 {
3822 ev_cb_set (w) = current_coro; 3973 ev_set_cb (w, current_coro);
3823 switch_to (libev_coro); 3974 switch_to (libev_coro);
3824 } 3975 }
3825 3976
3826That basically suspends the coroutine inside C<wait_for_event> and 3977That basically suspends the coroutine inside C<wait_for_event> and
3827continues the libev coroutine, which, when appropriate, switches back to 3978continues the libev coroutine, which, when appropriate, switches back to
3828this or any other coroutine. I am sure if you sue this your own :) 3979this or any other coroutine.
3829 3980
3830You can do similar tricks if you have, say, threads with an event queue - 3981You can do similar tricks if you have, say, threads with an event queue -
3831instead of storing a coroutine, you store the queue object and instead of 3982instead of storing a coroutine, you store the queue object and instead of
3832switching to a coroutine, you push the watcher onto the queue and notify 3983switching to a coroutine, you push the watcher onto the queue and notify
3833any waiters. 3984any waiters.
3834 3985
3835To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 3986To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3836files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 3987files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3837 3988
3838 // my_ev.h 3989 // my_ev.h
3839 #define EV_CB_DECLARE(type) struct my_coro *cb; 3990 #define EV_CB_DECLARE(type) struct my_coro *cb;
3840 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 3991 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3841 #include "../libev/ev.h" 3992 #include "../libev/ev.h"
3842 3993
3843 // my_ev.c 3994 // my_ev.c
3844 #define EV_H "my_ev.h" 3995 #define EV_H "my_ev.h"
3845 #include "../libev/ev.c" 3996 #include "../libev/ev.c"
3884 4035
3885=back 4036=back
3886 4037
3887=head1 C++ SUPPORT 4038=head1 C++ SUPPORT
3888 4039
4040=head2 C API
4041
4042The normal C API should work fine when used from C++: both ev.h and the
4043libev sources can be compiled as C++. Therefore, code that uses the C API
4044will work fine.
4045
4046Proper exception specifications might have to be added to callbacks passed
4047to libev: exceptions may be thrown only from watcher callbacks, all other
4048callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4049callbacks) must not throw exceptions, and might need a C<noexcept>
4050specification. If you have code that needs to be compiled as both C and
4051C++ you can use the C<EV_NOEXCEPT> macro for this:
4052
4053 static void
4054 fatal_error (const char *msg) EV_NOEXCEPT
4055 {
4056 perror (msg);
4057 abort ();
4058 }
4059
4060 ...
4061 ev_set_syserr_cb (fatal_error);
4062
4063The only API functions that can currently throw exceptions are C<ev_run>,
4064C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
4065because it runs cleanup watchers).
4066
4067Throwing exceptions in watcher callbacks is only supported if libev itself
4068is compiled with a C++ compiler or your C and C++ environments allow
4069throwing exceptions through C libraries (most do).
4070
4071=head2 C++ API
4072
3889Libev comes with some simplistic wrapper classes for C++ that mainly allow 4073Libev comes with some simplistic wrapper classes for C++ that mainly allow
3890you to use some convenience methods to start/stop watchers and also change 4074you to use some convenience methods to start/stop watchers and also change
3891the callback model to a model using method callbacks on objects. 4075the callback model to a model using method callbacks on objects.
3892 4076
3893To use it, 4077To use it,
3894 4078
3895 #include <ev++.h> 4079 #include <ev++.h>
3896 4080
3897This automatically includes F<ev.h> and puts all of its definitions (many 4081This automatically includes F<ev.h> and puts all of its definitions (many
3898of them macros) into the global namespace. All C++ specific things are 4082of them macros) into the global namespace. All C++ specific things are
3899put into the C<ev> namespace. It should support all the same embedding 4083put into the C<ev> namespace. It should support all the same embedding
3908with C<operator ()> can be used as callbacks. Other types should be easy 4092with C<operator ()> can be used as callbacks. Other types should be easy
3909to add as long as they only need one additional pointer for context. If 4093to add as long as they only need one additional pointer for context. If
3910you need support for other types of functors please contact the author 4094you need support for other types of functors please contact the author
3911(preferably after implementing it). 4095(preferably after implementing it).
3912 4096
4097For all this to work, your C++ compiler either has to use the same calling
4098conventions as your C compiler (for static member functions), or you have
4099to embed libev and compile libev itself as C++.
4100
3913Here is a list of things available in the C<ev> namespace: 4101Here is a list of things available in the C<ev> namespace:
3914 4102
3915=over 4 4103=over 4
3916 4104
3917=item C<ev::READ>, C<ev::WRITE> etc. 4105=item C<ev::READ>, C<ev::WRITE> etc.
3926=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. 4114=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3927 4115
3928For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of 4116For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3929the same name in the C<ev> namespace, with the exception of C<ev_signal> 4117the same name in the C<ev> namespace, with the exception of C<ev_signal>
3930which is called C<ev::sig> to avoid clashes with the C<signal> macro 4118which is called C<ev::sig> to avoid clashes with the C<signal> macro
3931defines by many implementations. 4119defined by many implementations.
3932 4120
3933All of those classes have these methods: 4121All of those classes have these methods:
3934 4122
3935=over 4 4123=over 4
3936 4124
3998 void operator() (ev::io &w, int revents) 4186 void operator() (ev::io &w, int revents)
3999 { 4187 {
4000 ... 4188 ...
4001 } 4189 }
4002 } 4190 }
4003 4191
4004 myfunctor f; 4192 myfunctor f;
4005 4193
4006 ev::io w; 4194 ev::io w;
4007 w.set (&f); 4195 w.set (&f);
4008 4196
4026Associates a different C<struct ev_loop> with this watcher. You can only 4214Associates a different C<struct ev_loop> with this watcher. You can only
4027do this when the watcher is inactive (and not pending either). 4215do this when the watcher is inactive (and not pending either).
4028 4216
4029=item w->set ([arguments]) 4217=item w->set ([arguments])
4030 4218
4031Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4219Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
4032method or a suitable start method must be called at least once. Unlike the 4220with the same arguments. Either this method or a suitable start method
4033C counterpart, an active watcher gets automatically stopped and restarted 4221must be called at least once. Unlike the C counterpart, an active watcher
4034when reconfiguring it with this method. 4222gets automatically stopped and restarted when reconfiguring it with this
4223method.
4224
4225For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4226clashing with the C<set (loop)> method.
4035 4227
4036=item w->start () 4228=item w->start ()
4037 4229
4038Starts the watcher. Note that there is no C<loop> argument, as the 4230Starts the watcher. Note that there is no C<loop> argument, as the
4039constructor already stores the event loop. 4231constructor already stores the event loop.
4143 4335
4144Brian Maher has written a partial interface to libev for lua (at the 4336Brian Maher has written a partial interface to libev for lua (at the
4145time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4337time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4146L<http://github.com/brimworks/lua-ev>. 4338L<http://github.com/brimworks/lua-ev>.
4147 4339
4340=item Javascript
4341
4342Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4343
4344=item Others
4345
4346There are others, and I stopped counting.
4347
4148=back 4348=back
4149 4349
4150 4350
4151=head1 MACRO MAGIC 4351=head1 MACRO MAGIC
4152 4352
4269 ev_vars.h 4469 ev_vars.h
4270 ev_wrap.h 4470 ev_wrap.h
4271 4471
4272 ev_win32.c required on win32 platforms only 4472 ev_win32.c required on win32 platforms only
4273 4473
4274 ev_select.c only when select backend is enabled (which is enabled by default) 4474 ev_select.c only when select backend is enabled
4275 ev_poll.c only when poll backend is enabled (disabled by default) 4475 ev_poll.c only when poll backend is enabled
4276 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4476 ev_epoll.c only when the epoll backend is enabled
4477 ev_linuxaio.c only when the linux aio backend is enabled
4277 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4478 ev_kqueue.c only when the kqueue backend is enabled
4278 ev_port.c only when the solaris port backend is enabled (disabled by default) 4479 ev_port.c only when the solaris port backend is enabled
4279 4480
4280F<ev.c> includes the backend files directly when enabled, so you only need 4481F<ev.c> includes the backend files directly when enabled, so you only need
4281to compile this single file. 4482to compile this single file.
4282 4483
4283=head3 LIBEVENT COMPATIBILITY API 4484=head3 LIBEVENT COMPATIBILITY API
4451If programs implement their own fd to handle mapping on win32, then this 4652If programs implement their own fd to handle mapping on win32, then this
4452macro can be used to override the C<close> function, useful to unregister 4653macro can be used to override the C<close> function, useful to unregister
4453file descriptors again. Note that the replacement function has to close 4654file descriptors again. Note that the replacement function has to close
4454the underlying OS handle. 4655the underlying OS handle.
4455 4656
4657=item EV_USE_WSASOCKET
4658
4659If defined to be C<1>, libev will use C<WSASocket> to create its internal
4660communication socket, which works better in some environments. Otherwise,
4661the normal C<socket> function will be used, which works better in other
4662environments.
4663
4456=item EV_USE_POLL 4664=item EV_USE_POLL
4457 4665
4458If defined to be C<1>, libev will compile in support for the C<poll>(2) 4666If defined to be C<1>, libev will compile in support for the C<poll>(2)
4459backend. Otherwise it will be enabled on non-win32 platforms. It 4667backend. Otherwise it will be enabled on non-win32 platforms. It
4460takes precedence over select. 4668takes precedence over select.
4464If defined to be C<1>, libev will compile in support for the Linux 4672If defined to be C<1>, libev will compile in support for the Linux
4465C<epoll>(7) backend. Its availability will be detected at runtime, 4673C<epoll>(7) backend. Its availability will be detected at runtime,
4466otherwise another method will be used as fallback. This is the preferred 4674otherwise another method will be used as fallback. This is the preferred
4467backend for GNU/Linux systems. If undefined, it will be enabled if the 4675backend for GNU/Linux systems. If undefined, it will be enabled if the
4468headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4676headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4677
4678=item EV_USE_LINUXAIO
4679
4680If defined to be C<1>, libev will compile in support for the Linux
4681aio backend. Due to it's currenbt limitations it has to be requested
4682explicitly. If undefined, it will be enabled on linux, otherwise
4683disabled.
4469 4684
4470=item EV_USE_KQUEUE 4685=item EV_USE_KQUEUE
4471 4686
4472If defined to be C<1>, libev will compile in support for the BSD style 4687If defined to be C<1>, libev will compile in support for the BSD style
4473C<kqueue>(2) backend. Its actual availability will be detected at runtime, 4688C<kqueue>(2) backend. Its actual availability will be detected at runtime,
4495If defined to be C<1>, libev will compile in support for the Linux inotify 4710If defined to be C<1>, libev will compile in support for the Linux inotify
4496interface to speed up C<ev_stat> watchers. Its actual availability will 4711interface to speed up C<ev_stat> watchers. Its actual availability will
4497be detected at runtime. If undefined, it will be enabled if the headers 4712be detected at runtime. If undefined, it will be enabled if the headers
4498indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4713indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4499 4714
4715=item EV_NO_SMP
4716
4717If defined to be C<1>, libev will assume that memory is always coherent
4718between threads, that is, threads can be used, but threads never run on
4719different cpus (or different cpu cores). This reduces dependencies
4720and makes libev faster.
4721
4722=item EV_NO_THREADS
4723
4724If defined to be C<1>, libev will assume that it will never be called from
4725different threads (that includes signal handlers), which is a stronger
4726assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4727libev faster.
4728
4500=item EV_ATOMIC_T 4729=item EV_ATOMIC_T
4501 4730
4502Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4731Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4503access is atomic and serialised with respect to other threads or signal 4732access is atomic with respect to other threads or signal contexts. No
4504contexts. No such type is easily found in the C language, so you can 4733such type is easily found in the C language, so you can provide your own
4505provide your own type that you know is safe for your purposes. It is used 4734type that you know is safe for your purposes. It is used both for signal
4506both for signal handler "locking" as well as for signal and thread safety 4735handler "locking" as well as for signal and thread safety in C<ev_async>
4507in C<ev_async> watchers. 4736watchers.
4508 4737
4509In the absence of this define, libev will use C<sig_atomic_t volatile> 4738In the absence of this define, libev will use C<sig_atomic_t volatile>
4510(from F<signal.h>), which is usually good enough on most platforms, 4739(from F<signal.h>), which is usually good enough on most platforms.
4511although strictly speaking using a type that also implies a memory fence
4512is required.
4513 4740
4514=item EV_H (h) 4741=item EV_H (h)
4515 4742
4516The name of the F<ev.h> header file used to include it. The default if 4743The name of the F<ev.h> header file used to include it. The default if
4517undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 4744undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
4590 #define EV_USE_POLL 1 4817 #define EV_USE_POLL 1
4591 #define EV_CHILD_ENABLE 1 4818 #define EV_CHILD_ENABLE 1
4592 #define EV_ASYNC_ENABLE 1 4819 #define EV_ASYNC_ENABLE 1
4593 4820
4594The actual value is a bitset, it can be a combination of the following 4821The actual value is a bitset, it can be a combination of the following
4595values: 4822values (by default, all of these are enabled):
4596 4823
4597=over 4 4824=over 4
4598 4825
4599=item C<1> - faster/larger code 4826=item C<1> - faster/larger code
4600 4827
4604code size by roughly 30% on amd64). 4831code size by roughly 30% on amd64).
4605 4832
4606When optimising for size, use of compiler flags such as C<-Os> with 4833When optimising for size, use of compiler flags such as C<-Os> with
4607gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of 4834gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4608assertions. 4835assertions.
4836
4837The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4838(e.g. gcc with C<-Os>).
4609 4839
4610=item C<2> - faster/larger data structures 4840=item C<2> - faster/larger data structures
4611 4841
4612Replaces the small 2-heap for timer management by a faster 4-heap, larger 4842Replaces the small 2-heap for timer management by a faster 4-heap, larger
4613hash table sizes and so on. This will usually further increase code size 4843hash table sizes and so on. This will usually further increase code size
4614and can additionally have an effect on the size of data structures at 4844and can additionally have an effect on the size of data structures at
4615runtime. 4845runtime.
4846
4847The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4848(e.g. gcc with C<-Os>).
4616 4849
4617=item C<4> - full API configuration 4850=item C<4> - full API configuration
4618 4851
4619This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and 4852This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4620enables multiplicity (C<EV_MULTIPLICITY>=1). 4853enables multiplicity (C<EV_MULTIPLICITY>=1).
4662when you embed libev, only want to use libev functions in a single file, 4895when you embed libev, only want to use libev functions in a single file,
4663and do not want its identifiers to be visible. 4896and do not want its identifiers to be visible.
4664 4897
4665To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that 4898To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
4666wants to use libev. 4899wants to use libev.
4900
4901This option only works when libev is compiled with a C compiler, as C++
4902doesn't support the required declaration syntax.
4667 4903
4668=item EV_AVOID_STDIO 4904=item EV_AVOID_STDIO
4669 4905
4670If this is set to C<1> at compiletime, then libev will avoid using stdio 4906If this is set to C<1> at compiletime, then libev will avoid using stdio
4671functions (printf, scanf, perror etc.). This will increase the code size 4907functions (printf, scanf, perror etc.). This will increase the code size
4876default loop and triggering an C<ev_async> watcher from the default loop 5112default loop and triggering an C<ev_async> watcher from the default loop
4877watcher callback into the event loop interested in the signal. 5113watcher callback into the event loop interested in the signal.
4878 5114
4879=back 5115=back
4880 5116
4881See also L<THREAD LOCKING EXAMPLE>. 5117See also L</THREAD LOCKING EXAMPLE>.
4882 5118
4883=head3 COROUTINES 5119=head3 COROUTINES
4884 5120
4885Libev is very accommodating to coroutines ("cooperative threads"): 5121Libev is very accommodating to coroutines ("cooperative threads"):
4886libev fully supports nesting calls to its functions from different 5122libev fully supports nesting calls to its functions from different
5155structure (guaranteed by POSIX but not by ISO C for example), but it also 5391structure (guaranteed by POSIX but not by ISO C for example), but it also
5156assumes that the same (machine) code can be used to call any watcher 5392assumes that the same (machine) code can be used to call any watcher
5157callback: The watcher callbacks have different type signatures, but libev 5393callback: The watcher callbacks have different type signatures, but libev
5158calls them using an C<ev_watcher *> internally. 5394calls them using an C<ev_watcher *> internally.
5159 5395
5396=item null pointers and integer zero are represented by 0 bytes
5397
5398Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
5399relies on this setting pointers and integers to null.
5400
5160=item pointer accesses must be thread-atomic 5401=item pointer accesses must be thread-atomic
5161 5402
5162Accessing a pointer value must be atomic, it must both be readable and 5403Accessing a pointer value must be atomic, it must both be readable and
5163writable in one piece - this is the case on all current architectures. 5404writable in one piece - this is the case on all current architectures.
5164 5405
5177thread" or will block signals process-wide, both behaviours would 5418thread" or will block signals process-wide, both behaviours would
5178be compatible with libev. Interaction between C<sigprocmask> and 5419be compatible with libev. Interaction between C<sigprocmask> and
5179C<pthread_sigmask> could complicate things, however. 5420C<pthread_sigmask> could complicate things, however.
5180 5421
5181The most portable way to handle signals is to block signals in all threads 5422The most portable way to handle signals is to block signals in all threads
5182except the initial one, and run the default loop in the initial thread as 5423except the initial one, and run the signal handling loop in the initial
5183well. 5424thread as well.
5184 5425
5185=item C<long> must be large enough for common memory allocation sizes 5426=item C<long> must be large enough for common memory allocation sizes
5186 5427
5187To improve portability and simplify its API, libev uses C<long> internally 5428To improve portability and simplify its API, libev uses C<long> internally
5188instead of C<size_t> when allocating its data structures. On non-POSIX 5429instead of C<size_t> when allocating its data structures. On non-POSIX
5292=over 4 5533=over 4
5293 5534
5294=item C<EV_COMPAT3> backwards compatibility mechanism 5535=item C<EV_COMPAT3> backwards compatibility mechanism
5295 5536
5296The backward compatibility mechanism can be controlled by 5537The backward compatibility mechanism can be controlled by
5297C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5538C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5298section. 5539section.
5299 5540
5300=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5541=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5301 5542
5302These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5543These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5345=over 4 5586=over 4
5346 5587
5347=item active 5588=item active
5348 5589
5349A watcher is active as long as it has been started and not yet stopped. 5590A watcher is active as long as it has been started and not yet stopped.
5350See L<WATCHER STATES> for details. 5591See L</WATCHER STATES> for details.
5351 5592
5352=item application 5593=item application
5353 5594
5354In this document, an application is whatever is using libev. 5595In this document, an application is whatever is using libev.
5355 5596
5391watchers and events. 5632watchers and events.
5392 5633
5393=item pending 5634=item pending
5394 5635
5395A watcher is pending as soon as the corresponding event has been 5636A watcher is pending as soon as the corresponding event has been
5396detected. See L<WATCHER STATES> for details. 5637detected. See L</WATCHER STATES> for details.
5397 5638
5398=item real time 5639=item real time
5399 5640
5400The physical time that is observed. It is apparently strictly monotonic :) 5641The physical time that is observed. It is apparently strictly monotonic :)
5401 5642

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines