… | |
… | |
214 | C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for |
214 | C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for |
215 | recommended ones. |
215 | recommended ones. |
216 | |
216 | |
217 | See the description of C<ev_embed> watchers for more info. |
217 | See the description of C<ev_embed> watchers for more info. |
218 | |
218 | |
219 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) |
219 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT] |
220 | |
220 | |
221 | Sets the allocation function to use (the prototype is similar - the |
221 | Sets the allocation function to use (the prototype is similar - the |
222 | semantics are identical to the C<realloc> C89/SuS/POSIX function). It is |
222 | semantics are identical to the C<realloc> C89/SuS/POSIX function). It is |
223 | used to allocate and free memory (no surprises here). If it returns zero |
223 | used to allocate and free memory (no surprises here). If it returns zero |
224 | when memory needs to be allocated (C<size != 0>), the library might abort |
224 | when memory needs to be allocated (C<size != 0>), the library might abort |
… | |
… | |
250 | } |
250 | } |
251 | |
251 | |
252 | ... |
252 | ... |
253 | ev_set_allocator (persistent_realloc); |
253 | ev_set_allocator (persistent_realloc); |
254 | |
254 | |
255 | =item ev_set_syserr_cb (void (*cb)(const char *msg)); |
255 | =item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT] |
256 | |
256 | |
257 | Set the callback function to call on a retryable system call error (such |
257 | Set the callback function to call on a retryable system call error (such |
258 | as failed select, poll, epoll_wait). The message is a printable string |
258 | as failed select, poll, epoll_wait). The message is a printable string |
259 | indicating the system call or subsystem causing the problem. If this |
259 | indicating the system call or subsystem causing the problem. If this |
260 | callback is set, then libev will expect it to remedy the situation, no |
260 | callback is set, then libev will expect it to remedy the situation, no |
… | |
… | |
396 | Please note that epoll sometimes generates spurious notifications, so you |
396 | Please note that epoll sometimes generates spurious notifications, so you |
397 | need to use non-blocking I/O or other means to avoid blocking when no data |
397 | need to use non-blocking I/O or other means to avoid blocking when no data |
398 | (or space) is available. |
398 | (or space) is available. |
399 | |
399 | |
400 | Best performance from this backend is achieved by not unregistering all |
400 | Best performance from this backend is achieved by not unregistering all |
401 | watchers for a file descriptor until it has been closed, if possible, i.e. |
401 | watchers for a file descriptor until it has been closed, if possible, |
402 | keep at least one watcher active per fd at all times. |
402 | i.e. keep at least one watcher active per fd at all times. Stopping and |
|
|
403 | starting a watcher (without re-setting it) also usually doesn't cause |
|
|
404 | extra overhead. |
403 | |
405 | |
404 | While nominally embeddable in other event loops, this feature is broken in |
406 | While nominally embeddable in other event loops, this feature is broken in |
405 | all kernel versions tested so far. |
407 | all kernel versions tested so far. |
406 | |
408 | |
407 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
409 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
408 | C<EVBACKEND_POLL>. |
410 | C<EVBACKEND_POLL>. |
409 | |
411 | |
410 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
412 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
411 | |
413 | |
412 | Kqueue deserves special mention, as at the time of this writing, it |
414 | Kqueue deserves special mention, as at the time of this writing, it was |
413 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
415 | broken on all BSDs except NetBSD (usually it doesn't work reliably with |
414 | with anything but sockets and pipes, except on Darwin, where of course |
416 | anything but sockets and pipes, except on Darwin, where of course it's |
415 | it's completely useless). For this reason it's not being "auto-detected" |
417 | completely useless). For this reason it's not being "auto-detected" unless |
416 | unless you explicitly specify it explicitly in the flags (i.e. using |
418 | you explicitly specify it in the flags (i.e. using C<EVBACKEND_KQUEUE>) or |
417 | C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) |
419 | libev was compiled on a known-to-be-good (-enough) system like NetBSD. |
418 | system like NetBSD. |
|
|
419 | |
420 | |
420 | You still can embed kqueue into a normal poll or select backend and use it |
421 | You still can embed kqueue into a normal poll or select backend and use it |
421 | only for sockets (after having made sure that sockets work with kqueue on |
422 | only for sockets (after having made sure that sockets work with kqueue on |
422 | the target platform). See C<ev_embed> watchers for more info. |
423 | the target platform). See C<ev_embed> watchers for more info. |
423 | |
424 | |
424 | It scales in the same way as the epoll backend, but the interface to the |
425 | It scales in the same way as the epoll backend, but the interface to the |
425 | kernel is more efficient (which says nothing about its actual speed, of |
426 | kernel is more efficient (which says nothing about its actual speed, of |
426 | course). While stopping, setting and starting an I/O watcher does never |
427 | course). While stopping, setting and starting an I/O watcher does never |
427 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
428 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
428 | two event changes per incident, support for C<fork ()> is very bad and it |
429 | two event changes per incident. Support for C<fork ()> is very bad and it |
429 | drops fds silently in similarly hard-to-detect cases. |
430 | drops fds silently in similarly hard-to-detect cases. |
430 | |
431 | |
431 | This backend usually performs well under most conditions. |
432 | This backend usually performs well under most conditions. |
432 | |
433 | |
433 | While nominally embeddable in other event loops, this doesn't work |
434 | While nominally embeddable in other event loops, this doesn't work |
434 | everywhere, so you might need to test for this. And since it is broken |
435 | everywhere, so you might need to test for this. And since it is broken |
435 | almost everywhere, you should only use it when you have a lot of sockets |
436 | almost everywhere, you should only use it when you have a lot of sockets |
436 | (for which it usually works), by embedding it into another event loop |
437 | (for which it usually works), by embedding it into another event loop |
437 | (e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for |
438 | (e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and, did I mention it, |
438 | sockets. |
439 | using it only for sockets. |
439 | |
440 | |
440 | This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with |
441 | This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with |
441 | C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with |
442 | C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with |
442 | C<NOTE_EOF>. |
443 | C<NOTE_EOF>. |
443 | |
444 | |
… | |
… | |
460 | While this backend scales well, it requires one system call per active |
461 | While this backend scales well, it requires one system call per active |
461 | file descriptor per loop iteration. For small and medium numbers of file |
462 | file descriptor per loop iteration. For small and medium numbers of file |
462 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
463 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
463 | might perform better. |
464 | might perform better. |
464 | |
465 | |
465 | On the positive side, ignoring the spurious readiness notifications, this |
466 | On the positive side, with the exception of the spurious readiness |
466 | backend actually performed to specification in all tests and is fully |
467 | notifications, this backend actually performed fully to specification |
467 | embeddable, which is a rare feat among the OS-specific backends. |
468 | in all tests and is fully embeddable, which is a rare feat among the |
|
|
469 | OS-specific backends. |
468 | |
470 | |
469 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
471 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
470 | C<EVBACKEND_POLL>. |
472 | C<EVBACKEND_POLL>. |
471 | |
473 | |
472 | =item C<EVBACKEND_ALL> |
474 | =item C<EVBACKEND_ALL> |
… | |
… | |
481 | |
483 | |
482 | If one or more of these are or'ed into the flags value, then only these |
484 | If one or more of these are or'ed into the flags value, then only these |
483 | backends will be tried (in the reverse order as listed here). If none are |
485 | backends will be tried (in the reverse order as listed here). If none are |
484 | specified, all backends in C<ev_recommended_backends ()> will be tried. |
486 | specified, all backends in C<ev_recommended_backends ()> will be tried. |
485 | |
487 | |
486 | The most typical usage is like this: |
488 | Example: This is the most typical usage. |
487 | |
489 | |
488 | if (!ev_default_loop (0)) |
490 | if (!ev_default_loop (0)) |
489 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
491 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
490 | |
492 | |
491 | Restrict libev to the select and poll backends, and do not allow |
493 | Example: Restrict libev to the select and poll backends, and do not allow |
492 | environment settings to be taken into account: |
494 | environment settings to be taken into account: |
493 | |
495 | |
494 | ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); |
496 | ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); |
495 | |
497 | |
496 | Use whatever libev has to offer, but make sure that kqueue is used if |
498 | Example: Use whatever libev has to offer, but make sure that kqueue is |
497 | available (warning, breaks stuff, best use only with your own private |
499 | used if available (warning, breaks stuff, best use only with your own |
498 | event loop and only if you know the OS supports your types of fds): |
500 | private event loop and only if you know the OS supports your types of |
|
|
501 | fds): |
499 | |
502 | |
500 | ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
503 | ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
501 | |
504 | |
502 | =item struct ev_loop *ev_loop_new (unsigned int flags) |
505 | =item struct ev_loop *ev_loop_new (unsigned int flags) |
503 | |
506 | |
… | |
… | |
561 | |
564 | |
562 | =item ev_loop_fork (loop) |
565 | =item ev_loop_fork (loop) |
563 | |
566 | |
564 | Like C<ev_default_fork>, but acts on an event loop created by |
567 | Like C<ev_default_fork>, but acts on an event loop created by |
565 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
568 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
566 | after fork, and how you do this is entirely your own problem. |
569 | after fork that you want to re-use in the child, and how you do this is |
|
|
570 | entirely your own problem. |
567 | |
571 | |
568 | =item int ev_is_default_loop (loop) |
572 | =item int ev_is_default_loop (loop) |
569 | |
573 | |
570 | Returns true when the given loop actually is the default loop, false otherwise. |
574 | Returns true when the given loop is, in fact, the default loop, and false |
|
|
575 | otherwise. |
571 | |
576 | |
572 | =item unsigned int ev_loop_count (loop) |
577 | =item unsigned int ev_loop_count (loop) |
573 | |
578 | |
574 | Returns the count of loop iterations for the loop, which is identical to |
579 | Returns the count of loop iterations for the loop, which is identical to |
575 | the number of times libev did poll for new events. It starts at C<0> and |
580 | the number of times libev did poll for new events. It starts at C<0> and |
… | |
… | |
613 | If the flags argument is specified as C<0>, it will not return until |
618 | If the flags argument is specified as C<0>, it will not return until |
614 | either no event watchers are active anymore or C<ev_unloop> was called. |
619 | either no event watchers are active anymore or C<ev_unloop> was called. |
615 | |
620 | |
616 | Please note that an explicit C<ev_unloop> is usually better than |
621 | Please note that an explicit C<ev_unloop> is usually better than |
617 | relying on all watchers to be stopped when deciding when a program has |
622 | relying on all watchers to be stopped when deciding when a program has |
618 | finished (especially in interactive programs), but having a program that |
623 | finished (especially in interactive programs), but having a program |
619 | automatically loops as long as it has to and no longer by virtue of |
624 | that automatically loops as long as it has to and no longer by virtue |
620 | relying on its watchers stopping correctly is a thing of beauty. |
625 | of relying on its watchers stopping correctly, that is truly a thing of |
|
|
626 | beauty. |
621 | |
627 | |
622 | A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle |
628 | A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle |
623 | those events and any outstanding ones, but will not block your process in |
629 | those events and any already outstanding ones, but will not block your |
624 | case there are no events and will return after one iteration of the loop. |
630 | process in case there are no events and will return after one iteration of |
|
|
631 | the loop. |
625 | |
632 | |
626 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
633 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
627 | necessary) and will handle those and any outstanding ones. It will block |
634 | necessary) and will handle those and any already outstanding ones. It |
628 | your process until at least one new event arrives, and will return after |
635 | will block your process until at least one new event arrives (which could |
629 | one iteration of the loop. This is useful if you are waiting for some |
636 | be an event internal to libev itself, so there is no guarentee that a |
630 | external event in conjunction with something not expressible using other |
637 | user-registered callback will be called), and will return after one |
|
|
638 | iteration of the loop. |
|
|
639 | |
|
|
640 | This is useful if you are waiting for some external event in conjunction |
|
|
641 | with something not expressible using other libev watchers (i.e. "roll your |
631 | libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is |
642 | own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is |
632 | usually a better approach for this kind of thing. |
643 | usually a better approach for this kind of thing. |
633 | |
644 | |
634 | Here are the gory details of what C<ev_loop> does: |
645 | Here are the gory details of what C<ev_loop> does: |
635 | |
646 | |
636 | - Before the first iteration, call any pending watchers. |
647 | - Before the first iteration, call any pending watchers. |
… | |
… | |
646 | any active watchers at all will result in not sleeping). |
657 | any active watchers at all will result in not sleeping). |
647 | - Sleep if the I/O and timer collect interval say so. |
658 | - Sleep if the I/O and timer collect interval say so. |
648 | - Block the process, waiting for any events. |
659 | - Block the process, waiting for any events. |
649 | - Queue all outstanding I/O (fd) events. |
660 | - Queue all outstanding I/O (fd) events. |
650 | - Update the "event loop time" (ev_now ()), and do time jump adjustments. |
661 | - Update the "event loop time" (ev_now ()), and do time jump adjustments. |
651 | - Queue all outstanding timers. |
662 | - Queue all expired timers. |
652 | - Queue all outstanding periodics. |
663 | - Queue all expired periodics. |
653 | - Unless any events are pending now, queue all idle watchers. |
664 | - Unless any events are pending now, queue all idle watchers. |
654 | - Queue all check watchers. |
665 | - Queue all check watchers. |
655 | - Call all queued watchers in reverse order (i.e. check watchers first). |
666 | - Call all queued watchers in reverse order (i.e. check watchers first). |
656 | Signals and child watchers are implemented as I/O watchers, and will |
667 | Signals and child watchers are implemented as I/O watchers, and will |
657 | be handled here by queueing them when their watcher gets executed. |
668 | be handled here by queueing them when their watcher gets executed. |
… | |
… | |
674 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
685 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
675 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
686 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
676 | |
687 | |
677 | This "unloop state" will be cleared when entering C<ev_loop> again. |
688 | This "unloop state" will be cleared when entering C<ev_loop> again. |
678 | |
689 | |
|
|
690 | It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls. |
|
|
691 | |
679 | =item ev_ref (loop) |
692 | =item ev_ref (loop) |
680 | |
693 | |
681 | =item ev_unref (loop) |
694 | =item ev_unref (loop) |
682 | |
695 | |
683 | Ref/unref can be used to add or remove a reference count on the event |
696 | Ref/unref can be used to add or remove a reference count on the event |
684 | loop: Every watcher keeps one reference, and as long as the reference |
697 | loop: Every watcher keeps one reference, and as long as the reference |
685 | count is nonzero, C<ev_loop> will not return on its own. If you have |
698 | count is nonzero, C<ev_loop> will not return on its own. |
|
|
699 | |
686 | a watcher you never unregister that should not keep C<ev_loop> from |
700 | If you have a watcher you never unregister that should not keep C<ev_loop> |
687 | returning, ev_unref() after starting, and ev_ref() before stopping it. For |
701 | from returning, call ev_unref() after starting, and ev_ref() before |
|
|
702 | stopping it. |
|
|
703 | |
688 | example, libev itself uses this for its internal signal pipe: It is not |
704 | As an example, libev itself uses this for its internal signal pipe: It is |
689 | visible to the libev user and should not keep C<ev_loop> from exiting if |
705 | not visible to the libev user and should not keep C<ev_loop> from exiting |
690 | no event watchers registered by it are active. It is also an excellent |
706 | if no event watchers registered by it are active. It is also an excellent |
691 | way to do this for generic recurring timers or from within third-party |
707 | way to do this for generic recurring timers or from within third-party |
692 | libraries. Just remember to I<unref after start> and I<ref before stop> |
708 | libraries. Just remember to I<unref after start> and I<ref before stop> |
693 | (but only if the watcher wasn't active before, or was active before, |
709 | (but only if the watcher wasn't active before, or was active before, |
694 | respectively). |
710 | respectively). |
695 | |
711 | |
… | |
… | |
718 | Setting these to a higher value (the C<interval> I<must> be >= C<0>) |
734 | Setting these to a higher value (the C<interval> I<must> be >= C<0>) |
719 | allows libev to delay invocation of I/O and timer/periodic callbacks |
735 | allows libev to delay invocation of I/O and timer/periodic callbacks |
720 | to increase efficiency of loop iterations (or to increase power-saving |
736 | to increase efficiency of loop iterations (or to increase power-saving |
721 | opportunities). |
737 | opportunities). |
722 | |
738 | |
723 | The background is that sometimes your program runs just fast enough to |
739 | The idea is that sometimes your program runs just fast enough to handle |
724 | handle one (or very few) event(s) per loop iteration. While this makes |
740 | one (or very few) event(s) per loop iteration. While this makes the |
725 | the program responsive, it also wastes a lot of CPU time to poll for new |
741 | program responsive, it also wastes a lot of CPU time to poll for new |
726 | events, especially with backends like C<select ()> which have a high |
742 | events, especially with backends like C<select ()> which have a high |
727 | overhead for the actual polling but can deliver many events at once. |
743 | overhead for the actual polling but can deliver many events at once. |
728 | |
744 | |
729 | By setting a higher I<io collect interval> you allow libev to spend more |
745 | By setting a higher I<io collect interval> you allow libev to spend more |
730 | time collecting I/O events, so you can handle more events per iteration, |
746 | time collecting I/O events, so you can handle more events per iteration, |
… | |
… | |
732 | C<ev_timer>) will be not affected. Setting this to a non-null value will |
748 | C<ev_timer>) will be not affected. Setting this to a non-null value will |
733 | introduce an additional C<ev_sleep ()> call into most loop iterations. |
749 | introduce an additional C<ev_sleep ()> call into most loop iterations. |
734 | |
750 | |
735 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
751 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
736 | to spend more time collecting timeouts, at the expense of increased |
752 | to spend more time collecting timeouts, at the expense of increased |
737 | latency (the watcher callback will be called later). C<ev_io> watchers |
753 | latency/jitter/inexactness (the watcher callback will be called |
738 | will not be affected. Setting this to a non-null value will not introduce |
754 | later). C<ev_io> watchers will not be affected. Setting this to a non-null |
739 | any overhead in libev. |
755 | value will not introduce any overhead in libev. |
740 | |
756 | |
741 | Many (busy) programs can usually benefit by setting the I/O collect |
757 | Many (busy) programs can usually benefit by setting the I/O collect |
742 | interval to a value near C<0.1> or so, which is often enough for |
758 | interval to a value near C<0.1> or so, which is often enough for |
743 | interactive servers (of course not for games), likewise for timeouts. It |
759 | interactive servers (of course not for games), likewise for timeouts. It |
744 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
760 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
… | |
… | |
752 | they fire on, say, one-second boundaries only. |
768 | they fire on, say, one-second boundaries only. |
753 | |
769 | |
754 | =item ev_loop_verify (loop) |
770 | =item ev_loop_verify (loop) |
755 | |
771 | |
756 | This function only does something when C<EV_VERIFY> support has been |
772 | This function only does something when C<EV_VERIFY> support has been |
757 | compiled in. It tries to go through all internal structures and checks |
773 | compiled in. which is the default for non-minimal builds. It tries to go |
758 | them for validity. If anything is found to be inconsistent, it will print |
774 | through all internal structures and checks them for validity. If anything |
759 | an error message to standard error and call C<abort ()>. |
775 | is found to be inconsistent, it will print an error message to standard |
|
|
776 | error and call C<abort ()>. |
760 | |
777 | |
761 | This can be used to catch bugs inside libev itself: under normal |
778 | This can be used to catch bugs inside libev itself: under normal |
762 | circumstances, this function will never abort as of course libev keeps its |
779 | circumstances, this function will never abort as of course libev keeps its |
763 | data structures consistent. |
780 | data structures consistent. |
764 | |
781 | |
… | |
… | |
880 | happen because the watcher could not be properly started because libev |
897 | happen because the watcher could not be properly started because libev |
881 | ran out of memory, a file descriptor was found to be closed or any other |
898 | ran out of memory, a file descriptor was found to be closed or any other |
882 | problem. You best act on it by reporting the problem and somehow coping |
899 | problem. You best act on it by reporting the problem and somehow coping |
883 | with the watcher being stopped. |
900 | with the watcher being stopped. |
884 | |
901 | |
885 | Libev will usually signal a few "dummy" events together with an error, |
902 | Libev will usually signal a few "dummy" events together with an error, for |
886 | for example it might indicate that a fd is readable or writable, and if |
903 | example it might indicate that a fd is readable or writable, and if your |
887 | your callbacks is well-written it can just attempt the operation and cope |
904 | callbacks is well-written it can just attempt the operation and cope with |
888 | with the error from read() or write(). This will not work in multi-threaded |
905 | the error from read() or write(). This will not work in multi-threaded |
889 | programs, though, so beware. |
906 | programs, though, as the fd could already be closed and reused for another |
|
|
907 | thing, so beware. |
890 | |
908 | |
891 | =back |
909 | =back |
892 | |
910 | |
893 | =head2 GENERIC WATCHER FUNCTIONS |
911 | =head2 GENERIC WATCHER FUNCTIONS |
894 | |
912 | |
… | |
… | |
910 | (or never started) and there are no pending events outstanding. |
928 | (or never started) and there are no pending events outstanding. |
911 | |
929 | |
912 | The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher, |
930 | The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher, |
913 | int revents)>. |
931 | int revents)>. |
914 | |
932 | |
|
|
933 | Example: Initialise an C<ev_io> watcher in two steps. |
|
|
934 | |
|
|
935 | ev_io w; |
|
|
936 | ev_init (&w, my_cb); |
|
|
937 | ev_io_set (&w, STDIN_FILENO, EV_READ); |
|
|
938 | |
915 | =item C<ev_TYPE_set> (ev_TYPE *, [args]) |
939 | =item C<ev_TYPE_set> (ev_TYPE *, [args]) |
916 | |
940 | |
917 | This macro initialises the type-specific parts of a watcher. You need to |
941 | This macro initialises the type-specific parts of a watcher. You need to |
918 | call C<ev_init> at least once before you call this macro, but you can |
942 | call C<ev_init> at least once before you call this macro, but you can |
919 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
943 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
… | |
… | |
921 | difference to the C<ev_init> macro). |
945 | difference to the C<ev_init> macro). |
922 | |
946 | |
923 | Although some watcher types do not have type-specific arguments |
947 | Although some watcher types do not have type-specific arguments |
924 | (e.g. C<ev_prepare>) you still need to call its C<set> macro. |
948 | (e.g. C<ev_prepare>) you still need to call its C<set> macro. |
925 | |
949 | |
|
|
950 | See C<ev_init>, above, for an example. |
|
|
951 | |
926 | =item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args]) |
952 | =item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args]) |
927 | |
953 | |
928 | This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro |
954 | This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro |
929 | calls into a single call. This is the most convenient method to initialise |
955 | calls into a single call. This is the most convenient method to initialise |
930 | a watcher. The same limitations apply, of course. |
956 | a watcher. The same limitations apply, of course. |
931 | |
957 | |
|
|
958 | Example: Initialise and set an C<ev_io> watcher in one step. |
|
|
959 | |
|
|
960 | ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
|
|
961 | |
932 | =item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) |
962 | =item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) |
933 | |
963 | |
934 | Starts (activates) the given watcher. Only active watchers will receive |
964 | Starts (activates) the given watcher. Only active watchers will receive |
935 | events. If the watcher is already active nothing will happen. |
965 | events. If the watcher is already active nothing will happen. |
936 | |
966 | |
|
|
967 | Example: Start the C<ev_io> watcher that is being abused as example in this |
|
|
968 | whole section. |
|
|
969 | |
|
|
970 | ev_io_start (EV_DEFAULT_UC, &w); |
|
|
971 | |
937 | =item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) |
972 | =item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) |
938 | |
973 | |
939 | Stops the given watcher again (if active) and clears the pending |
974 | Stops the given watcher if active, and clears the pending status (whether |
|
|
975 | the watcher was active or not). |
|
|
976 | |
940 | status. It is possible that stopped watchers are pending (for example, |
977 | It is possible that stopped watchers are pending - for example, |
941 | non-repeating timers are being stopped when they become pending), but |
978 | non-repeating timers are being stopped when they become pending - but |
942 | C<ev_TYPE_stop> ensures that the watcher is neither active nor pending. If |
979 | calling C<ev_TYPE_stop> ensures that the watcher is neither active nor |
943 | you want to free or reuse the memory used by the watcher it is therefore a |
980 | pending. If you want to free or reuse the memory used by the watcher it is |
944 | good idea to always call its C<ev_TYPE_stop> function. |
981 | therefore a good idea to always call its C<ev_TYPE_stop> function. |
945 | |
982 | |
946 | =item bool ev_is_active (ev_TYPE *watcher) |
983 | =item bool ev_is_active (ev_TYPE *watcher) |
947 | |
984 | |
948 | Returns a true value iff the watcher is active (i.e. it has been started |
985 | Returns a true value iff the watcher is active (i.e. it has been started |
949 | and not yet been stopped). As long as a watcher is active you must not modify |
986 | and not yet been stopped). As long as a watcher is active you must not modify |
… | |
… | |
997 | |
1034 | |
998 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1035 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
999 | |
1036 | |
1000 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
1037 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
1001 | C<loop> nor C<revents> need to be valid as long as the watcher callback |
1038 | C<loop> nor C<revents> need to be valid as long as the watcher callback |
1002 | can deal with that fact. |
1039 | can deal with that fact, as both are simply passed through to the |
|
|
1040 | callback. |
1003 | |
1041 | |
1004 | =item int ev_clear_pending (loop, ev_TYPE *watcher) |
1042 | =item int ev_clear_pending (loop, ev_TYPE *watcher) |
1005 | |
1043 | |
1006 | If the watcher is pending, this function returns clears its pending status |
1044 | If the watcher is pending, this function clears its pending status and |
1007 | and returns its C<revents> bitset (as if its callback was invoked). If the |
1045 | returns its C<revents> bitset (as if its callback was invoked). If the |
1008 | watcher isn't pending it does nothing and returns C<0>. |
1046 | watcher isn't pending it does nothing and returns C<0>. |
1009 | |
1047 | |
|
|
1048 | Sometimes it can be useful to "poll" a watcher instead of waiting for its |
|
|
1049 | callback to be invoked, which can be accomplished with this function. |
|
|
1050 | |
1010 | =back |
1051 | =back |
1011 | |
1052 | |
1012 | |
1053 | |
1013 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
1054 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
1014 | |
1055 | |
1015 | Each watcher has, by default, a member C<void *data> that you can change |
1056 | Each watcher has, by default, a member C<void *data> that you can change |
1016 | and read at any time, libev will completely ignore it. This can be used |
1057 | and read at any time: libev will completely ignore it. This can be used |
1017 | to associate arbitrary data with your watcher. If you need more data and |
1058 | to associate arbitrary data with your watcher. If you need more data and |
1018 | don't want to allocate memory and store a pointer to it in that data |
1059 | don't want to allocate memory and store a pointer to it in that data |
1019 | member, you can also "subclass" the watcher type and provide your own |
1060 | member, you can also "subclass" the watcher type and provide your own |
1020 | data: |
1061 | data: |
1021 | |
1062 | |
… | |
… | |
1053 | ev_timer t2; |
1094 | ev_timer t2; |
1054 | } |
1095 | } |
1055 | |
1096 | |
1056 | In this case getting the pointer to C<my_biggy> is a bit more |
1097 | In this case getting the pointer to C<my_biggy> is a bit more |
1057 | complicated: Either you store the address of your C<my_biggy> struct |
1098 | complicated: Either you store the address of your C<my_biggy> struct |
1058 | in the C<data> member of the watcher, or you need to use some pointer |
1099 | in the C<data> member of the watcher (for woozies), or you need to use |
1059 | arithmetic using C<offsetof> inside your watchers: |
1100 | some pointer arithmetic using C<offsetof> inside your watchers (for real |
|
|
1101 | programmers): |
1060 | |
1102 | |
1061 | #include <stddef.h> |
1103 | #include <stddef.h> |
1062 | |
1104 | |
1063 | static void |
1105 | static void |
1064 | t1_cb (EV_P_ struct ev_timer *w, int revents) |
1106 | t1_cb (EV_P_ struct ev_timer *w, int revents) |
… | |
… | |
1104 | In general you can register as many read and/or write event watchers per |
1146 | In general you can register as many read and/or write event watchers per |
1105 | fd as you want (as long as you don't confuse yourself). Setting all file |
1147 | fd as you want (as long as you don't confuse yourself). Setting all file |
1106 | descriptors to non-blocking mode is also usually a good idea (but not |
1148 | descriptors to non-blocking mode is also usually a good idea (but not |
1107 | required if you know what you are doing). |
1149 | required if you know what you are doing). |
1108 | |
1150 | |
1109 | If you must do this, then force the use of a known-to-be-good backend |
1151 | If you cannot use non-blocking mode, then force the use of a |
1110 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
1152 | known-to-be-good backend (at the time of this writing, this includes only |
1111 | C<EVBACKEND_POLL>). |
1153 | C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). |
1112 | |
1154 | |
1113 | Another thing you have to watch out for is that it is quite easy to |
1155 | Another thing you have to watch out for is that it is quite easy to |
1114 | receive "spurious" readiness notifications, that is your callback might |
1156 | receive "spurious" readiness notifications, that is your callback might |
1115 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
1157 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
1116 | because there is no data. Not only are some backends known to create a |
1158 | because there is no data. Not only are some backends known to create a |
1117 | lot of those (for example Solaris ports), it is very easy to get into |
1159 | lot of those (for example Solaris ports), it is very easy to get into |
1118 | this situation even with a relatively standard program structure. Thus |
1160 | this situation even with a relatively standard program structure. Thus |
1119 | it is best to always use non-blocking I/O: An extra C<read>(2) returning |
1161 | it is best to always use non-blocking I/O: An extra C<read>(2) returning |
1120 | C<EAGAIN> is far preferable to a program hanging until some data arrives. |
1162 | C<EAGAIN> is far preferable to a program hanging until some data arrives. |
1121 | |
1163 | |
1122 | If you cannot run the fd in non-blocking mode (for example you should not |
1164 | If you cannot run the fd in non-blocking mode (for example you should |
1123 | play around with an Xlib connection), then you have to separately re-test |
1165 | not play around with an Xlib connection), then you have to separately |
1124 | whether a file descriptor is really ready with a known-to-be good interface |
1166 | re-test whether a file descriptor is really ready with a known-to-be good |
1125 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1167 | interface such as poll (fortunately in our Xlib example, Xlib already |
1126 | its own, so its quite safe to use). |
1168 | does this on its own, so its quite safe to use). Some people additionally |
|
|
1169 | use C<SIGALRM> and an interval timer, just to be sure you won't block |
|
|
1170 | indefinitely. |
|
|
1171 | |
|
|
1172 | But really, best use non-blocking mode. |
1127 | |
1173 | |
1128 | =head3 The special problem of disappearing file descriptors |
1174 | =head3 The special problem of disappearing file descriptors |
1129 | |
1175 | |
1130 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
1176 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
1131 | descriptor (either by calling C<close> explicitly or by any other means, |
1177 | descriptor (either due to calling C<close> explicitly or any other means, |
1132 | such as C<dup>). The reason is that you register interest in some file |
1178 | such as C<dup2>). The reason is that you register interest in some file |
1133 | descriptor, but when it goes away, the operating system will silently drop |
1179 | descriptor, but when it goes away, the operating system will silently drop |
1134 | this interest. If another file descriptor with the same number then is |
1180 | this interest. If another file descriptor with the same number then is |
1135 | registered with libev, there is no efficient way to see that this is, in |
1181 | registered with libev, there is no efficient way to see that this is, in |
1136 | fact, a different file descriptor. |
1182 | fact, a different file descriptor. |
1137 | |
1183 | |
… | |
… | |
1168 | enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or |
1214 | enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or |
1169 | C<EVBACKEND_POLL>. |
1215 | C<EVBACKEND_POLL>. |
1170 | |
1216 | |
1171 | =head3 The special problem of SIGPIPE |
1217 | =head3 The special problem of SIGPIPE |
1172 | |
1218 | |
1173 | While not really specific to libev, it is easy to forget about SIGPIPE: |
1219 | While not really specific to libev, it is easy to forget about C<SIGPIPE>: |
1174 | when writing to a pipe whose other end has been closed, your program gets |
1220 | when writing to a pipe whose other end has been closed, your program gets |
1175 | send a SIGPIPE, which, by default, aborts your program. For most programs |
1221 | sent a SIGPIPE, which, by default, aborts your program. For most programs |
1176 | this is sensible behaviour, for daemons, this is usually undesirable. |
1222 | this is sensible behaviour, for daemons, this is usually undesirable. |
1177 | |
1223 | |
1178 | So when you encounter spurious, unexplained daemon exits, make sure you |
1224 | So when you encounter spurious, unexplained daemon exits, make sure you |
1179 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
1225 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
1180 | somewhere, as that would have given you a big clue). |
1226 | somewhere, as that would have given you a big clue). |
… | |
… | |
1187 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1233 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1188 | |
1234 | |
1189 | =item ev_io_set (ev_io *, int fd, int events) |
1235 | =item ev_io_set (ev_io *, int fd, int events) |
1190 | |
1236 | |
1191 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
1237 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
1192 | receive events for and events is either C<EV_READ>, C<EV_WRITE> or |
1238 | receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or |
1193 | C<EV_READ | EV_WRITE> to receive the given events. |
1239 | C<EV_READ | EV_WRITE>, to express the desire to receive the given events. |
1194 | |
1240 | |
1195 | =item int fd [read-only] |
1241 | =item int fd [read-only] |
1196 | |
1242 | |
1197 | The file descriptor being watched. |
1243 | The file descriptor being watched. |
1198 | |
1244 | |
… | |
… | |
1210 | |
1256 | |
1211 | static void |
1257 | static void |
1212 | stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1258 | stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1213 | { |
1259 | { |
1214 | ev_io_stop (loop, w); |
1260 | ev_io_stop (loop, w); |
1215 | .. read from stdin here (or from w->fd) and haqndle any I/O errors |
1261 | .. read from stdin here (or from w->fd) and handle any I/O errors |
1216 | } |
1262 | } |
1217 | |
1263 | |
1218 | ... |
1264 | ... |
1219 | struct ev_loop *loop = ev_default_init (0); |
1265 | struct ev_loop *loop = ev_default_init (0); |
1220 | struct ev_io stdin_readable; |
1266 | struct ev_io stdin_readable; |
… | |
… | |
1228 | Timer watchers are simple relative timers that generate an event after a |
1274 | Timer watchers are simple relative timers that generate an event after a |
1229 | given time, and optionally repeating in regular intervals after that. |
1275 | given time, and optionally repeating in regular intervals after that. |
1230 | |
1276 | |
1231 | The timers are based on real time, that is, if you register an event that |
1277 | The timers are based on real time, that is, if you register an event that |
1232 | times out after an hour and you reset your system clock to January last |
1278 | times out after an hour and you reset your system clock to January last |
1233 | year, it will still time out after (roughly) and hour. "Roughly" because |
1279 | year, it will still time out after (roughly) one hour. "Roughly" because |
1234 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1280 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1235 | monotonic clock option helps a lot here). |
1281 | monotonic clock option helps a lot here). |
1236 | |
1282 | |
1237 | The callback is guaranteed to be invoked only after its timeout has passed, |
1283 | The callback is guaranteed to be invoked only I<after> its timeout has |
1238 | but if multiple timers become ready during the same loop iteration then |
1284 | passed, but if multiple timers become ready during the same loop iteration |
1239 | order of execution is undefined. |
1285 | then order of execution is undefined. |
1240 | |
1286 | |
1241 | =head3 The special problem of time updates |
1287 | =head3 The special problem of time updates |
1242 | |
1288 | |
1243 | Establishing the current time is a costly operation (it usually takes at |
1289 | Establishing the current time is a costly operation (it usually takes at |
1244 | least two system calls): EV therefore updates its idea of the current |
1290 | least two system calls): EV therefore updates its idea of the current |
1245 | time only before and after C<ev_loop> polls for new events, which causes |
1291 | time only before and after C<ev_loop> collects new events, which causes a |
1246 | a growing difference between C<ev_now ()> and C<ev_time ()> when handling |
1292 | growing difference between C<ev_now ()> and C<ev_time ()> when handling |
1247 | lots of events. |
1293 | lots of events in one iteration. |
1248 | |
1294 | |
1249 | The relative timeouts are calculated relative to the C<ev_now ()> |
1295 | The relative timeouts are calculated relative to the C<ev_now ()> |
1250 | time. This is usually the right thing as this timestamp refers to the time |
1296 | time. This is usually the right thing as this timestamp refers to the time |
1251 | of the event triggering whatever timeout you are modifying/starting. If |
1297 | of the event triggering whatever timeout you are modifying/starting. If |
1252 | you suspect event processing to be delayed and you I<need> to base the |
1298 | you suspect event processing to be delayed and you I<need> to base the |
… | |
… | |
1313 | ev_timer_again (loop, timer); |
1359 | ev_timer_again (loop, timer); |
1314 | |
1360 | |
1315 | This is more slightly efficient then stopping/starting the timer each time |
1361 | This is more slightly efficient then stopping/starting the timer each time |
1316 | you want to modify its timeout value. |
1362 | you want to modify its timeout value. |
1317 | |
1363 | |
|
|
1364 | Note, however, that it is often even more efficient to remember the |
|
|
1365 | time of the last activity and let the timer time-out naturally. In the |
|
|
1366 | callback, you then check whether the time-out is real, or, if there was |
|
|
1367 | some activity, you reschedule the watcher to time-out in "last_activity + |
|
|
1368 | timeout - ev_now ()" seconds. |
|
|
1369 | |
1318 | =item ev_tstamp repeat [read-write] |
1370 | =item ev_tstamp repeat [read-write] |
1319 | |
1371 | |
1320 | The current C<repeat> value. Will be used each time the watcher times out |
1372 | The current C<repeat> value. Will be used each time the watcher times out |
1321 | or C<ev_timer_again> is called and determines the next timeout (if any), |
1373 | or C<ev_timer_again> is called, and determines the next timeout (if any), |
1322 | which is also when any modifications are taken into account. |
1374 | which is also when any modifications are taken into account. |
1323 | |
1375 | |
1324 | =back |
1376 | =back |
1325 | |
1377 | |
1326 | =head3 Examples |
1378 | =head3 Examples |
… | |
… | |
1370 | to trigger the event (unlike an C<ev_timer>, which would still trigger |
1422 | to trigger the event (unlike an C<ev_timer>, which would still trigger |
1371 | roughly 10 seconds later as it uses a relative timeout). |
1423 | roughly 10 seconds later as it uses a relative timeout). |
1372 | |
1424 | |
1373 | C<ev_periodic>s can also be used to implement vastly more complex timers, |
1425 | C<ev_periodic>s can also be used to implement vastly more complex timers, |
1374 | such as triggering an event on each "midnight, local time", or other |
1426 | such as triggering an event on each "midnight, local time", or other |
1375 | complicated, rules. |
1427 | complicated rules. |
1376 | |
1428 | |
1377 | As with timers, the callback is guaranteed to be invoked only when the |
1429 | As with timers, the callback is guaranteed to be invoked only when the |
1378 | time (C<at>) has passed, but if multiple periodic timers become ready |
1430 | time (C<at>) has passed, but if multiple periodic timers become ready |
1379 | during the same loop iteration then order of execution is undefined. |
1431 | during the same loop iteration, then order of execution is undefined. |
1380 | |
1432 | |
1381 | =head3 Watcher-Specific Functions and Data Members |
1433 | =head3 Watcher-Specific Functions and Data Members |
1382 | |
1434 | |
1383 | =over 4 |
1435 | =over 4 |
1384 | |
1436 | |
1385 | =item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) |
1437 | =item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) |
1386 | |
1438 | |
1387 | =item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) |
1439 | =item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) |
1388 | |
1440 | |
1389 | Lots of arguments, lets sort it out... There are basically three modes of |
1441 | Lots of arguments, lets sort it out... There are basically three modes of |
1390 | operation, and we will explain them from simplest to complex: |
1442 | operation, and we will explain them from simplest to most complex: |
1391 | |
1443 | |
1392 | =over 4 |
1444 | =over 4 |
1393 | |
1445 | |
1394 | =item * absolute timer (at = time, interval = reschedule_cb = 0) |
1446 | =item * absolute timer (at = time, interval = reschedule_cb = 0) |
1395 | |
1447 | |
1396 | In this configuration the watcher triggers an event after the wall clock |
1448 | In this configuration the watcher triggers an event after the wall clock |
1397 | time C<at> has passed and doesn't repeat. It will not adjust when a time |
1449 | time C<at> has passed. It will not repeat and will not adjust when a time |
1398 | jump occurs, that is, if it is to be run at January 1st 2011 then it will |
1450 | jump occurs, that is, if it is to be run at January 1st 2011 then it will |
1399 | run when the system time reaches or surpasses this time. |
1451 | only run when the system clock reaches or surpasses this time. |
1400 | |
1452 | |
1401 | =item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
1453 | =item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
1402 | |
1454 | |
1403 | In this mode the watcher will always be scheduled to time out at the next |
1455 | In this mode the watcher will always be scheduled to time out at the next |
1404 | C<at + N * interval> time (for some integer N, which can also be negative) |
1456 | C<at + N * interval> time (for some integer N, which can also be negative) |
1405 | and then repeat, regardless of any time jumps. |
1457 | and then repeat, regardless of any time jumps. |
1406 | |
1458 | |
1407 | This can be used to create timers that do not drift with respect to system |
1459 | This can be used to create timers that do not drift with respect to the |
1408 | time, for example, here is a C<ev_periodic> that triggers each hour, on |
1460 | system clock, for example, here is a C<ev_periodic> that triggers each |
1409 | the hour: |
1461 | hour, on the hour: |
1410 | |
1462 | |
1411 | ev_periodic_set (&periodic, 0., 3600., 0); |
1463 | ev_periodic_set (&periodic, 0., 3600., 0); |
1412 | |
1464 | |
1413 | This doesn't mean there will always be 3600 seconds in between triggers, |
1465 | This doesn't mean there will always be 3600 seconds in between triggers, |
1414 | but only that the callback will be called when the system time shows a |
1466 | but only that the callback will be called when the system time shows a |
… | |
… | |
1501 | =back |
1553 | =back |
1502 | |
1554 | |
1503 | =head3 Examples |
1555 | =head3 Examples |
1504 | |
1556 | |
1505 | Example: Call a callback every hour, or, more precisely, whenever the |
1557 | Example: Call a callback every hour, or, more precisely, whenever the |
1506 | system clock is divisible by 3600. The callback invocation times have |
1558 | system time is divisible by 3600. The callback invocation times have |
1507 | potentially a lot of jitter, but good long-term stability. |
1559 | potentially a lot of jitter, but good long-term stability. |
1508 | |
1560 | |
1509 | static void |
1561 | static void |
1510 | clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1562 | clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1511 | { |
1563 | { |
… | |
… | |
1521 | #include <math.h> |
1573 | #include <math.h> |
1522 | |
1574 | |
1523 | static ev_tstamp |
1575 | static ev_tstamp |
1524 | my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) |
1576 | my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) |
1525 | { |
1577 | { |
1526 | return fmod (now, 3600.) + 3600.; |
1578 | return now + (3600. - fmod (now, 3600.)); |
1527 | } |
1579 | } |
1528 | |
1580 | |
1529 | ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1581 | ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1530 | |
1582 | |
1531 | Example: Call a callback every hour, starting now: |
1583 | Example: Call a callback every hour, starting now: |
… | |
… | |
1541 | Signal watchers will trigger an event when the process receives a specific |
1593 | Signal watchers will trigger an event when the process receives a specific |
1542 | signal one or more times. Even though signals are very asynchronous, libev |
1594 | signal one or more times. Even though signals are very asynchronous, libev |
1543 | will try it's best to deliver signals synchronously, i.e. as part of the |
1595 | will try it's best to deliver signals synchronously, i.e. as part of the |
1544 | normal event processing, like any other event. |
1596 | normal event processing, like any other event. |
1545 | |
1597 | |
|
|
1598 | If you want signals asynchronously, just use C<sigaction> as you would |
|
|
1599 | do without libev and forget about sharing the signal. You can even use |
|
|
1600 | C<ev_async> from a signal handler to synchronously wake up an event loop. |
|
|
1601 | |
1546 | You can configure as many watchers as you like per signal. Only when the |
1602 | You can configure as many watchers as you like per signal. Only when the |
1547 | first watcher gets started will libev actually register a signal watcher |
1603 | first watcher gets started will libev actually register a signal handler |
1548 | with the kernel (thus it coexists with your own signal handlers as long |
1604 | with the kernel (thus it coexists with your own signal handlers as long as |
1549 | as you don't register any with libev). Similarly, when the last signal |
1605 | you don't register any with libev for the same signal). Similarly, when |
1550 | watcher for a signal is stopped libev will reset the signal handler to |
1606 | the last signal watcher for a signal is stopped, libev will reset the |
1551 | SIG_DFL (regardless of what it was set to before). |
1607 | signal handler to SIG_DFL (regardless of what it was set to before). |
1552 | |
1608 | |
1553 | If possible and supported, libev will install its handlers with |
1609 | If possible and supported, libev will install its handlers with |
1554 | C<SA_RESTART> behaviour enabled, so system calls should not be unduly |
1610 | C<SA_RESTART> behaviour enabled, so system calls should not be unduly |
1555 | interrupted. If you have a problem with system calls getting interrupted by |
1611 | interrupted. If you have a problem with system calls getting interrupted by |
1556 | signals you can block all signals in an C<ev_check> watcher and unblock |
1612 | signals you can block all signals in an C<ev_check> watcher and unblock |
… | |
… | |
1573 | |
1629 | |
1574 | =back |
1630 | =back |
1575 | |
1631 | |
1576 | =head3 Examples |
1632 | =head3 Examples |
1577 | |
1633 | |
1578 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
1634 | Example: Try to exit cleanly on SIGINT. |
1579 | |
1635 | |
1580 | static void |
1636 | static void |
1581 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1637 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1582 | { |
1638 | { |
1583 | ev_unloop (loop, EVUNLOOP_ALL); |
1639 | ev_unloop (loop, EVUNLOOP_ALL); |
1584 | } |
1640 | } |
1585 | |
1641 | |
1586 | struct ev_signal signal_watcher; |
1642 | struct ev_signal signal_watcher; |
1587 | ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1643 | ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1588 | ev_signal_start (loop, &sigint_cb); |
1644 | ev_signal_start (loop, &signal_watcher); |
1589 | |
1645 | |
1590 | |
1646 | |
1591 | =head2 C<ev_child> - watch out for process status changes |
1647 | =head2 C<ev_child> - watch out for process status changes |
1592 | |
1648 | |
1593 | Child watchers trigger when your process receives a SIGCHLD in response to |
1649 | Child watchers trigger when your process receives a SIGCHLD in response to |
1594 | some child status changes (most typically when a child of yours dies). It |
1650 | some child status changes (most typically when a child of yours dies or |
1595 | is permissible to install a child watcher I<after> the child has been |
1651 | exits). It is permissible to install a child watcher I<after> the child |
1596 | forked (which implies it might have already exited), as long as the event |
1652 | has been forked (which implies it might have already exited), as long |
1597 | loop isn't entered (or is continued from a watcher). |
1653 | as the event loop isn't entered (or is continued from a watcher), i.e., |
|
|
1654 | forking and then immediately registering a watcher for the child is fine, |
|
|
1655 | but forking and registering a watcher a few event loop iterations later is |
|
|
1656 | not. |
1598 | |
1657 | |
1599 | Only the default event loop is capable of handling signals, and therefore |
1658 | Only the default event loop is capable of handling signals, and therefore |
1600 | you can only register child watchers in the default event loop. |
1659 | you can only register child watchers in the default event loop. |
1601 | |
1660 | |
1602 | =head3 Process Interaction |
1661 | =head3 Process Interaction |
… | |
… | |
1700 | the stat buffer having unspecified contents. |
1759 | the stat buffer having unspecified contents. |
1701 | |
1760 | |
1702 | The path I<should> be absolute and I<must not> end in a slash. If it is |
1761 | The path I<should> be absolute and I<must not> end in a slash. If it is |
1703 | relative and your working directory changes, the behaviour is undefined. |
1762 | relative and your working directory changes, the behaviour is undefined. |
1704 | |
1763 | |
1705 | Since there is no standard to do this, the portable implementation simply |
1764 | Since there is no standard kernel interface to do this, the portable |
1706 | calls C<stat (2)> regularly on the path to see if it changed somehow. You |
1765 | implementation simply calls C<stat (2)> regularly on the path to see if |
1707 | can specify a recommended polling interval for this case. If you specify |
1766 | it changed somehow. You can specify a recommended polling interval for |
1708 | a polling interval of C<0> (highly recommended!) then a I<suitable, |
1767 | this case. If you specify a polling interval of C<0> (highly recommended!) |
1709 | unspecified default> value will be used (which you can expect to be around |
1768 | then a I<suitable, unspecified default> value will be used (which |
1710 | five seconds, although this might change dynamically). Libev will also |
1769 | you can expect to be around five seconds, although this might change |
1711 | impose a minimum interval which is currently around C<0.1>, but thats |
1770 | dynamically). Libev will also impose a minimum interval which is currently |
1712 | usually overkill. |
1771 | around C<0.1>, but thats usually overkill. |
1713 | |
1772 | |
1714 | This watcher type is not meant for massive numbers of stat watchers, |
1773 | This watcher type is not meant for massive numbers of stat watchers, |
1715 | as even with OS-supported change notifications, this can be |
1774 | as even with OS-supported change notifications, this can be |
1716 | resource-intensive. |
1775 | resource-intensive. |
1717 | |
1776 | |
1718 | At the time of this writing, only the Linux inotify interface is |
1777 | At the time of this writing, the only OS-specific interface implemented |
1719 | implemented (implementing kqueue support is left as an exercise for the |
1778 | is the Linux inotify interface (implementing kqueue support is left as |
1720 | reader, note, however, that the author sees no way of implementing ev_stat |
1779 | an exercise for the reader. Note, however, that the author sees no way |
1721 | semantics with kqueue). Inotify will be used to give hints only and should |
1780 | of implementing C<ev_stat> semantics with kqueue). |
1722 | not change the semantics of C<ev_stat> watchers, which means that libev |
|
|
1723 | sometimes needs to fall back to regular polling again even with inotify, |
|
|
1724 | but changes are usually detected immediately, and if the file exists there |
|
|
1725 | will be no polling. |
|
|
1726 | |
1781 | |
1727 | =head3 ABI Issues (Largefile Support) |
1782 | =head3 ABI Issues (Largefile Support) |
1728 | |
1783 | |
1729 | Libev by default (unless the user overrides this) uses the default |
1784 | Libev by default (unless the user overrides this) uses the default |
1730 | compilation environment, which means that on systems with large file |
1785 | compilation environment, which means that on systems with large file |
… | |
… | |
1739 | file interfaces available by default (as e.g. FreeBSD does) and not |
1794 | file interfaces available by default (as e.g. FreeBSD does) and not |
1740 | optional. Libev cannot simply switch on large file support because it has |
1795 | optional. Libev cannot simply switch on large file support because it has |
1741 | to exchange stat structures with application programs compiled using the |
1796 | to exchange stat structures with application programs compiled using the |
1742 | default compilation environment. |
1797 | default compilation environment. |
1743 | |
1798 | |
1744 | =head3 Inotify |
1799 | =head3 Inotify and Kqueue |
1745 | |
1800 | |
1746 | When C<inotify (7)> support has been compiled into libev (generally only |
1801 | When C<inotify (7)> support has been compiled into libev (generally only |
1747 | available on Linux) and present at runtime, it will be used to speed up |
1802 | available with Linux) and present at runtime, it will be used to speed up |
1748 | change detection where possible. The inotify descriptor will be created lazily |
1803 | change detection where possible. The inotify descriptor will be created lazily |
1749 | when the first C<ev_stat> watcher is being started. |
1804 | when the first C<ev_stat> watcher is being started. |
1750 | |
1805 | |
1751 | Inotify presence does not change the semantics of C<ev_stat> watchers |
1806 | Inotify presence does not change the semantics of C<ev_stat> watchers |
1752 | except that changes might be detected earlier, and in some cases, to avoid |
1807 | except that changes might be detected earlier, and in some cases, to avoid |
1753 | making regular C<stat> calls. Even in the presence of inotify support |
1808 | making regular C<stat> calls. Even in the presence of inotify support |
1754 | there are many cases where libev has to resort to regular C<stat> polling. |
1809 | there are many cases where libev has to resort to regular C<stat> polling, |
|
|
1810 | but as long as the path exists, libev usually gets away without polling. |
1755 | |
1811 | |
1756 | (There is no support for kqueue, as apparently it cannot be used to |
1812 | There is no support for kqueue, as apparently it cannot be used to |
1757 | implement this functionality, due to the requirement of having a file |
1813 | implement this functionality, due to the requirement of having a file |
1758 | descriptor open on the object at all times). |
1814 | descriptor open on the object at all times, and detecting renames, unlinks |
|
|
1815 | etc. is difficult. |
1759 | |
1816 | |
1760 | =head3 The special problem of stat time resolution |
1817 | =head3 The special problem of stat time resolution |
1761 | |
1818 | |
1762 | The C<stat ()> system call only supports full-second resolution portably, and |
1819 | The C<stat ()> system call only supports full-second resolution portably, and |
1763 | even on systems where the resolution is higher, many file systems still |
1820 | even on systems where the resolution is higher, most file systems still |
1764 | only support whole seconds. |
1821 | only support whole seconds. |
1765 | |
1822 | |
1766 | That means that, if the time is the only thing that changes, you can |
1823 | That means that, if the time is the only thing that changes, you can |
1767 | easily miss updates: on the first update, C<ev_stat> detects a change and |
1824 | easily miss updates: on the first update, C<ev_stat> detects a change and |
1768 | calls your callback, which does something. When there is another update |
1825 | calls your callback, which does something. When there is another update |
1769 | within the same second, C<ev_stat> will be unable to detect it as the stat |
1826 | within the same second, C<ev_stat> will be unable to detect unless the |
1770 | data does not change. |
1827 | stat data does change in other ways (e.g. file size). |
1771 | |
1828 | |
1772 | The solution to this is to delay acting on a change for slightly more |
1829 | The solution to this is to delay acting on a change for slightly more |
1773 | than a second (or till slightly after the next full second boundary), using |
1830 | than a second (or till slightly after the next full second boundary), using |
1774 | a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02); |
1831 | a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02); |
1775 | ev_timer_again (loop, w)>). |
1832 | ev_timer_again (loop, w)>). |
… | |
… | |
1795 | C<path>. The C<interval> is a hint on how quickly a change is expected to |
1852 | C<path>. The C<interval> is a hint on how quickly a change is expected to |
1796 | be detected and should normally be specified as C<0> to let libev choose |
1853 | be detected and should normally be specified as C<0> to let libev choose |
1797 | a suitable value. The memory pointed to by C<path> must point to the same |
1854 | a suitable value. The memory pointed to by C<path> must point to the same |
1798 | path for as long as the watcher is active. |
1855 | path for as long as the watcher is active. |
1799 | |
1856 | |
1800 | The callback will receive C<EV_STAT> when a change was detected, relative |
1857 | The callback will receive an C<EV_STAT> event when a change was detected, |
1801 | to the attributes at the time the watcher was started (or the last change |
1858 | relative to the attributes at the time the watcher was started (or the |
1802 | was detected). |
1859 | last change was detected). |
1803 | |
1860 | |
1804 | =item ev_stat_stat (loop, ev_stat *) |
1861 | =item ev_stat_stat (loop, ev_stat *) |
1805 | |
1862 | |
1806 | Updates the stat buffer immediately with new values. If you change the |
1863 | Updates the stat buffer immediately with new values. If you change the |
1807 | watched path in your callback, you could call this function to avoid |
1864 | watched path in your callback, you could call this function to avoid |
… | |
… | |
1890 | |
1947 | |
1891 | |
1948 | |
1892 | =head2 C<ev_idle> - when you've got nothing better to do... |
1949 | =head2 C<ev_idle> - when you've got nothing better to do... |
1893 | |
1950 | |
1894 | Idle watchers trigger events when no other events of the same or higher |
1951 | Idle watchers trigger events when no other events of the same or higher |
1895 | priority are pending (prepare, check and other idle watchers do not |
1952 | priority are pending (prepare, check and other idle watchers do not count |
1896 | count). |
1953 | as receiving "events"). |
1897 | |
1954 | |
1898 | That is, as long as your process is busy handling sockets or timeouts |
1955 | That is, as long as your process is busy handling sockets or timeouts |
1899 | (or even signals, imagine) of the same or higher priority it will not be |
1956 | (or even signals, imagine) of the same or higher priority it will not be |
1900 | triggered. But when your process is idle (or only lower-priority watchers |
1957 | triggered. But when your process is idle (or only lower-priority watchers |
1901 | are pending), the idle watchers are being called once per event loop |
1958 | are pending), the idle watchers are being called once per event loop |
… | |
… | |
1940 | ev_idle_start (loop, idle_cb); |
1997 | ev_idle_start (loop, idle_cb); |
1941 | |
1998 | |
1942 | |
1999 | |
1943 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2000 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
1944 | |
2001 | |
1945 | Prepare and check watchers are usually (but not always) used in tandem: |
2002 | Prepare and check watchers are usually (but not always) used in pairs: |
1946 | prepare watchers get invoked before the process blocks and check watchers |
2003 | prepare watchers get invoked before the process blocks and check watchers |
1947 | afterwards. |
2004 | afterwards. |
1948 | |
2005 | |
1949 | You I<must not> call C<ev_loop> or similar functions that enter |
2006 | You I<must not> call C<ev_loop> or similar functions that enter |
1950 | the current event loop from either C<ev_prepare> or C<ev_check> |
2007 | the current event loop from either C<ev_prepare> or C<ev_check> |
… | |
… | |
1953 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
2010 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
1954 | C<ev_check> so if you have one watcher of each kind they will always be |
2011 | C<ev_check> so if you have one watcher of each kind they will always be |
1955 | called in pairs bracketing the blocking call. |
2012 | called in pairs bracketing the blocking call. |
1956 | |
2013 | |
1957 | Their main purpose is to integrate other event mechanisms into libev and |
2014 | Their main purpose is to integrate other event mechanisms into libev and |
1958 | their use is somewhat advanced. This could be used, for example, to track |
2015 | their use is somewhat advanced. They could be used, for example, to track |
1959 | variable changes, implement your own watchers, integrate net-snmp or a |
2016 | variable changes, implement your own watchers, integrate net-snmp or a |
1960 | coroutine library and lots more. They are also occasionally useful if |
2017 | coroutine library and lots more. They are also occasionally useful if |
1961 | you cache some data and want to flush it before blocking (for example, |
2018 | you cache some data and want to flush it before blocking (for example, |
1962 | in X programs you might want to do an C<XFlush ()> in an C<ev_prepare> |
2019 | in X programs you might want to do an C<XFlush ()> in an C<ev_prepare> |
1963 | watcher). |
2020 | watcher). |
1964 | |
2021 | |
1965 | This is done by examining in each prepare call which file descriptors need |
2022 | This is done by examining in each prepare call which file descriptors |
1966 | to be watched by the other library, registering C<ev_io> watchers for |
2023 | need to be watched by the other library, registering C<ev_io> watchers |
1967 | them and starting an C<ev_timer> watcher for any timeouts (many libraries |
2024 | for them and starting an C<ev_timer> watcher for any timeouts (many |
1968 | provide just this functionality). Then, in the check watcher you check for |
2025 | libraries provide exactly this functionality). Then, in the check watcher, |
1969 | any events that occurred (by checking the pending status of all watchers |
2026 | you check for any events that occurred (by checking the pending status |
1970 | and stopping them) and call back into the library. The I/O and timer |
2027 | of all watchers and stopping them) and call back into the library. The |
1971 | callbacks will never actually be called (but must be valid nevertheless, |
2028 | I/O and timer callbacks will never actually be called (but must be valid |
1972 | because you never know, you know?). |
2029 | nevertheless, because you never know, you know?). |
1973 | |
2030 | |
1974 | As another example, the Perl Coro module uses these hooks to integrate |
2031 | As another example, the Perl Coro module uses these hooks to integrate |
1975 | coroutines into libev programs, by yielding to other active coroutines |
2032 | coroutines into libev programs, by yielding to other active coroutines |
1976 | during each prepare and only letting the process block if no coroutines |
2033 | during each prepare and only letting the process block if no coroutines |
1977 | are ready to run (it's actually more complicated: it only runs coroutines |
2034 | are ready to run (it's actually more complicated: it only runs coroutines |
… | |
… | |
1980 | loop from blocking if lower-priority coroutines are active, thus mapping |
2037 | loop from blocking if lower-priority coroutines are active, thus mapping |
1981 | low-priority coroutines to idle/background tasks). |
2038 | low-priority coroutines to idle/background tasks). |
1982 | |
2039 | |
1983 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
2040 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
1984 | priority, to ensure that they are being run before any other watchers |
2041 | priority, to ensure that they are being run before any other watchers |
|
|
2042 | after the poll (this doesn't matter for C<ev_prepare> watchers). |
|
|
2043 | |
1985 | after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, |
2044 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
1986 | too) should not activate ("feed") events into libev. While libev fully |
2045 | activate ("feed") events into libev. While libev fully supports this, they |
1987 | supports this, they might get executed before other C<ev_check> watchers |
2046 | might get executed before other C<ev_check> watchers did their job. As |
1988 | did their job. As C<ev_check> watchers are often used to embed other |
2047 | C<ev_check> watchers are often used to embed other (non-libev) event |
1989 | (non-libev) event loops those other event loops might be in an unusable |
2048 | loops those other event loops might be in an unusable state until their |
1990 | state until their C<ev_check> watcher ran (always remind yourself to |
2049 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
1991 | coexist peacefully with others). |
2050 | others). |
1992 | |
2051 | |
1993 | =head3 Watcher-Specific Functions and Data Members |
2052 | =head3 Watcher-Specific Functions and Data Members |
1994 | |
2053 | |
1995 | =over 4 |
2054 | =over 4 |
1996 | |
2055 | |
… | |
… | |
1998 | |
2057 | |
1999 | =item ev_check_init (ev_check *, callback) |
2058 | =item ev_check_init (ev_check *, callback) |
2000 | |
2059 | |
2001 | Initialises and configures the prepare or check watcher - they have no |
2060 | Initialises and configures the prepare or check watcher - they have no |
2002 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
2061 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
2003 | macros, but using them is utterly, utterly and completely pointless. |
2062 | macros, but using them is utterly, utterly, utterly and completely |
|
|
2063 | pointless. |
2004 | |
2064 | |
2005 | =back |
2065 | =back |
2006 | |
2066 | |
2007 | =head3 Examples |
2067 | =head3 Examples |
2008 | |
2068 | |
… | |
… | |
2101 | } |
2161 | } |
2102 | |
2162 | |
2103 | // do not ever call adns_afterpoll |
2163 | // do not ever call adns_afterpoll |
2104 | |
2164 | |
2105 | Method 4: Do not use a prepare or check watcher because the module you |
2165 | Method 4: Do not use a prepare or check watcher because the module you |
2106 | want to embed is too inflexible to support it. Instead, you can override |
2166 | want to embed is not flexible enough to support it. Instead, you can |
2107 | their poll function. The drawback with this solution is that the main |
2167 | override their poll function. The drawback with this solution is that the |
2108 | loop is now no longer controllable by EV. The C<Glib::EV> module does |
2168 | main loop is now no longer controllable by EV. The C<Glib::EV> module uses |
2109 | this. |
2169 | this approach, effectively embedding EV as a client into the horrible |
|
|
2170 | libglib event loop. |
2110 | |
2171 | |
2111 | static gint |
2172 | static gint |
2112 | event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
2173 | event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
2113 | { |
2174 | { |
2114 | int got_events = 0; |
2175 | int got_events = 0; |
… | |
… | |
2145 | prioritise I/O. |
2206 | prioritise I/O. |
2146 | |
2207 | |
2147 | As an example for a bug workaround, the kqueue backend might only support |
2208 | As an example for a bug workaround, the kqueue backend might only support |
2148 | sockets on some platform, so it is unusable as generic backend, but you |
2209 | sockets on some platform, so it is unusable as generic backend, but you |
2149 | still want to make use of it because you have many sockets and it scales |
2210 | still want to make use of it because you have many sockets and it scales |
2150 | so nicely. In this case, you would create a kqueue-based loop and embed it |
2211 | so nicely. In this case, you would create a kqueue-based loop and embed |
2151 | into your default loop (which might use e.g. poll). Overall operation will |
2212 | it into your default loop (which might use e.g. poll). Overall operation |
2152 | be a bit slower because first libev has to poll and then call kevent, but |
2213 | will be a bit slower because first libev has to call C<poll> and then |
2153 | at least you can use both at what they are best. |
2214 | C<kevent>, but at least you can use both mechanisms for what they are |
|
|
2215 | best: C<kqueue> for scalable sockets and C<poll> if you want it to work :) |
2154 | |
2216 | |
2155 | As for prioritising I/O: rarely you have the case where some fds have |
2217 | As for prioritising I/O: under rare circumstances you have the case where |
2156 | to be watched and handled very quickly (with low latency), and even |
2218 | some fds have to be watched and handled very quickly (with low latency), |
2157 | priorities and idle watchers might have too much overhead. In this case |
2219 | and even priorities and idle watchers might have too much overhead. In |
2158 | you would put all the high priority stuff in one loop and all the rest in |
2220 | this case you would put all the high priority stuff in one loop and all |
2159 | a second one, and embed the second one in the first. |
2221 | the rest in a second one, and embed the second one in the first. |
2160 | |
2222 | |
2161 | As long as the watcher is active, the callback will be invoked every time |
2223 | As long as the watcher is active, the callback will be invoked every time |
2162 | there might be events pending in the embedded loop. The callback must then |
2224 | there might be events pending in the embedded loop. The callback must then |
2163 | call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke |
2225 | call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke |
2164 | their callbacks (you could also start an idle watcher to give the embedded |
2226 | their callbacks (you could also start an idle watcher to give the embedded |
… | |
… | |
2172 | interested in that. |
2234 | interested in that. |
2173 | |
2235 | |
2174 | Also, there have not currently been made special provisions for forking: |
2236 | Also, there have not currently been made special provisions for forking: |
2175 | when you fork, you not only have to call C<ev_loop_fork> on both loops, |
2237 | when you fork, you not only have to call C<ev_loop_fork> on both loops, |
2176 | but you will also have to stop and restart any C<ev_embed> watchers |
2238 | but you will also have to stop and restart any C<ev_embed> watchers |
2177 | yourself. |
2239 | yourself - but you can use a fork watcher to handle this automatically, |
|
|
2240 | and future versions of libev might do just that. |
2178 | |
2241 | |
2179 | Unfortunately, not all backends are embeddable, only the ones returned by |
2242 | Unfortunately, not all backends are embeddable: only the ones returned by |
2180 | C<ev_embeddable_backends> are, which, unfortunately, does not include any |
2243 | C<ev_embeddable_backends> are, which, unfortunately, does not include any |
2181 | portable one. |
2244 | portable one. |
2182 | |
2245 | |
2183 | So when you want to use this feature you will always have to be prepared |
2246 | So when you want to use this feature you will always have to be prepared |
2184 | that you cannot get an embeddable loop. The recommended way to get around |
2247 | that you cannot get an embeddable loop. The recommended way to get around |
2185 | this is to have a separate variables for your embeddable loop, try to |
2248 | this is to have a separate variables for your embeddable loop, try to |
2186 | create it, and if that fails, use the normal loop for everything. |
2249 | create it, and if that fails, use the normal loop for everything. |
|
|
2250 | |
|
|
2251 | =head3 C<ev_embed> and fork |
|
|
2252 | |
|
|
2253 | While the C<ev_embed> watcher is running, forks in the embedding loop will |
|
|
2254 | automatically be applied to the embedded loop as well, so no special |
|
|
2255 | fork handling is required in that case. When the watcher is not running, |
|
|
2256 | however, it is still the task of the libev user to call C<ev_loop_fork ()> |
|
|
2257 | as applicable. |
2187 | |
2258 | |
2188 | =head3 Watcher-Specific Functions and Data Members |
2259 | =head3 Watcher-Specific Functions and Data Members |
2189 | |
2260 | |
2190 | =over 4 |
2261 | =over 4 |
2191 | |
2262 | |
… | |
… | |
2309 | is that the author does not know of a simple (or any) algorithm for a |
2380 | is that the author does not know of a simple (or any) algorithm for a |
2310 | multiple-writer-single-reader queue that works in all cases and doesn't |
2381 | multiple-writer-single-reader queue that works in all cases and doesn't |
2311 | need elaborate support such as pthreads. |
2382 | need elaborate support such as pthreads. |
2312 | |
2383 | |
2313 | That means that if you want to queue data, you have to provide your own |
2384 | That means that if you want to queue data, you have to provide your own |
2314 | queue. But at least I can tell you would implement locking around your |
2385 | queue. But at least I can tell you how to implement locking around your |
2315 | queue: |
2386 | queue: |
2316 | |
2387 | |
2317 | =over 4 |
2388 | =over 4 |
2318 | |
2389 | |
2319 | =item queueing from a signal handler context |
2390 | =item queueing from a signal handler context |
2320 | |
2391 | |
2321 | To implement race-free queueing, you simply add to the queue in the signal |
2392 | To implement race-free queueing, you simply add to the queue in the signal |
2322 | handler but you block the signal handler in the watcher callback. Here is an example that does that for |
2393 | handler but you block the signal handler in the watcher callback. Here is |
2323 | some fictitious SIGUSR1 handler: |
2394 | an example that does that for some fictitious SIGUSR1 handler: |
2324 | |
2395 | |
2325 | static ev_async mysig; |
2396 | static ev_async mysig; |
2326 | |
2397 | |
2327 | static void |
2398 | static void |
2328 | sigusr1_handler (void) |
2399 | sigusr1_handler (void) |
… | |
… | |
2395 | |
2466 | |
2396 | =item ev_async_init (ev_async *, callback) |
2467 | =item ev_async_init (ev_async *, callback) |
2397 | |
2468 | |
2398 | Initialises and configures the async watcher - it has no parameters of any |
2469 | Initialises and configures the async watcher - it has no parameters of any |
2399 | kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless, |
2470 | kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless, |
2400 | believe me. |
2471 | trust me. |
2401 | |
2472 | |
2402 | =item ev_async_send (loop, ev_async *) |
2473 | =item ev_async_send (loop, ev_async *) |
2403 | |
2474 | |
2404 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
2475 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
2405 | an C<EV_ASYNC> event on the watcher into the event loop. Unlike |
2476 | an C<EV_ASYNC> event on the watcher into the event loop. Unlike |
2406 | C<ev_feed_event>, this call is safe to do in other threads, signal or |
2477 | C<ev_feed_event>, this call is safe to do from other threads, signal or |
2407 | similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding |
2478 | similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding |
2408 | section below on what exactly this means). |
2479 | section below on what exactly this means). |
2409 | |
2480 | |
2410 | This call incurs the overhead of a system call only once per loop iteration, |
2481 | This call incurs the overhead of a system call only once per loop iteration, |
2411 | so while the overhead might be noticeable, it doesn't apply to repeated |
2482 | so while the overhead might be noticeable, it doesn't apply to repeated |
… | |
… | |
2435 | =over 4 |
2506 | =over 4 |
2436 | |
2507 | |
2437 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
2508 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
2438 | |
2509 | |
2439 | This function combines a simple timer and an I/O watcher, calls your |
2510 | This function combines a simple timer and an I/O watcher, calls your |
2440 | callback on whichever event happens first and automatically stop both |
2511 | callback on whichever event happens first and automatically stops both |
2441 | watchers. This is useful if you want to wait for a single event on an fd |
2512 | watchers. This is useful if you want to wait for a single event on an fd |
2442 | or timeout without having to allocate/configure/start/stop/free one or |
2513 | or timeout without having to allocate/configure/start/stop/free one or |
2443 | more watchers yourself. |
2514 | more watchers yourself. |
2444 | |
2515 | |
2445 | If C<fd> is less than 0, then no I/O watcher will be started and events |
2516 | If C<fd> is less than 0, then no I/O watcher will be started and the |
2446 | is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and |
2517 | C<events> argument is being ignored. Otherwise, an C<ev_io> watcher for |
2447 | C<events> set will be created and started. |
2518 | the given C<fd> and C<events> set will be created and started. |
2448 | |
2519 | |
2449 | If C<timeout> is less than 0, then no timeout watcher will be |
2520 | If C<timeout> is less than 0, then no timeout watcher will be |
2450 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
2521 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
2451 | repeat = 0) will be started. While C<0> is a valid timeout, it is of |
2522 | repeat = 0) will be started. C<0> is a valid timeout. |
2452 | dubious value. |
|
|
2453 | |
2523 | |
2454 | The callback has the type C<void (*cb)(int revents, void *arg)> and gets |
2524 | The callback has the type C<void (*cb)(int revents, void *arg)> and gets |
2455 | passed an C<revents> set like normal event callbacks (a combination of |
2525 | passed an C<revents> set like normal event callbacks (a combination of |
2456 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> |
2526 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> |
2457 | value passed to C<ev_once>: |
2527 | value passed to C<ev_once>. Note that it is possible to receive I<both> |
|
|
2528 | a timeout and an io event at the same time - you probably should give io |
|
|
2529 | events precedence. |
|
|
2530 | |
|
|
2531 | Example: wait up to ten seconds for data to appear on STDIN_FILENO. |
2458 | |
2532 | |
2459 | static void stdin_ready (int revents, void *arg) |
2533 | static void stdin_ready (int revents, void *arg) |
2460 | { |
2534 | { |
|
|
2535 | if (revents & EV_READ) |
|
|
2536 | /* stdin might have data for us, joy! */; |
2461 | if (revents & EV_TIMEOUT) |
2537 | else if (revents & EV_TIMEOUT) |
2462 | /* doh, nothing entered */; |
2538 | /* doh, nothing entered */; |
2463 | else if (revents & EV_READ) |
|
|
2464 | /* stdin might have data for us, joy! */; |
|
|
2465 | } |
2539 | } |
2466 | |
2540 | |
2467 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
2541 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
2468 | |
2542 | |
2469 | =item ev_feed_event (ev_loop *, watcher *, int revents) |
2543 | =item ev_feed_event (ev_loop *, watcher *, int revents) |
… | |
… | |
2617 | |
2691 | |
2618 | The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>. |
2692 | The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>. |
2619 | |
2693 | |
2620 | See the method-C<set> above for more details. |
2694 | See the method-C<set> above for more details. |
2621 | |
2695 | |
2622 | Example: |
2696 | Example: Use a plain function as callback. |
2623 | |
2697 | |
2624 | static void io_cb (ev::io &w, int revents) { } |
2698 | static void io_cb (ev::io &w, int revents) { } |
2625 | iow.set <io_cb> (); |
2699 | iow.set <io_cb> (); |
2626 | |
2700 | |
2627 | =item w->set (struct ev_loop *) |
2701 | =item w->set (struct ev_loop *) |
… | |
… | |
2665 | Example: Define a class with an IO and idle watcher, start one of them in |
2739 | Example: Define a class with an IO and idle watcher, start one of them in |
2666 | the constructor. |
2740 | the constructor. |
2667 | |
2741 | |
2668 | class myclass |
2742 | class myclass |
2669 | { |
2743 | { |
2670 | ev::io io; void io_cb (ev::io &w, int revents); |
2744 | ev::io io ; void io_cb (ev::io &w, int revents); |
2671 | ev:idle idle void idle_cb (ev::idle &w, int revents); |
2745 | ev::idle idle; void idle_cb (ev::idle &w, int revents); |
2672 | |
2746 | |
2673 | myclass (int fd) |
2747 | myclass (int fd) |
2674 | { |
2748 | { |
2675 | io .set <myclass, &myclass::io_cb > (this); |
2749 | io .set <myclass, &myclass::io_cb > (this); |
2676 | idle.set <myclass, &myclass::idle_cb> (this); |
2750 | idle.set <myclass, &myclass::idle_cb> (this); |
… | |
… | |
2692 | =item Perl |
2766 | =item Perl |
2693 | |
2767 | |
2694 | The EV module implements the full libev API and is actually used to test |
2768 | The EV module implements the full libev API and is actually used to test |
2695 | libev. EV is developed together with libev. Apart from the EV core module, |
2769 | libev. EV is developed together with libev. Apart from the EV core module, |
2696 | there are additional modules that implement libev-compatible interfaces |
2770 | there are additional modules that implement libev-compatible interfaces |
2697 | to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the |
2771 | to C<libadns> (C<EV::ADNS>, but C<AnyEvent::DNS> is preferred nowadays), |
2698 | C<libglib> event core (C<Glib::EV> and C<EV::Glib>). |
2772 | C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV> |
|
|
2773 | and C<EV::Glib>). |
2699 | |
2774 | |
2700 | It can be found and installed via CPAN, its homepage is at |
2775 | It can be found and installed via CPAN, its homepage is at |
2701 | L<http://software.schmorp.de/pkg/EV>. |
2776 | L<http://software.schmorp.de/pkg/EV>. |
2702 | |
2777 | |
2703 | =item Python |
2778 | =item Python |
… | |
… | |
2882 | |
2957 | |
2883 | =head2 PREPROCESSOR SYMBOLS/MACROS |
2958 | =head2 PREPROCESSOR SYMBOLS/MACROS |
2884 | |
2959 | |
2885 | Libev can be configured via a variety of preprocessor symbols you have to |
2960 | Libev can be configured via a variety of preprocessor symbols you have to |
2886 | define before including any of its files. The default in the absence of |
2961 | define before including any of its files. The default in the absence of |
2887 | autoconf is noted for every option. |
2962 | autoconf is documented for every option. |
2888 | |
2963 | |
2889 | =over 4 |
2964 | =over 4 |
2890 | |
2965 | |
2891 | =item EV_STANDALONE |
2966 | =item EV_STANDALONE |
2892 | |
2967 | |
… | |
… | |
3062 | When doing priority-based operations, libev usually has to linearly search |
3137 | When doing priority-based operations, libev usually has to linearly search |
3063 | all the priorities, so having many of them (hundreds) uses a lot of space |
3138 | all the priorities, so having many of them (hundreds) uses a lot of space |
3064 | and time, so using the defaults of five priorities (-2 .. +2) is usually |
3139 | and time, so using the defaults of five priorities (-2 .. +2) is usually |
3065 | fine. |
3140 | fine. |
3066 | |
3141 | |
3067 | If your embedding application does not need any priorities, defining these both to |
3142 | If your embedding application does not need any priorities, defining these |
3068 | C<0> will save some memory and CPU. |
3143 | both to C<0> will save some memory and CPU. |
3069 | |
3144 | |
3070 | =item EV_PERIODIC_ENABLE |
3145 | =item EV_PERIODIC_ENABLE |
3071 | |
3146 | |
3072 | If undefined or defined to be C<1>, then periodic timers are supported. If |
3147 | If undefined or defined to be C<1>, then periodic timers are supported. If |
3073 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
3148 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
… | |
… | |
3080 | code. |
3155 | code. |
3081 | |
3156 | |
3082 | =item EV_EMBED_ENABLE |
3157 | =item EV_EMBED_ENABLE |
3083 | |
3158 | |
3084 | If undefined or defined to be C<1>, then embed watchers are supported. If |
3159 | If undefined or defined to be C<1>, then embed watchers are supported. If |
3085 | defined to be C<0>, then they are not. |
3160 | defined to be C<0>, then they are not. Embed watchers rely on most other |
|
|
3161 | watcher types, which therefore must not be disabled. |
3086 | |
3162 | |
3087 | =item EV_STAT_ENABLE |
3163 | =item EV_STAT_ENABLE |
3088 | |
3164 | |
3089 | If undefined or defined to be C<1>, then stat watchers are supported. If |
3165 | If undefined or defined to be C<1>, then stat watchers are supported. If |
3090 | defined to be C<0>, then they are not. |
3166 | defined to be C<0>, then they are not. |
… | |
… | |
3122 | two). |
3198 | two). |
3123 | |
3199 | |
3124 | =item EV_USE_4HEAP |
3200 | =item EV_USE_4HEAP |
3125 | |
3201 | |
3126 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3202 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3127 | timer and periodics heap, libev uses a 4-heap when this symbol is defined |
3203 | timer and periodics heaps, libev uses a 4-heap when this symbol is defined |
3128 | to C<1>. The 4-heap uses more complicated (longer) code but has |
3204 | to C<1>. The 4-heap uses more complicated (longer) code but has noticeably |
3129 | noticeably faster performance with many (thousands) of watchers. |
3205 | faster performance with many (thousands) of watchers. |
3130 | |
3206 | |
3131 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3207 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3132 | (disabled). |
3208 | (disabled). |
3133 | |
3209 | |
3134 | =item EV_HEAP_CACHE_AT |
3210 | =item EV_HEAP_CACHE_AT |
3135 | |
3211 | |
3136 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3212 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3137 | timer and periodics heap, libev can cache the timestamp (I<at>) within |
3213 | timer and periodics heaps, libev can cache the timestamp (I<at>) within |
3138 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
3214 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
3139 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
3215 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
3140 | but avoids random read accesses on heap changes. This improves performance |
3216 | but avoids random read accesses on heap changes. This improves performance |
3141 | noticeably with with many (hundreds) of watchers. |
3217 | noticeably with many (hundreds) of watchers. |
3142 | |
3218 | |
3143 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3219 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3144 | (disabled). |
3220 | (disabled). |
3145 | |
3221 | |
3146 | =item EV_VERIFY |
3222 | =item EV_VERIFY |
… | |
… | |
3152 | called once per loop, which can slow down libev. If set to C<3>, then the |
3228 | called once per loop, which can slow down libev. If set to C<3>, then the |
3153 | verification code will be called very frequently, which will slow down |
3229 | verification code will be called very frequently, which will slow down |
3154 | libev considerably. |
3230 | libev considerably. |
3155 | |
3231 | |
3156 | The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be |
3232 | The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be |
3157 | C<0.> |
3233 | C<0>. |
3158 | |
3234 | |
3159 | =item EV_COMMON |
3235 | =item EV_COMMON |
3160 | |
3236 | |
3161 | By default, all watchers have a C<void *data> member. By redefining |
3237 | By default, all watchers have a C<void *data> member. By redefining |
3162 | this macro to a something else you can include more and other types of |
3238 | this macro to a something else you can include more and other types of |
… | |
… | |
3179 | and the way callbacks are invoked and set. Must expand to a struct member |
3255 | and the way callbacks are invoked and set. Must expand to a struct member |
3180 | definition and a statement, respectively. See the F<ev.h> header file for |
3256 | definition and a statement, respectively. See the F<ev.h> header file for |
3181 | their default definitions. One possible use for overriding these is to |
3257 | their default definitions. One possible use for overriding these is to |
3182 | avoid the C<struct ev_loop *> as first argument in all cases, or to use |
3258 | avoid the C<struct ev_loop *> as first argument in all cases, or to use |
3183 | method calls instead of plain function calls in C++. |
3259 | method calls instead of plain function calls in C++. |
|
|
3260 | |
|
|
3261 | =back |
3184 | |
3262 | |
3185 | =head2 EXPORTED API SYMBOLS |
3263 | =head2 EXPORTED API SYMBOLS |
3186 | |
3264 | |
3187 | If you need to re-export the API (e.g. via a DLL) and you need a list of |
3265 | If you need to re-export the API (e.g. via a DLL) and you need a list of |
3188 | exported symbols, you can use the provided F<Symbol.*> files which list |
3266 | exported symbols, you can use the provided F<Symbol.*> files which list |
… | |
… | |
3235 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
3313 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
3236 | |
3314 | |
3237 | #include "ev_cpp.h" |
3315 | #include "ev_cpp.h" |
3238 | #include "ev.c" |
3316 | #include "ev.c" |
3239 | |
3317 | |
|
|
3318 | =head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES |
3240 | |
3319 | |
3241 | =head1 THREADS AND COROUTINES |
3320 | =head2 THREADS AND COROUTINES |
3242 | |
3321 | |
3243 | =head2 THREADS |
3322 | =head3 THREADS |
3244 | |
3323 | |
3245 | Libev itself is completely thread-safe, but it uses no locking. This |
3324 | All libev functions are reentrant and thread-safe unless explicitly |
|
|
3325 | documented otherwise, but libev implements no locking itself. This means |
3246 | means that you can use as many loops as you want in parallel, as long as |
3326 | that you can use as many loops as you want in parallel, as long as there |
3247 | only one thread ever calls into one libev function with the same loop |
3327 | are no concurrent calls into any libev function with the same loop |
3248 | parameter. |
3328 | parameter (C<ev_default_*> calls have an implicit default loop parameter, |
|
|
3329 | of course): libev guarantees that different event loops share no data |
|
|
3330 | structures that need any locking. |
3249 | |
3331 | |
3250 | Or put differently: calls with different loop parameters can be done in |
3332 | Or to put it differently: calls with different loop parameters can be done |
3251 | parallel from multiple threads, calls with the same loop parameter must be |
3333 | concurrently from multiple threads, calls with the same loop parameter |
3252 | done serially (but can be done from different threads, as long as only one |
3334 | must be done serially (but can be done from different threads, as long as |
3253 | thread ever is inside a call at any point in time, e.g. by using a mutex |
3335 | only one thread ever is inside a call at any point in time, e.g. by using |
3254 | per loop). |
3336 | a mutex per loop). |
|
|
3337 | |
|
|
3338 | Specifically to support threads (and signal handlers), libev implements |
|
|
3339 | so-called C<ev_async> watchers, which allow some limited form of |
|
|
3340 | concurrency on the same event loop, namely waking it up "from the |
|
|
3341 | outside". |
3255 | |
3342 | |
3256 | If you want to know which design (one loop, locking, or multiple loops |
3343 | If you want to know which design (one loop, locking, or multiple loops |
3257 | without or something else still) is best for your problem, then I cannot |
3344 | without or something else still) is best for your problem, then I cannot |
3258 | help you. I can give some generic advice however: |
3345 | help you, but here is some generic advice: |
3259 | |
3346 | |
3260 | =over 4 |
3347 | =over 4 |
3261 | |
3348 | |
3262 | =item * most applications have a main thread: use the default libev loop |
3349 | =item * most applications have a main thread: use the default libev loop |
3263 | in that thread, or create a separate thread running only the default loop. |
3350 | in that thread, or create a separate thread running only the default loop. |
… | |
… | |
3275 | |
3362 | |
3276 | Choosing a model is hard - look around, learn, know that usually you can do |
3363 | Choosing a model is hard - look around, learn, know that usually you can do |
3277 | better than you currently do :-) |
3364 | better than you currently do :-) |
3278 | |
3365 | |
3279 | =item * often you need to talk to some other thread which blocks in the |
3366 | =item * often you need to talk to some other thread which blocks in the |
|
|
3367 | event loop. |
|
|
3368 | |
3280 | event loop - C<ev_async> watchers can be used to wake them up from other |
3369 | C<ev_async> watchers can be used to wake them up from other threads safely |
3281 | threads safely (or from signal contexts...). |
3370 | (or from signal contexts...). |
|
|
3371 | |
|
|
3372 | An example use would be to communicate signals or other events that only |
|
|
3373 | work in the default loop by registering the signal watcher with the |
|
|
3374 | default loop and triggering an C<ev_async> watcher from the default loop |
|
|
3375 | watcher callback into the event loop interested in the signal. |
3282 | |
3376 | |
3283 | =back |
3377 | =back |
3284 | |
3378 | |
3285 | =head2 COROUTINES |
3379 | =head3 COROUTINES |
3286 | |
3380 | |
3287 | Libev is much more accommodating to coroutines ("cooperative threads"): |
3381 | Libev is very accommodating to coroutines ("cooperative threads"): |
3288 | libev fully supports nesting calls to it's functions from different |
3382 | libev fully supports nesting calls to its functions from different |
3289 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
3383 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
3290 | different coroutines and switch freely between both coroutines running the |
3384 | different coroutines, and switch freely between both coroutines running the |
3291 | loop, as long as you don't confuse yourself). The only exception is that |
3385 | loop, as long as you don't confuse yourself). The only exception is that |
3292 | you must not do this from C<ev_periodic> reschedule callbacks. |
3386 | you must not do this from C<ev_periodic> reschedule callbacks. |
3293 | |
3387 | |
3294 | Care has been invested into making sure that libev does not keep local |
3388 | Care has been taken to ensure that libev does not keep local state inside |
3295 | state inside C<ev_loop>, and other calls do not usually allow coroutine |
3389 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
3296 | switches. |
3390 | they do not clal any callbacks. |
3297 | |
3391 | |
|
|
3392 | =head2 COMPILER WARNINGS |
3298 | |
3393 | |
3299 | =head1 COMPLEXITIES |
3394 | Depending on your compiler and compiler settings, you might get no or a |
|
|
3395 | lot of warnings when compiling libev code. Some people are apparently |
|
|
3396 | scared by this. |
3300 | |
3397 | |
3301 | In this section the complexities of (many of) the algorithms used inside |
3398 | However, these are unavoidable for many reasons. For one, each compiler |
3302 | libev will be explained. For complexity discussions about backends see the |
3399 | has different warnings, and each user has different tastes regarding |
3303 | documentation for C<ev_default_init>. |
3400 | warning options. "Warn-free" code therefore cannot be a goal except when |
|
|
3401 | targeting a specific compiler and compiler-version. |
3304 | |
3402 | |
3305 | All of the following are about amortised time: If an array needs to be |
3403 | Another reason is that some compiler warnings require elaborate |
3306 | extended, libev needs to realloc and move the whole array, but this |
3404 | workarounds, or other changes to the code that make it less clear and less |
3307 | happens asymptotically never with higher number of elements, so O(1) might |
3405 | maintainable. |
3308 | mean it might do a lengthy realloc operation in rare cases, but on average |
|
|
3309 | it is much faster and asymptotically approaches constant time. |
|
|
3310 | |
3406 | |
3311 | =over 4 |
3407 | And of course, some compiler warnings are just plain stupid, or simply |
|
|
3408 | wrong (because they don't actually warn about the condition their message |
|
|
3409 | seems to warn about). For example, certain older gcc versions had some |
|
|
3410 | warnings that resulted an extreme number of false positives. These have |
|
|
3411 | been fixed, but some people still insist on making code warn-free with |
|
|
3412 | such buggy versions. |
3312 | |
3413 | |
3313 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
3414 | While libev is written to generate as few warnings as possible, |
|
|
3415 | "warn-free" code is not a goal, and it is recommended not to build libev |
|
|
3416 | with any compiler warnings enabled unless you are prepared to cope with |
|
|
3417 | them (e.g. by ignoring them). Remember that warnings are just that: |
|
|
3418 | warnings, not errors, or proof of bugs. |
3314 | |
3419 | |
3315 | This means that, when you have a watcher that triggers in one hour and |
|
|
3316 | there are 100 watchers that would trigger before that then inserting will |
|
|
3317 | have to skip roughly seven (C<ld 100>) of these watchers. |
|
|
3318 | |
3420 | |
3319 | =item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers) |
3421 | =head2 VALGRIND |
3320 | |
3422 | |
3321 | That means that changing a timer costs less than removing/adding them |
3423 | Valgrind has a special section here because it is a popular tool that is |
3322 | as only the relative motion in the event queue has to be paid for. |
3424 | highly useful. Unfortunately, valgrind reports are very hard to interpret. |
3323 | |
3425 | |
3324 | =item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1) |
3426 | If you think you found a bug (memory leak, uninitialised data access etc.) |
|
|
3427 | in libev, then check twice: If valgrind reports something like: |
3325 | |
3428 | |
3326 | These just add the watcher into an array or at the head of a list. |
3429 | ==2274== definitely lost: 0 bytes in 0 blocks. |
|
|
3430 | ==2274== possibly lost: 0 bytes in 0 blocks. |
|
|
3431 | ==2274== still reachable: 256 bytes in 1 blocks. |
3327 | |
3432 | |
3328 | =item Stopping check/prepare/idle/fork/async watchers: O(1) |
3433 | Then there is no memory leak, just as memory accounted to global variables |
|
|
3434 | is not a memleak - the memory is still being refernced, and didn't leak. |
3329 | |
3435 | |
3330 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
3436 | Similarly, under some circumstances, valgrind might report kernel bugs |
|
|
3437 | as if it were a bug in libev (e.g. in realloc or in the poll backend, |
|
|
3438 | although an acceptable workaround has been found here), or it might be |
|
|
3439 | confused. |
3331 | |
3440 | |
3332 | These watchers are stored in lists then need to be walked to find the |
3441 | Keep in mind that valgrind is a very good tool, but only a tool. Don't |
3333 | correct watcher to remove. The lists are usually short (you don't usually |
3442 | make it into some kind of religion. |
3334 | have many watchers waiting for the same fd or signal). |
|
|
3335 | |
3443 | |
3336 | =item Finding the next timer in each loop iteration: O(1) |
3444 | If you are unsure about something, feel free to contact the mailing list |
|
|
3445 | with the full valgrind report and an explanation on why you think this |
|
|
3446 | is a bug in libev (best check the archives, too :). However, don't be |
|
|
3447 | annoyed when you get a brisk "this is no bug" answer and take the chance |
|
|
3448 | of learning how to interpret valgrind properly. |
3337 | |
3449 | |
3338 | By virtue of using a binary or 4-heap, the next timer is always found at a |
3450 | If you need, for some reason, empty reports from valgrind for your project |
3339 | fixed position in the storage array. |
3451 | I suggest using suppression lists. |
3340 | |
3452 | |
3341 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
|
|
3342 | |
3453 | |
3343 | A change means an I/O watcher gets started or stopped, which requires |
3454 | =head1 PORTABILITY NOTES |
3344 | libev to recalculate its status (and possibly tell the kernel, depending |
|
|
3345 | on backend and whether C<ev_io_set> was used). |
|
|
3346 | |
3455 | |
3347 | =item Activating one watcher (putting it into the pending state): O(1) |
|
|
3348 | |
|
|
3349 | =item Priority handling: O(number_of_priorities) |
|
|
3350 | |
|
|
3351 | Priorities are implemented by allocating some space for each |
|
|
3352 | priority. When doing priority-based operations, libev usually has to |
|
|
3353 | linearly search all the priorities, but starting/stopping and activating |
|
|
3354 | watchers becomes O(1) w.r.t. priority handling. |
|
|
3355 | |
|
|
3356 | =item Sending an ev_async: O(1) |
|
|
3357 | |
|
|
3358 | =item Processing ev_async_send: O(number_of_async_watchers) |
|
|
3359 | |
|
|
3360 | =item Processing signals: O(max_signal_number) |
|
|
3361 | |
|
|
3362 | Sending involves a system call I<iff> there were no other C<ev_async_send> |
|
|
3363 | calls in the current loop iteration. Checking for async and signal events |
|
|
3364 | involves iterating over all running async watchers or all signal numbers. |
|
|
3365 | |
|
|
3366 | =back |
|
|
3367 | |
|
|
3368 | |
|
|
3369 | =head1 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS |
3456 | =head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS |
3370 | |
3457 | |
3371 | Win32 doesn't support any of the standards (e.g. POSIX) that libev |
3458 | Win32 doesn't support any of the standards (e.g. POSIX) that libev |
3372 | requires, and its I/O model is fundamentally incompatible with the POSIX |
3459 | requires, and its I/O model is fundamentally incompatible with the POSIX |
3373 | model. Libev still offers limited functionality on this platform in |
3460 | model. Libev still offers limited functionality on this platform in |
3374 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
3461 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
… | |
… | |
3385 | |
3472 | |
3386 | Not a libev limitation but worth mentioning: windows apparently doesn't |
3473 | Not a libev limitation but worth mentioning: windows apparently doesn't |
3387 | accept large writes: instead of resulting in a partial write, windows will |
3474 | accept large writes: instead of resulting in a partial write, windows will |
3388 | either accept everything or return C<ENOBUFS> if the buffer is too large, |
3475 | either accept everything or return C<ENOBUFS> if the buffer is too large, |
3389 | so make sure you only write small amounts into your sockets (less than a |
3476 | so make sure you only write small amounts into your sockets (less than a |
3390 | megabyte seems safe, but thsi apparently depends on the amount of memory |
3477 | megabyte seems safe, but this apparently depends on the amount of memory |
3391 | available). |
3478 | available). |
3392 | |
3479 | |
3393 | Due to the many, low, and arbitrary limits on the win32 platform and |
3480 | Due to the many, low, and arbitrary limits on the win32 platform and |
3394 | the abysmal performance of winsockets, using a large number of sockets |
3481 | the abysmal performance of winsockets, using a large number of sockets |
3395 | is not recommended (and not reasonable). If your program needs to use |
3482 | is not recommended (and not reasonable). If your program needs to use |
… | |
… | |
3406 | #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */ |
3493 | #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */ |
3407 | |
3494 | |
3408 | #include "ev.h" |
3495 | #include "ev.h" |
3409 | |
3496 | |
3410 | And compile the following F<evwrap.c> file into your project (make sure |
3497 | And compile the following F<evwrap.c> file into your project (make sure |
3411 | you do I<not> compile the F<ev.c> or any other embedded soruce files!): |
3498 | you do I<not> compile the F<ev.c> or any other embedded source files!): |
3412 | |
3499 | |
3413 | #include "evwrap.h" |
3500 | #include "evwrap.h" |
3414 | #include "ev.c" |
3501 | #include "ev.c" |
3415 | |
3502 | |
3416 | =over 4 |
3503 | =over 4 |
… | |
… | |
3461 | wrap all I/O functions and provide your own fd management, but the cost of |
3548 | wrap all I/O functions and provide your own fd management, but the cost of |
3462 | calling select (O(n²)) will likely make this unworkable. |
3549 | calling select (O(n²)) will likely make this unworkable. |
3463 | |
3550 | |
3464 | =back |
3551 | =back |
3465 | |
3552 | |
3466 | |
|
|
3467 | =head1 PORTABILITY REQUIREMENTS |
3553 | =head2 PORTABILITY REQUIREMENTS |
3468 | |
3554 | |
3469 | In addition to a working ISO-C implementation, libev relies on a few |
3555 | In addition to a working ISO-C implementation and of course the |
3470 | additional extensions: |
3556 | backend-specific APIs, libev relies on a few additional extensions: |
3471 | |
3557 | |
3472 | =over 4 |
3558 | =over 4 |
3473 | |
3559 | |
3474 | =item C<void (*)(ev_watcher_type *, int revents)> must have compatible |
3560 | =item C<void (*)(ev_watcher_type *, int revents)> must have compatible |
3475 | calling conventions regardless of C<ev_watcher_type *>. |
3561 | calling conventions regardless of C<ev_watcher_type *>. |
… | |
… | |
3481 | calls them using an C<ev_watcher *> internally. |
3567 | calls them using an C<ev_watcher *> internally. |
3482 | |
3568 | |
3483 | =item C<sig_atomic_t volatile> must be thread-atomic as well |
3569 | =item C<sig_atomic_t volatile> must be thread-atomic as well |
3484 | |
3570 | |
3485 | The type C<sig_atomic_t volatile> (or whatever is defined as |
3571 | The type C<sig_atomic_t volatile> (or whatever is defined as |
3486 | C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different |
3572 | C<EV_ATOMIC_T>) must be atomic with respect to accesses from different |
3487 | threads. This is not part of the specification for C<sig_atomic_t>, but is |
3573 | threads. This is not part of the specification for C<sig_atomic_t>, but is |
3488 | believed to be sufficiently portable. |
3574 | believed to be sufficiently portable. |
3489 | |
3575 | |
3490 | =item C<sigprocmask> must work in a threaded environment |
3576 | =item C<sigprocmask> must work in a threaded environment |
3491 | |
3577 | |
… | |
… | |
3500 | except the initial one, and run the default loop in the initial thread as |
3586 | except the initial one, and run the default loop in the initial thread as |
3501 | well. |
3587 | well. |
3502 | |
3588 | |
3503 | =item C<long> must be large enough for common memory allocation sizes |
3589 | =item C<long> must be large enough for common memory allocation sizes |
3504 | |
3590 | |
3505 | To improve portability and simplify using libev, libev uses C<long> |
3591 | To improve portability and simplify its API, libev uses C<long> internally |
3506 | internally instead of C<size_t> when allocating its data structures. On |
3592 | instead of C<size_t> when allocating its data structures. On non-POSIX |
3507 | non-POSIX systems (Microsoft...) this might be unexpectedly low, but |
3593 | systems (Microsoft...) this might be unexpectedly low, but is still at |
3508 | is still at least 31 bits everywhere, which is enough for hundreds of |
3594 | least 31 bits everywhere, which is enough for hundreds of millions of |
3509 | millions of watchers. |
3595 | watchers. |
3510 | |
3596 | |
3511 | =item C<double> must hold a time value in seconds with enough accuracy |
3597 | =item C<double> must hold a time value in seconds with enough accuracy |
3512 | |
3598 | |
3513 | The type C<double> is used to represent timestamps. It is required to |
3599 | The type C<double> is used to represent timestamps. It is required to |
3514 | have at least 51 bits of mantissa (and 9 bits of exponent), which is good |
3600 | have at least 51 bits of mantissa (and 9 bits of exponent), which is good |
… | |
… | |
3518 | =back |
3604 | =back |
3519 | |
3605 | |
3520 | If you know of other additional requirements drop me a note. |
3606 | If you know of other additional requirements drop me a note. |
3521 | |
3607 | |
3522 | |
3608 | |
3523 | =head1 COMPILER WARNINGS |
3609 | =head1 ALGORITHMIC COMPLEXITIES |
3524 | |
3610 | |
3525 | Depending on your compiler and compiler settings, you might get no or a |
3611 | In this section the complexities of (many of) the algorithms used inside |
3526 | lot of warnings when compiling libev code. Some people are apparently |
3612 | libev will be documented. For complexity discussions about backends see |
3527 | scared by this. |
3613 | the documentation for C<ev_default_init>. |
3528 | |
3614 | |
3529 | However, these are unavoidable for many reasons. For one, each compiler |
3615 | All of the following are about amortised time: If an array needs to be |
3530 | has different warnings, and each user has different tastes regarding |
3616 | extended, libev needs to realloc and move the whole array, but this |
3531 | warning options. "Warn-free" code therefore cannot be a goal except when |
3617 | happens asymptotically rarer with higher number of elements, so O(1) might |
3532 | targeting a specific compiler and compiler-version. |
3618 | mean that libev does a lengthy realloc operation in rare cases, but on |
|
|
3619 | average it is much faster and asymptotically approaches constant time. |
3533 | |
3620 | |
3534 | Another reason is that some compiler warnings require elaborate |
3621 | =over 4 |
3535 | workarounds, or other changes to the code that make it less clear and less |
|
|
3536 | maintainable. |
|
|
3537 | |
3622 | |
3538 | And of course, some compiler warnings are just plain stupid, or simply |
3623 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
3539 | wrong (because they don't actually warn about the condition their message |
|
|
3540 | seems to warn about). |
|
|
3541 | |
3624 | |
3542 | While libev is written to generate as few warnings as possible, |
3625 | This means that, when you have a watcher that triggers in one hour and |
3543 | "warn-free" code is not a goal, and it is recommended not to build libev |
3626 | there are 100 watchers that would trigger before that, then inserting will |
3544 | with any compiler warnings enabled unless you are prepared to cope with |
3627 | have to skip roughly seven (C<ld 100>) of these watchers. |
3545 | them (e.g. by ignoring them). Remember that warnings are just that: |
|
|
3546 | warnings, not errors, or proof of bugs. |
|
|
3547 | |
3628 | |
|
|
3629 | =item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers) |
3548 | |
3630 | |
3549 | =head1 VALGRIND |
3631 | That means that changing a timer costs less than removing/adding them, |
|
|
3632 | as only the relative motion in the event queue has to be paid for. |
3550 | |
3633 | |
3551 | Valgrind has a special section here because it is a popular tool that is |
3634 | =item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1) |
3552 | highly useful, but valgrind reports are very hard to interpret. |
|
|
3553 | |
3635 | |
3554 | If you think you found a bug (memory leak, uninitialised data access etc.) |
3636 | These just add the watcher into an array or at the head of a list. |
3555 | in libev, then check twice: If valgrind reports something like: |
|
|
3556 | |
3637 | |
3557 | ==2274== definitely lost: 0 bytes in 0 blocks. |
3638 | =item Stopping check/prepare/idle/fork/async watchers: O(1) |
3558 | ==2274== possibly lost: 0 bytes in 0 blocks. |
|
|
3559 | ==2274== still reachable: 256 bytes in 1 blocks. |
|
|
3560 | |
3639 | |
3561 | Then there is no memory leak. Similarly, under some circumstances, |
3640 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
3562 | valgrind might report kernel bugs as if it were a bug in libev, or it |
|
|
3563 | might be confused (it is a very good tool, but only a tool). |
|
|
3564 | |
3641 | |
3565 | If you are unsure about something, feel free to contact the mailing list |
3642 | These watchers are stored in lists, so they need to be walked to find the |
3566 | with the full valgrind report and an explanation on why you think this is |
3643 | correct watcher to remove. The lists are usually short (you don't usually |
3567 | a bug in libev. However, don't be annoyed when you get a brisk "this is |
3644 | have many watchers waiting for the same fd or signal: one is typical, two |
3568 | no bug" answer and take the chance of learning how to interpret valgrind |
3645 | is rare). |
3569 | properly. |
|
|
3570 | |
3646 | |
3571 | If you need, for some reason, empty reports from valgrind for your project |
3647 | =item Finding the next timer in each loop iteration: O(1) |
3572 | I suggest using suppression lists. |
3648 | |
|
|
3649 | By virtue of using a binary or 4-heap, the next timer is always found at a |
|
|
3650 | fixed position in the storage array. |
|
|
3651 | |
|
|
3652 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
|
|
3653 | |
|
|
3654 | A change means an I/O watcher gets started or stopped, which requires |
|
|
3655 | libev to recalculate its status (and possibly tell the kernel, depending |
|
|
3656 | on backend and whether C<ev_io_set> was used). |
|
|
3657 | |
|
|
3658 | =item Activating one watcher (putting it into the pending state): O(1) |
|
|
3659 | |
|
|
3660 | =item Priority handling: O(number_of_priorities) |
|
|
3661 | |
|
|
3662 | Priorities are implemented by allocating some space for each |
|
|
3663 | priority. When doing priority-based operations, libev usually has to |
|
|
3664 | linearly search all the priorities, but starting/stopping and activating |
|
|
3665 | watchers becomes O(1) with respect to priority handling. |
|
|
3666 | |
|
|
3667 | =item Sending an ev_async: O(1) |
|
|
3668 | |
|
|
3669 | =item Processing ev_async_send: O(number_of_async_watchers) |
|
|
3670 | |
|
|
3671 | =item Processing signals: O(max_signal_number) |
|
|
3672 | |
|
|
3673 | Sending involves a system call I<iff> there were no other C<ev_async_send> |
|
|
3674 | calls in the current loop iteration. Checking for async and signal events |
|
|
3675 | involves iterating over all running async watchers or all signal numbers. |
|
|
3676 | |
|
|
3677 | =back |
3573 | |
3678 | |
3574 | |
3679 | |
3575 | =head1 AUTHOR |
3680 | =head1 AUTHOR |
3576 | |
3681 | |
3577 | Marc Lehmann <libev@schmorp.de>. |
3682 | Marc Lehmann <libev@schmorp.de>. |