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

Comparing libev/ev.pod (file contents):
Revision 1.403 by sf-exg, Wed Apr 18 06:56:53 2012 UTC vs.
Revision 1.459 by root, Wed Jan 22 01:50:42 2020 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
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)
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>
451unblocking the signals. 480unblocking the signals.
452 481
453It's also required by POSIX in a threaded program, as libev calls 482It's also required by POSIX in a threaded program, as libev calls
454C<sigprocmask>, whose behaviour is officially unspecified. 483C<sigprocmask>, whose behaviour is officially unspecified.
455 484
456This flag's behaviour will become the default in future versions of libev. 485=item C<EVFLAG_NOTIMERFD>
486
487When this flag is specified, the libev will avoid using a C<timerfd> to
488detect time jumps. It will still be able to detect time jumps, but takes
489longer and has a lower accuracy in doing so, but saves a file descriptor
490per loop.
491
492The current implementation only tries to use a C<timerfd> when the first
493C<ev_periodic> watcher is started and falls back on other methods if it
494cannot be created, but this behaviour might change in the future.
457 495
458=item C<EVBACKEND_SELECT> (value 1, portable select backend) 496=item C<EVBACKEND_SELECT> (value 1, portable select backend)
459 497
460This is your standard select(2) backend. Not I<completely> standard, as 498This is your standard select(2) backend. Not I<completely> standard, as
461libev tries to roll its own fd_set with no limits on the number of fds, 499libev tries to roll its own fd_set with no limits on the number of fds,
486This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and 524This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
487C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. 525C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
488 526
489=item C<EVBACKEND_EPOLL> (value 4, Linux) 527=item C<EVBACKEND_EPOLL> (value 4, Linux)
490 528
491Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 529Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9
492kernels). 530kernels).
493 531
494For few fds, this backend is a bit little slower than poll and select, but 532For few fds, this backend is a bit little slower than poll and select, but
495it scales phenomenally better. While poll and select usually scale like 533it 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 534O(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 580All 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 581faster than epoll for maybe up to a hundred file descriptors, depending on
544the usage. So sad. 582the usage. So sad.
545 583
546While nominally embeddable in other event loops, this feature is broken in 584While nominally embeddable in other event loops, this feature is broken in
547all kernel versions tested so far. 585a lot of kernel revisions, but probably(!) works in current versions.
548 586
549This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 587This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
550C<EVBACKEND_POLL>. 588C<EVBACKEND_POLL>.
551 589
590=item C<EVBACKEND_LINUXAIO> (value 64, Linux)
591
592Use the Linux-specific Linux AIO (I<not> C<< aio(7) >> but C<<
593io_submit(2) >>) event interface available in post-4.18 kernels (but libev
594only tries to use it in 4.19+).
595
596This is another Linux train wreck of an event interface.
597
598If this backend works for you (as of this writing, it was very
599experimental), it is the best event interface available on Linux and might
600be well worth enabling it - if it isn't available in your kernel this will
601be detected and this backend will be skipped.
602
603This backend can batch oneshot requests and supports a user-space ring
604buffer to receive events. It also doesn't suffer from most of the design
605problems of epoll (such as not being able to remove event sources from
606the epoll set), and generally sounds too good to be true. Because, this
607being the Linux kernel, of course it suffers from a whole new set of
608limitations, forcing you to fall back to epoll, inheriting all its design
609issues.
610
611For one, it is not easily embeddable (but probably could be done using
612an event fd at some extra overhead). It also is subject to a system wide
613limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no AIO
614requests are left, this backend will be skipped during initialisation, and
615will switch to epoll when the loop is active.
616
617Most problematic in practice, however, is that not all file descriptors
618work with it. For example, in Linux 5.1, TCP sockets, pipes, event fds,
619files, F</dev/null> and many others are supported, but ttys do not work
620properly (a known bug that the kernel developers don't care about, see
621L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
622(yet?) a generic event polling interface.
623
624Overall, it seems the Linux developers just don't want it to have a
625generic event handling mechanism other than C<select> or C<poll>.
626
627To work around all these problem, the current version of libev uses its
628epoll backend as a fallback for file descriptor types that do not work. Or
629falls back completely to epoll if the kernel acts up.
630
631This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
632C<EVBACKEND_POLL>.
633
552=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 634=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
553 635
554Kqueue deserves special mention, as at the time of this writing, it 636Kqueue deserves special mention, as at the time this backend was
555was broken on all BSDs except NetBSD (usually it doesn't work reliably 637implemented, it was broken on all BSDs except NetBSD (usually it doesn't
556with anything but sockets and pipes, except on Darwin, where of course 638work reliably with anything but sockets and pipes, except on Darwin,
557it's completely useless). Unlike epoll, however, whose brokenness 639where of course it's completely useless). Unlike epoll, however, whose
558is by design, these kqueue bugs can (and eventually will) be fixed 640brokenness 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 641fixed 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 642being "auto-detected" on all platforms unless you explicitly specify it
561C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) 643in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a
562system like NetBSD. 644known-to-be-good (-enough) system like NetBSD.
563 645
564You still can embed kqueue into a normal poll or select backend and use it 646You still can embed kqueue into a normal poll or select backend and use it
565only for sockets (after having made sure that sockets work with kqueue on 647only for sockets (after having made sure that sockets work with kqueue on
566the target platform). See C<ev_embed> watchers for more info. 648the target platform). See C<ev_embed> watchers for more info.
567 649
568It scales in the same way as the epoll backend, but the interface to the 650It scales in the same way as the epoll backend, but the interface to the
569kernel is more efficient (which says nothing about its actual speed, of 651kernel is more efficient (which says nothing about its actual speed, of
570course). While stopping, setting and starting an I/O watcher does never 652course). 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 653cause 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 (you 654two event changes per incident. Support for C<fork ()> is very bad (you
573might have to leak fd's on fork, but it's more sane than epoll) and it 655might have to leak fds on fork, but it's more sane than epoll) and it
574drops fds silently in similarly hard-to-detect cases 656drops fds silently in similarly hard-to-detect cases.
575 657
576This backend usually performs well under most conditions. 658This backend usually performs well under most conditions.
577 659
578While nominally embeddable in other event loops, this doesn't work 660While nominally embeddable in other event loops, this doesn't work
579everywhere, so you might need to test for this. And since it is broken 661everywhere, so you might need to test for this. And since it is broken
653Example: Use whatever libev has to offer, but make sure that kqueue is 735Example: Use whatever libev has to offer, but make sure that kqueue is
654used if available. 736used if available.
655 737
656 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 738 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
657 739
740Example: Similarly, on linux, you mgiht want to take advantage of the
741linux aio backend if possible, but fall back to something else if that
742isn't available.
743
744 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
745
658=item ev_loop_destroy (loop) 746=item ev_loop_destroy (loop)
659 747
660Destroys an event loop object (frees all memory and kernel state 748Destroys an event loop object (frees all memory and kernel state
661etc.). None of the active event watchers will be stopped in the normal 749etc.). None of the active event watchers will be stopped in the normal
662sense, so e.g. C<ev_is_active> might still return true. It is your 750sense, 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> 766If you need dynamically allocated loops it is better to use C<ev_loop_new>
679and C<ev_loop_destroy>. 767and C<ev_loop_destroy>.
680 768
681=item ev_loop_fork (loop) 769=item ev_loop_fork (loop)
682 770
683This function sets a flag that causes subsequent C<ev_run> iterations to 771This function sets a flag that causes subsequent C<ev_run> iterations
684reinitialise the kernel state for backends that have one. Despite the 772to reinitialise the kernel state for backends that have one. Despite
685name, you can call it anytime, but it makes most sense after forking, in 773the name, you can call it anytime you are allowed to start or stop
686the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the 774watchers (except inside an C<ev_prepare> callback), but it makes most
775sense after forking, in the child process. You I<must> call it (or use
687child before resuming or calling C<ev_run>. 776C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
688 777
778In addition, if you want to reuse a loop (via this function or
779C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>.
780
689Again, you I<have> to call it on I<any> loop that you want to re-use after 781Again, you I<have> to call it on I<any> loop that you want to re-use after
690a fork, I<even if you do not plan to use the loop in the parent>. This is 782a fork, I<even if you do not plan to use the loop in the parent>. This is
691because some kernel interfaces *cough* I<kqueue> *cough* do funny things 783because some kernel interfaces *cough* I<kqueue> *cough* do funny things
692during fork. 784during fork.
693 785
694On the other hand, you only need to call this function in the child 786On the other hand, you only need to call this function in the child
764 856
765This function is rarely useful, but when some event callback runs for a 857This function is rarely useful, but when some event callback runs for a
766very long time without entering the event loop, updating libev's idea of 858very long time without entering the event loop, updating libev's idea of
767the current time is a good idea. 859the current time is a good idea.
768 860
769See also L<The special problem of time updates> in the C<ev_timer> section. 861See also L</The special problem of time updates> in the C<ev_timer> section.
770 862
771=item ev_suspend (loop) 863=item ev_suspend (loop)
772 864
773=item ev_resume (loop) 865=item ev_resume (loop)
774 866
1174 1266
1175=item C<EV_PREPARE> 1267=item C<EV_PREPARE>
1176 1268
1177=item C<EV_CHECK> 1269=item C<EV_CHECK>
1178 1270
1179All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts 1271All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1180to gather new events, and all C<ev_check> watchers are invoked just after 1272gather new events, and all C<ev_check> watchers are queued (not invoked)
1181C<ev_run> has gathered them, but before it invokes any callbacks for any 1273just after C<ev_run> has gathered them, but before it queues any callbacks
1274for any received events. That means C<ev_prepare> watchers are the last
1275watchers invoked before the event loop sleeps or polls for new events, and
1276C<ev_check> watchers will be invoked before any other watchers of the same
1277or lower priority within an event loop iteration.
1278
1182received events. Callbacks of both watcher types can start and stop as 1279Callbacks of both watcher types can start and stop as many watchers as
1183many watchers as they want, and all of them will be taken into account 1280they want, and all of them will be taken into account (for example, a
1184(for example, a C<ev_prepare> watcher might start an idle watcher to keep 1281C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1185C<ev_run> from blocking). 1282blocking).
1186 1283
1187=item C<EV_EMBED> 1284=item C<EV_EMBED>
1188 1285
1189The embedded event loop specified in the C<ev_embed> watcher needs attention. 1286The embedded event loop specified in the C<ev_embed> watcher needs attention.
1190 1287
1313 1410
1314=item callback ev_cb (ev_TYPE *watcher) 1411=item callback ev_cb (ev_TYPE *watcher)
1315 1412
1316Returns the callback currently set on the watcher. 1413Returns the callback currently set on the watcher.
1317 1414
1318=item ev_cb_set (ev_TYPE *watcher, callback) 1415=item ev_set_cb (ev_TYPE *watcher, callback)
1319 1416
1320Change the callback. You can change the callback at virtually any time 1417Change the callback. You can change the callback at virtually any time
1321(modulo threads). 1418(modulo threads).
1322 1419
1323=item ev_set_priority (ev_TYPE *watcher, int priority) 1420=item ev_set_priority (ev_TYPE *watcher, int priority)
1341or might not have been clamped to the valid range. 1438or might not have been clamped to the valid range.
1342 1439
1343The default priority used by watchers when no priority has been set is 1440The default priority used by watchers when no priority has been set is
1344always C<0>, which is supposed to not be too high and not be too low :). 1441always C<0>, which is supposed to not be too high and not be too low :).
1345 1442
1346See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1443See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1347priorities. 1444priorities.
1348 1445
1349=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1446=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1350 1447
1351Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1448Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1376See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related 1473See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1377functions that do not need a watcher. 1474functions that do not need a watcher.
1378 1475
1379=back 1476=back
1380 1477
1381See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1478See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1382OWN COMPOSITE WATCHERS> idioms. 1479OWN COMPOSITE WATCHERS> idioms.
1383 1480
1384=head2 WATCHER STATES 1481=head2 WATCHER STATES
1385 1482
1386There are various watcher states mentioned throughout this manual - 1483There are various watcher states mentioned throughout this manual -
1388transition between them will be described in more detail - and while these 1485transition between them will be described in more detail - and while these
1389rules might look complicated, they usually do "the right thing". 1486rules might look complicated, they usually do "the right thing".
1390 1487
1391=over 4 1488=over 4
1392 1489
1393=item initialiased 1490=item initialised
1394 1491
1395Before a watcher can be registered with the event loop it has to be 1492Before a watcher can be registered with the event loop it has to be
1396initialised. This can be done with a call to C<ev_TYPE_init>, or calls to 1493initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1397C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. 1494C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1398 1495
1447 1544
1448Many event loops support I<watcher priorities>, which are usually small 1545Many event loops support I<watcher priorities>, which are usually small
1449integers that influence the ordering of event callback invocation 1546integers that influence the ordering of event callback invocation
1450between watchers in some way, all else being equal. 1547between watchers in some way, all else being equal.
1451 1548
1452In libev, Watcher priorities can be set using C<ev_set_priority>. See its 1549In libev, watcher priorities can be set using C<ev_set_priority>. See its
1453description for the more technical details such as the actual priority 1550description for the more technical details such as the actual priority
1454range. 1551range.
1455 1552
1456There are two common ways how these these priorities are being interpreted 1553There are two common ways how these these priorities are being interpreted
1457by event loops: 1554by event loops:
1551 1648
1552This section describes each watcher in detail, but will not repeat 1649This section describes each watcher in detail, but will not repeat
1553information given in the last section. Any initialisation/set macros, 1650information given in the last section. Any initialisation/set macros,
1554functions and members specific to the watcher type are explained. 1651functions and members specific to the watcher type are explained.
1555 1652
1556Members are additionally marked with either I<[read-only]>, meaning that, 1653Most members are additionally marked with either I<[read-only]>, meaning
1557while the watcher is active, you can look at the member and expect some 1654that, while the watcher is active, you can look at the member and expect
1558sensible content, but you must not modify it (you can modify it while the 1655some sensible content, but you must not modify it (you can modify it while
1559watcher is stopped to your hearts content), or I<[read-write]>, which 1656the watcher is stopped to your hearts content), or I<[read-write]>, which
1560means you can expect it to have some sensible content while the watcher 1657means you can expect it to have some sensible content while the watcher
1561is active, but you can also modify it. Modifying it may not do something 1658is active, but you can also modify it. Modifying it may not do something
1562sensible or take immediate effect (or do anything at all), but libev will 1659sensible or take immediate effect (or do anything at all), but libev will
1563not crash or malfunction in any way. 1660not crash or malfunction in any way.
1564 1661
1662In any case, the documentation for each member will explain what the
1663effects are, and if there are any additional access restrictions.
1565 1664
1566=head2 C<ev_io> - is this file descriptor readable or writable? 1665=head2 C<ev_io> - is this file descriptor readable or writable?
1567 1666
1568I/O watchers check whether a file descriptor is readable or writable 1667I/O watchers check whether a file descriptor is readable or writable
1569in each iteration of the event loop, or, more precisely, when reading 1668in each iteration of the event loop, or, more precisely, when reading
1596 1695
1597But really, best use non-blocking mode. 1696But really, best use non-blocking mode.
1598 1697
1599=head3 The special problem of disappearing file descriptors 1698=head3 The special problem of disappearing file descriptors
1600 1699
1601Some backends (e.g. kqueue, epoll) need to be told about closing a file 1700Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1602descriptor (either due to calling C<close> explicitly or any other means, 1701a file descriptor (either due to calling C<close> explicitly or any other
1603such as C<dup2>). The reason is that you register interest in some file 1702means, such as C<dup2>). The reason is that you register interest in some
1604descriptor, but when it goes away, the operating system will silently drop 1703file descriptor, but when it goes away, the operating system will silently
1605this interest. If another file descriptor with the same number then is 1704drop this interest. If another file descriptor with the same number then
1606registered with libev, there is no efficient way to see that this is, in 1705is registered with libev, there is no efficient way to see that this is,
1607fact, a different file descriptor. 1706in fact, a different file descriptor.
1608 1707
1609To avoid having to explicitly tell libev about such cases, libev follows 1708To avoid having to explicitly tell libev about such cases, libev follows
1610the following policy: Each time C<ev_io_set> is being called, libev 1709the following policy: Each time C<ev_io_set> is being called, libev
1611will assume that this is potentially a new file descriptor, otherwise 1710will assume that this is potentially a new file descriptor, otherwise
1612it is assumed that the file descriptor stays the same. That means that 1711it is assumed that the file descriptor stays the same. That means that
1661when you rarely read from a file instead of from a socket, and want to 1760when you rarely read from a file instead of from a socket, and want to
1662reuse the same code path. 1761reuse the same code path.
1663 1762
1664=head3 The special problem of fork 1763=head3 The special problem of fork
1665 1764
1666Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1765Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()>
1667useless behaviour. Libev fully supports fork, but needs to be told about 1766at all or exhibit useless behaviour. Libev fully supports fork, but needs
1668it in the child if you want to continue to use it in the child. 1767to be told about it in the child if you want to continue to use it in the
1768child.
1669 1769
1670To support fork in your child processes, you have to call C<ev_loop_fork 1770To support fork in your child processes, you have to call C<ev_loop_fork
1671()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to 1771()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1672C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1772C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1673 1773
1731 1831
1732Configures an C<ev_io> watcher. The C<fd> is the file descriptor to 1832Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1733receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or 1833receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or
1734C<EV_READ | EV_WRITE>, to express the desire to receive the given events. 1834C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1735 1835
1736=item int fd [read-only] 1836=item ev_io_modify (ev_io *, int events)
1737 1837
1738The file descriptor being watched. 1838Similar to C<ev_io_set>, but only changes the event mask. Using this might
1839be faster with some backends, as libev can assume that the C<fd> still
1840refers to the same underlying file description, something it cannot do
1841when using C<ev_io_set>.
1739 1842
1843=item int fd [no-modify]
1844
1845The file descriptor being watched. While it can be read at any time, you
1846must not modify this member even when the watcher is stopped - always use
1847C<ev_io_set> for that.
1848
1740=item int events [read-only] 1849=item int events [no-modify]
1741 1850
1742The events being watched. 1851The set of events being watched, among other flags. This field is a
1852bit set - to test for C<EV_READ>, use C<< w->events & EV_READ >>, and
1853similarly for C<EV_WRITE>.
1854
1855As with C<fd>, you must not modify this member even when the watcher is
1856stopped, always use C<ev_io_set> or C<ev_io_modify> for that.
1743 1857
1744=back 1858=back
1745 1859
1746=head3 Examples 1860=head3 Examples
1747 1861
2019 2133
2020The relative timeouts are calculated relative to the C<ev_now ()> 2134The relative timeouts are calculated relative to the C<ev_now ()>
2021time. This is usually the right thing as this timestamp refers to the time 2135time. This is usually the right thing as this timestamp refers to the time
2022of the event triggering whatever timeout you are modifying/starting. If 2136of the event triggering whatever timeout you are modifying/starting. If
2023you suspect event processing to be delayed and you I<need> to base the 2137you suspect event processing to be delayed and you I<need> to base the
2024timeout on the current time, use something like this to adjust for this: 2138timeout on the current time, use something like the following to adjust
2139for it:
2025 2140
2026 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2141 ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
2027 2142
2028If the event loop is suspended for a long time, you can also force an 2143If the event loop is suspended for a long time, you can also force an
2029update of the time returned by C<ev_now ()> by calling C<ev_now_update 2144update of the time returned by C<ev_now ()> by calling C<ev_now_update
2030()>. 2145()>, although that will push the event time of all outstanding events
2146further into the future.
2031 2147
2032=head3 The special problem of unsynchronised clocks 2148=head3 The special problem of unsynchronised clocks
2033 2149
2034Modern systems have a variety of clocks - libev itself uses the normal 2150Modern systems have a variety of clocks - libev itself uses the normal
2035"wall clock" clock and, if available, the monotonic clock (to avoid time 2151"wall clock" clock and, if available, the monotonic clock (to avoid time
2098 2214
2099=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 2215=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
2100 2216
2101=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 2217=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
2102 2218
2103Configure the timer to trigger after C<after> seconds. If C<repeat> 2219Configure the timer to trigger after C<after> seconds (fractional and
2104is C<0.>, then it will automatically be stopped once the timeout is 2220negative values are supported). If C<repeat> is C<0.>, then it will
2105reached. If it is positive, then the timer will automatically be 2221automatically be stopped once the timeout is reached. If it is positive,
2106configured to trigger again C<repeat> seconds later, again, and again, 2222then the timer will automatically be configured to trigger again C<repeat>
2107until stopped manually. 2223seconds later, again, and again, until stopped manually.
2108 2224
2109The timer itself will do a best-effort at avoiding drift, that is, if 2225The timer itself will do a best-effort at avoiding drift, that is, if
2110you configure a timer to trigger every 10 seconds, then it will normally 2226you configure a timer to trigger every 10 seconds, then it will normally
2111trigger at exactly 10 second intervals. If, however, your program cannot 2227trigger at exactly 10 second intervals. If, however, your program cannot
2112keep up with the timer (because it takes longer than those 10 seconds to 2228keep up with the timer (because it takes longer than those 10 seconds to
2131=item If the timer is repeating, make the C<repeat> value the new timeout 2247=item If the timer is repeating, make the C<repeat> value the new timeout
2132and start the timer, if necessary. 2248and start the timer, if necessary.
2133 2249
2134=back 2250=back
2135 2251
2136This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2252This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2137usage example. 2253usage example.
2138 2254
2139=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2255=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2140 2256
2141Returns the remaining time until a timer fires. If the timer is active, 2257Returns the remaining time until a timer fires. If the timer is active,
2194Periodic watchers are also timers of a kind, but they are very versatile 2310Periodic watchers are also timers of a kind, but they are very versatile
2195(and unfortunately a bit complex). 2311(and unfortunately a bit complex).
2196 2312
2197Unlike C<ev_timer>, periodic watchers are not based on real time (or 2313Unlike C<ev_timer>, periodic watchers are not based on real time (or
2198relative time, the physical time that passes) but on wall clock time 2314relative time, the physical time that passes) but on wall clock time
2199(absolute time, the thing you can read on your calender or clock). The 2315(absolute time, the thing you can read on your calendar or clock). The
2200difference is that wall clock time can run faster or slower than real 2316difference is that wall clock time can run faster or slower than real
2201time, and time jumps are not uncommon (e.g. when you adjust your 2317time, and time jumps are not uncommon (e.g. when you adjust your
2202wrist-watch). 2318wrist-watch).
2203 2319
2204You can tell a periodic watcher to trigger after some specific point 2320You can tell a periodic watcher to trigger after some specific point
2209C<ev_timer>, which would still trigger roughly 10 seconds after starting 2325C<ev_timer>, which would still trigger roughly 10 seconds after starting
2210it, as it uses a relative timeout). 2326it, as it uses a relative timeout).
2211 2327
2212C<ev_periodic> watchers can also be used to implement vastly more complex 2328C<ev_periodic> watchers can also be used to implement vastly more complex
2213timers, such as triggering an event on each "midnight, local time", or 2329timers, such as triggering an event on each "midnight, local time", or
2214other complicated rules. This cannot be done with C<ev_timer> watchers, as 2330other complicated rules. This cannot easily be done with C<ev_timer>
2215those cannot react to time jumps. 2331watchers, as those cannot react to time jumps.
2216 2332
2217As with timers, the callback is guaranteed to be invoked only when the 2333As with timers, the callback is guaranteed to be invoked only when the
2218point in time where it is supposed to trigger has passed. If multiple 2334point in time where it is supposed to trigger has passed. If multiple
2219timers become ready during the same loop iteration then the ones with 2335timers become ready during the same loop iteration then the ones with
2220earlier time-out values are invoked before ones with later time-out values 2336earlier time-out values are invoked before ones with later time-out values
2306 2422
2307NOTE: I<< This callback must always return a time that is higher than or 2423NOTE: I<< This callback must always return a time that is higher than or
2308equal to the passed C<now> value >>. 2424equal to the passed C<now> value >>.
2309 2425
2310This can be used to create very complex timers, such as a timer that 2426This can be used to create very complex timers, such as a timer that
2311triggers on "next midnight, local time". To do this, you would calculate the 2427triggers on "next midnight, local time". To do this, you would calculate
2312next midnight after C<now> and return the timestamp value for this. How 2428the next midnight after C<now> and return the timestamp value for
2313you do this is, again, up to you (but it is not trivial, which is the main 2429this. Here is a (completely untested, no error checking) example on how to
2314reason I omitted it as an example). 2430do this:
2431
2432 #include <time.h>
2433
2434 static ev_tstamp
2435 my_rescheduler (ev_periodic *w, ev_tstamp now)
2436 {
2437 time_t tnow = (time_t)now;
2438 struct tm tm;
2439 localtime_r (&tnow, &tm);
2440
2441 tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2442 ++tm.tm_mday; // midnight next day
2443
2444 return mktime (&tm);
2445 }
2446
2447Note: this code might run into trouble on days that have more then two
2448midnights (beginning and end).
2315 2449
2316=back 2450=back
2317 2451
2318=item ev_periodic_again (loop, ev_periodic *) 2452=item ev_periodic_again (loop, ev_periodic *)
2319 2453
2384 2518
2385 ev_periodic hourly_tick; 2519 ev_periodic hourly_tick;
2386 ev_periodic_init (&hourly_tick, clock_cb, 2520 ev_periodic_init (&hourly_tick, clock_cb,
2387 fmod (ev_now (loop), 3600.), 3600., 0); 2521 fmod (ev_now (loop), 3600.), 3600., 0);
2388 ev_periodic_start (loop, &hourly_tick); 2522 ev_periodic_start (loop, &hourly_tick);
2389 2523
2390 2524
2391=head2 C<ev_signal> - signal me when a signal gets signalled! 2525=head2 C<ev_signal> - signal me when a signal gets signalled!
2392 2526
2393Signal watchers will trigger an event when the process receives a specific 2527Signal watchers will trigger an event when the process receives a specific
2394signal one or more times. Even though signals are very asynchronous, libev 2528signal one or more times. Even though signals are very asynchronous, libev
2404only within the same loop, i.e. you can watch for C<SIGINT> in your 2538only within the same loop, i.e. you can watch for C<SIGINT> in your
2405default loop and for C<SIGIO> in another loop, but you cannot watch for 2539default loop and for C<SIGIO> in another loop, but you cannot watch for
2406C<SIGINT> in both the default loop and another loop at the same time. At 2540C<SIGINT> in both the default loop and another loop at the same time. At
2407the moment, C<SIGCHLD> is permanently tied to the default loop. 2541the moment, C<SIGCHLD> is permanently tied to the default loop.
2408 2542
2409When the first watcher gets started will libev actually register something 2543Only after the first watcher for a signal is started will libev actually
2410with the kernel (thus it coexists with your own signal handlers as long as 2544register something with the kernel. It thus coexists with your own signal
2411you don't register any with libev for the same signal). 2545handlers as long as you don't register any with libev for the same signal.
2412 2546
2413If possible and supported, libev will install its handlers with 2547If possible and supported, libev will install its handlers with
2414C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2548C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2415not be unduly interrupted. If you have a problem with system calls getting 2549not be unduly interrupted. If you have a problem with system calls getting
2416interrupted by signals you can block all signals in an C<ev_check> watcher 2550interrupted by signals you can block all signals in an C<ev_check> watcher
2601 2735
2602=head2 C<ev_stat> - did the file attributes just change? 2736=head2 C<ev_stat> - did the file attributes just change?
2603 2737
2604This watches a file system path for attribute changes. That is, it calls 2738This watches a file system path for attribute changes. That is, it calls
2605C<stat> on that path in regular intervals (or when the OS says it changed) 2739C<stat> on that path in regular intervals (or when the OS says it changed)
2606and sees if it changed compared to the last time, invoking the callback if 2740and sees if it changed compared to the last time, invoking the callback
2607it did. 2741if it did. Starting the watcher C<stat>'s the file, so only changes that
2742happen after the watcher has been started will be reported.
2608 2743
2609The path does not need to exist: changing from "path exists" to "path does 2744The path does not need to exist: changing from "path exists" to "path does
2610not exist" is a status change like any other. The condition "path does not 2745not exist" is a status change like any other. The condition "path does not
2611exist" (or more correctly "path cannot be stat'ed") is signified by the 2746exist" (or more correctly "path cannot be stat'ed") is signified by the
2612C<st_nlink> field being zero (which is otherwise always forced to be at 2747C<st_nlink> field being zero (which is otherwise always forced to be at
2842Apart from keeping your process non-blocking (which is a useful 2977Apart from keeping your process non-blocking (which is a useful
2843effect on its own sometimes), idle watchers are a good place to do 2978effect on its own sometimes), idle watchers are a good place to do
2844"pseudo-background processing", or delay processing stuff to after the 2979"pseudo-background processing", or delay processing stuff to after the
2845event loop has handled all outstanding events. 2980event loop has handled all outstanding events.
2846 2981
2982=head3 Abusing an C<ev_idle> watcher for its side-effect
2983
2984As long as there is at least one active idle watcher, libev will never
2985sleep unnecessarily. Or in other words, it will loop as fast as possible.
2986For this to work, the idle watcher doesn't need to be invoked at all - the
2987lowest priority will do.
2988
2989This mode of operation can be useful together with an C<ev_check> watcher,
2990to do something on each event loop iteration - for example to balance load
2991between different connections.
2992
2993See L</Abusing an ev_check watcher for its side-effect> for a longer
2994example.
2995
2847=head3 Watcher-Specific Functions and Data Members 2996=head3 Watcher-Specific Functions and Data Members
2848 2997
2849=over 4 2998=over 4
2850 2999
2851=item ev_idle_init (ev_idle *, callback) 3000=item ev_idle_init (ev_idle *, callback)
2862callback, free it. Also, use no error checking, as usual. 3011callback, free it. Also, use no error checking, as usual.
2863 3012
2864 static void 3013 static void
2865 idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 3014 idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2866 { 3015 {
3016 // stop the watcher
3017 ev_idle_stop (loop, w);
3018
3019 // now we can free it
2867 free (w); 3020 free (w);
3021
2868 // now do something you wanted to do when the program has 3022 // now do something you wanted to do when the program has
2869 // no longer anything immediate to do. 3023 // no longer anything immediate to do.
2870 } 3024 }
2871 3025
2872 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3026 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2874 ev_idle_start (loop, idle_watcher); 3028 ev_idle_start (loop, idle_watcher);
2875 3029
2876 3030
2877=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 3031=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2878 3032
2879Prepare and check watchers are usually (but not always) used in pairs: 3033Prepare and check watchers are often (but not always) used in pairs:
2880prepare watchers get invoked before the process blocks and check watchers 3034prepare watchers get invoked before the process blocks and check watchers
2881afterwards. 3035afterwards.
2882 3036
2883You I<must not> call C<ev_run> or similar functions that enter 3037You I<must not> call C<ev_run> (or similar functions that enter the
2884the current event loop from either C<ev_prepare> or C<ev_check> 3038current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2885watchers. Other loops than the current one are fine, however. The 3039C<ev_check> watchers. Other loops than the current one are fine,
2886rationale behind this is that you do not need to check for recursion in 3040however. The rationale behind this is that you do not need to check
2887those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, 3041for recursion in those watchers, i.e. the sequence will always be
2888C<ev_check> so if you have one watcher of each kind they will always be 3042C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2889called in pairs bracketing the blocking call. 3043kind they will always be called in pairs bracketing the blocking call.
2890 3044
2891Their main purpose is to integrate other event mechanisms into libev and 3045Their main purpose is to integrate other event mechanisms into libev and
2892their use is somewhat advanced. They could be used, for example, to track 3046their use is somewhat advanced. They could be used, for example, to track
2893variable changes, implement your own watchers, integrate net-snmp or a 3047variable changes, implement your own watchers, integrate net-snmp or a
2894coroutine library and lots more. They are also occasionally useful if 3048coroutine library and lots more. They are also occasionally useful if
2912with priority higher than or equal to the event loop and one coroutine 3066with priority higher than or equal to the event loop and one coroutine
2913of lower priority, but only once, using idle watchers to keep the event 3067of lower priority, but only once, using idle watchers to keep the event
2914loop from blocking if lower-priority coroutines are active, thus mapping 3068loop from blocking if lower-priority coroutines are active, thus mapping
2915low-priority coroutines to idle/background tasks). 3069low-priority coroutines to idle/background tasks).
2916 3070
2917It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 3071When used for this purpose, it is recommended to give C<ev_check> watchers
2918priority, to ensure that they are being run before any other watchers 3072highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2919after the poll (this doesn't matter for C<ev_prepare> watchers). 3073any other watchers after the poll (this doesn't matter for C<ev_prepare>
3074watchers).
2920 3075
2921Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not 3076Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2922activate ("feed") events into libev. While libev fully supports this, they 3077activate ("feed") events into libev. While libev fully supports this, they
2923might get executed before other C<ev_check> watchers did their job. As 3078might get executed before other C<ev_check> watchers did their job. As
2924C<ev_check> watchers are often used to embed other (non-libev) event 3079C<ev_check> watchers are often used to embed other (non-libev) event
2925loops those other event loops might be in an unusable state until their 3080loops those other event loops might be in an unusable state until their
2926C<ev_check> watcher ran (always remind yourself to coexist peacefully with 3081C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2927others). 3082others).
3083
3084=head3 Abusing an C<ev_check> watcher for its side-effect
3085
3086C<ev_check> (and less often also C<ev_prepare>) watchers can also be
3087useful because they are called once per event loop iteration. For
3088example, if you want to handle a large number of connections fairly, you
3089normally only do a bit of work for each active connection, and if there
3090is more work to do, you wait for the next event loop iteration, so other
3091connections have a chance of making progress.
3092
3093Using an C<ev_check> watcher is almost enough: it will be called on the
3094next event loop iteration. However, that isn't as soon as possible -
3095without external events, your C<ev_check> watcher will not be invoked.
3096
3097This is where C<ev_idle> watchers come in handy - all you need is a
3098single global idle watcher that is active as long as you have one active
3099C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
3100will not sleep, and the C<ev_check> watcher makes sure a callback gets
3101invoked. Neither watcher alone can do that.
2928 3102
2929=head3 Watcher-Specific Functions and Data Members 3103=head3 Watcher-Specific Functions and Data Members
2930 3104
2931=over 4 3105=over 4
2932 3106
3133 3307
3134=over 4 3308=over 4
3135 3309
3136=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3310=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3137 3311
3138=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3312=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3139 3313
3140Configures the watcher to embed the given loop, which must be 3314Configures the watcher to embed the given loop, which must be
3141embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3315embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3142invoked automatically, otherwise it is the responsibility of the callback 3316invoked automatically, otherwise it is the responsibility of the callback
3143to invoke it (it will continue to be called until the sweep has been done, 3317to invoke it (it will continue to be called until the sweep has been done,
3164used). 3338used).
3165 3339
3166 struct ev_loop *loop_hi = ev_default_init (0); 3340 struct ev_loop *loop_hi = ev_default_init (0);
3167 struct ev_loop *loop_lo = 0; 3341 struct ev_loop *loop_lo = 0;
3168 ev_embed embed; 3342 ev_embed embed;
3169 3343
3170 // see if there is a chance of getting one that works 3344 // see if there is a chance of getting one that works
3171 // (remember that a flags value of 0 means autodetection) 3345 // (remember that a flags value of 0 means autodetection)
3172 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3346 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3173 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3347 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3174 : 0; 3348 : 0;
3188C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3362C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3189 3363
3190 struct ev_loop *loop = ev_default_init (0); 3364 struct ev_loop *loop = ev_default_init (0);
3191 struct ev_loop *loop_socket = 0; 3365 struct ev_loop *loop_socket = 0;
3192 ev_embed embed; 3366 ev_embed embed;
3193 3367
3194 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3368 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3195 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3369 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3196 { 3370 {
3197 ev_embed_init (&embed, 0, loop_socket); 3371 ev_embed_init (&embed, 0, loop_socket);
3198 ev_embed_start (loop, &embed); 3372 ev_embed_start (loop, &embed);
3206 3380
3207=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3381=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3208 3382
3209Fork watchers are called when a C<fork ()> was detected (usually because 3383Fork watchers are called when a C<fork ()> was detected (usually because
3210whoever is a good citizen cared to tell libev about it by calling 3384whoever is a good citizen cared to tell libev about it by calling
3211C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the 3385C<ev_loop_fork>). The invocation is done before the event loop blocks next
3212event loop blocks next and before C<ev_check> watchers are being called, 3386and before C<ev_check> watchers are being called, and only in the child
3213and only in the child after the fork. If whoever good citizen calling 3387after the fork. If whoever good citizen calling C<ev_default_fork> cheats
3214C<ev_default_fork> cheats and calls it in the wrong process, the fork 3388and calls it in the wrong process, the fork handlers will be invoked, too,
3215handlers will be invoked, too, of course. 3389of course.
3216 3390
3217=head3 The special problem of life after fork - how is it possible? 3391=head3 The special problem of life after fork - how is it possible?
3218 3392
3219Most uses of C<fork()> consist of forking, then some simple calls to set 3393Most uses of C<fork ()> consist of forking, then some simple calls to set
3220up/change the process environment, followed by a call to C<exec()>. This 3394up/change the process environment, followed by a call to C<exec()>. This
3221sequence should be handled by libev without any problems. 3395sequence should be handled by libev without any problems.
3222 3396
3223This changes when the application actually wants to do event handling 3397This changes when the application actually wants to do event handling
3224in the child, or both parent in child, in effect "continuing" after the 3398in the child, or both parent in child, in effect "continuing" after the
3313it by calling C<ev_async_send>, which is thread- and signal safe. 3487it by calling C<ev_async_send>, which is thread- and signal safe.
3314 3488
3315This functionality is very similar to C<ev_signal> watchers, as signals, 3489This functionality is very similar to C<ev_signal> watchers, as signals,
3316too, are asynchronous in nature, and signals, too, will be compressed 3490too, are asynchronous in nature, and signals, too, will be compressed
3317(i.e. the number of callback invocations may be less than the number of 3491(i.e. the number of callback invocations may be less than the number of
3318C<ev_async_sent> calls). In fact, you could use signal watchers as a kind 3492C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3319of "global async watchers" by using a watcher on an otherwise unused 3493of "global async watchers" by using a watcher on an otherwise unused
3320signal, and C<ev_feed_signal> to signal this watcher from another thread, 3494signal, and C<ev_feed_signal> to signal this watcher from another thread,
3321even without knowing which loop owns the signal. 3495even without knowing which loop owns the signal.
3322 3496
3323=head3 Queueing 3497=head3 Queueing
3462 3636
3463There are some other functions of possible interest. Described. Here. Now. 3637There are some other functions of possible interest. Described. Here. Now.
3464 3638
3465=over 4 3639=over 4
3466 3640
3467=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 3641=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3468 3642
3469This function combines a simple timer and an I/O watcher, calls your 3643This function combines a simple timer and an I/O watcher, calls your
3470callback on whichever event happens first and automatically stops both 3644callback on whichever event happens first and automatically stops both
3471watchers. This is useful if you want to wait for a single event on an fd 3645watchers. This is useful if you want to wait for a single event on an fd
3472or timeout without having to allocate/configure/start/stop/free one or 3646or timeout without having to allocate/configure/start/stop/free one or
3614already been invoked. 3788already been invoked.
3615 3789
3616A common way around all these issues is to make sure that 3790A common way around all these issues is to make sure that
3617C<start_new_request> I<always> returns before the callback is invoked. If 3791C<start_new_request> I<always> returns before the callback is invoked. If
3618C<start_new_request> immediately knows the result, it can artificially 3792C<start_new_request> immediately knows the result, it can artificially
3619delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher 3793delay invoking the callback by using a C<prepare> or C<idle> watcher for
3620for example, or more sneakily, by reusing an existing (stopped) watcher 3794example, or more sneakily, by reusing an existing (stopped) watcher and
3621and pushing it into the pending queue: 3795pushing it into the pending queue:
3622 3796
3623 ev_set_cb (watcher, callback); 3797 ev_set_cb (watcher, callback);
3624 ev_feed_event (EV_A_ watcher, 0); 3798 ev_feed_event (EV_A_ watcher, 0);
3625 3799
3626This way, C<start_new_request> can safely return before the callback is 3800This way, C<start_new_request> can safely return before the callback is
3634 3808
3635This brings the problem of exiting - a callback might want to finish the 3809This brings the problem of exiting - a callback might want to finish the
3636main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but 3810main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3637a modal "Are you sure?" dialog is still waiting), or just the nested one 3811a modal "Are you sure?" dialog is still waiting), or just the nested one
3638and not the main one (e.g. user clocked "Ok" in a modal dialog), or some 3812and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3639other combination: In these cases, C<ev_break> will not work alone. 3813other combination: In these cases, a simple C<ev_break> will not work.
3640 3814
3641The solution is to maintain "break this loop" variable for each C<ev_run> 3815The solution is to maintain "break this loop" variable for each C<ev_run>
3642invocation, and use a loop around C<ev_run> until the condition is 3816invocation, and use a loop around C<ev_run> until the condition is
3643triggered, using C<EVRUN_ONCE>: 3817triggered, using C<EVRUN_ONCE>:
3644 3818
3830called): 4004called):
3831 4005
3832 void 4006 void
3833 wait_for_event (ev_watcher *w) 4007 wait_for_event (ev_watcher *w)
3834 { 4008 {
3835 ev_cb_set (w) = current_coro; 4009 ev_set_cb (w, current_coro);
3836 switch_to (libev_coro); 4010 switch_to (libev_coro);
3837 } 4011 }
3838 4012
3839That basically suspends the coroutine inside C<wait_for_event> and 4013That basically suspends the coroutine inside C<wait_for_event> and
3840continues the libev coroutine, which, when appropriate, switches back to 4014continues the libev coroutine, which, when appropriate, switches back to
3843You can do similar tricks if you have, say, threads with an event queue - 4017You can do similar tricks if you have, say, threads with an event queue -
3844instead of storing a coroutine, you store the queue object and instead of 4018instead of storing a coroutine, you store the queue object and instead of
3845switching to a coroutine, you push the watcher onto the queue and notify 4019switching to a coroutine, you push the watcher onto the queue and notify
3846any waiters. 4020any waiters.
3847 4021
3848To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 4022To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3849files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 4023files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3850 4024
3851 // my_ev.h 4025 // my_ev.h
3852 #define EV_CB_DECLARE(type) struct my_coro *cb; 4026 #define EV_CB_DECLARE(type) struct my_coro *cb;
3853 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 4027 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3854 #include "../libev/ev.h" 4028 #include "../libev/ev.h"
3855 4029
3856 // my_ev.c 4030 // my_ev.c
3857 #define EV_H "my_ev.h" 4031 #define EV_H "my_ev.h"
3858 #include "../libev/ev.c" 4032 #include "../libev/ev.c"
3904The normal C API should work fine when used from C++: both ev.h and the 4078The normal C API should work fine when used from C++: both ev.h and the
3905libev sources can be compiled as C++. Therefore, code that uses the C API 4079libev sources can be compiled as C++. Therefore, code that uses the C API
3906will work fine. 4080will work fine.
3907 4081
3908Proper exception specifications might have to be added to callbacks passed 4082Proper exception specifications might have to be added to callbacks passed
3909to libev: exceptions may be thrown only from watcher callbacks, all 4083to libev: exceptions may be thrown only from watcher callbacks, all other
3910other callbacks (allocator, syserr, loop acquire/release and periodioc 4084callbacks (allocator, syserr, loop acquire/release and periodic reschedule
3911reschedule callbacks) must not throw exceptions, and might need a C<throw 4085callbacks) must not throw exceptions, and might need a C<noexcept>
3912()> specification. If you have code that needs to be compiled as both C 4086specification. If you have code that needs to be compiled as both C and
3913and C++ you can use the C<EV_THROW> macro for this: 4087C++ you can use the C<EV_NOEXCEPT> macro for this:
3914 4088
3915 static void 4089 static void
3916 fatal_error (const char *msg) EV_THROW 4090 fatal_error (const char *msg) EV_NOEXCEPT
3917 { 4091 {
3918 perror (msg); 4092 perror (msg);
3919 abort (); 4093 abort ();
3920 } 4094 }
3921 4095
3935Libev comes with some simplistic wrapper classes for C++ that mainly allow 4109Libev comes with some simplistic wrapper classes for C++ that mainly allow
3936you to use some convenience methods to start/stop watchers and also change 4110you to use some convenience methods to start/stop watchers and also change
3937the callback model to a model using method callbacks on objects. 4111the callback model to a model using method callbacks on objects.
3938 4112
3939To use it, 4113To use it,
3940 4114
3941 #include <ev++.h> 4115 #include <ev++.h>
3942 4116
3943This automatically includes F<ev.h> and puts all of its definitions (many 4117This automatically includes F<ev.h> and puts all of its definitions (many
3944of them macros) into the global namespace. All C++ specific things are 4118of them macros) into the global namespace. All C++ specific things are
3945put into the C<ev> namespace. It should support all the same embedding 4119put into the C<ev> namespace. It should support all the same embedding
4048 void operator() (ev::io &w, int revents) 4222 void operator() (ev::io &w, int revents)
4049 { 4223 {
4050 ... 4224 ...
4051 } 4225 }
4052 } 4226 }
4053 4227
4054 myfunctor f; 4228 myfunctor f;
4055 4229
4056 ev::io w; 4230 ev::io w;
4057 w.set (&f); 4231 w.set (&f);
4058 4232
4076Associates a different C<struct ev_loop> with this watcher. You can only 4250Associates a different C<struct ev_loop> with this watcher. You can only
4077do this when the watcher is inactive (and not pending either). 4251do this when the watcher is inactive (and not pending either).
4078 4252
4079=item w->set ([arguments]) 4253=item w->set ([arguments])
4080 4254
4081Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4255Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
4082method or a suitable start method must be called at least once. Unlike the 4256with the same arguments. Either this method or a suitable start method
4083C counterpart, an active watcher gets automatically stopped and restarted 4257must be called at least once. Unlike the C counterpart, an active watcher
4084when reconfiguring it with this method. 4258gets automatically stopped and restarted when reconfiguring it with this
4259method.
4260
4261For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4262clashing with the C<set (loop)> method.
4085 4263
4086=item w->start () 4264=item w->start ()
4087 4265
4088Starts the watcher. Note that there is no C<loop> argument, as the 4266Starts the watcher. Note that there is no C<loop> argument, as the
4089constructor already stores the event loop. 4267constructor already stores the event loop.
4193 4371
4194Brian Maher has written a partial interface to libev for lua (at the 4372Brian Maher has written a partial interface to libev for lua (at the
4195time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4373time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4196L<http://github.com/brimworks/lua-ev>. 4374L<http://github.com/brimworks/lua-ev>.
4197 4375
4376=item Javascript
4377
4378Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4379
4380=item Others
4381
4382There are others, and I stopped counting.
4383
4198=back 4384=back
4199 4385
4200 4386
4201=head1 MACRO MAGIC 4387=head1 MACRO MAGIC
4202 4388
4319 ev_vars.h 4505 ev_vars.h
4320 ev_wrap.h 4506 ev_wrap.h
4321 4507
4322 ev_win32.c required on win32 platforms only 4508 ev_win32.c required on win32 platforms only
4323 4509
4324 ev_select.c only when select backend is enabled (which is enabled by default) 4510 ev_select.c only when select backend is enabled
4325 ev_poll.c only when poll backend is enabled (disabled by default) 4511 ev_poll.c only when poll backend is enabled
4326 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4512 ev_epoll.c only when the epoll backend is enabled
4513 ev_linuxaio.c only when the linux aio backend is enabled
4514 ev_iouring.c only when the linux io_uring backend is enabled
4327 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4515 ev_kqueue.c only when the kqueue backend is enabled
4328 ev_port.c only when the solaris port backend is enabled (disabled by default) 4516 ev_port.c only when the solaris port backend is enabled
4329 4517
4330F<ev.c> includes the backend files directly when enabled, so you only need 4518F<ev.c> includes the backend files directly when enabled, so you only need
4331to compile this single file. 4519to compile this single file.
4332 4520
4333=head3 LIBEVENT COMPATIBILITY API 4521=head3 LIBEVENT COMPATIBILITY API
4452available and will probe for kernel support at runtime. This will improve 4640available and will probe for kernel support at runtime. This will improve
4453C<ev_signal> and C<ev_async> performance and reduce resource consumption. 4641C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4454If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc 4642If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
44552.7 or newer, otherwise disabled. 46432.7 or newer, otherwise disabled.
4456 4644
4645=item EV_USE_SIGNALFD
4646
4647If defined to be C<1>, then libev will assume that C<signalfd ()> is
4648available and will probe for kernel support at runtime. This enables
4649the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If
4650undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46512.7 or newer, otherwise disabled.
4652
4653=item EV_USE_TIMERFD
4654
4655If defined to be C<1>, then libev will assume that C<timerfd ()> is
4656available and will probe for kernel support at runtime. This allows
4657libev to detect time jumps accurately. If undefined, it will be enabled
4658if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
4659C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled.
4660
4661=item EV_USE_EVENTFD
4662
4663If defined to be C<1>, then libev will assume that C<eventfd ()> is
4664available and will probe for kernel support at runtime. This will improve
4665C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4666If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46672.7 or newer, otherwise disabled.
4668
4457=item EV_USE_SELECT 4669=item EV_USE_SELECT
4458 4670
4459If undefined or defined to be C<1>, libev will compile in support for the 4671If undefined or defined to be C<1>, libev will compile in support for the
4460C<select>(2) backend. No attempt at auto-detection will be done: if no 4672C<select>(2) backend. No attempt at auto-detection will be done: if no
4461other method takes over, select will be it. Otherwise the select backend 4673other method takes over, select will be it. Otherwise the select backend
4501If programs implement their own fd to handle mapping on win32, then this 4713If programs implement their own fd to handle mapping on win32, then this
4502macro can be used to override the C<close> function, useful to unregister 4714macro can be used to override the C<close> function, useful to unregister
4503file descriptors again. Note that the replacement function has to close 4715file descriptors again. Note that the replacement function has to close
4504the underlying OS handle. 4716the underlying OS handle.
4505 4717
4718=item EV_USE_WSASOCKET
4719
4720If defined to be C<1>, libev will use C<WSASocket> to create its internal
4721communication socket, which works better in some environments. Otherwise,
4722the normal C<socket> function will be used, which works better in other
4723environments.
4724
4506=item EV_USE_POLL 4725=item EV_USE_POLL
4507 4726
4508If defined to be C<1>, libev will compile in support for the C<poll>(2) 4727If defined to be C<1>, libev will compile in support for the C<poll>(2)
4509backend. Otherwise it will be enabled on non-win32 platforms. It 4728backend. Otherwise it will be enabled on non-win32 platforms. It
4510takes precedence over select. 4729takes precedence over select.
4514If defined to be C<1>, libev will compile in support for the Linux 4733If defined to be C<1>, libev will compile in support for the Linux
4515C<epoll>(7) backend. Its availability will be detected at runtime, 4734C<epoll>(7) backend. Its availability will be detected at runtime,
4516otherwise another method will be used as fallback. This is the preferred 4735otherwise another method will be used as fallback. This is the preferred
4517backend for GNU/Linux systems. If undefined, it will be enabled if the 4736backend for GNU/Linux systems. If undefined, it will be enabled if the
4518headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4737headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4738
4739=item EV_USE_LINUXAIO
4740
4741If defined to be C<1>, libev will compile in support for the Linux aio
4742backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be
4743enabled on linux, otherwise disabled.
4744
4745=item EV_USE_IOURING
4746
4747If defined to be C<1>, libev will compile in support for the Linux
4748io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's
4749current limitations it has to be requested explicitly. If undefined, it
4750will be enabled on linux, otherwise disabled.
4519 4751
4520=item EV_USE_KQUEUE 4752=item EV_USE_KQUEUE
4521 4753
4522If defined to be C<1>, libev will compile in support for the BSD style 4754If defined to be C<1>, libev will compile in support for the BSD style
4523C<kqueue>(2) backend. Its actual availability will be detected at runtime, 4755C<kqueue>(2) backend. Its actual availability will be detected at runtime,
4554different cpus (or different cpu cores). This reduces dependencies 4786different cpus (or different cpu cores). This reduces dependencies
4555and makes libev faster. 4787and makes libev faster.
4556 4788
4557=item EV_NO_THREADS 4789=item EV_NO_THREADS
4558 4790
4559If defined to be C<1>, libev will assume that it will never be called 4791If defined to be C<1>, libev will assume that it will never be called from
4560from different threads, which is a stronger assumption than C<EV_NO_SMP>, 4792different threads (that includes signal handlers), which is a stronger
4561above. This reduces dependencies and makes libev faster. 4793assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4794libev faster.
4562 4795
4563=item EV_ATOMIC_T 4796=item EV_ATOMIC_T
4564 4797
4565Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4798Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4566access is atomic and serialised with respect to other threads or signal 4799access is atomic with respect to other threads or signal contexts. No
4567contexts. No such type is easily found in the C language, so you can 4800such type is easily found in the C language, so you can provide your own
4568provide your own type that you know is safe for your purposes. It is used 4801type that you know is safe for your purposes. It is used both for signal
4569both for signal handler "locking" as well as for signal and thread safety 4802handler "locking" as well as for signal and thread safety in C<ev_async>
4570in C<ev_async> watchers. 4803watchers.
4571 4804
4572In the absence of this define, libev will use C<sig_atomic_t volatile> 4805In the absence of this define, libev will use C<sig_atomic_t volatile>
4573(from F<signal.h>), which is usually good enough on most platforms, 4806(from F<signal.h>), which is usually good enough on most platforms.
4574although strictly speaking using a type that also implies a memory fence
4575is required.
4576 4807
4577=item EV_H (h) 4808=item EV_H (h)
4578 4809
4579The name of the F<ev.h> header file used to include it. The default if 4810The name of the F<ev.h> header file used to include it. The default if
4580undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 4811undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
4801in. If set to C<1>, then verification code will be compiled in, but not 5032in. If set to C<1>, then verification code will be compiled in, but not
4802called. If set to C<2>, then the internal verification code will be 5033called. If set to C<2>, then the internal verification code will be
4803called once per loop, which can slow down libev. If set to C<3>, then the 5034called once per loop, which can slow down libev. If set to C<3>, then the
4804verification code will be called very frequently, which will slow down 5035verification code will be called very frequently, which will slow down
4805libev considerably. 5036libev considerably.
5037
5038Verification errors are reported via C's C<assert> mechanism, so if you
5039disable that (e.g. by defining C<NDEBUG>) then no errors will be reported.
4806 5040
4807The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it 5041The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4808will be C<0>. 5042will be C<0>.
4809 5043
4810=item EV_COMMON 5044=item EV_COMMON
4948default loop and triggering an C<ev_async> watcher from the default loop 5182default loop and triggering an C<ev_async> watcher from the default loop
4949watcher callback into the event loop interested in the signal. 5183watcher callback into the event loop interested in the signal.
4950 5184
4951=back 5185=back
4952 5186
4953See also L<THREAD LOCKING EXAMPLE>. 5187See also L</THREAD LOCKING EXAMPLE>.
4954 5188
4955=head3 COROUTINES 5189=head3 COROUTINES
4956 5190
4957Libev is very accommodating to coroutines ("cooperative threads"): 5191Libev is very accommodating to coroutines ("cooperative threads"):
4958libev fully supports nesting calls to its functions from different 5192libev fully supports nesting calls to its functions from different
5227structure (guaranteed by POSIX but not by ISO C for example), but it also 5461structure (guaranteed by POSIX but not by ISO C for example), but it also
5228assumes that the same (machine) code can be used to call any watcher 5462assumes that the same (machine) code can be used to call any watcher
5229callback: The watcher callbacks have different type signatures, but libev 5463callback: The watcher callbacks have different type signatures, but libev
5230calls them using an C<ev_watcher *> internally. 5464calls them using an C<ev_watcher *> internally.
5231 5465
5466=item null pointers and integer zero are represented by 0 bytes
5467
5468Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
5469relies on this setting pointers and integers to null.
5470
5232=item pointer accesses must be thread-atomic 5471=item pointer accesses must be thread-atomic
5233 5472
5234Accessing a pointer value must be atomic, it must both be readable and 5473Accessing a pointer value must be atomic, it must both be readable and
5235writable in one piece - this is the case on all current architectures. 5474writable in one piece - this is the case on all current architectures.
5236 5475
5249thread" or will block signals process-wide, both behaviours would 5488thread" or will block signals process-wide, both behaviours would
5250be compatible with libev. Interaction between C<sigprocmask> and 5489be compatible with libev. Interaction between C<sigprocmask> and
5251C<pthread_sigmask> could complicate things, however. 5490C<pthread_sigmask> could complicate things, however.
5252 5491
5253The most portable way to handle signals is to block signals in all threads 5492The most portable way to handle signals is to block signals in all threads
5254except the initial one, and run the default loop in the initial thread as 5493except the initial one, and run the signal handling loop in the initial
5255well. 5494thread as well.
5256 5495
5257=item C<long> must be large enough for common memory allocation sizes 5496=item C<long> must be large enough for common memory allocation sizes
5258 5497
5259To improve portability and simplify its API, libev uses C<long> internally 5498To improve portability and simplify its API, libev uses C<long> internally
5260instead of C<size_t> when allocating its data structures. On non-POSIX 5499instead of C<size_t> when allocating its data structures. On non-POSIX
5364=over 4 5603=over 4
5365 5604
5366=item C<EV_COMPAT3> backwards compatibility mechanism 5605=item C<EV_COMPAT3> backwards compatibility mechanism
5367 5606
5368The backward compatibility mechanism can be controlled by 5607The backward compatibility mechanism can be controlled by
5369C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5608C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5370section. 5609section.
5371 5610
5372=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5611=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5373 5612
5374These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5613These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5417=over 4 5656=over 4
5418 5657
5419=item active 5658=item active
5420 5659
5421A watcher is active as long as it has been started and not yet stopped. 5660A watcher is active as long as it has been started and not yet stopped.
5422See L<WATCHER STATES> for details. 5661See L</WATCHER STATES> for details.
5423 5662
5424=item application 5663=item application
5425 5664
5426In this document, an application is whatever is using libev. 5665In this document, an application is whatever is using libev.
5427 5666
5463watchers and events. 5702watchers and events.
5464 5703
5465=item pending 5704=item pending
5466 5705
5467A watcher is pending as soon as the corresponding event has been 5706A watcher is pending as soon as the corresponding event has been
5468detected. See L<WATCHER STATES> for details. 5707detected. See L</WATCHER STATES> for details.
5469 5708
5470=item real time 5709=item real time
5471 5710
5472The physical time that is observed. It is apparently strictly monotonic :) 5711The physical time that is observed. It is apparently strictly monotonic :)
5473 5712

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines