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

Comparing libev/ev.pod (file contents):
Revision 1.426 by root, Sat Feb 23 23:06:40 2013 UTC vs.
Revision 1.454 by root, Tue Jun 25 05:17:50 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
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
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)
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>
486This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and 511This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
487C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. 512C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
488 513
489=item C<EVBACKEND_EPOLL> (value 4, Linux) 514=item C<EVBACKEND_EPOLL> (value 4, Linux)
490 515
491Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 516Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9
492kernels). 517kernels).
493 518
494For few fds, this backend is a bit little slower than poll and select, but 519For 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 520it 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 521O(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 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.
548 573
549This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 574This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
550C<EVBACKEND_POLL>. 575C<EVBACKEND_POLL>.
551 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 (but libev
581only tries to use it in 4.19+).
582
583This is another Linux train wreck of an event interface.
584
585If this backend works for you (as of this writing, it was very
586experimental), it is the best event interface available on Linux and might
587be well worth enabling it - if it isn't available in your kernel this will
588be detected and this backend will be skipped.
589
590This backend can batch oneshot requests and supports a user-space ring
591buffer to receive events. It also doesn't suffer from most of the design
592problems of epoll (such as not being able to remove event sources from
593the epoll set), and generally sounds too good to be true. Because, this
594being the Linux kernel, of course it suffers from a whole new set of
595limitations, forcing you to fall back to epoll, inheriting all its design
596issues.
597
598For one, it is not easily embeddable (but probably could be done using
599an event fd at some extra overhead). It also is subject to a system wide
600limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no AIO
601requests are left, this backend will be skipped during initialisation, and
602will switch to epoll when the loop is active.
603
604Most problematic in practice, however, is that not all file descriptors
605work with it. For example, in Linux 5.1, TCP sockets, pipes, event fds,
606files, F</dev/null> and many others are supported, but ttys do not work
607properly (a known bug that the kernel developers don't care about, see
608L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
609(yet?) a generic event polling interface.
610
611Overall, it seems the Linux developers just don't want it to have a
612generic event handling mechanism other than C<select> or C<poll>.
613
614To work around all these problem, the current version of libev uses its
615epoll backend as a fallback for file descriptor types that do not work. Or
616falls back completely to epoll if the kernel acts up.
617
618This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
619C<EVBACKEND_POLL>.
620
552=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 621=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
553 622
554Kqueue deserves special mention, as at the time of this writing, it 623Kqueue deserves special mention, as at the time this backend was
555was broken on all BSDs except NetBSD (usually it doesn't work reliably 624implemented, it was broken on all BSDs except NetBSD (usually it doesn't
556with anything but sockets and pipes, except on Darwin, where of course 625work reliably with anything but sockets and pipes, except on Darwin,
557it's completely useless). Unlike epoll, however, whose brokenness 626where of course it's completely useless). Unlike epoll, however, whose
558is by design, these kqueue bugs can (and eventually will) be fixed 627brokenness 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 628fixed 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 629being "auto-detected" on all platforms unless you explicitly specify it
561C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) 630in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a
562system like NetBSD. 631known-to-be-good (-enough) system like NetBSD.
563 632
564You still can embed kqueue into a normal poll or select backend and use it 633You 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 634only for sockets (after having made sure that sockets work with kqueue on
566the target platform). See C<ev_embed> watchers for more info. 635the target platform). See C<ev_embed> watchers for more info.
567 636
568It scales in the same way as the epoll backend, but the interface to the 637It 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 638kernel is more efficient (which says nothing about its actual speed, of
570course). While stopping, setting and starting an I/O watcher does never 639course). 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 640cause 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 641two 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 642might have to leak fds on fork, but it's more sane than epoll) and it
574drops fds silently in similarly hard-to-detect cases. 643drops fds silently in similarly hard-to-detect cases.
575 644
576This backend usually performs well under most conditions. 645This backend usually performs well under most conditions.
577 646
578While nominally embeddable in other event loops, this doesn't work 647While nominally embeddable in other event loops, this doesn't work
653Example: Use whatever libev has to offer, but make sure that kqueue is 722Example: Use whatever libev has to offer, but make sure that kqueue is
654used if available. 723used if available.
655 724
656 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 725 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
657 726
727Example: Similarly, on linux, you mgiht want to take advantage of the
728linux aio backend if possible, but fall back to something else if that
729isn't available.
730
731 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
732
658=item ev_loop_destroy (loop) 733=item ev_loop_destroy (loop)
659 734
660Destroys an event loop object (frees all memory and kernel state 735Destroys an event loop object (frees all memory and kernel state
661etc.). None of the active event watchers will be stopped in the normal 736etc.). 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 737sense, 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> 753If you need dynamically allocated loops it is better to use C<ev_loop_new>
679and C<ev_loop_destroy>. 754and C<ev_loop_destroy>.
680 755
681=item ev_loop_fork (loop) 756=item ev_loop_fork (loop)
682 757
683This function sets a flag that causes subsequent C<ev_run> iterations to 758This function sets a flag that causes subsequent C<ev_run> iterations
684reinitialise the kernel state for backends that have one. Despite the 759to reinitialise the kernel state for backends that have one. Despite
685name, you can call it anytime, but it makes most sense after forking, in 760the 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 761watchers (except inside an C<ev_prepare> callback), but it makes most
762sense after forking, in the child process. You I<must> call it (or use
687child before resuming or calling C<ev_run>. 763C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
688 764
765In addition, if you want to reuse a loop (via this function or
766C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>.
767
689Again, you I<have> to call it on I<any> loop that you want to re-use after 768Again, 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 769a 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 770because some kernel interfaces *cough* I<kqueue> *cough* do funny things
692during fork. 771during fork.
693 772
694On the other hand, you only need to call this function in the child 773On the other hand, you only need to call this function in the child
1601 1680
1602But really, best use non-blocking mode. 1681But really, best use non-blocking mode.
1603 1682
1604=head3 The special problem of disappearing file descriptors 1683=head3 The special problem of disappearing file descriptors
1605 1684
1606Some backends (e.g. kqueue, epoll) need to be told about closing a file 1685Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1607descriptor (either due to calling C<close> explicitly or any other means, 1686a file descriptor (either due to calling C<close> explicitly or any other
1608such as C<dup2>). The reason is that you register interest in some file 1687means, such as C<dup2>). The reason is that you register interest in some
1609descriptor, but when it goes away, the operating system will silently drop 1688file descriptor, but when it goes away, the operating system will silently
1610this interest. If another file descriptor with the same number then is 1689drop this interest. If another file descriptor with the same number then
1611registered with libev, there is no efficient way to see that this is, in 1690is registered with libev, there is no efficient way to see that this is,
1612fact, a different file descriptor. 1691in fact, a different file descriptor.
1613 1692
1614To avoid having to explicitly tell libev about such cases, libev follows 1693To avoid having to explicitly tell libev about such cases, libev follows
1615the following policy: Each time C<ev_io_set> is being called, libev 1694the following policy: Each time C<ev_io_set> is being called, libev
1616will assume that this is potentially a new file descriptor, otherwise 1695will assume that this is potentially a new file descriptor, otherwise
1617it is assumed that the file descriptor stays the same. That means that 1696it is assumed that the file descriptor stays the same. That means that
1666when you rarely read from a file instead of from a socket, and want to 1745when you rarely read from a file instead of from a socket, and want to
1667reuse the same code path. 1746reuse the same code path.
1668 1747
1669=head3 The special problem of fork 1748=head3 The special problem of fork
1670 1749
1671Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1750Some backends (epoll, kqueue, probably linuxaio) do not support C<fork ()>
1672useless behaviour. Libev fully supports fork, but needs to be told about 1751at all or exhibit useless behaviour. Libev fully supports fork, but needs
1673it in the child if you want to continue to use it in the child. 1752to be told about it in the child if you want to continue to use it in the
1753child.
1674 1754
1675To support fork in your child processes, you have to call C<ev_loop_fork 1755To support fork in your child processes, you have to call C<ev_loop_fork
1676()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to 1756()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1677C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1757C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1678 1758
2024 2104
2025The relative timeouts are calculated relative to the C<ev_now ()> 2105The relative timeouts are calculated relative to the C<ev_now ()>
2026time. This is usually the right thing as this timestamp refers to the time 2106time. This is usually the right thing as this timestamp refers to the time
2027of the event triggering whatever timeout you are modifying/starting. If 2107of the event triggering whatever timeout you are modifying/starting. If
2028you suspect event processing to be delayed and you I<need> to base the 2108you suspect event processing to be delayed and you I<need> to base the
2029timeout on the current time, use something like this to adjust for this: 2109timeout on the current time, use something like the following to adjust
2110for it:
2030 2111
2031 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2112 ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
2032 2113
2033If the event loop is suspended for a long time, you can also force an 2114If the event loop is suspended for a long time, you can also force an
2034update of the time returned by C<ev_now ()> by calling C<ev_now_update 2115update of the time returned by C<ev_now ()> by calling C<ev_now_update
2035()>. 2116()>, although that will push the event time of all outstanding events
2117further into the future.
2036 2118
2037=head3 The special problem of unsynchronised clocks 2119=head3 The special problem of unsynchronised clocks
2038 2120
2039Modern systems have a variety of clocks - libev itself uses the normal 2121Modern systems have a variety of clocks - libev itself uses the normal
2040"wall clock" clock and, if available, the monotonic clock (to avoid time 2122"wall clock" clock and, if available, the monotonic clock (to avoid time
2103 2185
2104=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 2186=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
2105 2187
2106=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 2188=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
2107 2189
2108Configure the timer to trigger after C<after> seconds. If C<repeat> 2190Configure the timer to trigger after C<after> seconds (fractional and
2109is C<0.>, then it will automatically be stopped once the timeout is 2191negative values are supported). If C<repeat> is C<0.>, then it will
2110reached. If it is positive, then the timer will automatically be 2192automatically be stopped once the timeout is reached. If it is positive,
2111configured to trigger again C<repeat> seconds later, again, and again, 2193then the timer will automatically be configured to trigger again C<repeat>
2112until stopped manually. 2194seconds later, again, and again, until stopped manually.
2113 2195
2114The timer itself will do a best-effort at avoiding drift, that is, if 2196The timer itself will do a best-effort at avoiding drift, that is, if
2115you configure a timer to trigger every 10 seconds, then it will normally 2197you configure a timer to trigger every 10 seconds, then it will normally
2116trigger at exactly 10 second intervals. If, however, your program cannot 2198trigger at exactly 10 second intervals. If, however, your program cannot
2117keep up with the timer (because it takes longer than those 10 seconds to 2199keep up with the timer (because it takes longer than those 10 seconds to
2199Periodic watchers are also timers of a kind, but they are very versatile 2281Periodic watchers are also timers of a kind, but they are very versatile
2200(and unfortunately a bit complex). 2282(and unfortunately a bit complex).
2201 2283
2202Unlike C<ev_timer>, periodic watchers are not based on real time (or 2284Unlike C<ev_timer>, periodic watchers are not based on real time (or
2203relative time, the physical time that passes) but on wall clock time 2285relative time, the physical time that passes) but on wall clock time
2204(absolute time, the thing you can read on your calender or clock). The 2286(absolute time, the thing you can read on your calendar or clock). The
2205difference is that wall clock time can run faster or slower than real 2287difference is that wall clock time can run faster or slower than real
2206time, and time jumps are not uncommon (e.g. when you adjust your 2288time, and time jumps are not uncommon (e.g. when you adjust your
2207wrist-watch). 2289wrist-watch).
2208 2290
2209You can tell a periodic watcher to trigger after some specific point 2291You can tell a periodic watcher to trigger after some specific point
2214C<ev_timer>, which would still trigger roughly 10 seconds after starting 2296C<ev_timer>, which would still trigger roughly 10 seconds after starting
2215it, as it uses a relative timeout). 2297it, as it uses a relative timeout).
2216 2298
2217C<ev_periodic> watchers can also be used to implement vastly more complex 2299C<ev_periodic> watchers can also be used to implement vastly more complex
2218timers, such as triggering an event on each "midnight, local time", or 2300timers, such as triggering an event on each "midnight, local time", or
2219other complicated rules. This cannot be done with C<ev_timer> watchers, as 2301other complicated rules. This cannot easily be done with C<ev_timer>
2220those cannot react to time jumps. 2302watchers, as those cannot react to time jumps.
2221 2303
2222As with timers, the callback is guaranteed to be invoked only when the 2304As with timers, the callback is guaranteed to be invoked only when the
2223point in time where it is supposed to trigger has passed. If multiple 2305point in time where it is supposed to trigger has passed. If multiple
2224timers become ready during the same loop iteration then the ones with 2306timers become ready during the same loop iteration then the ones with
2225earlier time-out values are invoked before ones with later time-out values 2307earlier time-out values are invoked before ones with later time-out values
2311 2393
2312NOTE: I<< This callback must always return a time that is higher than or 2394NOTE: I<< This callback must always return a time that is higher than or
2313equal to the passed C<now> value >>. 2395equal to the passed C<now> value >>.
2314 2396
2315This can be used to create very complex timers, such as a timer that 2397This can be used to create very complex timers, such as a timer that
2316triggers on "next midnight, local time". To do this, you would calculate the 2398triggers on "next midnight, local time". To do this, you would calculate
2317next midnight after C<now> and return the timestamp value for this. How 2399the next midnight after C<now> and return the timestamp value for
2318you do this is, again, up to you (but it is not trivial, which is the main 2400this. Here is a (completely untested, no error checking) example on how to
2319reason I omitted it as an example). 2401do this:
2402
2403 #include <time.h>
2404
2405 static ev_tstamp
2406 my_rescheduler (ev_periodic *w, ev_tstamp now)
2407 {
2408 time_t tnow = (time_t)now;
2409 struct tm tm;
2410 localtime_r (&tnow, &tm);
2411
2412 tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2413 ++tm.tm_mday; // midnight next day
2414
2415 return mktime (&tm);
2416 }
2417
2418Note: this code might run into trouble on days that have more then two
2419midnights (beginning and end).
2320 2420
2321=back 2421=back
2322 2422
2323=item ev_periodic_again (loop, ev_periodic *) 2423=item ev_periodic_again (loop, ev_periodic *)
2324 2424
2389 2489
2390 ev_periodic hourly_tick; 2490 ev_periodic hourly_tick;
2391 ev_periodic_init (&hourly_tick, clock_cb, 2491 ev_periodic_init (&hourly_tick, clock_cb,
2392 fmod (ev_now (loop), 3600.), 3600., 0); 2492 fmod (ev_now (loop), 3600.), 3600., 0);
2393 ev_periodic_start (loop, &hourly_tick); 2493 ev_periodic_start (loop, &hourly_tick);
2394 2494
2395 2495
2396=head2 C<ev_signal> - signal me when a signal gets signalled! 2496=head2 C<ev_signal> - signal me when a signal gets signalled!
2397 2497
2398Signal watchers will trigger an event when the process receives a specific 2498Signal watchers will trigger an event when the process receives a specific
2399signal one or more times. Even though signals are very asynchronous, libev 2499signal one or more times. Even though signals are very asynchronous, libev
2409only within the same loop, i.e. you can watch for C<SIGINT> in your 2509only within the same loop, i.e. you can watch for C<SIGINT> in your
2410default loop and for C<SIGIO> in another loop, but you cannot watch for 2510default loop and for C<SIGIO> in another loop, but you cannot watch for
2411C<SIGINT> in both the default loop and another loop at the same time. At 2511C<SIGINT> in both the default loop and another loop at the same time. At
2412the moment, C<SIGCHLD> is permanently tied to the default loop. 2512the moment, C<SIGCHLD> is permanently tied to the default loop.
2413 2513
2414When the first watcher gets started will libev actually register something 2514Only after the first watcher for a signal is started will libev actually
2415with the kernel (thus it coexists with your own signal handlers as long as 2515register something with the kernel. It thus coexists with your own signal
2416you don't register any with libev for the same signal). 2516handlers as long as you don't register any with libev for the same signal.
2417 2517
2418If possible and supported, libev will install its handlers with 2518If possible and supported, libev will install its handlers with
2419C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2519C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2420not be unduly interrupted. If you have a problem with system calls getting 2520not be unduly interrupted. If you have a problem with system calls getting
2421interrupted by signals you can block all signals in an C<ev_check> watcher 2521interrupted by signals you can block all signals in an C<ev_check> watcher
2903 3003
2904Prepare and check watchers are often (but not always) used in pairs: 3004Prepare and check watchers are often (but not always) used in pairs:
2905prepare watchers get invoked before the process blocks and check watchers 3005prepare watchers get invoked before the process blocks and check watchers
2906afterwards. 3006afterwards.
2907 3007
2908You I<must not> call C<ev_run> or similar functions that enter 3008You I<must not> call C<ev_run> (or similar functions that enter the
2909the current event loop from either C<ev_prepare> or C<ev_check> 3009current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2910watchers. Other loops than the current one are fine, however. The 3010C<ev_check> watchers. Other loops than the current one are fine,
2911rationale behind this is that you do not need to check for recursion in 3011however. The rationale behind this is that you do not need to check
2912those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, 3012for recursion in those watchers, i.e. the sequence will always be
2913C<ev_check> so if you have one watcher of each kind they will always be 3013C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2914called in pairs bracketing the blocking call. 3014kind they will always be called in pairs bracketing the blocking call.
2915 3015
2916Their main purpose is to integrate other event mechanisms into libev and 3016Their main purpose is to integrate other event mechanisms into libev and
2917their use is somewhat advanced. They could be used, for example, to track 3017their use is somewhat advanced. They could be used, for example, to track
2918variable changes, implement your own watchers, integrate net-snmp or a 3018variable changes, implement your own watchers, integrate net-snmp or a
2919coroutine library and lots more. They are also occasionally useful if 3019coroutine library and lots more. They are also occasionally useful if
3209used). 3309used).
3210 3310
3211 struct ev_loop *loop_hi = ev_default_init (0); 3311 struct ev_loop *loop_hi = ev_default_init (0);
3212 struct ev_loop *loop_lo = 0; 3312 struct ev_loop *loop_lo = 0;
3213 ev_embed embed; 3313 ev_embed embed;
3214 3314
3215 // see if there is a chance of getting one that works 3315 // see if there is a chance of getting one that works
3216 // (remember that a flags value of 0 means autodetection) 3316 // (remember that a flags value of 0 means autodetection)
3217 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3317 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3218 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3318 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3219 : 0; 3319 : 0;
3233C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3333C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3234 3334
3235 struct ev_loop *loop = ev_default_init (0); 3335 struct ev_loop *loop = ev_default_init (0);
3236 struct ev_loop *loop_socket = 0; 3336 struct ev_loop *loop_socket = 0;
3237 ev_embed embed; 3337 ev_embed embed;
3238 3338
3239 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3339 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3240 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3340 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3241 { 3341 {
3242 ev_embed_init (&embed, 0, loop_socket); 3342 ev_embed_init (&embed, 0, loop_socket);
3243 ev_embed_start (loop, &embed); 3343 ev_embed_start (loop, &embed);
3259and calls it in the wrong process, the fork handlers will be invoked, too, 3359and calls it in the wrong process, the fork handlers will be invoked, too,
3260of course. 3360of course.
3261 3361
3262=head3 The special problem of life after fork - how is it possible? 3362=head3 The special problem of life after fork - how is it possible?
3263 3363
3264Most uses of C<fork()> consist of forking, then some simple calls to set 3364Most uses of C<fork ()> consist of forking, then some simple calls to set
3265up/change the process environment, followed by a call to C<exec()>. This 3365up/change the process environment, followed by a call to C<exec()>. This
3266sequence should be handled by libev without any problems. 3366sequence should be handled by libev without any problems.
3267 3367
3268This changes when the application actually wants to do event handling 3368This changes when the application actually wants to do event handling
3269in the child, or both parent in child, in effect "continuing" after the 3369in the child, or both parent in child, in effect "continuing" after the
3507 3607
3508There are some other functions of possible interest. Described. Here. Now. 3608There are some other functions of possible interest. Described. Here. Now.
3509 3609
3510=over 4 3610=over 4
3511 3611
3512=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) 3612=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3513 3613
3514This function combines a simple timer and an I/O watcher, calls your 3614This function combines a simple timer and an I/O watcher, calls your
3515callback on whichever event happens first and automatically stops both 3615callback on whichever event happens first and automatically stops both
3516watchers. This is useful if you want to wait for a single event on an fd 3616watchers. This is useful if you want to wait for a single event on an fd
3517or timeout without having to allocate/configure/start/stop/free one or 3617or timeout without having to allocate/configure/start/stop/free one or
3893To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two 3993To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3894files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 3994files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3895 3995
3896 // my_ev.h 3996 // my_ev.h
3897 #define EV_CB_DECLARE(type) struct my_coro *cb; 3997 #define EV_CB_DECLARE(type) struct my_coro *cb;
3898 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 3998 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3899 #include "../libev/ev.h" 3999 #include "../libev/ev.h"
3900 4000
3901 // my_ev.c 4001 // my_ev.c
3902 #define EV_H "my_ev.h" 4002 #define EV_H "my_ev.h"
3903 #include "../libev/ev.c" 4003 #include "../libev/ev.c"
3949The normal C API should work fine when used from C++: both ev.h and the 4049The normal C API should work fine when used from C++: both ev.h and the
3950libev sources can be compiled as C++. Therefore, code that uses the C API 4050libev sources can be compiled as C++. Therefore, code that uses the C API
3951will work fine. 4051will work fine.
3952 4052
3953Proper exception specifications might have to be added to callbacks passed 4053Proper exception specifications might have to be added to callbacks passed
3954to libev: exceptions may be thrown only from watcher callbacks, all 4054to libev: exceptions may be thrown only from watcher callbacks, all other
3955other callbacks (allocator, syserr, loop acquire/release and periodic 4055callbacks (allocator, syserr, loop acquire/release and periodic reschedule
3956reschedule callbacks) must not throw exceptions, and might need a C<throw 4056callbacks) must not throw exceptions, and might need a C<noexcept>
3957()> specification. If you have code that needs to be compiled as both C 4057specification. If you have code that needs to be compiled as both C and
3958and C++ you can use the C<EV_THROW> macro for this: 4058C++ you can use the C<EV_NOEXCEPT> macro for this:
3959 4059
3960 static void 4060 static void
3961 fatal_error (const char *msg) EV_THROW 4061 fatal_error (const char *msg) EV_NOEXCEPT
3962 { 4062 {
3963 perror (msg); 4063 perror (msg);
3964 abort (); 4064 abort ();
3965 } 4065 }
3966 4066
3980Libev comes with some simplistic wrapper classes for C++ that mainly allow 4080Libev comes with some simplistic wrapper classes for C++ that mainly allow
3981you to use some convenience methods to start/stop watchers and also change 4081you to use some convenience methods to start/stop watchers and also change
3982the callback model to a model using method callbacks on objects. 4082the callback model to a model using method callbacks on objects.
3983 4083
3984To use it, 4084To use it,
3985 4085
3986 #include <ev++.h> 4086 #include <ev++.h>
3987 4087
3988This automatically includes F<ev.h> and puts all of its definitions (many 4088This automatically includes F<ev.h> and puts all of its definitions (many
3989of them macros) into the global namespace. All C++ specific things are 4089of them macros) into the global namespace. All C++ specific things are
3990put into the C<ev> namespace. It should support all the same embedding 4090put into the C<ev> namespace. It should support all the same embedding
4093 void operator() (ev::io &w, int revents) 4193 void operator() (ev::io &w, int revents)
4094 { 4194 {
4095 ... 4195 ...
4096 } 4196 }
4097 } 4197 }
4098 4198
4099 myfunctor f; 4199 myfunctor f;
4100 4200
4101 ev::io w; 4201 ev::io w;
4102 w.set (&f); 4202 w.set (&f);
4103 4203
4376 ev_vars.h 4476 ev_vars.h
4377 ev_wrap.h 4477 ev_wrap.h
4378 4478
4379 ev_win32.c required on win32 platforms only 4479 ev_win32.c required on win32 platforms only
4380 4480
4381 ev_select.c only when select backend is enabled (which is enabled by default) 4481 ev_select.c only when select backend is enabled
4382 ev_poll.c only when poll backend is enabled (disabled by default) 4482 ev_poll.c only when poll backend is enabled
4383 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4483 ev_epoll.c only when the epoll backend is enabled
4484 ev_linuxaio.c only when the linux aio backend is enabled
4384 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4485 ev_kqueue.c only when the kqueue backend is enabled
4385 ev_port.c only when the solaris port backend is enabled (disabled by default) 4486 ev_port.c only when the solaris port backend is enabled
4386 4487
4387F<ev.c> includes the backend files directly when enabled, so you only need 4488F<ev.c> includes the backend files directly when enabled, so you only need
4388to compile this single file. 4489to compile this single file.
4389 4490
4390=head3 LIBEVENT COMPATIBILITY API 4491=head3 LIBEVENT COMPATIBILITY API
4578If defined to be C<1>, libev will compile in support for the Linux 4679If defined to be C<1>, libev will compile in support for the Linux
4579C<epoll>(7) backend. Its availability will be detected at runtime, 4680C<epoll>(7) backend. Its availability will be detected at runtime,
4580otherwise another method will be used as fallback. This is the preferred 4681otherwise another method will be used as fallback. This is the preferred
4581backend for GNU/Linux systems. If undefined, it will be enabled if the 4682backend for GNU/Linux systems. If undefined, it will be enabled if the
4582headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4683headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4684
4685=item EV_USE_LINUXAIO
4686
4687If defined to be C<1>, libev will compile in support for the Linux
4688aio backend. Due to it's currenbt limitations it has to be requested
4689explicitly. If undefined, it will be enabled on linux, otherwise
4690disabled.
4583 4691
4584=item EV_USE_KQUEUE 4692=item EV_USE_KQUEUE
4585 4693
4586If defined to be C<1>, libev will compile in support for the BSD style 4694If defined to be C<1>, libev will compile in support for the BSD style
4587C<kqueue>(2) backend. Its actual availability will be detected at runtime, 4695C<kqueue>(2) backend. Its actual availability will be detected at runtime,
5290structure (guaranteed by POSIX but not by ISO C for example), but it also 5398structure (guaranteed by POSIX but not by ISO C for example), but it also
5291assumes that the same (machine) code can be used to call any watcher 5399assumes that the same (machine) code can be used to call any watcher
5292callback: The watcher callbacks have different type signatures, but libev 5400callback: The watcher callbacks have different type signatures, but libev
5293calls them using an C<ev_watcher *> internally. 5401calls them using an C<ev_watcher *> internally.
5294 5402
5403=item null pointers and integer zero are represented by 0 bytes
5404
5405Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
5406relies on this setting pointers and integers to null.
5407
5295=item pointer accesses must be thread-atomic 5408=item pointer accesses must be thread-atomic
5296 5409
5297Accessing a pointer value must be atomic, it must both be readable and 5410Accessing a pointer value must be atomic, it must both be readable and
5298writable in one piece - this is the case on all current architectures. 5411writable in one piece - this is the case on all current architectures.
5299 5412
5427=over 4 5540=over 4
5428 5541
5429=item C<EV_COMPAT3> backwards compatibility mechanism 5542=item C<EV_COMPAT3> backwards compatibility mechanism
5430 5543
5431The backward compatibility mechanism can be controlled by 5544The backward compatibility mechanism can be controlled by
5432C<EV_COMPAT3>. See L</PREPROCESSOR SYMBOLS/MACROS> in the L</EMBEDDING> 5545C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5433section. 5546section.
5434 5547
5435=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5548=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5436 5549
5437These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5550These calls can be replaced easily by their C<ev_loop_xxx> counterparts:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines