… | |
… | |
178 | you actually want to know. Also interesting is the combination of |
178 | you actually want to know. Also interesting is the combination of |
179 | C<ev_update_now> and C<ev_now>. |
179 | C<ev_update_now> and C<ev_now>. |
180 | |
180 | |
181 | =item ev_sleep (ev_tstamp interval) |
181 | =item ev_sleep (ev_tstamp interval) |
182 | |
182 | |
183 | Sleep for the given interval: The current thread will be blocked until |
183 | Sleep for the given interval: The current thread will be blocked |
184 | either it is interrupted or the given time interval has passed. Basically |
184 | until either it is interrupted or the given time interval has |
|
|
185 | passed (approximately - it might return a bit earlier even if not |
|
|
186 | interrupted). Returns immediately if C<< interval <= 0 >>. |
|
|
187 | |
185 | this is a sub-second-resolution C<sleep ()>. |
188 | Basically this is a sub-second-resolution C<sleep ()>. |
|
|
189 | |
|
|
190 | The range of the C<interval> is limited - libev only guarantees to work |
|
|
191 | with sleep times of up to one day (C<< interval <= 86400 >>). |
186 | |
192 | |
187 | =item int ev_version_major () |
193 | =item int ev_version_major () |
188 | |
194 | |
189 | =item int ev_version_minor () |
195 | =item int ev_version_minor () |
190 | |
196 | |
… | |
… | |
435 | example) that can't properly initialise their signal masks. |
441 | example) that can't properly initialise their signal masks. |
436 | |
442 | |
437 | =item C<EVFLAG_NOSIGMASK> |
443 | =item C<EVFLAG_NOSIGMASK> |
438 | |
444 | |
439 | When this flag is specified, then libev will avoid to modify the signal |
445 | When this flag is specified, then libev will avoid to modify the signal |
440 | mask. Specifically, this means you ahve to make sure signals are unblocked |
446 | mask. Specifically, this means you have to make sure signals are unblocked |
441 | when you want to receive them. |
447 | when you want to receive them. |
442 | |
448 | |
443 | This behaviour is useful when you want to do your own signal handling, or |
449 | This behaviour is useful when you want to do your own signal handling, or |
444 | want to handle signals only in specific threads and want to avoid libev |
450 | want to handle signals only in specific threads and want to avoid libev |
445 | unblocking the signals. |
451 | unblocking the signals. |
… | |
… | |
506 | totally I<different> file descriptors (even already closed ones, so |
512 | totally I<different> file descriptors (even already closed ones, so |
507 | one cannot even remove them from the set) than registered in the set |
513 | one cannot even remove them from the set) than registered in the set |
508 | (especially on SMP systems). Libev tries to counter these spurious |
514 | (especially on SMP systems). Libev tries to counter these spurious |
509 | notifications by employing an additional generation counter and comparing |
515 | notifications by employing an additional generation counter and comparing |
510 | that against the events to filter out spurious ones, recreating the set |
516 | that against the events to filter out spurious ones, recreating the set |
511 | when required. Epoll also errornously rounds down timeouts, but gives you |
517 | when required. Epoll also erroneously rounds down timeouts, but gives you |
512 | no way to know when and by how much, so sometimes you have to busy-wait |
518 | no way to know when and by how much, so sometimes you have to busy-wait |
513 | because epoll returns immediately despite a nonzero timeout. And last |
519 | because epoll returns immediately despite a nonzero timeout. And last |
514 | not least, it also refuses to work with some file descriptors which work |
520 | not least, it also refuses to work with some file descriptors which work |
515 | perfectly fine with C<select> (files, many character devices...). |
521 | perfectly fine with C<select> (files, many character devices...). |
516 | |
522 | |
… | |
… | |
602 | among the OS-specific backends (I vastly prefer correctness over speed |
608 | among the OS-specific backends (I vastly prefer correctness over speed |
603 | hacks). |
609 | hacks). |
604 | |
610 | |
605 | On the negative side, the interface is I<bizarre> - so bizarre that |
611 | On the negative side, the interface is I<bizarre> - so bizarre that |
606 | even sun itself gets it wrong in their code examples: The event polling |
612 | even sun itself gets it wrong in their code examples: The event polling |
607 | function sometimes returning events to the caller even though an error |
613 | function sometimes returns events to the caller even though an error |
608 | occurred, but with no indication whether it has done so or not (yes, it's |
614 | occurred, but with no indication whether it has done so or not (yes, it's |
609 | even documented that way) - deadly for edge-triggered interfaces where |
615 | even documented that way) - deadly for edge-triggered interfaces where you |
610 | you absolutely have to know whether an event occurred or not because you |
616 | absolutely have to know whether an event occurred or not because you have |
611 | have to re-arm the watcher. |
617 | to re-arm the watcher. |
612 | |
618 | |
613 | Fortunately libev seems to be able to work around these idiocies. |
619 | Fortunately libev seems to be able to work around these idiocies. |
614 | |
620 | |
615 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
621 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
616 | C<EVBACKEND_POLL>. |
622 | C<EVBACKEND_POLL>. |
… | |
… | |
946 | overhead for the actual polling but can deliver many events at once. |
952 | overhead for the actual polling but can deliver many events at once. |
947 | |
953 | |
948 | By setting a higher I<io collect interval> you allow libev to spend more |
954 | By setting a higher I<io collect interval> you allow libev to spend more |
949 | time collecting I/O events, so you can handle more events per iteration, |
955 | time collecting I/O events, so you can handle more events per iteration, |
950 | at the cost of increasing latency. Timeouts (both C<ev_periodic> and |
956 | at the cost of increasing latency. Timeouts (both C<ev_periodic> and |
951 | C<ev_timer>) will be not affected. Setting this to a non-null value will |
957 | C<ev_timer>) will not be affected. Setting this to a non-null value will |
952 | introduce an additional C<ev_sleep ()> call into most loop iterations. The |
958 | introduce an additional C<ev_sleep ()> call into most loop iterations. The |
953 | sleep time ensures that libev will not poll for I/O events more often then |
959 | sleep time ensures that libev will not poll for I/O events more often then |
954 | once per this interval, on average. |
960 | once per this interval, on average (as long as the host time resolution is |
|
|
961 | good enough). |
955 | |
962 | |
956 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
963 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
957 | to spend more time collecting timeouts, at the expense of increased |
964 | to spend more time collecting timeouts, at the expense of increased |
958 | latency/jitter/inexactness (the watcher callback will be called |
965 | latency/jitter/inexactness (the watcher callback will be called |
959 | later). C<ev_io> watchers will not be affected. Setting this to a non-null |
966 | later). C<ev_io> watchers will not be affected. Setting this to a non-null |
… | |
… | |
1379 | |
1386 | |
1380 | =over 4 |
1387 | =over 4 |
1381 | |
1388 | |
1382 | =item initialiased |
1389 | =item initialiased |
1383 | |
1390 | |
1384 | Before a watcher can be registered with the event looop it has to be |
1391 | Before a watcher can be registered with the event loop it has to be |
1385 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
1392 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
1386 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1393 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1387 | |
1394 | |
1388 | In this state it is simply some block of memory that is suitable for |
1395 | In this state it is simply some block of memory that is suitable for |
1389 | use in an event loop. It can be moved around, freed, reused etc. at |
1396 | use in an event loop. It can be moved around, freed, reused etc. at |
… | |
… | |
2016 | keep up with the timer (because it takes longer than those 10 seconds to |
2023 | keep up with the timer (because it takes longer than those 10 seconds to |
2017 | do stuff) the timer will not fire more than once per event loop iteration. |
2024 | do stuff) the timer will not fire more than once per event loop iteration. |
2018 | |
2025 | |
2019 | =item ev_timer_again (loop, ev_timer *) |
2026 | =item ev_timer_again (loop, ev_timer *) |
2020 | |
2027 | |
2021 | This will act as if the timer timed out and restart it again if it is |
2028 | This will act as if the timer timed out and restarts it again if it is |
2022 | repeating. The exact semantics are: |
2029 | repeating. The exact semantics are: |
2023 | |
2030 | |
2024 | If the timer is pending, its pending status is cleared. |
2031 | If the timer is pending, its pending status is cleared. |
2025 | |
2032 | |
2026 | If the timer is started but non-repeating, stop it (as if it timed out). |
2033 | If the timer is started but non-repeating, stop it (as if it timed out). |
… | |
… | |
3213 | C<ev_async_sent> calls). In fact, you could use signal watchers as a kind |
3220 | C<ev_async_sent> calls). In fact, you could use signal watchers as a kind |
3214 | of "global async watchers" by using a watcher on an otherwise unused |
3221 | of "global async watchers" by using a watcher on an otherwise unused |
3215 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3222 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3216 | even without knowing which loop owns the signal. |
3223 | even without knowing which loop owns the signal. |
3217 | |
3224 | |
3218 | Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not |
|
|
3219 | just the default loop. |
|
|
3220 | |
|
|
3221 | =head3 Queueing |
3225 | =head3 Queueing |
3222 | |
3226 | |
3223 | C<ev_async> does not support queueing of data in any way. The reason |
3227 | C<ev_async> does not support queueing of data in any way. The reason |
3224 | is that the author does not know of a simple (or any) algorithm for a |
3228 | is that the author does not know of a simple (or any) algorithm for a |
3225 | multiple-writer-single-reader queue that works in all cases and doesn't |
3229 | multiple-writer-single-reader queue that works in all cases and doesn't |
… | |
… | |
3324 | Unlike C<ev_feed_event>, this call is safe to do from other threads, |
3328 | Unlike C<ev_feed_event>, this call is safe to do from other threads, |
3325 | signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the |
3329 | signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the |
3326 | embedding section below on what exactly this means). |
3330 | embedding section below on what exactly this means). |
3327 | |
3331 | |
3328 | Note that, as with other watchers in libev, multiple events might get |
3332 | Note that, as with other watchers in libev, multiple events might get |
3329 | compressed into a single callback invocation (another way to look at this |
3333 | compressed into a single callback invocation (another way to look at |
3330 | is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, |
3334 | this is that C<ev_async> watchers are level-triggered: they are set on |
3331 | reset when the event loop detects that). |
3335 | C<ev_async_send>, reset when the event loop detects that). |
3332 | |
3336 | |
3333 | This call incurs the overhead of a system call only once per event loop |
3337 | This call incurs the overhead of at most one extra system call per event |
3334 | iteration, so while the overhead might be noticeable, it doesn't apply to |
3338 | loop iteration, if the event loop is blocked, and no syscall at all if |
3335 | repeated calls to C<ev_async_send> for the same event loop. |
3339 | the event loop (or your program) is processing events. That means that |
|
|
3340 | repeated calls are basically free (there is no need to avoid calls for |
|
|
3341 | performance reasons) and that the overhead becomes smaller (typically |
|
|
3342 | zero) under load. |
3336 | |
3343 | |
3337 | =item bool = ev_async_pending (ev_async *) |
3344 | =item bool = ev_async_pending (ev_async *) |
3338 | |
3345 | |
3339 | Returns a non-zero value when C<ev_async_send> has been called on the |
3346 | Returns a non-zero value when C<ev_async_send> has been called on the |
3340 | watcher but the event has not yet been processed (or even noted) by the |
3347 | watcher but the event has not yet been processed (or even noted) by the |
… | |
… | |
3937 | watchers in the constructor. |
3944 | watchers in the constructor. |
3938 | |
3945 | |
3939 | class myclass |
3946 | class myclass |
3940 | { |
3947 | { |
3941 | ev::io io ; void io_cb (ev::io &w, int revents); |
3948 | ev::io io ; void io_cb (ev::io &w, int revents); |
3942 | ev::io2 io2 ; void io2_cb (ev::io &w, int revents); |
3949 | ev::io io2 ; void io2_cb (ev::io &w, int revents); |
3943 | ev::idle idle; void idle_cb (ev::idle &w, int revents); |
3950 | ev::idle idle; void idle_cb (ev::idle &w, int revents); |
3944 | |
3951 | |
3945 | myclass (int fd) |
3952 | myclass (int fd) |
3946 | { |
3953 | { |
3947 | io .set <myclass, &myclass::io_cb > (this); |
3954 | io .set <myclass, &myclass::io_cb > (this); |
… | |
… | |
3998 | L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. |
4005 | L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. |
3999 | |
4006 | |
4000 | =item D |
4007 | =item D |
4001 | |
4008 | |
4002 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
4009 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
4003 | be found at L<http://proj.llucax.com.ar/wiki/evd>. |
4010 | be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>. |
4004 | |
4011 | |
4005 | =item Ocaml |
4012 | =item Ocaml |
4006 | |
4013 | |
4007 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
4014 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
4008 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
4015 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
… | |
… | |
4362 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4369 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4363 | |
4370 | |
4364 | =item EV_ATOMIC_T |
4371 | =item EV_ATOMIC_T |
4365 | |
4372 | |
4366 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4373 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4367 | access is atomic with respect to other threads or signal contexts. No such |
4374 | access is atomic and serialised with respect to other threads or signal |
4368 | type is easily found in the C language, so you can provide your own type |
4375 | contexts. No such type is easily found in the C language, so you can |
4369 | that you know is safe for your purposes. It is used both for signal handler "locking" |
4376 | provide your own type that you know is safe for your purposes. It is used |
4370 | as well as for signal and thread safety in C<ev_async> watchers. |
4377 | both for signal handler "locking" as well as for signal and thread safety |
|
|
4378 | in C<ev_async> watchers. |
4371 | |
4379 | |
4372 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4380 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4373 | (from F<signal.h>), which is usually good enough on most platforms. |
4381 | (from F<signal.h>), which is usually good enough on most platforms, |
|
|
4382 | although strictly speaking using a type that also implies a memory fence |
|
|
4383 | is required. |
4374 | |
4384 | |
4375 | =item EV_H (h) |
4385 | =item EV_H (h) |
4376 | |
4386 | |
4377 | The name of the F<ev.h> header file used to include it. The default if |
4387 | The name of the F<ev.h> header file used to include it. The default if |
4378 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
4388 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
… | |
… | |
4897 | requires, and its I/O model is fundamentally incompatible with the POSIX |
4907 | requires, and its I/O model is fundamentally incompatible with the POSIX |
4898 | model. Libev still offers limited functionality on this platform in |
4908 | model. Libev still offers limited functionality on this platform in |
4899 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
4909 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
4900 | descriptors. This only applies when using Win32 natively, not when using |
4910 | descriptors. This only applies when using Win32 natively, not when using |
4901 | e.g. cygwin. Actually, it only applies to the microsofts own compilers, |
4911 | e.g. cygwin. Actually, it only applies to the microsofts own compilers, |
4902 | as every compielr comes with a slightly differently broken/incompatible |
4912 | as every compiler comes with a slightly differently broken/incompatible |
4903 | environment. |
4913 | environment. |
4904 | |
4914 | |
4905 | Lifting these limitations would basically require the full |
4915 | Lifting these limitations would basically require the full |
4906 | re-implementation of the I/O system. If you are into this kind of thing, |
4916 | re-implementation of the I/O system. If you are into this kind of thing, |
4907 | then note that glib does exactly that for you in a very portable way (note |
4917 | then note that glib does exactly that for you in a very portable way (note |
… | |
… | |
5040 | |
5050 | |
5041 | The type C<double> is used to represent timestamps. It is required to |
5051 | The type C<double> is used to represent timestamps. It is required to |
5042 | have at least 51 bits of mantissa (and 9 bits of exponent), which is |
5052 | have at least 51 bits of mantissa (and 9 bits of exponent), which is |
5043 | good enough for at least into the year 4000 with millisecond accuracy |
5053 | good enough for at least into the year 4000 with millisecond accuracy |
5044 | (the design goal for libev). This requirement is overfulfilled by |
5054 | (the design goal for libev). This requirement is overfulfilled by |
5045 | implementations using IEEE 754, which is basically all existing ones. With |
5055 | implementations using IEEE 754, which is basically all existing ones. |
|
|
5056 | |
5046 | IEEE 754 doubles, you get microsecond accuracy until at least 2200. |
5057 | With IEEE 754 doubles, you get microsecond accuracy until at least the |
|
|
5058 | year 2255 (and millisecond accuray till the year 287396 - by then, libev |
|
|
5059 | is either obsolete or somebody patched it to use C<long double> or |
|
|
5060 | something like that, just kidding). |
5047 | |
5061 | |
5048 | =back |
5062 | =back |
5049 | |
5063 | |
5050 | If you know of other additional requirements drop me a note. |
5064 | If you know of other additional requirements drop me a note. |
5051 | |
5065 | |
… | |
… | |
5113 | =item Processing ev_async_send: O(number_of_async_watchers) |
5127 | =item Processing ev_async_send: O(number_of_async_watchers) |
5114 | |
5128 | |
5115 | =item Processing signals: O(max_signal_number) |
5129 | =item Processing signals: O(max_signal_number) |
5116 | |
5130 | |
5117 | Sending involves a system call I<iff> there were no other C<ev_async_send> |
5131 | Sending involves a system call I<iff> there were no other C<ev_async_send> |
5118 | calls in the current loop iteration. Checking for async and signal events |
5132 | calls in the current loop iteration and the loop is currently |
|
|
5133 | blocked. Checking for async and signal events involves iterating over all |
5119 | involves iterating over all running async watchers or all signal numbers. |
5134 | running async watchers or all signal numbers. |
5120 | |
5135 | |
5121 | =back |
5136 | =back |
5122 | |
5137 | |
5123 | |
5138 | |
5124 | =head1 PORTING FROM LIBEV 3.X TO 4.X |
5139 | =head1 PORTING FROM LIBEV 3.X TO 4.X |