… | |
… | |
98 | =head2 FEATURES |
98 | =head2 FEATURES |
99 | |
99 | |
100 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
100 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
101 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
101 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
102 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
102 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
103 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
103 | (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner |
104 | with customised rescheduling (C<ev_periodic>), synchronous signals |
104 | inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative |
105 | (C<ev_signal>), process status change events (C<ev_child>), and event |
105 | timers (C<ev_timer>), absolute timers with customised rescheduling |
106 | watchers dealing with the event loop mechanism itself (C<ev_idle>, |
106 | (C<ev_periodic>), synchronous signals (C<ev_signal>), process status |
107 | C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as |
107 | change events (C<ev_child>), and event watchers dealing with the event |
108 | file watchers (C<ev_stat>) and even limited support for fork events |
108 | loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and |
109 | (C<ev_fork>). |
109 | C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even |
|
|
110 | limited support for fork events (C<ev_fork>). |
110 | |
111 | |
111 | It also is quite fast (see this |
112 | It also is quite fast (see this |
112 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
113 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
113 | for example). |
114 | for example). |
114 | |
115 | |
… | |
… | |
117 | Libev is very configurable. In this manual the default (and most common) |
118 | Libev is very configurable. In this manual the default (and most common) |
118 | configuration will be described, which supports multiple event loops. For |
119 | configuration will be described, which supports multiple event loops. For |
119 | more info about various configuration options please have a look at |
120 | more info about various configuration options please have a look at |
120 | B<EMBED> section in this manual. If libev was configured without support |
121 | B<EMBED> section in this manual. If libev was configured without support |
121 | for multiple event loops, then all functions taking an initial argument of |
122 | for multiple event loops, then all functions taking an initial argument of |
122 | name C<loop> (which is always of type C<ev_loop *>) will not have |
123 | name C<loop> (which is always of type C<struct ev_loop *>) will not have |
123 | this argument. |
124 | this argument. |
124 | |
125 | |
125 | =head2 TIME REPRESENTATION |
126 | =head2 TIME REPRESENTATION |
126 | |
127 | |
127 | Libev represents time as a single floating point number, representing |
128 | Libev represents time as a single floating point number, representing |
128 | the (fractional) number of seconds since the (POSIX) epoch (somewhere |
129 | the (fractional) number of seconds since the (POSIX) epoch (in practise |
129 | near the beginning of 1970, details are complicated, don't ask). This |
130 | somewhere near the beginning of 1970, details are complicated, don't |
130 | type is called C<ev_tstamp>, which is what you should use too. It usually |
131 | ask). This type is called C<ev_tstamp>, which is what you should use |
131 | aliases to the C<double> type in C. When you need to do any calculations |
132 | too. It usually aliases to the C<double> type in C. When you need to do |
132 | on it, you should treat it as some floating point value. Unlike the name |
133 | any calculations on it, you should treat it as some floating point value. |
|
|
134 | |
133 | component C<stamp> might indicate, it is also used for time differences |
135 | Unlike the name component C<stamp> might indicate, it is also used for |
134 | throughout libev. |
136 | time differences (e.g. delays) throughout libev. |
135 | |
137 | |
136 | =head1 ERROR HANDLING |
138 | =head1 ERROR HANDLING |
137 | |
139 | |
138 | Libev knows three classes of errors: operating system errors, usage errors |
140 | Libev knows three classes of errors: operating system errors, usage errors |
139 | and internal errors (bugs). |
141 | and internal errors (bugs). |
… | |
… | |
190 | as this indicates an incompatible change. Minor versions are usually |
192 | as this indicates an incompatible change. Minor versions are usually |
191 | compatible to older versions, so a larger minor version alone is usually |
193 | compatible to older versions, so a larger minor version alone is usually |
192 | not a problem. |
194 | not a problem. |
193 | |
195 | |
194 | Example: Make sure we haven't accidentally been linked against the wrong |
196 | Example: Make sure we haven't accidentally been linked against the wrong |
195 | version. |
197 | version (note, however, that this will not detect ABI mismatches :). |
196 | |
198 | |
197 | assert (("libev version mismatch", |
199 | assert (("libev version mismatch", |
198 | ev_version_major () == EV_VERSION_MAJOR |
200 | ev_version_major () == EV_VERSION_MAJOR |
199 | && ev_version_minor () >= EV_VERSION_MINOR)); |
201 | && ev_version_minor () >= EV_VERSION_MINOR)); |
200 | |
202 | |
… | |
… | |
344 | useful to try out specific backends to test their performance, or to work |
346 | useful to try out specific backends to test their performance, or to work |
345 | around bugs. |
347 | around bugs. |
346 | |
348 | |
347 | =item C<EVFLAG_FORKCHECK> |
349 | =item C<EVFLAG_FORKCHECK> |
348 | |
350 | |
349 | Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after |
351 | Instead of calling C<ev_loop_fork> manually after a fork, you can also |
350 | a fork, you can also make libev check for a fork in each iteration by |
352 | make libev check for a fork in each iteration by enabling this flag. |
351 | enabling this flag. |
|
|
352 | |
353 | |
353 | This works by calling C<getpid ()> on every iteration of the loop, |
354 | This works by calling C<getpid ()> on every iteration of the loop, |
354 | and thus this might slow down your event loop if you do a lot of loop |
355 | and thus this might slow down your event loop if you do a lot of loop |
355 | iterations and little real work, but is usually not noticeable (on my |
356 | iterations and little real work, but is usually not noticeable (on my |
356 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence |
357 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence |
… | |
… | |
362 | flag. |
363 | flag. |
363 | |
364 | |
364 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
365 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
365 | environment variable. |
366 | environment variable. |
366 | |
367 | |
|
|
368 | =item C<EVFLAG_NOINOTIFY> |
|
|
369 | |
|
|
370 | When this flag is specified, then libev will not attempt to use the |
|
|
371 | I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and |
|
|
372 | testing, this flag can be useful to conserve inotify file descriptors, as |
|
|
373 | otherwise each loop using C<ev_stat> watchers consumes one inotify handle. |
|
|
374 | |
|
|
375 | =item C<EVFLAG_SIGNALFD> |
|
|
376 | |
|
|
377 | When this flag is specified, then libev will attempt to use the |
|
|
378 | I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API |
|
|
379 | delivers signals synchronously, which makes it both faster and might make |
|
|
380 | it possible to get the queued signal data. It can also simplify signal |
|
|
381 | handling with threads, as long as you properly block signals in your |
|
|
382 | threads that are not interested in handling them. |
|
|
383 | |
|
|
384 | Signalfd will not be used by default as this changes your signal mask, and |
|
|
385 | there are a lot of shoddy libraries and programs (glib's threadpool for |
|
|
386 | example) that can't properly initialise their signal masks. |
|
|
387 | |
367 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
388 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
368 | |
389 | |
369 | This is your standard select(2) backend. Not I<completely> standard, as |
390 | This is your standard select(2) backend. Not I<completely> standard, as |
370 | libev tries to roll its own fd_set with no limits on the number of fds, |
391 | libev tries to roll its own fd_set with no limits on the number of fds, |
371 | but if that fails, expect a fairly low limit on the number of fds when |
392 | but if that fails, expect a fairly low limit on the number of fds when |
… | |
… | |
394 | |
415 | |
395 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
416 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
396 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
417 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
397 | |
418 | |
398 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
419 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
|
|
420 | |
|
|
421 | Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
|
|
422 | kernels). |
399 | |
423 | |
400 | For few fds, this backend is a bit little slower than poll and select, |
424 | For few fds, this backend is a bit little slower than poll and select, |
401 | but it scales phenomenally better. While poll and select usually scale |
425 | but it scales phenomenally better. While poll and select usually scale |
402 | like O(total_fds) where n is the total number of fds (or the highest fd), |
426 | like O(total_fds) where n is the total number of fds (or the highest fd), |
403 | epoll scales either O(1) or O(active_fds). |
427 | epoll scales either O(1) or O(active_fds). |
… | |
… | |
518 | |
542 | |
519 | It is definitely not recommended to use this flag. |
543 | It is definitely not recommended to use this flag. |
520 | |
544 | |
521 | =back |
545 | =back |
522 | |
546 | |
523 | If one or more of these are or'ed into the flags value, then only these |
547 | If one or more of the backend flags are or'ed into the flags value, |
524 | backends will be tried (in the reverse order as listed here). If none are |
548 | then only these backends will be tried (in the reverse order as listed |
525 | specified, all backends in C<ev_recommended_backends ()> will be tried. |
549 | here). If none are specified, all backends in C<ev_recommended_backends |
|
|
550 | ()> will be tried. |
526 | |
551 | |
527 | Example: This is the most typical usage. |
552 | Example: This is the most typical usage. |
528 | |
553 | |
529 | if (!ev_default_loop (0)) |
554 | if (!ev_default_loop (0)) |
530 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
555 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
… | |
… | |
542 | ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
567 | ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
543 | |
568 | |
544 | =item struct ev_loop *ev_loop_new (unsigned int flags) |
569 | =item struct ev_loop *ev_loop_new (unsigned int flags) |
545 | |
570 | |
546 | Similar to C<ev_default_loop>, but always creates a new event loop that is |
571 | Similar to C<ev_default_loop>, but always creates a new event loop that is |
547 | always distinct from the default loop. Unlike the default loop, it cannot |
572 | always distinct from the default loop. |
548 | handle signal and child watchers, and attempts to do so will be greeted by |
|
|
549 | undefined behaviour (or a failed assertion if assertions are enabled). |
|
|
550 | |
573 | |
551 | Note that this function I<is> thread-safe, and the recommended way to use |
574 | Note that this function I<is> thread-safe, and one common way to use |
552 | libev with threads is indeed to create one loop per thread, and using the |
575 | libev with threads is indeed to create one loop per thread, and using the |
553 | default loop in the "main" or "initial" thread. |
576 | default loop in the "main" or "initial" thread. |
554 | |
577 | |
555 | Example: Try to create a event loop that uses epoll and nothing else. |
578 | Example: Try to create a event loop that uses epoll and nothing else. |
556 | |
579 | |
… | |
… | |
558 | if (!epoller) |
581 | if (!epoller) |
559 | fatal ("no epoll found here, maybe it hides under your chair"); |
582 | fatal ("no epoll found here, maybe it hides under your chair"); |
560 | |
583 | |
561 | =item ev_default_destroy () |
584 | =item ev_default_destroy () |
562 | |
585 | |
563 | Destroys the default loop again (frees all memory and kernel state |
586 | Destroys the default loop (frees all memory and kernel state etc.). None |
564 | etc.). None of the active event watchers will be stopped in the normal |
587 | of the active event watchers will be stopped in the normal sense, so |
565 | sense, so e.g. C<ev_is_active> might still return true. It is your |
588 | e.g. C<ev_is_active> might still return true. It is your responsibility to |
566 | responsibility to either stop all watchers cleanly yourself I<before> |
589 | either stop all watchers cleanly yourself I<before> calling this function, |
567 | calling this function, or cope with the fact afterwards (which is usually |
590 | or cope with the fact afterwards (which is usually the easiest thing, you |
568 | the easiest thing, you can just ignore the watchers and/or C<free ()> them |
591 | can just ignore the watchers and/or C<free ()> them for example). |
569 | for example). |
|
|
570 | |
592 | |
571 | Note that certain global state, such as signal state (and installed signal |
593 | Note that certain global state, such as signal state (and installed signal |
572 | handlers), will not be freed by this function, and related watchers (such |
594 | handlers), will not be freed by this function, and related watchers (such |
573 | as signal and child watchers) would need to be stopped manually. |
595 | as signal and child watchers) would need to be stopped manually. |
574 | |
596 | |
575 | In general it is not advisable to call this function except in the |
597 | In general it is not advisable to call this function except in the |
576 | rare occasion where you really need to free e.g. the signal handling |
598 | rare occasion where you really need to free e.g. the signal handling |
577 | pipe fds. If you need dynamically allocated loops it is better to use |
599 | pipe fds. If you need dynamically allocated loops it is better to use |
578 | C<ev_loop_new> and C<ev_loop_destroy>). |
600 | C<ev_loop_new> and C<ev_loop_destroy>. |
579 | |
601 | |
580 | =item ev_loop_destroy (loop) |
602 | =item ev_loop_destroy (loop) |
581 | |
603 | |
582 | Like C<ev_default_destroy>, but destroys an event loop created by an |
604 | Like C<ev_default_destroy>, but destroys an event loop created by an |
583 | earlier call to C<ev_loop_new>. |
605 | earlier call to C<ev_loop_new>. |
… | |
… | |
589 | name, you can call it anytime, but it makes most sense after forking, in |
611 | name, you can call it anytime, but it makes most sense after forking, in |
590 | the child process (or both child and parent, but that again makes little |
612 | the child process (or both child and parent, but that again makes little |
591 | sense). You I<must> call it in the child before using any of the libev |
613 | sense). You I<must> call it in the child before using any of the libev |
592 | functions, and it will only take effect at the next C<ev_loop> iteration. |
614 | functions, and it will only take effect at the next C<ev_loop> iteration. |
593 | |
615 | |
|
|
616 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
|
|
617 | a fork, I<even if you do not plan to use the loop in the parent>. This is |
|
|
618 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
|
|
619 | during fork. |
|
|
620 | |
594 | On the other hand, you only need to call this function in the child |
621 | On the other hand, you only need to call this function in the child |
595 | process if and only if you want to use the event library in the child. If |
622 | process if and only if you want to use the event loop in the child. If you |
596 | you just fork+exec, you don't have to call it at all. |
623 | just fork+exec or create a new loop in the child, you don't have to call |
|
|
624 | it at all. |
597 | |
625 | |
598 | The function itself is quite fast and it's usually not a problem to call |
626 | The function itself is quite fast and it's usually not a problem to call |
599 | it just in case after a fork. To make this easy, the function will fit in |
627 | it just in case after a fork. To make this easy, the function will fit in |
600 | quite nicely into a call to C<pthread_atfork>: |
628 | quite nicely into a call to C<pthread_atfork>: |
601 | |
629 | |
… | |
… | |
603 | |
631 | |
604 | =item ev_loop_fork (loop) |
632 | =item ev_loop_fork (loop) |
605 | |
633 | |
606 | Like C<ev_default_fork>, but acts on an event loop created by |
634 | Like C<ev_default_fork>, but acts on an event loop created by |
607 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
635 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
608 | after fork that you want to re-use in the child, and how you do this is |
636 | after fork that you want to re-use in the child, and how you keep track of |
609 | entirely your own problem. |
637 | them is entirely your own problem. |
610 | |
638 | |
611 | =item int ev_is_default_loop (loop) |
639 | =item int ev_is_default_loop (loop) |
612 | |
640 | |
613 | Returns true when the given loop is, in fact, the default loop, and false |
641 | Returns true when the given loop is, in fact, the default loop, and false |
614 | otherwise. |
642 | otherwise. |
615 | |
643 | |
616 | =item unsigned int ev_loop_count (loop) |
644 | =item unsigned int ev_iteration (loop) |
617 | |
645 | |
618 | Returns the count of loop iterations for the loop, which is identical to |
646 | Returns the current iteration count for the loop, which is identical to |
619 | the number of times libev did poll for new events. It starts at C<0> and |
647 | the number of times libev did poll for new events. It starts at C<0> and |
620 | happily wraps around with enough iterations. |
648 | happily wraps around with enough iterations. |
621 | |
649 | |
622 | This value can sometimes be useful as a generation counter of sorts (it |
650 | This value can sometimes be useful as a generation counter of sorts (it |
623 | "ticks" the number of loop iterations), as it roughly corresponds with |
651 | "ticks" the number of loop iterations), as it roughly corresponds with |
624 | C<ev_prepare> and C<ev_check> calls. |
652 | C<ev_prepare> and C<ev_check> calls - and is incremented between the |
|
|
653 | prepare and check phases. |
625 | |
654 | |
626 | =item unsigned int ev_loop_depth (loop) |
655 | =item unsigned int ev_depth (loop) |
627 | |
656 | |
628 | Returns the number of times C<ev_loop> was entered minus the number of |
657 | Returns the number of times C<ev_loop> was entered minus the number of |
629 | times C<ev_loop> was exited, in other words, the recursion depth. |
658 | times C<ev_loop> was exited, in other words, the recursion depth. |
630 | |
659 | |
631 | Outside C<ev_loop>, this number is zero. In a callback, this number is |
660 | Outside C<ev_loop>, this number is zero. In a callback, this number is |
632 | C<1>, unless C<ev_loop> was invoked recursively (or from another thread), |
661 | C<1>, unless C<ev_loop> was invoked recursively (or from another thread), |
633 | in which case it is higher. |
662 | in which case it is higher. |
634 | |
663 | |
635 | Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread |
664 | Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread |
636 | etc.), doesn't count as exit. |
665 | etc.), doesn't count as "exit" - consider this as a hint to avoid such |
|
|
666 | ungentleman behaviour unless it's really convenient. |
637 | |
667 | |
638 | =item unsigned int ev_backend (loop) |
668 | =item unsigned int ev_backend (loop) |
639 | |
669 | |
640 | Returns one of the C<EVBACKEND_*> flags indicating the event backend in |
670 | Returns one of the C<EVBACKEND_*> flags indicating the event backend in |
641 | use. |
671 | use. |
… | |
… | |
687 | event loop time (see C<ev_now_update>). |
717 | event loop time (see C<ev_now_update>). |
688 | |
718 | |
689 | =item ev_loop (loop, int flags) |
719 | =item ev_loop (loop, int flags) |
690 | |
720 | |
691 | Finally, this is it, the event handler. This function usually is called |
721 | Finally, this is it, the event handler. This function usually is called |
692 | after you initialised all your watchers and you want to start handling |
722 | after you have initialised all your watchers and you want to start |
693 | events. |
723 | handling events. |
694 | |
724 | |
695 | If the flags argument is specified as C<0>, it will not return until |
725 | If the flags argument is specified as C<0>, it will not return until |
696 | either no event watchers are active anymore or C<ev_unloop> was called. |
726 | either no event watchers are active anymore or C<ev_unloop> was called. |
697 | |
727 | |
698 | Please note that an explicit C<ev_unloop> is usually better than |
728 | Please note that an explicit C<ev_unloop> is usually better than |
… | |
… | |
772 | |
802 | |
773 | Ref/unref can be used to add or remove a reference count on the event |
803 | Ref/unref can be used to add or remove a reference count on the event |
774 | loop: Every watcher keeps one reference, and as long as the reference |
804 | loop: Every watcher keeps one reference, and as long as the reference |
775 | count is nonzero, C<ev_loop> will not return on its own. |
805 | count is nonzero, C<ev_loop> will not return on its own. |
776 | |
806 | |
777 | If you have a watcher you never unregister that should not keep C<ev_loop> |
807 | This is useful when you have a watcher that you never intend to |
778 | from returning, call ev_unref() after starting, and ev_ref() before |
808 | unregister, but that nevertheless should not keep C<ev_loop> from |
|
|
809 | returning. In such a case, call C<ev_unref> after starting, and C<ev_ref> |
779 | stopping it. |
810 | before stopping it. |
780 | |
811 | |
781 | As an example, libev itself uses this for its internal signal pipe: It |
812 | As an example, libev itself uses this for its internal signal pipe: It |
782 | is not visible to the libev user and should not keep C<ev_loop> from |
813 | is not visible to the libev user and should not keep C<ev_loop> from |
783 | exiting if no event watchers registered by it are active. It is also an |
814 | exiting if no event watchers registered by it are active. It is also an |
784 | excellent way to do this for generic recurring timers or from within |
815 | excellent way to do this for generic recurring timers or from within |
… | |
… | |
862 | |
893 | |
863 | This call will simply invoke all pending watchers while resetting their |
894 | This call will simply invoke all pending watchers while resetting their |
864 | pending state. Normally, C<ev_loop> does this automatically when required, |
895 | pending state. Normally, C<ev_loop> does this automatically when required, |
865 | but when overriding the invoke callback this call comes handy. |
896 | but when overriding the invoke callback this call comes handy. |
866 | |
897 | |
|
|
898 | =item int ev_pending_count (loop) |
|
|
899 | |
|
|
900 | Returns the number of pending watchers - zero indicates that no watchers |
|
|
901 | are pending. |
|
|
902 | |
867 | =item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P)) |
903 | =item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P)) |
868 | |
904 | |
869 | This overrides the invoke pending functionality of the loop: Instead of |
905 | This overrides the invoke pending functionality of the loop: Instead of |
870 | invoking all pending watchers when there are any, C<ev_loop> will call |
906 | invoking all pending watchers when there are any, C<ev_loop> will call |
871 | this callback instead. This is useful, for example, when you want to |
907 | this callback instead. This is useful, for example, when you want to |
… | |
… | |
894 | |
930 | |
895 | While event loop modifications are allowed between invocations of |
931 | While event loop modifications are allowed between invocations of |
896 | C<release> and C<acquire> (that's their only purpose after all), no |
932 | C<release> and C<acquire> (that's their only purpose after all), no |
897 | modifications done will affect the event loop, i.e. adding watchers will |
933 | modifications done will affect the event loop, i.e. adding watchers will |
898 | have no effect on the set of file descriptors being watched, or the time |
934 | have no effect on the set of file descriptors being watched, or the time |
899 | waited. USe an C<ev_async> watcher to wake up C<ev_loop> when you want it |
935 | waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it |
900 | to take note of any changes you made. |
936 | to take note of any changes you made. |
901 | |
937 | |
902 | In theory, threads executing C<ev_loop> will be async-cancel safe between |
938 | In theory, threads executing C<ev_loop> will be async-cancel safe between |
903 | invocations of C<release> and C<acquire>. |
939 | invocations of C<release> and C<acquire>. |
904 | |
940 | |
… | |
… | |
1001 | =item C<EV_WRITE> |
1037 | =item C<EV_WRITE> |
1002 | |
1038 | |
1003 | The file descriptor in the C<ev_io> watcher has become readable and/or |
1039 | The file descriptor in the C<ev_io> watcher has become readable and/or |
1004 | writable. |
1040 | writable. |
1005 | |
1041 | |
1006 | =item C<EV_TIMEOUT> |
1042 | =item C<EV_TIMER> |
1007 | |
1043 | |
1008 | The C<ev_timer> watcher has timed out. |
1044 | The C<ev_timer> watcher has timed out. |
1009 | |
1045 | |
1010 | =item C<EV_PERIODIC> |
1046 | =item C<EV_PERIODIC> |
1011 | |
1047 | |
… | |
… | |
1101 | |
1137 | |
1102 | ev_io w; |
1138 | ev_io w; |
1103 | ev_init (&w, my_cb); |
1139 | ev_init (&w, my_cb); |
1104 | ev_io_set (&w, STDIN_FILENO, EV_READ); |
1140 | ev_io_set (&w, STDIN_FILENO, EV_READ); |
1105 | |
1141 | |
1106 | =item C<ev_TYPE_set> (ev_TYPE *, [args]) |
1142 | =item C<ev_TYPE_set> (ev_TYPE *watcher, [args]) |
1107 | |
1143 | |
1108 | This macro initialises the type-specific parts of a watcher. You need to |
1144 | This macro initialises the type-specific parts of a watcher. You need to |
1109 | call C<ev_init> at least once before you call this macro, but you can |
1145 | call C<ev_init> at least once before you call this macro, but you can |
1110 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
1146 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
1111 | macro on a watcher that is active (it can be pending, however, which is a |
1147 | macro on a watcher that is active (it can be pending, however, which is a |
… | |
… | |
1124 | |
1160 | |
1125 | Example: Initialise and set an C<ev_io> watcher in one step. |
1161 | Example: Initialise and set an C<ev_io> watcher in one step. |
1126 | |
1162 | |
1127 | ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
1163 | ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
1128 | |
1164 | |
1129 | =item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) |
1165 | =item C<ev_TYPE_start> (loop, ev_TYPE *watcher) |
1130 | |
1166 | |
1131 | Starts (activates) the given watcher. Only active watchers will receive |
1167 | Starts (activates) the given watcher. Only active watchers will receive |
1132 | events. If the watcher is already active nothing will happen. |
1168 | events. If the watcher is already active nothing will happen. |
1133 | |
1169 | |
1134 | Example: Start the C<ev_io> watcher that is being abused as example in this |
1170 | Example: Start the C<ev_io> watcher that is being abused as example in this |
1135 | whole section. |
1171 | whole section. |
1136 | |
1172 | |
1137 | ev_io_start (EV_DEFAULT_UC, &w); |
1173 | ev_io_start (EV_DEFAULT_UC, &w); |
1138 | |
1174 | |
1139 | =item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) |
1175 | =item C<ev_TYPE_stop> (loop, ev_TYPE *watcher) |
1140 | |
1176 | |
1141 | Stops the given watcher if active, and clears the pending status (whether |
1177 | Stops the given watcher if active, and clears the pending status (whether |
1142 | the watcher was active or not). |
1178 | the watcher was active or not). |
1143 | |
1179 | |
1144 | It is possible that stopped watchers are pending - for example, |
1180 | It is possible that stopped watchers are pending - for example, |
… | |
… | |
1169 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1205 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1170 | |
1206 | |
1171 | Change the callback. You can change the callback at virtually any time |
1207 | Change the callback. You can change the callback at virtually any time |
1172 | (modulo threads). |
1208 | (modulo threads). |
1173 | |
1209 | |
1174 | =item ev_set_priority (ev_TYPE *watcher, priority) |
1210 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
1175 | |
1211 | |
1176 | =item int ev_priority (ev_TYPE *watcher) |
1212 | =item int ev_priority (ev_TYPE *watcher) |
1177 | |
1213 | |
1178 | Set and query the priority of the watcher. The priority is a small |
1214 | Set and query the priority of the watcher. The priority is a small |
1179 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
1215 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
… | |
… | |
1210 | returns its C<revents> bitset (as if its callback was invoked). If the |
1246 | returns its C<revents> bitset (as if its callback was invoked). If the |
1211 | watcher isn't pending it does nothing and returns C<0>. |
1247 | watcher isn't pending it does nothing and returns C<0>. |
1212 | |
1248 | |
1213 | Sometimes it can be useful to "poll" a watcher instead of waiting for its |
1249 | Sometimes it can be useful to "poll" a watcher instead of waiting for its |
1214 | callback to be invoked, which can be accomplished with this function. |
1250 | callback to be invoked, which can be accomplished with this function. |
|
|
1251 | |
|
|
1252 | =item ev_feed_event (loop, ev_TYPE *watcher, int revents) |
|
|
1253 | |
|
|
1254 | Feeds the given event set into the event loop, as if the specified event |
|
|
1255 | had happened for the specified watcher (which must be a pointer to an |
|
|
1256 | initialised but not necessarily started event watcher). Obviously you must |
|
|
1257 | not free the watcher as long as it has pending events. |
|
|
1258 | |
|
|
1259 | Stopping the watcher, letting libev invoke it, or calling |
|
|
1260 | C<ev_clear_pending> will clear the pending event, even if the watcher was |
|
|
1261 | not started in the first place. |
|
|
1262 | |
|
|
1263 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
|
|
1264 | functions that do not need a watcher. |
1215 | |
1265 | |
1216 | =back |
1266 | =back |
1217 | |
1267 | |
1218 | |
1268 | |
1219 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
1269 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
… | |
… | |
1354 | { |
1404 | { |
1355 | // stop the I/O watcher, we received the event, but |
1405 | // stop the I/O watcher, we received the event, but |
1356 | // are not yet ready to handle it. |
1406 | // are not yet ready to handle it. |
1357 | ev_io_stop (EV_A_ w); |
1407 | ev_io_stop (EV_A_ w); |
1358 | |
1408 | |
1359 | // start the idle watcher to ahndle the actual event. |
1409 | // start the idle watcher to handle the actual event. |
1360 | // it will not be executed as long as other watchers |
1410 | // it will not be executed as long as other watchers |
1361 | // with the default priority are receiving events. |
1411 | // with the default priority are receiving events. |
1362 | ev_idle_start (EV_A_ &idle); |
1412 | ev_idle_start (EV_A_ &idle); |
1363 | } |
1413 | } |
1364 | |
1414 | |
… | |
… | |
1493 | |
1543 | |
1494 | So when you encounter spurious, unexplained daemon exits, make sure you |
1544 | So when you encounter spurious, unexplained daemon exits, make sure you |
1495 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
1545 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
1496 | somewhere, as that would have given you a big clue). |
1546 | somewhere, as that would have given you a big clue). |
1497 | |
1547 | |
|
|
1548 | =head3 The special problem of accept()ing when you can't |
|
|
1549 | |
|
|
1550 | Many implementations of the POSIX C<accept> function (for example, |
|
|
1551 | found in post-2004 Linux) have the peculiar behaviour of not removing a |
|
|
1552 | connection from the pending queue in all error cases. |
|
|
1553 | |
|
|
1554 | For example, larger servers often run out of file descriptors (because |
|
|
1555 | of resource limits), causing C<accept> to fail with C<ENFILE> but not |
|
|
1556 | rejecting the connection, leading to libev signalling readiness on |
|
|
1557 | the next iteration again (the connection still exists after all), and |
|
|
1558 | typically causing the program to loop at 100% CPU usage. |
|
|
1559 | |
|
|
1560 | Unfortunately, the set of errors that cause this issue differs between |
|
|
1561 | operating systems, there is usually little the app can do to remedy the |
|
|
1562 | situation, and no known thread-safe method of removing the connection to |
|
|
1563 | cope with overload is known (to me). |
|
|
1564 | |
|
|
1565 | One of the easiest ways to handle this situation is to just ignore it |
|
|
1566 | - when the program encounters an overload, it will just loop until the |
|
|
1567 | situation is over. While this is a form of busy waiting, no OS offers an |
|
|
1568 | event-based way to handle this situation, so it's the best one can do. |
|
|
1569 | |
|
|
1570 | A better way to handle the situation is to log any errors other than |
|
|
1571 | C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such |
|
|
1572 | messages, and continue as usual, which at least gives the user an idea of |
|
|
1573 | what could be wrong ("raise the ulimit!"). For extra points one could stop |
|
|
1574 | the C<ev_io> watcher on the listening fd "for a while", which reduces CPU |
|
|
1575 | usage. |
|
|
1576 | |
|
|
1577 | If your program is single-threaded, then you could also keep a dummy file |
|
|
1578 | descriptor for overload situations (e.g. by opening F</dev/null>), and |
|
|
1579 | when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>, |
|
|
1580 | close that fd, and create a new dummy fd. This will gracefully refuse |
|
|
1581 | clients under typical overload conditions. |
|
|
1582 | |
|
|
1583 | The last way to handle it is to simply log the error and C<exit>, as |
|
|
1584 | is often done with C<malloc> failures, but this results in an easy |
|
|
1585 | opportunity for a DoS attack. |
1498 | |
1586 | |
1499 | =head3 Watcher-Specific Functions |
1587 | =head3 Watcher-Specific Functions |
1500 | |
1588 | |
1501 | =over 4 |
1589 | =over 4 |
1502 | |
1590 | |
… | |
… | |
1681 | to the current time (meaning we just have some activity :), then call the |
1769 | to the current time (meaning we just have some activity :), then call the |
1682 | callback, which will "do the right thing" and start the timer: |
1770 | callback, which will "do the right thing" and start the timer: |
1683 | |
1771 | |
1684 | ev_init (timer, callback); |
1772 | ev_init (timer, callback); |
1685 | last_activity = ev_now (loop); |
1773 | last_activity = ev_now (loop); |
1686 | callback (loop, timer, EV_TIMEOUT); |
1774 | callback (loop, timer, EV_TIMER); |
1687 | |
1775 | |
1688 | And when there is some activity, simply store the current time in |
1776 | And when there is some activity, simply store the current time in |
1689 | C<last_activity>, no libev calls at all: |
1777 | C<last_activity>, no libev calls at all: |
1690 | |
1778 | |
1691 | last_actiivty = ev_now (loop); |
1779 | last_activity = ev_now (loop); |
1692 | |
1780 | |
1693 | This technique is slightly more complex, but in most cases where the |
1781 | This technique is slightly more complex, but in most cases where the |
1694 | time-out is unlikely to be triggered, much more efficient. |
1782 | time-out is unlikely to be triggered, much more efficient. |
1695 | |
1783 | |
1696 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
1784 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
… | |
… | |
1750 | |
1838 | |
1751 | If the event loop is suspended for a long time, you can also force an |
1839 | If the event loop is suspended for a long time, you can also force an |
1752 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1840 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1753 | ()>. |
1841 | ()>. |
1754 | |
1842 | |
|
|
1843 | =head3 The special problems of suspended animation |
|
|
1844 | |
|
|
1845 | When you leave the server world it is quite customary to hit machines that |
|
|
1846 | can suspend/hibernate - what happens to the clocks during such a suspend? |
|
|
1847 | |
|
|
1848 | Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes |
|
|
1849 | all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue |
|
|
1850 | to run until the system is suspended, but they will not advance while the |
|
|
1851 | system is suspended. That means, on resume, it will be as if the program |
|
|
1852 | was frozen for a few seconds, but the suspend time will not be counted |
|
|
1853 | towards C<ev_timer> when a monotonic clock source is used. The real time |
|
|
1854 | clock advanced as expected, but if it is used as sole clocksource, then a |
|
|
1855 | long suspend would be detected as a time jump by libev, and timers would |
|
|
1856 | be adjusted accordingly. |
|
|
1857 | |
|
|
1858 | I would not be surprised to see different behaviour in different between |
|
|
1859 | operating systems, OS versions or even different hardware. |
|
|
1860 | |
|
|
1861 | The other form of suspend (job control, or sending a SIGSTOP) will see a |
|
|
1862 | time jump in the monotonic clocks and the realtime clock. If the program |
|
|
1863 | is suspended for a very long time, and monotonic clock sources are in use, |
|
|
1864 | then you can expect C<ev_timer>s to expire as the full suspension time |
|
|
1865 | will be counted towards the timers. When no monotonic clock source is in |
|
|
1866 | use, then libev will again assume a timejump and adjust accordingly. |
|
|
1867 | |
|
|
1868 | It might be beneficial for this latter case to call C<ev_suspend> |
|
|
1869 | and C<ev_resume> in code that handles C<SIGTSTP>, to at least get |
|
|
1870 | deterministic behaviour in this case (you can do nothing against |
|
|
1871 | C<SIGSTOP>). |
|
|
1872 | |
1755 | =head3 Watcher-Specific Functions and Data Members |
1873 | =head3 Watcher-Specific Functions and Data Members |
1756 | |
1874 | |
1757 | =over 4 |
1875 | =over 4 |
1758 | |
1876 | |
1759 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
1877 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
… | |
… | |
1784 | If the timer is repeating, either start it if necessary (with the |
1902 | If the timer is repeating, either start it if necessary (with the |
1785 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1903 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1786 | |
1904 | |
1787 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
1905 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
1788 | usage example. |
1906 | usage example. |
|
|
1907 | |
|
|
1908 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
|
|
1909 | |
|
|
1910 | Returns the remaining time until a timer fires. If the timer is active, |
|
|
1911 | then this time is relative to the current event loop time, otherwise it's |
|
|
1912 | the timeout value currently configured. |
|
|
1913 | |
|
|
1914 | That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns |
|
|
1915 | C<5>. When the timer is started and one second passes, C<ev_timer_remaining> |
|
|
1916 | will return C<4>. When the timer expires and is restarted, it will return |
|
|
1917 | roughly C<7> (likely slightly less as callback invocation takes some time, |
|
|
1918 | too), and so on. |
1789 | |
1919 | |
1790 | =item ev_tstamp repeat [read-write] |
1920 | =item ev_tstamp repeat [read-write] |
1791 | |
1921 | |
1792 | The current C<repeat> value. Will be used each time the watcher times out |
1922 | The current C<repeat> value. Will be used each time the watcher times out |
1793 | or C<ev_timer_again> is called, and determines the next timeout (if any), |
1923 | or C<ev_timer_again> is called, and determines the next timeout (if any), |
… | |
… | |
2029 | Signal watchers will trigger an event when the process receives a specific |
2159 | Signal watchers will trigger an event when the process receives a specific |
2030 | signal one or more times. Even though signals are very asynchronous, libev |
2160 | signal one or more times. Even though signals are very asynchronous, libev |
2031 | will try it's best to deliver signals synchronously, i.e. as part of the |
2161 | will try it's best to deliver signals synchronously, i.e. as part of the |
2032 | normal event processing, like any other event. |
2162 | normal event processing, like any other event. |
2033 | |
2163 | |
2034 | If you want signals asynchronously, just use C<sigaction> as you would |
2164 | If you want signals to be delivered truly asynchronously, just use |
2035 | do without libev and forget about sharing the signal. You can even use |
2165 | C<sigaction> as you would do without libev and forget about sharing |
2036 | C<ev_async> from a signal handler to synchronously wake up an event loop. |
2166 | the signal. You can even use C<ev_async> from a signal handler to |
|
|
2167 | synchronously wake up an event loop. |
2037 | |
2168 | |
2038 | You can configure as many watchers as you like per signal. Only when the |
2169 | You can configure as many watchers as you like for the same signal, but |
|
|
2170 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
|
|
2171 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
|
|
2172 | C<SIGINT> in both the default loop and another loop at the same time. At |
|
|
2173 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
|
|
2174 | |
2039 | first watcher gets started will libev actually register a signal handler |
2175 | When the first watcher gets started will libev actually register something |
2040 | with the kernel (thus it coexists with your own signal handlers as long as |
2176 | with the kernel (thus it coexists with your own signal handlers as long as |
2041 | you don't register any with libev for the same signal). Similarly, when |
2177 | you don't register any with libev for the same signal). |
2042 | the last signal watcher for a signal is stopped, libev will reset the |
|
|
2043 | signal handler to SIG_DFL (regardless of what it was set to before). |
|
|
2044 | |
2178 | |
2045 | If possible and supported, libev will install its handlers with |
2179 | If possible and supported, libev will install its handlers with |
2046 | C<SA_RESTART> behaviour enabled, so system calls should not be unduly |
2180 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2047 | interrupted. If you have a problem with system calls getting interrupted by |
2181 | not be unduly interrupted. If you have a problem with system calls getting |
2048 | signals you can block all signals in an C<ev_check> watcher and unblock |
2182 | interrupted by signals you can block all signals in an C<ev_check> watcher |
2049 | them in an C<ev_prepare> watcher. |
2183 | and unblock them in an C<ev_prepare> watcher. |
|
|
2184 | |
|
|
2185 | =head3 The special problem of inheritance over fork/execve/pthread_create |
|
|
2186 | |
|
|
2187 | Both the signal mask (C<sigprocmask>) and the signal disposition |
|
|
2188 | (C<sigaction>) are unspecified after starting a signal watcher (and after |
|
|
2189 | stopping it again), that is, libev might or might not block the signal, |
|
|
2190 | and might or might not set or restore the installed signal handler. |
|
|
2191 | |
|
|
2192 | While this does not matter for the signal disposition (libev never |
|
|
2193 | sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on |
|
|
2194 | C<execve>), this matters for the signal mask: many programs do not expect |
|
|
2195 | certain signals to be blocked. |
|
|
2196 | |
|
|
2197 | This means that before calling C<exec> (from the child) you should reset |
|
|
2198 | the signal mask to whatever "default" you expect (all clear is a good |
|
|
2199 | choice usually). |
|
|
2200 | |
|
|
2201 | The simplest way to ensure that the signal mask is reset in the child is |
|
|
2202 | to install a fork handler with C<pthread_atfork> that resets it. That will |
|
|
2203 | catch fork calls done by libraries (such as the libc) as well. |
|
|
2204 | |
|
|
2205 | In current versions of libev, the signal will not be blocked indefinitely |
|
|
2206 | unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces |
|
|
2207 | the window of opportunity for problems, it will not go away, as libev |
|
|
2208 | I<has> to modify the signal mask, at least temporarily. |
|
|
2209 | |
|
|
2210 | So I can't stress this enough: I<If you do not reset your signal mask when |
|
|
2211 | you expect it to be empty, you have a race condition in your code>. This |
|
|
2212 | is not a libev-specific thing, this is true for most event libraries. |
2050 | |
2213 | |
2051 | =head3 Watcher-Specific Functions and Data Members |
2214 | =head3 Watcher-Specific Functions and Data Members |
2052 | |
2215 | |
2053 | =over 4 |
2216 | =over 4 |
2054 | |
2217 | |
… | |
… | |
2099 | libev) |
2262 | libev) |
2100 | |
2263 | |
2101 | =head3 Process Interaction |
2264 | =head3 Process Interaction |
2102 | |
2265 | |
2103 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
2266 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
2104 | initialised. This is necessary to guarantee proper behaviour even if |
2267 | initialised. This is necessary to guarantee proper behaviour even if the |
2105 | the first child watcher is started after the child exits. The occurrence |
2268 | first child watcher is started after the child exits. The occurrence |
2106 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
2269 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
2107 | synchronously as part of the event loop processing. Libev always reaps all |
2270 | synchronously as part of the event loop processing. Libev always reaps all |
2108 | children, even ones not watched. |
2271 | children, even ones not watched. |
2109 | |
2272 | |
2110 | =head3 Overriding the Built-In Processing |
2273 | =head3 Overriding the Built-In Processing |
… | |
… | |
2120 | =head3 Stopping the Child Watcher |
2283 | =head3 Stopping the Child Watcher |
2121 | |
2284 | |
2122 | Currently, the child watcher never gets stopped, even when the |
2285 | Currently, the child watcher never gets stopped, even when the |
2123 | child terminates, so normally one needs to stop the watcher in the |
2286 | child terminates, so normally one needs to stop the watcher in the |
2124 | callback. Future versions of libev might stop the watcher automatically |
2287 | callback. Future versions of libev might stop the watcher automatically |
2125 | when a child exit is detected. |
2288 | when a child exit is detected (calling C<ev_child_stop> twice is not a |
|
|
2289 | problem). |
2126 | |
2290 | |
2127 | =head3 Watcher-Specific Functions and Data Members |
2291 | =head3 Watcher-Specific Functions and Data Members |
2128 | |
2292 | |
2129 | =over 4 |
2293 | =over 4 |
2130 | |
2294 | |
… | |
… | |
2870 | =head3 Queueing |
3034 | =head3 Queueing |
2871 | |
3035 | |
2872 | C<ev_async> does not support queueing of data in any way. The reason |
3036 | C<ev_async> does not support queueing of data in any way. The reason |
2873 | is that the author does not know of a simple (or any) algorithm for a |
3037 | is that the author does not know of a simple (or any) algorithm for a |
2874 | multiple-writer-single-reader queue that works in all cases and doesn't |
3038 | multiple-writer-single-reader queue that works in all cases and doesn't |
2875 | need elaborate support such as pthreads. |
3039 | need elaborate support such as pthreads or unportable memory access |
|
|
3040 | semantics. |
2876 | |
3041 | |
2877 | That means that if you want to queue data, you have to provide your own |
3042 | That means that if you want to queue data, you have to provide your own |
2878 | queue. But at least I can tell you how to implement locking around your |
3043 | queue. But at least I can tell you how to implement locking around your |
2879 | queue: |
3044 | queue: |
2880 | |
3045 | |
… | |
… | |
3019 | |
3184 | |
3020 | If C<timeout> is less than 0, then no timeout watcher will be |
3185 | If C<timeout> is less than 0, then no timeout watcher will be |
3021 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
3186 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
3022 | repeat = 0) will be started. C<0> is a valid timeout. |
3187 | repeat = 0) will be started. C<0> is a valid timeout. |
3023 | |
3188 | |
3024 | The callback has the type C<void (*cb)(int revents, void *arg)> and gets |
3189 | The callback has the type C<void (*cb)(int revents, void *arg)> and is |
3025 | passed an C<revents> set like normal event callbacks (a combination of |
3190 | passed an C<revents> set like normal event callbacks (a combination of |
3026 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> |
3191 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg> |
3027 | value passed to C<ev_once>. Note that it is possible to receive I<both> |
3192 | value passed to C<ev_once>. Note that it is possible to receive I<both> |
3028 | a timeout and an io event at the same time - you probably should give io |
3193 | a timeout and an io event at the same time - you probably should give io |
3029 | events precedence. |
3194 | events precedence. |
3030 | |
3195 | |
3031 | Example: wait up to ten seconds for data to appear on STDIN_FILENO. |
3196 | Example: wait up to ten seconds for data to appear on STDIN_FILENO. |
3032 | |
3197 | |
3033 | static void stdin_ready (int revents, void *arg) |
3198 | static void stdin_ready (int revents, void *arg) |
3034 | { |
3199 | { |
3035 | if (revents & EV_READ) |
3200 | if (revents & EV_READ) |
3036 | /* stdin might have data for us, joy! */; |
3201 | /* stdin might have data for us, joy! */; |
3037 | else if (revents & EV_TIMEOUT) |
3202 | else if (revents & EV_TIMER) |
3038 | /* doh, nothing entered */; |
3203 | /* doh, nothing entered */; |
3039 | } |
3204 | } |
3040 | |
3205 | |
3041 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3206 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3042 | |
3207 | |
3043 | =item ev_feed_event (struct ev_loop *, watcher *, int revents) |
|
|
3044 | |
|
|
3045 | Feeds the given event set into the event loop, as if the specified event |
|
|
3046 | had happened for the specified watcher (which must be a pointer to an |
|
|
3047 | initialised but not necessarily started event watcher). |
|
|
3048 | |
|
|
3049 | =item ev_feed_fd_event (struct ev_loop *, int fd, int revents) |
3208 | =item ev_feed_fd_event (loop, int fd, int revents) |
3050 | |
3209 | |
3051 | Feed an event on the given fd, as if a file descriptor backend detected |
3210 | Feed an event on the given fd, as if a file descriptor backend detected |
3052 | the given events it. |
3211 | the given events it. |
3053 | |
3212 | |
3054 | =item ev_feed_signal_event (struct ev_loop *loop, int signum) |
3213 | =item ev_feed_signal_event (loop, int signum) |
3055 | |
3214 | |
3056 | Feed an event as if the given signal occurred (C<loop> must be the default |
3215 | Feed an event as if the given signal occurred (C<loop> must be the default |
3057 | loop!). |
3216 | loop!). |
3058 | |
3217 | |
3059 | =back |
3218 | =back |
… | |
… | |
3139 | |
3298 | |
3140 | =over 4 |
3299 | =over 4 |
3141 | |
3300 | |
3142 | =item ev::TYPE::TYPE () |
3301 | =item ev::TYPE::TYPE () |
3143 | |
3302 | |
3144 | =item ev::TYPE::TYPE (struct ev_loop *) |
3303 | =item ev::TYPE::TYPE (loop) |
3145 | |
3304 | |
3146 | =item ev::TYPE::~TYPE |
3305 | =item ev::TYPE::~TYPE |
3147 | |
3306 | |
3148 | The constructor (optionally) takes an event loop to associate the watcher |
3307 | The constructor (optionally) takes an event loop to associate the watcher |
3149 | with. If it is omitted, it will use C<EV_DEFAULT>. |
3308 | with. If it is omitted, it will use C<EV_DEFAULT>. |
… | |
… | |
3226 | Example: Use a plain function as callback. |
3385 | Example: Use a plain function as callback. |
3227 | |
3386 | |
3228 | static void io_cb (ev::io &w, int revents) { } |
3387 | static void io_cb (ev::io &w, int revents) { } |
3229 | iow.set <io_cb> (); |
3388 | iow.set <io_cb> (); |
3230 | |
3389 | |
3231 | =item w->set (struct ev_loop *) |
3390 | =item w->set (loop) |
3232 | |
3391 | |
3233 | Associates a different C<struct ev_loop> with this watcher. You can only |
3392 | Associates a different C<struct ev_loop> with this watcher. You can only |
3234 | do this when the watcher is inactive (and not pending either). |
3393 | do this when the watcher is inactive (and not pending either). |
3235 | |
3394 | |
3236 | =item w->set ([arguments]) |
3395 | =item w->set ([arguments]) |
… | |
… | |
3333 | =item Ocaml |
3492 | =item Ocaml |
3334 | |
3493 | |
3335 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
3494 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
3336 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
3495 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
3337 | |
3496 | |
|
|
3497 | =item Lua |
|
|
3498 | |
|
|
3499 | Brian Maher has written a partial interface to libev for lua (at the |
|
|
3500 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
|
|
3501 | L<http://github.com/brimworks/lua-ev>. |
|
|
3502 | |
3338 | =back |
3503 | =back |
3339 | |
3504 | |
3340 | |
3505 | |
3341 | =head1 MACRO MAGIC |
3506 | =head1 MACRO MAGIC |
3342 | |
3507 | |
… | |
… | |
3495 | libev.m4 |
3660 | libev.m4 |
3496 | |
3661 | |
3497 | =head2 PREPROCESSOR SYMBOLS/MACROS |
3662 | =head2 PREPROCESSOR SYMBOLS/MACROS |
3498 | |
3663 | |
3499 | Libev can be configured via a variety of preprocessor symbols you have to |
3664 | Libev can be configured via a variety of preprocessor symbols you have to |
3500 | define before including any of its files. The default in the absence of |
3665 | define before including (or compiling) any of its files. The default in |
3501 | autoconf is documented for every option. |
3666 | the absence of autoconf is documented for every option. |
|
|
3667 | |
|
|
3668 | Symbols marked with "(h)" do not change the ABI, and can have different |
|
|
3669 | values when compiling libev vs. including F<ev.h>, so it is permissible |
|
|
3670 | to redefine them before including F<ev.h> without breaking compatibility |
|
|
3671 | to a compiled library. All other symbols change the ABI, which means all |
|
|
3672 | users of libev and the libev code itself must be compiled with compatible |
|
|
3673 | settings. |
3502 | |
3674 | |
3503 | =over 4 |
3675 | =over 4 |
3504 | |
3676 | |
3505 | =item EV_STANDALONE |
3677 | =item EV_STANDALONE (h) |
3506 | |
3678 | |
3507 | Must always be C<1> if you do not use autoconf configuration, which |
3679 | Must always be C<1> if you do not use autoconf configuration, which |
3508 | keeps libev from including F<config.h>, and it also defines dummy |
3680 | keeps libev from including F<config.h>, and it also defines dummy |
3509 | implementations for some libevent functions (such as logging, which is not |
3681 | implementations for some libevent functions (such as logging, which is not |
3510 | supported). It will also not define any of the structs usually found in |
3682 | supported). It will also not define any of the structs usually found in |
3511 | F<event.h> that are not directly supported by the libev core alone. |
3683 | F<event.h> that are not directly supported by the libev core alone. |
3512 | |
3684 | |
3513 | In stanbdalone mode, libev will still try to automatically deduce the |
3685 | In standalone mode, libev will still try to automatically deduce the |
3514 | configuration, but has to be more conservative. |
3686 | configuration, but has to be more conservative. |
3515 | |
3687 | |
3516 | =item EV_USE_MONOTONIC |
3688 | =item EV_USE_MONOTONIC |
3517 | |
3689 | |
3518 | If defined to be C<1>, libev will try to detect the availability of the |
3690 | If defined to be C<1>, libev will try to detect the availability of the |
… | |
… | |
3583 | be used is the winsock select). This means that it will call |
3755 | be used is the winsock select). This means that it will call |
3584 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
3756 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
3585 | it is assumed that all these functions actually work on fds, even |
3757 | it is assumed that all these functions actually work on fds, even |
3586 | on win32. Should not be defined on non-win32 platforms. |
3758 | on win32. Should not be defined on non-win32 platforms. |
3587 | |
3759 | |
3588 | =item EV_FD_TO_WIN32_HANDLE |
3760 | =item EV_FD_TO_WIN32_HANDLE(fd) |
3589 | |
3761 | |
3590 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
3762 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
3591 | file descriptors to socket handles. When not defining this symbol (the |
3763 | file descriptors to socket handles. When not defining this symbol (the |
3592 | default), then libev will call C<_get_osfhandle>, which is usually |
3764 | default), then libev will call C<_get_osfhandle>, which is usually |
3593 | correct. In some cases, programs use their own file descriptor management, |
3765 | correct. In some cases, programs use their own file descriptor management, |
3594 | in which case they can provide this function to map fds to socket handles. |
3766 | in which case they can provide this function to map fds to socket handles. |
|
|
3767 | |
|
|
3768 | =item EV_WIN32_HANDLE_TO_FD(handle) |
|
|
3769 | |
|
|
3770 | If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors |
|
|
3771 | using the standard C<_open_osfhandle> function. For programs implementing |
|
|
3772 | their own fd to handle mapping, overwriting this function makes it easier |
|
|
3773 | to do so. This can be done by defining this macro to an appropriate value. |
|
|
3774 | |
|
|
3775 | =item EV_WIN32_CLOSE_FD(fd) |
|
|
3776 | |
|
|
3777 | If programs implement their own fd to handle mapping on win32, then this |
|
|
3778 | macro can be used to override the C<close> function, useful to unregister |
|
|
3779 | file descriptors again. Note that the replacement function has to close |
|
|
3780 | the underlying OS handle. |
3595 | |
3781 | |
3596 | =item EV_USE_POLL |
3782 | =item EV_USE_POLL |
3597 | |
3783 | |
3598 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
3784 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
3599 | backend. Otherwise it will be enabled on non-win32 platforms. It |
3785 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
3646 | as well as for signal and thread safety in C<ev_async> watchers. |
3832 | as well as for signal and thread safety in C<ev_async> watchers. |
3647 | |
3833 | |
3648 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
3834 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
3649 | (from F<signal.h>), which is usually good enough on most platforms. |
3835 | (from F<signal.h>), which is usually good enough on most platforms. |
3650 | |
3836 | |
3651 | =item EV_H |
3837 | =item EV_H (h) |
3652 | |
3838 | |
3653 | The name of the F<ev.h> header file used to include it. The default if |
3839 | The name of the F<ev.h> header file used to include it. The default if |
3654 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
3840 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
3655 | used to virtually rename the F<ev.h> header file in case of conflicts. |
3841 | used to virtually rename the F<ev.h> header file in case of conflicts. |
3656 | |
3842 | |
3657 | =item EV_CONFIG_H |
3843 | =item EV_CONFIG_H (h) |
3658 | |
3844 | |
3659 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
3845 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
3660 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
3846 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
3661 | C<EV_H>, above. |
3847 | C<EV_H>, above. |
3662 | |
3848 | |
3663 | =item EV_EVENT_H |
3849 | =item EV_EVENT_H (h) |
3664 | |
3850 | |
3665 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
3851 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
3666 | of how the F<event.h> header can be found, the default is C<"event.h">. |
3852 | of how the F<event.h> header can be found, the default is C<"event.h">. |
3667 | |
3853 | |
3668 | =item EV_PROTOTYPES |
3854 | =item EV_PROTOTYPES (h) |
3669 | |
3855 | |
3670 | If defined to be C<0>, then F<ev.h> will not define any function |
3856 | If defined to be C<0>, then F<ev.h> will not define any function |
3671 | prototypes, but still define all the structs and other symbols. This is |
3857 | prototypes, but still define all the structs and other symbols. This is |
3672 | occasionally useful if you want to provide your own wrapper functions |
3858 | occasionally useful if you want to provide your own wrapper functions |
3673 | around libev functions. |
3859 | around libev functions. |
… | |
… | |
3695 | fine. |
3881 | fine. |
3696 | |
3882 | |
3697 | If your embedding application does not need any priorities, defining these |
3883 | If your embedding application does not need any priorities, defining these |
3698 | both to C<0> will save some memory and CPU. |
3884 | both to C<0> will save some memory and CPU. |
3699 | |
3885 | |
3700 | =item EV_PERIODIC_ENABLE |
3886 | =item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, |
|
|
3887 | EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, |
|
|
3888 | EV_ASYNC_ENABLE, EV_CHILD_ENABLE. |
3701 | |
3889 | |
3702 | If undefined or defined to be C<1>, then periodic timers are supported. If |
3890 | If undefined or defined to be C<1> (and the platform supports it), then |
3703 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
3891 | the respective watcher type is supported. If defined to be C<0>, then it |
3704 | code. |
3892 | is not. Disabling watcher types mainly saves codesize. |
3705 | |
3893 | |
3706 | =item EV_IDLE_ENABLE |
3894 | =item EV_FEATURES |
3707 | |
|
|
3708 | If undefined or defined to be C<1>, then idle watchers are supported. If |
|
|
3709 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
|
|
3710 | code. |
|
|
3711 | |
|
|
3712 | =item EV_EMBED_ENABLE |
|
|
3713 | |
|
|
3714 | If undefined or defined to be C<1>, then embed watchers are supported. If |
|
|
3715 | defined to be C<0>, then they are not. Embed watchers rely on most other |
|
|
3716 | watcher types, which therefore must not be disabled. |
|
|
3717 | |
|
|
3718 | =item EV_STAT_ENABLE |
|
|
3719 | |
|
|
3720 | If undefined or defined to be C<1>, then stat watchers are supported. If |
|
|
3721 | defined to be C<0>, then they are not. |
|
|
3722 | |
|
|
3723 | =item EV_FORK_ENABLE |
|
|
3724 | |
|
|
3725 | If undefined or defined to be C<1>, then fork watchers are supported. If |
|
|
3726 | defined to be C<0>, then they are not. |
|
|
3727 | |
|
|
3728 | =item EV_ASYNC_ENABLE |
|
|
3729 | |
|
|
3730 | If undefined or defined to be C<1>, then async watchers are supported. If |
|
|
3731 | defined to be C<0>, then they are not. |
|
|
3732 | |
|
|
3733 | =item EV_MINIMAL |
|
|
3734 | |
3895 | |
3735 | If you need to shave off some kilobytes of code at the expense of some |
3896 | If you need to shave off some kilobytes of code at the expense of some |
3736 | speed (but with the full API), define this symbol to C<1>. Currently this |
3897 | speed (but with the full API), you can define this symbol to request |
3737 | is used to override some inlining decisions, saves roughly 30% code size |
3898 | certain subsets of functionality. The default is to enable all features |
3738 | on amd64. It also selects a much smaller 2-heap for timer management over |
3899 | that can be enabled on the platform. |
3739 | the default 4-heap. |
|
|
3740 | |
3900 | |
3741 | You can save even more by disabling watcher types you do not need |
3901 | A typical way to use this symbol is to define it to C<0> (or to a bitset |
3742 | and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert> |
3902 | with some broad features you want) and then selectively re-enable |
3743 | (C<-DNDEBUG>) will usually reduce code size a lot. |
3903 | additional parts you want, for example if you want everything minimal, |
|
|
3904 | but multiple event loop support, async and child watchers and the poll |
|
|
3905 | backend, use this: |
3744 | |
3906 | |
3745 | Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to |
3907 | #define EV_FEATURES 0 |
3746 | provide a bare-bones event library. See C<ev.h> for details on what parts |
3908 | #define EV_MULTIPLICITY 1 |
3747 | of the API are still available, and do not complain if this subset changes |
3909 | #define EV_USE_POLL 1 |
3748 | over time. |
3910 | #define EV_CHILD_ENABLE 1 |
|
|
3911 | #define EV_ASYNC_ENABLE 1 |
|
|
3912 | |
|
|
3913 | The actual value is a bitset, it can be a combination of the following |
|
|
3914 | values: |
|
|
3915 | |
|
|
3916 | =over 4 |
|
|
3917 | |
|
|
3918 | =item C<1> - faster/larger code |
|
|
3919 | |
|
|
3920 | Use larger code to speed up some operations. |
|
|
3921 | |
|
|
3922 | Currently this is used to override some inlining decisions (enlarging the roughly |
|
|
3923 | 30% code size on amd64. |
|
|
3924 | |
|
|
3925 | When optimising for size, use of compiler flags such as C<-Os> with |
|
|
3926 | gcc recommended, as well as C<-DNDEBUG>, as libev contains a number of |
|
|
3927 | assertions. |
|
|
3928 | |
|
|
3929 | =item C<2> - faster/larger data structures |
|
|
3930 | |
|
|
3931 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
|
|
3932 | hash table sizes and so on. This will usually further increase codesize |
|
|
3933 | and can additionally have an effect on the size of data structures at |
|
|
3934 | runtime. |
|
|
3935 | |
|
|
3936 | =item C<4> - full API configuration |
|
|
3937 | |
|
|
3938 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
|
|
3939 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
|
|
3940 | |
|
|
3941 | =item C<8> - full API |
|
|
3942 | |
|
|
3943 | This enables a lot of the "lesser used" API functions. See C<ev.h> for |
|
|
3944 | details on which parts of the API are still available without this |
|
|
3945 | feature, and do not complain if this subset changes over time. |
|
|
3946 | |
|
|
3947 | =item C<16> - enable all optional watcher types |
|
|
3948 | |
|
|
3949 | Enables all optional watcher types. If you want to selectively enable |
|
|
3950 | only some watcher types other than I/O and timers (e.g. prepare, |
|
|
3951 | embed, async, child...) you can enable them manually by defining |
|
|
3952 | C<EV_watchertype_ENABLE> to C<1> instead. |
|
|
3953 | |
|
|
3954 | =item C<32> - enable all backends |
|
|
3955 | |
|
|
3956 | This enables all backends - without this feature, you need to enable at |
|
|
3957 | least one backend manually (C<EV_USE_SELECT> is a good choice). |
|
|
3958 | |
|
|
3959 | =item C<64> - enable OS-specific "helper" APIs |
|
|
3960 | |
|
|
3961 | Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by |
|
|
3962 | default. |
|
|
3963 | |
|
|
3964 | =back |
|
|
3965 | |
|
|
3966 | Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0> |
|
|
3967 | reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb |
|
|
3968 | code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O |
|
|
3969 | watchers, timers and monotonic clock support. |
|
|
3970 | |
|
|
3971 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
|
|
3972 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
|
|
3973 | your program might be left out as well - a binary starting a timer and an |
|
|
3974 | I/O watcher then might come out at only 5Kb. |
|
|
3975 | |
|
|
3976 | =item EV_AVOID_STDIO |
|
|
3977 | |
|
|
3978 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
|
|
3979 | functions (printf, scanf, perror etc.). This will increase the codesize |
|
|
3980 | somewhat, but if your program doesn't otherwise depend on stdio and your |
|
|
3981 | libc allows it, this avoids linking in the stdio library which is quite |
|
|
3982 | big. |
|
|
3983 | |
|
|
3984 | Note that error messages might become less precise when this option is |
|
|
3985 | enabled. |
|
|
3986 | |
|
|
3987 | =item EV_NSIG |
|
|
3988 | |
|
|
3989 | The highest supported signal number, +1 (or, the number of |
|
|
3990 | signals): Normally, libev tries to deduce the maximum number of signals |
|
|
3991 | automatically, but sometimes this fails, in which case it can be |
|
|
3992 | specified. Also, using a lower number than detected (C<32> should be |
|
|
3993 | good for about any system in existance) can save some memory, as libev |
|
|
3994 | statically allocates some 12-24 bytes per signal number. |
3749 | |
3995 | |
3750 | =item EV_PID_HASHSIZE |
3996 | =item EV_PID_HASHSIZE |
3751 | |
3997 | |
3752 | C<ev_child> watchers use a small hash table to distribute workload by |
3998 | C<ev_child> watchers use a small hash table to distribute workload by |
3753 | pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more |
3999 | pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled), |
3754 | than enough. If you need to manage thousands of children you might want to |
4000 | usually more than enough. If you need to manage thousands of children you |
3755 | increase this value (I<must> be a power of two). |
4001 | might want to increase this value (I<must> be a power of two). |
3756 | |
4002 | |
3757 | =item EV_INOTIFY_HASHSIZE |
4003 | =item EV_INOTIFY_HASHSIZE |
3758 | |
4004 | |
3759 | C<ev_stat> watchers use a small hash table to distribute workload by |
4005 | C<ev_stat> watchers use a small hash table to distribute workload by |
3760 | inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), |
4006 | inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES> |
3761 | usually more than enough. If you need to manage thousands of C<ev_stat> |
4007 | disabled), usually more than enough. If you need to manage thousands of |
3762 | watchers you might want to increase this value (I<must> be a power of |
4008 | C<ev_stat> watchers you might want to increase this value (I<must> be a |
3763 | two). |
4009 | power of two). |
3764 | |
4010 | |
3765 | =item EV_USE_4HEAP |
4011 | =item EV_USE_4HEAP |
3766 | |
4012 | |
3767 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
4013 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3768 | timer and periodics heaps, libev uses a 4-heap when this symbol is defined |
4014 | timer and periodics heaps, libev uses a 4-heap when this symbol is defined |
3769 | to C<1>. The 4-heap uses more complicated (longer) code but has noticeably |
4015 | to C<1>. The 4-heap uses more complicated (longer) code but has noticeably |
3770 | faster performance with many (thousands) of watchers. |
4016 | faster performance with many (thousands) of watchers. |
3771 | |
4017 | |
3772 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
4018 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
3773 | (disabled). |
4019 | will be C<0>. |
3774 | |
4020 | |
3775 | =item EV_HEAP_CACHE_AT |
4021 | =item EV_HEAP_CACHE_AT |
3776 | |
4022 | |
3777 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
4023 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3778 | timer and periodics heaps, libev can cache the timestamp (I<at>) within |
4024 | timer and periodics heaps, libev can cache the timestamp (I<at>) within |
3779 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
4025 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
3780 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
4026 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
3781 | but avoids random read accesses on heap changes. This improves performance |
4027 | but avoids random read accesses on heap changes. This improves performance |
3782 | noticeably with many (hundreds) of watchers. |
4028 | noticeably with many (hundreds) of watchers. |
3783 | |
4029 | |
3784 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
4030 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
3785 | (disabled). |
4031 | will be C<0>. |
3786 | |
4032 | |
3787 | =item EV_VERIFY |
4033 | =item EV_VERIFY |
3788 | |
4034 | |
3789 | Controls how much internal verification (see C<ev_loop_verify ()>) will |
4035 | Controls how much internal verification (see C<ev_loop_verify ()>) will |
3790 | be done: If set to C<0>, no internal verification code will be compiled |
4036 | be done: If set to C<0>, no internal verification code will be compiled |
… | |
… | |
3792 | called. If set to C<2>, then the internal verification code will be |
4038 | called. If set to C<2>, then the internal verification code will be |
3793 | called once per loop, which can slow down libev. If set to C<3>, then the |
4039 | called once per loop, which can slow down libev. If set to C<3>, then the |
3794 | verification code will be called very frequently, which will slow down |
4040 | verification code will be called very frequently, which will slow down |
3795 | libev considerably. |
4041 | libev considerably. |
3796 | |
4042 | |
3797 | The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be |
4043 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
3798 | C<0>. |
4044 | will be C<0>. |
3799 | |
4045 | |
3800 | =item EV_COMMON |
4046 | =item EV_COMMON |
3801 | |
4047 | |
3802 | By default, all watchers have a C<void *data> member. By redefining |
4048 | By default, all watchers have a C<void *data> member. By redefining |
3803 | this macro to a something else you can include more and other types of |
4049 | this macro to a something else you can include more and other types of |
… | |
… | |
3861 | file. |
4107 | file. |
3862 | |
4108 | |
3863 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
4109 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
3864 | that everybody includes and which overrides some configure choices: |
4110 | that everybody includes and which overrides some configure choices: |
3865 | |
4111 | |
3866 | #define EV_MINIMAL 1 |
4112 | #define EV_FEATURES 8 |
3867 | #define EV_USE_POLL 0 |
4113 | #define EV_USE_SELECT 1 |
3868 | #define EV_MULTIPLICITY 0 |
|
|
3869 | #define EV_PERIODIC_ENABLE 0 |
4114 | #define EV_PREPARE_ENABLE 1 |
|
|
4115 | #define EV_IDLE_ENABLE 1 |
3870 | #define EV_STAT_ENABLE 0 |
4116 | #define EV_SIGNAL_ENABLE 1 |
3871 | #define EV_FORK_ENABLE 0 |
4117 | #define EV_CHILD_ENABLE 1 |
|
|
4118 | #define EV_USE_STDEXCEPT 0 |
3872 | #define EV_CONFIG_H <config.h> |
4119 | #define EV_CONFIG_H <config.h> |
3873 | #define EV_MINPRI 0 |
|
|
3874 | #define EV_MAXPRI 0 |
|
|
3875 | |
4120 | |
3876 | #include "ev++.h" |
4121 | #include "ev++.h" |
3877 | |
4122 | |
3878 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
4123 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
3879 | |
4124 | |
… | |
… | |
3998 | protecting the loop data, respectively. |
4243 | protecting the loop data, respectively. |
3999 | |
4244 | |
4000 | static void |
4245 | static void |
4001 | l_release (EV_P) |
4246 | l_release (EV_P) |
4002 | { |
4247 | { |
4003 | udat *u = ev_userdata (EV_A); |
4248 | userdata *u = ev_userdata (EV_A); |
4004 | pthread_mutex_unlock (&u->lock); |
4249 | pthread_mutex_unlock (&u->lock); |
4005 | } |
4250 | } |
4006 | |
4251 | |
4007 | static void |
4252 | static void |
4008 | l_acquire (EV_P) |
4253 | l_acquire (EV_P) |
4009 | { |
4254 | { |
4010 | udat *u = ev_userdata (EV_A); |
4255 | userdata *u = ev_userdata (EV_A); |
4011 | pthread_mutex_lock (&u->lock); |
4256 | pthread_mutex_lock (&u->lock); |
4012 | } |
4257 | } |
4013 | |
4258 | |
4014 | The event loop thread first acquires the mutex, and then jumps straight |
4259 | The event loop thread first acquires the mutex, and then jumps straight |
4015 | into C<ev_loop>: |
4260 | into C<ev_loop>: |
… | |
… | |
4028 | } |
4273 | } |
4029 | |
4274 | |
4030 | Instead of invoking all pending watchers, the C<l_invoke> callback will |
4275 | Instead of invoking all pending watchers, the C<l_invoke> callback will |
4031 | signal the main thread via some unspecified mechanism (signals? pipe |
4276 | signal the main thread via some unspecified mechanism (signals? pipe |
4032 | writes? C<Async::Interrupt>?) and then waits until all pending watchers |
4277 | writes? C<Async::Interrupt>?) and then waits until all pending watchers |
4033 | have been called: |
4278 | have been called (in a while loop because a) spurious wakeups are possible |
|
|
4279 | and b) skipping inter-thread-communication when there are no pending |
|
|
4280 | watchers is very beneficial): |
4034 | |
4281 | |
4035 | static void |
4282 | static void |
4036 | l_invoke (EV_P) |
4283 | l_invoke (EV_P) |
4037 | { |
4284 | { |
4038 | udat *u = ev_userdata (EV_A); |
4285 | userdata *u = ev_userdata (EV_A); |
4039 | |
4286 | |
|
|
4287 | while (ev_pending_count (EV_A)) |
|
|
4288 | { |
4040 | wake_up_other_thread_in_some_magic_or_not_so_magic_way (); |
4289 | wake_up_other_thread_in_some_magic_or_not_so_magic_way (); |
4041 | |
|
|
4042 | pthread_cond_wait (&u->invoke_cv, &u->lock); |
4290 | pthread_cond_wait (&u->invoke_cv, &u->lock); |
|
|
4291 | } |
4043 | } |
4292 | } |
4044 | |
4293 | |
4045 | Now, whenever the main thread gets told to invoke pending watchers, it |
4294 | Now, whenever the main thread gets told to invoke pending watchers, it |
4046 | will grab the lock, call C<ev_invoke_pending> and then signal the loop |
4295 | will grab the lock, call C<ev_invoke_pending> and then signal the loop |
4047 | thread to continue: |
4296 | thread to continue: |
4048 | |
4297 | |
4049 | static void |
4298 | static void |
4050 | real_invoke_pending (EV_P) |
4299 | real_invoke_pending (EV_P) |
4051 | { |
4300 | { |
4052 | udat *u = ev_userdata (EV_A); |
4301 | userdata *u = ev_userdata (EV_A); |
4053 | |
4302 | |
4054 | pthread_mutex_lock (&u->lock); |
4303 | pthread_mutex_lock (&u->lock); |
4055 | ev_invoke_pending (EV_A); |
4304 | ev_invoke_pending (EV_A); |
4056 | pthread_cond_signal (&u->invoke_cv); |
4305 | pthread_cond_signal (&u->invoke_cv); |
4057 | pthread_mutex_unlock (&u->lock); |
4306 | pthread_mutex_unlock (&u->lock); |
… | |
… | |
4059 | |
4308 | |
4060 | Whenever you want to start/stop a watcher or do other modifications to an |
4309 | Whenever you want to start/stop a watcher or do other modifications to an |
4061 | event loop, you will now have to lock: |
4310 | event loop, you will now have to lock: |
4062 | |
4311 | |
4063 | ev_timer timeout_watcher; |
4312 | ev_timer timeout_watcher; |
4064 | udat *u = ev_userdata (EV_A); |
4313 | userdata *u = ev_userdata (EV_A); |
4065 | |
4314 | |
4066 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
4315 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
4067 | |
4316 | |
4068 | pthread_mutex_lock (&u->lock); |
4317 | pthread_mutex_lock (&u->lock); |
4069 | ev_timer_start (EV_A_ &timeout_watcher); |
4318 | ev_timer_start (EV_A_ &timeout_watcher); |
… | |
… | |
4078 | =head3 COROUTINES |
4327 | =head3 COROUTINES |
4079 | |
4328 | |
4080 | Libev is very accommodating to coroutines ("cooperative threads"): |
4329 | Libev is very accommodating to coroutines ("cooperative threads"): |
4081 | libev fully supports nesting calls to its functions from different |
4330 | libev fully supports nesting calls to its functions from different |
4082 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
4331 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
4083 | different coroutines, and switch freely between both coroutines running the |
4332 | different coroutines, and switch freely between both coroutines running |
4084 | loop, as long as you don't confuse yourself). The only exception is that |
4333 | the loop, as long as you don't confuse yourself). The only exception is |
4085 | you must not do this from C<ev_periodic> reschedule callbacks. |
4334 | that you must not do this from C<ev_periodic> reschedule callbacks. |
4086 | |
4335 | |
4087 | Care has been taken to ensure that libev does not keep local state inside |
4336 | Care has been taken to ensure that libev does not keep local state inside |
4088 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
4337 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
4089 | they do not call any callbacks. |
4338 | they do not call any callbacks. |
4090 | |
4339 | |
… | |
… | |
4377 | involves iterating over all running async watchers or all signal numbers. |
4626 | involves iterating over all running async watchers or all signal numbers. |
4378 | |
4627 | |
4379 | =back |
4628 | =back |
4380 | |
4629 | |
4381 | |
4630 | |
|
|
4631 | =head1 PORTING FROM LIBEV 3.X TO 4.X |
|
|
4632 | |
|
|
4633 | The major version 4 introduced some minor incompatible changes to the API. |
|
|
4634 | |
|
|
4635 | At the moment, the C<ev.h> header file tries to implement superficial |
|
|
4636 | compatibility, so most programs should still compile. Those might be |
|
|
4637 | removed in later versions of libev, so better update early than late. |
|
|
4638 | |
|
|
4639 | =over 4 |
|
|
4640 | |
|
|
4641 | =item C<ev_loop_count> renamed to C<ev_iteration> |
|
|
4642 | |
|
|
4643 | =item C<ev_loop_depth> renamed to C<ev_depth> |
|
|
4644 | |
|
|
4645 | =item C<ev_loop_verify> renamed to C<ev_verify> |
|
|
4646 | |
|
|
4647 | Most functions working on C<struct ev_loop> objects don't have an |
|
|
4648 | C<ev_loop_> prefix, so it was removed. Note that C<ev_loop_fork> is |
|
|
4649 | still called C<ev_loop_fork> because it would otherwise clash with the |
|
|
4650 | C<ev_fork> typedef. |
|
|
4651 | |
|
|
4652 | =item C<EV_TIMEOUT> renamed to C<EV_TIMER> in C<revents> |
|
|
4653 | |
|
|
4654 | This is a simple rename - all other watcher types use their name |
|
|
4655 | as revents flag, and now C<ev_timer> does, too. |
|
|
4656 | |
|
|
4657 | Both C<EV_TIMER> and C<EV_TIMEOUT> symbols were present in 3.x versions |
|
|
4658 | and continue to be present for the forseeable future, so this is mostly a |
|
|
4659 | documentation change. |
|
|
4660 | |
|
|
4661 | =item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES> |
|
|
4662 | |
|
|
4663 | The preprocessor symbol C<EV_MINIMAL> has been replaced by a different |
|
|
4664 | mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile |
|
|
4665 | and work, but the library code will of course be larger. |
|
|
4666 | |
|
|
4667 | =back |
|
|
4668 | |
|
|
4669 | |
4382 | =head1 GLOSSARY |
4670 | =head1 GLOSSARY |
4383 | |
4671 | |
4384 | =over 4 |
4672 | =over 4 |
4385 | |
4673 | |
4386 | =item active |
4674 | =item active |
… | |
… | |
4407 | A change of state of some external event, such as data now being available |
4695 | A change of state of some external event, such as data now being available |
4408 | for reading on a file descriptor, time having passed or simply not having |
4696 | for reading on a file descriptor, time having passed or simply not having |
4409 | any other events happening anymore. |
4697 | any other events happening anymore. |
4410 | |
4698 | |
4411 | In libev, events are represented as single bits (such as C<EV_READ> or |
4699 | In libev, events are represented as single bits (such as C<EV_READ> or |
4412 | C<EV_TIMEOUT>). |
4700 | C<EV_TIMER>). |
4413 | |
4701 | |
4414 | =item event library |
4702 | =item event library |
4415 | |
4703 | |
4416 | A software package implementing an event model and loop. |
4704 | A software package implementing an event model and loop. |
4417 | |
4705 | |