… | |
… | |
75 | While this document tries to be as complete as possible in documenting |
75 | While this document tries to be as complete as possible in documenting |
76 | libev, its usage and the rationale behind its design, it is not a tutorial |
76 | libev, its usage and the rationale behind its design, it is not a tutorial |
77 | on event-based programming, nor will it introduce event-based programming |
77 | on event-based programming, nor will it introduce event-based programming |
78 | with libev. |
78 | with libev. |
79 | |
79 | |
80 | Familarity with event based programming techniques in general is assumed |
80 | Familiarity with event based programming techniques in general is assumed |
81 | throughout this document. |
81 | throughout this document. |
82 | |
82 | |
83 | =head1 ABOUT LIBEV |
83 | =head1 ABOUT LIBEV |
84 | |
84 | |
85 | Libev is an event loop: you register interest in certain events (such as a |
85 | Libev is an event loop: you register interest in certain events (such as a |
… | |
… | |
705 | C<ev_resume> directly afterwards to resume timer processing. |
705 | C<ev_resume> directly afterwards to resume timer processing. |
706 | |
706 | |
707 | Effectively, all C<ev_timer> watchers will be delayed by the time spend |
707 | Effectively, all C<ev_timer> watchers will be delayed by the time spend |
708 | between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers |
708 | between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers |
709 | will be rescheduled (that is, they will lose any events that would have |
709 | will be rescheduled (that is, they will lose any events that would have |
710 | occured while suspended). |
710 | occurred while suspended). |
711 | |
711 | |
712 | After calling C<ev_suspend> you B<must not> call I<any> function on the |
712 | After calling C<ev_suspend> you B<must not> call I<any> function on the |
713 | given loop other than C<ev_resume>, and you B<must not> call C<ev_resume> |
713 | given loop other than C<ev_resume>, and you B<must not> call C<ev_resume> |
714 | without a previous call to C<ev_suspend>. |
714 | without a previous call to C<ev_suspend>. |
715 | |
715 | |
… | |
… | |
792 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
792 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
793 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
793 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
794 | |
794 | |
795 | This "unloop state" will be cleared when entering C<ev_loop> again. |
795 | This "unloop state" will be cleared when entering C<ev_loop> again. |
796 | |
796 | |
797 | It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls. |
797 | It is safe to call C<ev_unloop> from outside any C<ev_loop> calls. |
798 | |
798 | |
799 | =item ev_ref (loop) |
799 | =item ev_ref (loop) |
800 | |
800 | |
801 | =item ev_unref (loop) |
801 | =item ev_unref (loop) |
802 | |
802 | |
… | |
… | |
872 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
872 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
873 | as this approaches the timing granularity of most systems. Note that if |
873 | as this approaches the timing granularity of most systems. Note that if |
874 | you do transactions with the outside world and you can't increase the |
874 | you do transactions with the outside world and you can't increase the |
875 | parallelity, then this setting will limit your transaction rate (if you |
875 | parallelity, then this setting will limit your transaction rate (if you |
876 | need to poll once per transaction and the I/O collect interval is 0.01, |
876 | need to poll once per transaction and the I/O collect interval is 0.01, |
877 | then you can't do more than 100 transations per second). |
877 | then you can't do more than 100 transactions per second). |
878 | |
878 | |
879 | Setting the I<timeout collect interval> can improve the opportunity for |
879 | Setting the I<timeout collect interval> can improve the opportunity for |
880 | saving power, as the program will "bundle" timer callback invocations that |
880 | saving power, as the program will "bundle" timer callback invocations that |
881 | are "near" in time together, by delaying some, thus reducing the number of |
881 | are "near" in time together, by delaying some, thus reducing the number of |
882 | times the process sleeps and wakes up again. Another useful technique to |
882 | times the process sleeps and wakes up again. Another useful technique to |
… | |
… | |
1380 | |
1380 | |
1381 | For example, to emulate how many other event libraries handle priorities, |
1381 | For example, to emulate how many other event libraries handle priorities, |
1382 | you can associate an C<ev_idle> watcher to each such watcher, and in |
1382 | you can associate an C<ev_idle> watcher to each such watcher, and in |
1383 | the normal watcher callback, you just start the idle watcher. The real |
1383 | the normal watcher callback, you just start the idle watcher. The real |
1384 | processing is done in the idle watcher callback. This causes libev to |
1384 | processing is done in the idle watcher callback. This causes libev to |
1385 | continously poll and process kernel event data for the watcher, but when |
1385 | continuously poll and process kernel event data for the watcher, but when |
1386 | the lock-out case is known to be rare (which in turn is rare :), this is |
1386 | the lock-out case is known to be rare (which in turn is rare :), this is |
1387 | workable. |
1387 | workable. |
1388 | |
1388 | |
1389 | Usually, however, the lock-out model implemented that way will perform |
1389 | Usually, however, the lock-out model implemented that way will perform |
1390 | miserably under the type of load it was designed to handle. In that case, |
1390 | miserably under the type of load it was designed to handle. In that case, |
… | |
… | |
1468 | |
1468 | |
1469 | If you cannot use non-blocking mode, then force the use of a |
1469 | If you cannot use non-blocking mode, then force the use of a |
1470 | known-to-be-good backend (at the time of this writing, this includes only |
1470 | known-to-be-good backend (at the time of this writing, this includes only |
1471 | C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file |
1471 | C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file |
1472 | descriptors for which non-blocking operation makes no sense (such as |
1472 | descriptors for which non-blocking operation makes no sense (such as |
1473 | files) - libev doesn't guarentee any specific behaviour in that case. |
1473 | files) - libev doesn't guarantee any specific behaviour in that case. |
1474 | |
1474 | |
1475 | Another thing you have to watch out for is that it is quite easy to |
1475 | Another thing you have to watch out for is that it is quite easy to |
1476 | receive "spurious" readiness notifications, that is your callback might |
1476 | receive "spurious" readiness notifications, that is your callback might |
1477 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
1477 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
1478 | because there is no data. Not only are some backends known to create a |
1478 | because there is no data. Not only are some backends known to create a |
… | |
… | |
1737 | ev_tstamp timeout = last_activity + 60.; |
1737 | ev_tstamp timeout = last_activity + 60.; |
1738 | |
1738 | |
1739 | // if last_activity + 60. is older than now, we did time out |
1739 | // if last_activity + 60. is older than now, we did time out |
1740 | if (timeout < now) |
1740 | if (timeout < now) |
1741 | { |
1741 | { |
1742 | // timeout occured, take action |
1742 | // timeout occurred, take action |
1743 | } |
1743 | } |
1744 | else |
1744 | else |
1745 | { |
1745 | { |
1746 | // callback was invoked, but there was some activity, re-arm |
1746 | // callback was invoked, but there was some activity, re-arm |
1747 | // the watcher to fire in last_activity + 60, which is |
1747 | // the watcher to fire in last_activity + 60, which is |
… | |
… | |
2123 | Example: Call a callback every hour, or, more precisely, whenever the |
2123 | Example: Call a callback every hour, or, more precisely, whenever the |
2124 | system time is divisible by 3600. The callback invocation times have |
2124 | system time is divisible by 3600. The callback invocation times have |
2125 | potentially a lot of jitter, but good long-term stability. |
2125 | potentially a lot of jitter, but good long-term stability. |
2126 | |
2126 | |
2127 | static void |
2127 | static void |
2128 | clock_cb (struct ev_loop *loop, ev_io *w, int revents) |
2128 | clock_cb (struct ev_loop *loop, ev_periodic *w, int revents) |
2129 | { |
2129 | { |
2130 | ... its now a full hour (UTC, or TAI or whatever your clock follows) |
2130 | ... its now a full hour (UTC, or TAI or whatever your clock follows) |
2131 | } |
2131 | } |
2132 | |
2132 | |
2133 | ev_periodic hourly_tick; |
2133 | ev_periodic hourly_tick; |
… | |
… | |
3342 | ev::io iow; |
3342 | ev::io iow; |
3343 | iow.set <myclass, &myclass::io_cb> (&obj); |
3343 | iow.set <myclass, &myclass::io_cb> (&obj); |
3344 | |
3344 | |
3345 | =item w->set (object *) |
3345 | =item w->set (object *) |
3346 | |
3346 | |
3347 | This is an B<experimental> feature that might go away in a future version. |
|
|
3348 | |
|
|
3349 | This is a variation of a method callback - leaving out the method to call |
3347 | This is a variation of a method callback - leaving out the method to call |
3350 | will default the method to C<operator ()>, which makes it possible to use |
3348 | will default the method to C<operator ()>, which makes it possible to use |
3351 | functor objects without having to manually specify the C<operator ()> all |
3349 | functor objects without having to manually specify the C<operator ()> all |
3352 | the time. Incidentally, you can then also leave out the template argument |
3350 | the time. Incidentally, you can then also leave out the template argument |
3353 | list. |
3351 | list. |
… | |
… | |
3887 | EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, |
3885 | EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, |
3888 | EV_ASYNC_ENABLE, EV_CHILD_ENABLE. |
3886 | EV_ASYNC_ENABLE, EV_CHILD_ENABLE. |
3889 | |
3887 | |
3890 | If undefined or defined to be C<1> (and the platform supports it), then |
3888 | If undefined or defined to be C<1> (and the platform supports it), then |
3891 | the respective watcher type is supported. If defined to be C<0>, then it |
3889 | the respective watcher type is supported. If defined to be C<0>, then it |
3892 | is not. Disabling watcher types mainly saves codesize. |
3890 | is not. Disabling watcher types mainly saves code size. |
3893 | |
3891 | |
3894 | =item EV_FEATURES |
3892 | =item EV_FEATURES |
3895 | |
3893 | |
3896 | If you need to shave off some kilobytes of code at the expense of some |
3894 | If you need to shave off some kilobytes of code at the expense of some |
3897 | speed (but with the full API), you can define this symbol to request |
3895 | speed (but with the full API), you can define this symbol to request |
… | |
… | |
3917 | |
3915 | |
3918 | =item C<1> - faster/larger code |
3916 | =item C<1> - faster/larger code |
3919 | |
3917 | |
3920 | Use larger code to speed up some operations. |
3918 | Use larger code to speed up some operations. |
3921 | |
3919 | |
3922 | Currently this is used to override some inlining decisions (enlarging the roughly |
3920 | Currently this is used to override some inlining decisions (enlarging the |
3923 | 30% code size on amd64. |
3921 | code size by roughly 30% on amd64). |
3924 | |
3922 | |
3925 | When optimising for size, use of compiler flags such as C<-Os> with |
3923 | 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 |
3924 | gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of |
3927 | assertions. |
3925 | assertions. |
3928 | |
3926 | |
3929 | =item C<2> - faster/larger data structures |
3927 | =item C<2> - faster/larger data structures |
3930 | |
3928 | |
3931 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
3929 | 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 |
3930 | hash table sizes and so on. This will usually further increase code size |
3933 | and can additionally have an effect on the size of data structures at |
3931 | and can additionally have an effect on the size of data structures at |
3934 | runtime. |
3932 | runtime. |
3935 | |
3933 | |
3936 | =item C<4> - full API configuration |
3934 | =item C<4> - full API configuration |
3937 | |
3935 | |
… | |
… | |
3974 | I/O watcher then might come out at only 5Kb. |
3972 | I/O watcher then might come out at only 5Kb. |
3975 | |
3973 | |
3976 | =item EV_AVOID_STDIO |
3974 | =item EV_AVOID_STDIO |
3977 | |
3975 | |
3978 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
3976 | 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 |
3977 | functions (printf, scanf, perror etc.). This will increase the code size |
3980 | somewhat, but if your program doesn't otherwise depend on stdio and your |
3978 | 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 |
3979 | libc allows it, this avoids linking in the stdio library which is quite |
3982 | big. |
3980 | big. |
3983 | |
3981 | |
3984 | Note that error messages might become less precise when this option is |
3982 | Note that error messages might become less precise when this option is |
… | |
… | |
3988 | |
3986 | |
3989 | The highest supported signal number, +1 (or, the number of |
3987 | The highest supported signal number, +1 (or, the number of |
3990 | signals): Normally, libev tries to deduce the maximum number of signals |
3988 | signals): Normally, libev tries to deduce the maximum number of signals |
3991 | automatically, but sometimes this fails, in which case it can be |
3989 | automatically, but sometimes this fails, in which case it can be |
3992 | specified. Also, using a lower number than detected (C<32> should be |
3990 | 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 |
3991 | good for about any system in existence) can save some memory, as libev |
3994 | statically allocates some 12-24 bytes per signal number. |
3992 | statically allocates some 12-24 bytes per signal number. |
3995 | |
3993 | |
3996 | =item EV_PID_HASHSIZE |
3994 | =item EV_PID_HASHSIZE |
3997 | |
3995 | |
3998 | C<ev_child> watchers use a small hash table to distribute workload by |
3996 | C<ev_child> watchers use a small hash table to distribute workload by |
… | |
… | |
4044 | will be C<0>. |
4042 | will be C<0>. |
4045 | |
4043 | |
4046 | =item EV_COMMON |
4044 | =item EV_COMMON |
4047 | |
4045 | |
4048 | By default, all watchers have a C<void *data> member. By redefining |
4046 | By default, all watchers have a C<void *data> member. By redefining |
4049 | this macro to a something else you can include more and other types of |
4047 | this macro to something else you can include more and other types of |
4050 | members. You have to define it each time you include one of the files, |
4048 | members. You have to define it each time you include one of the files, |
4051 | though, and it must be identical each time. |
4049 | though, and it must be identical each time. |
4052 | |
4050 | |
4053 | For example, the perl EV module uses something like this: |
4051 | For example, the perl EV module uses something like this: |
4054 | |
4052 | |
… | |
… | |
4353 | maintainable. |
4351 | maintainable. |
4354 | |
4352 | |
4355 | And of course, some compiler warnings are just plain stupid, or simply |
4353 | And of course, some compiler warnings are just plain stupid, or simply |
4356 | wrong (because they don't actually warn about the condition their message |
4354 | wrong (because they don't actually warn about the condition their message |
4357 | seems to warn about). For example, certain older gcc versions had some |
4355 | seems to warn about). For example, certain older gcc versions had some |
4358 | warnings that resulted an extreme number of false positives. These have |
4356 | warnings that resulted in an extreme number of false positives. These have |
4359 | been fixed, but some people still insist on making code warn-free with |
4357 | been fixed, but some people still insist on making code warn-free with |
4360 | such buggy versions. |
4358 | such buggy versions. |
4361 | |
4359 | |
4362 | While libev is written to generate as few warnings as possible, |
4360 | While libev is written to generate as few warnings as possible, |
4363 | "warn-free" code is not a goal, and it is recommended not to build libev |
4361 | "warn-free" code is not a goal, and it is recommended not to build libev |
… | |
… | |
4653 | |
4651 | |
4654 | This is a simple rename - all other watcher types use their name |
4652 | This is a simple rename - all other watcher types use their name |
4655 | as revents flag, and now C<ev_timer> does, too. |
4653 | as revents flag, and now C<ev_timer> does, too. |
4656 | |
4654 | |
4657 | Both C<EV_TIMER> and C<EV_TIMEOUT> symbols were present in 3.x versions |
4655 | 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 |
4656 | and continue to be present for the foreseeable future, so this is mostly a |
4659 | documentation change. |
4657 | documentation change. |
4660 | |
4658 | |
4661 | =item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES> |
4659 | =item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES> |
4662 | |
4660 | |
4663 | The preprocessor symbol C<EV_MINIMAL> has been replaced by a different |
4661 | The preprocessor symbol C<EV_MINIMAL> has been replaced by a different |