… | |
… | |
8 | |
8 | |
9 | =head2 EXAMPLE PROGRAM |
9 | =head2 EXAMPLE PROGRAM |
10 | |
10 | |
11 | // a single header file is required |
11 | // a single header file is required |
12 | #include <ev.h> |
12 | #include <ev.h> |
|
|
13 | |
|
|
14 | #include <stdio.h> // for puts |
13 | |
15 | |
14 | // every watcher type has its own typedef'd struct |
16 | // every watcher type has its own typedef'd struct |
15 | // with the name ev_TYPE |
17 | // with the name ev_TYPE |
16 | ev_io stdin_watcher; |
18 | ev_io stdin_watcher; |
17 | ev_timer timeout_watcher; |
19 | ev_timer timeout_watcher; |
… | |
… | |
41 | |
43 | |
42 | int |
44 | int |
43 | main (void) |
45 | main (void) |
44 | { |
46 | { |
45 | // use the default event loop unless you have special needs |
47 | // use the default event loop unless you have special needs |
46 | ev_loop *loop = ev_default_loop (0); |
48 | struct ev_loop *loop = ev_default_loop (0); |
47 | |
49 | |
48 | // initialise an io watcher, then start it |
50 | // initialise an io watcher, then start it |
49 | // this one will watch for stdin to become readable |
51 | // this one will watch for stdin to become readable |
50 | ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
52 | ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
51 | ev_io_start (loop, &stdin_watcher); |
53 | ev_io_start (loop, &stdin_watcher); |
… | |
… | |
60 | |
62 | |
61 | // unloop was called, so exit |
63 | // unloop was called, so exit |
62 | return 0; |
64 | return 0; |
63 | } |
65 | } |
64 | |
66 | |
65 | =head1 DESCRIPTION |
67 | =head1 ABOUT THIS DOCUMENT |
|
|
68 | |
|
|
69 | This document documents the libev software package. |
66 | |
70 | |
67 | The newest version of this document is also available as an html-formatted |
71 | The newest version of this document is also available as an html-formatted |
68 | web page you might find easier to navigate when reading it for the first |
72 | web page you might find easier to navigate when reading it for the first |
69 | time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. |
73 | time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. |
|
|
74 | |
|
|
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 |
|
|
77 | on event-based programming, nor will it introduce event-based programming |
|
|
78 | with libev. |
|
|
79 | |
|
|
80 | Familarity with event based programming techniques in general is assumed |
|
|
81 | throughout this document. |
|
|
82 | |
|
|
83 | =head1 ABOUT LIBEV |
70 | |
84 | |
71 | 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 |
72 | file descriptor being readable or a timeout occurring), and it will manage |
86 | file descriptor being readable or a timeout occurring), and it will manage |
73 | these event sources and provide your program with events. |
87 | these event sources and provide your program with events. |
74 | |
88 | |
… | |
… | |
298 | If you don't know what event loop to use, use the one returned from this |
312 | If you don't know what event loop to use, use the one returned from this |
299 | function. |
313 | function. |
300 | |
314 | |
301 | Note that this function is I<not> thread-safe, so if you want to use it |
315 | Note that this function is I<not> thread-safe, so if you want to use it |
302 | from multiple threads, you have to lock (note also that this is unlikely, |
316 | from multiple threads, you have to lock (note also that this is unlikely, |
303 | as loops cannot bes hared easily between threads anyway). |
317 | as loops cannot be shared easily between threads anyway). |
304 | |
318 | |
305 | The default loop is the only loop that can handle C<ev_signal> and |
319 | The default loop is the only loop that can handle C<ev_signal> and |
306 | C<ev_child> watchers, and to do this, it always registers a handler |
320 | C<ev_child> watchers, and to do this, it always registers a handler |
307 | for C<SIGCHLD>. If this is a problem for your application you can either |
321 | for C<SIGCHLD>. If this is a problem for your application you can either |
308 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
322 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
… | |
… | |
386 | For few fds, this backend is a bit little slower than poll and select, |
400 | For few fds, this backend is a bit little slower than poll and select, |
387 | but it scales phenomenally better. While poll and select usually scale |
401 | but it scales phenomenally better. While poll and select usually scale |
388 | like O(total_fds) where n is the total number of fds (or the highest fd), |
402 | like O(total_fds) where n is the total number of fds (or the highest fd), |
389 | epoll scales either O(1) or O(active_fds). |
403 | epoll scales either O(1) or O(active_fds). |
390 | |
404 | |
391 | The epoll syscalls are the most misdesigned of the more advanced event |
405 | The epoll mechanism deserves honorable mention as the most misdesigned |
392 | mechanisms: problems include silently dropping fds, requiring a system |
406 | of the more advanced event mechanisms: mere annoyances include silently |
393 | call per change per fd (and unnecessary guessing of parameters), problems |
407 | dropping file descriptors, requiring a system call per change per file |
|
|
408 | descriptor (and unnecessary guessing of parameters), problems with dup and |
394 | with dup and so on. The biggest issue is fork races, however - if a |
409 | so on. The biggest issue is fork races, however - if a program forks then |
395 | program forks then I<both> parent and child process have to recreate the |
410 | I<both> parent and child process have to recreate the epoll set, which can |
396 | epoll set, which can take considerable time (one syscall per fd) and is of |
411 | take considerable time (one syscall per file descriptor) and is of course |
397 | course hard to detect. |
412 | hard to detect. |
398 | |
413 | |
399 | Epoll is also notoriously buggy - embedding epoll fds should work, but |
414 | Epoll is also notoriously buggy - embedding epoll fds I<should> work, but |
400 | of course doesn't, and epoll just loves to report events for totally |
415 | of course I<doesn't>, and epoll just loves to report events for totally |
401 | I<different> file descriptors (even already closed ones, so one cannot |
416 | I<different> file descriptors (even already closed ones, so one cannot |
402 | even remove them from the set) than registered in the set (especially |
417 | even remove them from the set) than registered in the set (especially |
403 | on SMP systems). Libev tries to counter these spurious notifications by |
418 | on SMP systems). Libev tries to counter these spurious notifications by |
404 | employing an additional generation counter and comparing that against the |
419 | employing an additional generation counter and comparing that against the |
405 | events to filter out spurious ones. |
420 | events to filter out spurious ones, recreating the set when required. |
406 | |
421 | |
407 | While stopping, setting and starting an I/O watcher in the same iteration |
422 | While stopping, setting and starting an I/O watcher in the same iteration |
408 | will result in some caching, there is still a system call per such incident |
423 | will result in some caching, there is still a system call per such |
409 | (because the fd could point to a different file description now), so its |
424 | incident (because the same I<file descriptor> could point to a different |
410 | best to avoid that. Also, C<dup ()>'ed file descriptors might not work |
425 | I<file description> now), so its best to avoid that. Also, C<dup ()>'ed |
411 | very well if you register events for both fds. |
426 | file descriptors might not work very well if you register events for both |
|
|
427 | file descriptors. |
412 | |
428 | |
413 | Best performance from this backend is achieved by not unregistering all |
429 | Best performance from this backend is achieved by not unregistering all |
414 | watchers for a file descriptor until it has been closed, if possible, |
430 | watchers for a file descriptor until it has been closed, if possible, |
415 | i.e. keep at least one watcher active per fd at all times. Stopping and |
431 | i.e. keep at least one watcher active per fd at all times. Stopping and |
416 | starting a watcher (without re-setting it) also usually doesn't cause |
432 | starting a watcher (without re-setting it) also usually doesn't cause |
417 | extra overhead. A fork can both result in spurious notifications as well |
433 | extra overhead. A fork can both result in spurious notifications as well |
418 | as in libev having to destroy and recreate the epoll object, which can |
434 | as in libev having to destroy and recreate the epoll object, which can |
419 | take considerable time and thus should be avoided. |
435 | take considerable time and thus should be avoided. |
420 | |
436 | |
|
|
437 | All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or |
|
|
438 | faster than epoll for maybe up to a hundred file descriptors, depending on |
|
|
439 | the usage. So sad. |
|
|
440 | |
421 | While nominally embeddable in other event loops, this feature is broken in |
441 | While nominally embeddable in other event loops, this feature is broken in |
422 | all kernel versions tested so far. |
442 | all kernel versions tested so far. |
423 | |
443 | |
424 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
444 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
425 | C<EVBACKEND_POLL>. |
445 | C<EVBACKEND_POLL>. |
426 | |
446 | |
427 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
447 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
428 | |
448 | |
429 | Kqueue deserves special mention, as at the time of this writing, it was |
449 | Kqueue deserves special mention, as at the time of this writing, it |
430 | broken on all BSDs except NetBSD (usually it doesn't work reliably with |
450 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
431 | anything but sockets and pipes, except on Darwin, where of course it's |
451 | with anything but sockets and pipes, except on Darwin, where of course |
432 | completely useless). For this reason it's not being "auto-detected" unless |
452 | it's completely useless). Unlike epoll, however, whose brokenness |
433 | you explicitly specify it in the flags (i.e. using C<EVBACKEND_KQUEUE>) or |
453 | is by design, these kqueue bugs can (and eventually will) be fixed |
434 | libev was compiled on a known-to-be-good (-enough) system like NetBSD. |
454 | without API changes to existing programs. For this reason it's not being |
|
|
455 | "auto-detected" unless you explicitly specify it in the flags (i.e. using |
|
|
456 | C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) |
|
|
457 | system like NetBSD. |
435 | |
458 | |
436 | You still can embed kqueue into a normal poll or select backend and use it |
459 | You still can embed kqueue into a normal poll or select backend and use it |
437 | only for sockets (after having made sure that sockets work with kqueue on |
460 | only for sockets (after having made sure that sockets work with kqueue on |
438 | the target platform). See C<ev_embed> watchers for more info. |
461 | the target platform). See C<ev_embed> watchers for more info. |
439 | |
462 | |
… | |
… | |
449 | |
472 | |
450 | While nominally embeddable in other event loops, this doesn't work |
473 | While nominally embeddable in other event loops, this doesn't work |
451 | everywhere, so you might need to test for this. And since it is broken |
474 | everywhere, so you might need to test for this. And since it is broken |
452 | almost everywhere, you should only use it when you have a lot of sockets |
475 | almost everywhere, you should only use it when you have a lot of sockets |
453 | (for which it usually works), by embedding it into another event loop |
476 | (for which it usually works), by embedding it into another event loop |
454 | (e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and, did I mention it, |
477 | (e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course |
455 | using it only for sockets. |
478 | also broken on OS X)) and, did I mention it, using it only for sockets. |
456 | |
479 | |
457 | This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with |
480 | This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with |
458 | C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with |
481 | C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with |
459 | C<NOTE_EOF>. |
482 | C<NOTE_EOF>. |
460 | |
483 | |
… | |
… | |
623 | very long time without entering the event loop, updating libev's idea of |
646 | very long time without entering the event loop, updating libev's idea of |
624 | the current time is a good idea. |
647 | the current time is a good idea. |
625 | |
648 | |
626 | See also "The special problem of time updates" in the C<ev_timer> section. |
649 | See also "The special problem of time updates" in the C<ev_timer> section. |
627 | |
650 | |
|
|
651 | =item ev_suspend (loop) |
|
|
652 | |
|
|
653 | =item ev_resume (loop) |
|
|
654 | |
|
|
655 | These two functions suspend and resume a loop, for use when the loop is |
|
|
656 | not used for a while and timeouts should not be processed. |
|
|
657 | |
|
|
658 | A typical use case would be an interactive program such as a game: When |
|
|
659 | the user presses C<^Z> to suspend the game and resumes it an hour later it |
|
|
660 | would be best to handle timeouts as if no time had actually passed while |
|
|
661 | the program was suspended. This can be achieved by calling C<ev_suspend> |
|
|
662 | in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling |
|
|
663 | C<ev_resume> directly afterwards to resume timer processing. |
|
|
664 | |
|
|
665 | Effectively, all C<ev_timer> watchers will be delayed by the time spend |
|
|
666 | between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers |
|
|
667 | will be rescheduled (that is, they will lose any events that would have |
|
|
668 | occured while suspended). |
|
|
669 | |
|
|
670 | After calling C<ev_suspend> you B<must not> call I<any> function on the |
|
|
671 | given loop other than C<ev_resume>, and you B<must not> call C<ev_resume> |
|
|
672 | without a previous call to C<ev_suspend>. |
|
|
673 | |
|
|
674 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
|
|
675 | event loop time (see C<ev_now_update>). |
|
|
676 | |
628 | =item ev_loop (loop, int flags) |
677 | =item ev_loop (loop, int flags) |
629 | |
678 | |
630 | Finally, this is it, the event handler. This function usually is called |
679 | Finally, this is it, the event handler. This function usually is called |
631 | after you initialised all your watchers and you want to start handling |
680 | after you initialised all your watchers and you want to start handling |
632 | events. |
681 | events. |
… | |
… | |
647 | the loop. |
696 | the loop. |
648 | |
697 | |
649 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
698 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
650 | necessary) and will handle those and any already outstanding ones. It |
699 | necessary) and will handle those and any already outstanding ones. It |
651 | will block your process until at least one new event arrives (which could |
700 | will block your process until at least one new event arrives (which could |
652 | be an event internal to libev itself, so there is no guarentee that a |
701 | be an event internal to libev itself, so there is no guarantee that a |
653 | user-registered callback will be called), and will return after one |
702 | user-registered callback will be called), and will return after one |
654 | iteration of the loop. |
703 | iteration of the loop. |
655 | |
704 | |
656 | This is useful if you are waiting for some external event in conjunction |
705 | This is useful if you are waiting for some external event in conjunction |
657 | with something not expressible using other libev watchers (i.e. "roll your |
706 | with something not expressible using other libev watchers (i.e. "roll your |
… | |
… | |
715 | |
764 | |
716 | If you have a watcher you never unregister that should not keep C<ev_loop> |
765 | If you have a watcher you never unregister that should not keep C<ev_loop> |
717 | from returning, call ev_unref() after starting, and ev_ref() before |
766 | from returning, call ev_unref() after starting, and ev_ref() before |
718 | stopping it. |
767 | stopping it. |
719 | |
768 | |
720 | As an example, libev itself uses this for its internal signal pipe: It is |
769 | As an example, libev itself uses this for its internal signal pipe: It |
721 | not visible to the libev user and should not keep C<ev_loop> from exiting |
770 | is not visible to the libev user and should not keep C<ev_loop> from |
722 | if no event watchers registered by it are active. It is also an excellent |
771 | exiting if no event watchers registered by it are active. It is also an |
723 | way to do this for generic recurring timers or from within third-party |
772 | excellent way to do this for generic recurring timers or from within |
724 | libraries. Just remember to I<unref after start> and I<ref before stop> |
773 | third-party libraries. Just remember to I<unref after start> and I<ref |
725 | (but only if the watcher wasn't active before, or was active before, |
774 | before stop> (but only if the watcher wasn't active before, or was active |
726 | respectively). |
775 | before, respectively. Note also that libev might stop watchers itself |
|
|
776 | (e.g. non-repeating timers) in which case you have to C<ev_ref> |
|
|
777 | in the callback). |
727 | |
778 | |
728 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
779 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
729 | running when nothing else is active. |
780 | running when nothing else is active. |
730 | |
781 | |
731 | ev_signal exitsig; |
782 | ev_signal exitsig; |
… | |
… | |
915 | |
966 | |
916 | =item C<EV_ASYNC> |
967 | =item C<EV_ASYNC> |
917 | |
968 | |
918 | The given async watcher has been asynchronously notified (see C<ev_async>). |
969 | The given async watcher has been asynchronously notified (see C<ev_async>). |
919 | |
970 | |
|
|
971 | =item C<EV_CUSTOM> |
|
|
972 | |
|
|
973 | Not ever sent (or otherwise used) by libev itself, but can be freely used |
|
|
974 | by libev users to signal watchers (e.g. via C<ev_feed_event>). |
|
|
975 | |
920 | =item C<EV_ERROR> |
976 | =item C<EV_ERROR> |
921 | |
977 | |
922 | An unspecified error has occurred, the watcher has been stopped. This might |
978 | An unspecified error has occurred, the watcher has been stopped. This might |
923 | happen because the watcher could not be properly started because libev |
979 | happen because the watcher could not be properly started because libev |
924 | ran out of memory, a file descriptor was found to be closed or any other |
980 | ran out of memory, a file descriptor was found to be closed or any other |
… | |
… | |
1039 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
1095 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
1040 | (default: C<-2>). Pending watchers with higher priority will be invoked |
1096 | (default: C<-2>). Pending watchers with higher priority will be invoked |
1041 | before watchers with lower priority, but priority will not keep watchers |
1097 | before watchers with lower priority, but priority will not keep watchers |
1042 | from being executed (except for C<ev_idle> watchers). |
1098 | from being executed (except for C<ev_idle> watchers). |
1043 | |
1099 | |
1044 | This means that priorities are I<only> used for ordering callback |
|
|
1045 | invocation after new events have been received. This is useful, for |
|
|
1046 | example, to reduce latency after idling, or more often, to bind two |
|
|
1047 | watchers on the same event and make sure one is called first. |
|
|
1048 | |
|
|
1049 | If you need to suppress invocation when higher priority events are pending |
1100 | If you need to suppress invocation when higher priority events are pending |
1050 | you need to look at C<ev_idle> watchers, which provide this functionality. |
1101 | you need to look at C<ev_idle> watchers, which provide this functionality. |
1051 | |
1102 | |
1052 | You I<must not> change the priority of a watcher as long as it is active or |
1103 | You I<must not> change the priority of a watcher as long as it is active or |
1053 | pending. |
1104 | pending. |
1054 | |
|
|
1055 | The default priority used by watchers when no priority has been set is |
|
|
1056 | always C<0>, which is supposed to not be too high and not be too low :). |
|
|
1057 | |
1105 | |
1058 | Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is |
1106 | Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is |
1059 | fine, as long as you do not mind that the priority value you query might |
1107 | fine, as long as you do not mind that the priority value you query might |
1060 | or might not have been clamped to the valid range. |
1108 | or might not have been clamped to the valid range. |
|
|
1109 | |
|
|
1110 | The default priority used by watchers when no priority has been set is |
|
|
1111 | always C<0>, which is supposed to not be too high and not be too low :). |
|
|
1112 | |
|
|
1113 | See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
|
|
1114 | priorities. |
1061 | |
1115 | |
1062 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1116 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1063 | |
1117 | |
1064 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
1118 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
1065 | C<loop> nor C<revents> need to be valid as long as the watcher callback |
1119 | C<loop> nor C<revents> need to be valid as long as the watcher callback |
… | |
… | |
1140 | t2_cb (EV_P_ ev_timer *w, int revents) |
1194 | t2_cb (EV_P_ ev_timer *w, int revents) |
1141 | { |
1195 | { |
1142 | struct my_biggy big = (struct my_biggy * |
1196 | struct my_biggy big = (struct my_biggy * |
1143 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1197 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1144 | } |
1198 | } |
|
|
1199 | |
|
|
1200 | =head2 WATCHER PRIORITY MODELS |
|
|
1201 | |
|
|
1202 | Many event loops support I<watcher priorities>, which are usually small |
|
|
1203 | integers that influence the ordering of event callback invocation |
|
|
1204 | between watchers in some way, all else being equal. |
|
|
1205 | |
|
|
1206 | In libev, Watcher priorities can be set using C<ev_set_priority>. See its |
|
|
1207 | description for the more technical details such as the actual priority |
|
|
1208 | range. |
|
|
1209 | |
|
|
1210 | There are two common ways how these these priorities are being interpreted |
|
|
1211 | by event loops: |
|
|
1212 | |
|
|
1213 | In the more common lock-out model, higher priorities "lock out" invocation |
|
|
1214 | of lower priority watchers, which means as long as higher priority |
|
|
1215 | watchers receive events, lower priority watchers are not being invoked. |
|
|
1216 | |
|
|
1217 | The less common only-for-ordering model uses priorities solely to order |
|
|
1218 | callback invocation within a single event loop iteration: Higher priority |
|
|
1219 | watchers are invoked before lower priority ones, but they all get invoked |
|
|
1220 | before polling for new events. |
|
|
1221 | |
|
|
1222 | Libev uses the second (only-for-ordering) model for all its watchers |
|
|
1223 | except for idle watchers (which use the lock-out model). |
|
|
1224 | |
|
|
1225 | The rationale behind this is that implementing the lock-out model for |
|
|
1226 | watchers is not well supported by most kernel interfaces, and most event |
|
|
1227 | libraries will just poll for the same events again and again as long as |
|
|
1228 | their callbacks have not been executed, which is very inefficient in the |
|
|
1229 | common case of one high-priority watcher locking out a mass of lower |
|
|
1230 | priority ones. |
|
|
1231 | |
|
|
1232 | Static (ordering) priorities are most useful when you have two or more |
|
|
1233 | watchers handling the same resource: a typical usage example is having an |
|
|
1234 | C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle |
|
|
1235 | timeouts. Under load, data might be received while the program handles |
|
|
1236 | other jobs, but since timers normally get invoked first, the timeout |
|
|
1237 | handler will be executed before checking for data. In that case, giving |
|
|
1238 | the timer a lower priority than the I/O watcher ensures that I/O will be |
|
|
1239 | handled first even under adverse conditions (which is usually, but not |
|
|
1240 | always, what you want). |
|
|
1241 | |
|
|
1242 | Since idle watchers use the "lock-out" model, meaning that idle watchers |
|
|
1243 | will only be executed when no same or higher priority watchers have |
|
|
1244 | received events, they can be used to implement the "lock-out" model when |
|
|
1245 | required. |
|
|
1246 | |
|
|
1247 | For example, to emulate how many other event libraries handle priorities, |
|
|
1248 | you can associate an C<ev_idle> watcher to each such watcher, and in |
|
|
1249 | the normal watcher callback, you just start the idle watcher. The real |
|
|
1250 | processing is done in the idle watcher callback. This causes libev to |
|
|
1251 | continously poll and process kernel event data for the watcher, but when |
|
|
1252 | the lock-out case is known to be rare (which in turn is rare :), this is |
|
|
1253 | workable. |
|
|
1254 | |
|
|
1255 | Usually, however, the lock-out model implemented that way will perform |
|
|
1256 | miserably under the type of load it was designed to handle. In that case, |
|
|
1257 | it might be preferable to stop the real watcher before starting the |
|
|
1258 | idle watcher, so the kernel will not have to process the event in case |
|
|
1259 | the actual processing will be delayed for considerable time. |
|
|
1260 | |
|
|
1261 | Here is an example of an I/O watcher that should run at a strictly lower |
|
|
1262 | priority than the default, and which should only process data when no |
|
|
1263 | other events are pending: |
|
|
1264 | |
|
|
1265 | ev_idle idle; // actual processing watcher |
|
|
1266 | ev_io io; // actual event watcher |
|
|
1267 | |
|
|
1268 | static void |
|
|
1269 | io_cb (EV_P_ ev_io *w, int revents) |
|
|
1270 | { |
|
|
1271 | // stop the I/O watcher, we received the event, but |
|
|
1272 | // are not yet ready to handle it. |
|
|
1273 | ev_io_stop (EV_A_ w); |
|
|
1274 | |
|
|
1275 | // start the idle watcher to ahndle the actual event. |
|
|
1276 | // it will not be executed as long as other watchers |
|
|
1277 | // with the default priority are receiving events. |
|
|
1278 | ev_idle_start (EV_A_ &idle); |
|
|
1279 | } |
|
|
1280 | |
|
|
1281 | static void |
|
|
1282 | idle-cb (EV_P_ ev_idle *w, int revents) |
|
|
1283 | { |
|
|
1284 | // actual processing |
|
|
1285 | read (STDIN_FILENO, ...); |
|
|
1286 | |
|
|
1287 | // have to start the I/O watcher again, as |
|
|
1288 | // we have handled the event |
|
|
1289 | ev_io_start (EV_P_ &io); |
|
|
1290 | } |
|
|
1291 | |
|
|
1292 | // initialisation |
|
|
1293 | ev_idle_init (&idle, idle_cb); |
|
|
1294 | ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ); |
|
|
1295 | ev_io_start (EV_DEFAULT_ &io); |
|
|
1296 | |
|
|
1297 | In the "real" world, it might also be beneficial to start a timer, so that |
|
|
1298 | low-priority connections can not be locked out forever under load. This |
|
|
1299 | enables your program to keep a lower latency for important connections |
|
|
1300 | during short periods of high load, while not completely locking out less |
|
|
1301 | important ones. |
1145 | |
1302 | |
1146 | |
1303 | |
1147 | =head1 WATCHER TYPES |
1304 | =head1 WATCHER TYPES |
1148 | |
1305 | |
1149 | This section describes each watcher in detail, but will not repeat |
1306 | This section describes each watcher in detail, but will not repeat |
… | |
… | |
1306 | year, it will still time out after (roughly) one hour. "Roughly" because |
1463 | year, it will still time out after (roughly) one hour. "Roughly" because |
1307 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1464 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1308 | monotonic clock option helps a lot here). |
1465 | monotonic clock option helps a lot here). |
1309 | |
1466 | |
1310 | The callback is guaranteed to be invoked only I<after> its timeout has |
1467 | The callback is guaranteed to be invoked only I<after> its timeout has |
1311 | passed, but if multiple timers become ready during the same loop iteration |
1468 | passed. If multiple timers become ready during the same loop iteration |
1312 | then order of execution is undefined. |
1469 | then the ones with earlier time-out values are invoked before ones with |
|
|
1470 | later time-out values (but this is no longer true when a callback calls |
|
|
1471 | C<ev_loop> recursively). |
1313 | |
1472 | |
1314 | =head3 Be smart about timeouts |
1473 | =head3 Be smart about timeouts |
1315 | |
1474 | |
1316 | Many real-world problems involve some kind of timeout, usually for error |
1475 | Many real-world problems involve some kind of timeout, usually for error |
1317 | recovery. A typical example is an HTTP request - if the other side hangs, |
1476 | recovery. A typical example is an HTTP request - if the other side hangs, |
… | |
… | |
1410 | else |
1569 | else |
1411 | { |
1570 | { |
1412 | // callback was invoked, but there was some activity, re-arm |
1571 | // callback was invoked, but there was some activity, re-arm |
1413 | // the watcher to fire in last_activity + 60, which is |
1572 | // the watcher to fire in last_activity + 60, which is |
1414 | // guaranteed to be in the future, so "again" is positive: |
1573 | // guaranteed to be in the future, so "again" is positive: |
1415 | w->again = timeout - now; |
1574 | w->repeat = timeout - now; |
1416 | ev_timer_again (EV_A_ w); |
1575 | ev_timer_again (EV_A_ w); |
1417 | } |
1576 | } |
1418 | } |
1577 | } |
1419 | |
1578 | |
1420 | To summarise the callback: first calculate the real timeout (defined |
1579 | To summarise the callback: first calculate the real timeout (defined |
… | |
… | |
1536 | If the timer is started but non-repeating, stop it (as if it timed out). |
1695 | If the timer is started but non-repeating, stop it (as if it timed out). |
1537 | |
1696 | |
1538 | If the timer is repeating, either start it if necessary (with the |
1697 | If the timer is repeating, either start it if necessary (with the |
1539 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1698 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1540 | |
1699 | |
1541 | This sounds a bit complicated, see "Be smart about timeouts", above, for a |
1700 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
1542 | usage example. |
1701 | usage example. |
1543 | |
1702 | |
1544 | =item ev_tstamp repeat [read-write] |
1703 | =item ev_tstamp repeat [read-write] |
1545 | |
1704 | |
1546 | The current C<repeat> value. Will be used each time the watcher times out |
1705 | The current C<repeat> value. Will be used each time the watcher times out |
… | |
… | |
1585 | =head2 C<ev_periodic> - to cron or not to cron? |
1744 | =head2 C<ev_periodic> - to cron or not to cron? |
1586 | |
1745 | |
1587 | Periodic watchers are also timers of a kind, but they are very versatile |
1746 | Periodic watchers are also timers of a kind, but they are very versatile |
1588 | (and unfortunately a bit complex). |
1747 | (and unfortunately a bit complex). |
1589 | |
1748 | |
1590 | Unlike C<ev_timer>'s, they are not based on real time (or relative time) |
1749 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
1591 | but on wall clock time (absolute time). You can tell a periodic watcher |
1750 | relative time, the physical time that passes) but on wall clock time |
1592 | to trigger after some specific point in time. For example, if you tell a |
1751 | (absolute time, the thing you can read on your calender or clock). The |
1593 | periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now () |
1752 | difference is that wall clock time can run faster or slower than real |
1594 | + 10.>, that is, an absolute time not a delay) and then reset your system |
1753 | time, and time jumps are not uncommon (e.g. when you adjust your |
1595 | clock to January of the previous year, then it will take more than year |
1754 | wrist-watch). |
1596 | to trigger the event (unlike an C<ev_timer>, which would still trigger |
|
|
1597 | roughly 10 seconds later as it uses a relative timeout). |
|
|
1598 | |
1755 | |
|
|
1756 | You can tell a periodic watcher to trigger after some specific point |
|
|
1757 | in time: for example, if you tell a periodic watcher to trigger "in 10 |
|
|
1758 | seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time |
|
|
1759 | not a delay) and then reset your system clock to January of the previous |
|
|
1760 | year, then it will take a year or more to trigger the event (unlike an |
|
|
1761 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
|
|
1762 | it, as it uses a relative timeout). |
|
|
1763 | |
1599 | C<ev_periodic>s can also be used to implement vastly more complex timers, |
1764 | C<ev_periodic> watchers can also be used to implement vastly more complex |
1600 | such as triggering an event on each "midnight, local time", or other |
1765 | timers, such as triggering an event on each "midnight, local time", or |
1601 | complicated rules. |
1766 | other complicated rules. This cannot be done with C<ev_timer> watchers, as |
|
|
1767 | those cannot react to time jumps. |
1602 | |
1768 | |
1603 | As with timers, the callback is guaranteed to be invoked only when the |
1769 | As with timers, the callback is guaranteed to be invoked only when the |
1604 | time (C<at>) has passed, but if multiple periodic timers become ready |
1770 | point in time where it is supposed to trigger has passed. If multiple |
1605 | during the same loop iteration, then order of execution is undefined. |
1771 | timers become ready during the same loop iteration then the ones with |
|
|
1772 | earlier time-out values are invoked before ones with later time-out values |
|
|
1773 | (but this is no longer true when a callback calls C<ev_loop> recursively). |
1606 | |
1774 | |
1607 | =head3 Watcher-Specific Functions and Data Members |
1775 | =head3 Watcher-Specific Functions and Data Members |
1608 | |
1776 | |
1609 | =over 4 |
1777 | =over 4 |
1610 | |
1778 | |
1611 | =item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) |
1779 | =item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb) |
1612 | |
1780 | |
1613 | =item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) |
1781 | =item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb) |
1614 | |
1782 | |
1615 | Lots of arguments, lets sort it out... There are basically three modes of |
1783 | Lots of arguments, let's sort it out... There are basically three modes of |
1616 | operation, and we will explain them from simplest to most complex: |
1784 | operation, and we will explain them from simplest to most complex: |
1617 | |
1785 | |
1618 | =over 4 |
1786 | =over 4 |
1619 | |
1787 | |
1620 | =item * absolute timer (at = time, interval = reschedule_cb = 0) |
1788 | =item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0) |
1621 | |
1789 | |
1622 | In this configuration the watcher triggers an event after the wall clock |
1790 | In this configuration the watcher triggers an event after the wall clock |
1623 | time C<at> has passed. It will not repeat and will not adjust when a time |
1791 | time C<offset> has passed. It will not repeat and will not adjust when a |
1624 | jump occurs, that is, if it is to be run at January 1st 2011 then it will |
1792 | time jump occurs, that is, if it is to be run at January 1st 2011 then it |
1625 | only run when the system clock reaches or surpasses this time. |
1793 | will be stopped and invoked when the system clock reaches or surpasses |
|
|
1794 | this point in time. |
1626 | |
1795 | |
1627 | =item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
1796 | =item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0) |
1628 | |
1797 | |
1629 | In this mode the watcher will always be scheduled to time out at the next |
1798 | In this mode the watcher will always be scheduled to time out at the next |
1630 | C<at + N * interval> time (for some integer N, which can also be negative) |
1799 | C<offset + N * interval> time (for some integer N, which can also be |
1631 | and then repeat, regardless of any time jumps. |
1800 | negative) and then repeat, regardless of any time jumps. The C<offset> |
|
|
1801 | argument is merely an offset into the C<interval> periods. |
1632 | |
1802 | |
1633 | This can be used to create timers that do not drift with respect to the |
1803 | This can be used to create timers that do not drift with respect to the |
1634 | system clock, for example, here is a C<ev_periodic> that triggers each |
1804 | system clock, for example, here is an C<ev_periodic> that triggers each |
1635 | hour, on the hour: |
1805 | hour, on the hour (with respect to UTC): |
1636 | |
1806 | |
1637 | ev_periodic_set (&periodic, 0., 3600., 0); |
1807 | ev_periodic_set (&periodic, 0., 3600., 0); |
1638 | |
1808 | |
1639 | This doesn't mean there will always be 3600 seconds in between triggers, |
1809 | This doesn't mean there will always be 3600 seconds in between triggers, |
1640 | but only that the callback will be called when the system time shows a |
1810 | but only that the callback will be called when the system time shows a |
1641 | full hour (UTC), or more correctly, when the system time is evenly divisible |
1811 | full hour (UTC), or more correctly, when the system time is evenly divisible |
1642 | by 3600. |
1812 | by 3600. |
1643 | |
1813 | |
1644 | Another way to think about it (for the mathematically inclined) is that |
1814 | Another way to think about it (for the mathematically inclined) is that |
1645 | C<ev_periodic> will try to run the callback in this mode at the next possible |
1815 | C<ev_periodic> will try to run the callback in this mode at the next possible |
1646 | time where C<time = at (mod interval)>, regardless of any time jumps. |
1816 | time where C<time = offset (mod interval)>, regardless of any time jumps. |
1647 | |
1817 | |
1648 | For numerical stability it is preferable that the C<at> value is near |
1818 | For numerical stability it is preferable that the C<offset> value is near |
1649 | C<ev_now ()> (the current time), but there is no range requirement for |
1819 | C<ev_now ()> (the current time), but there is no range requirement for |
1650 | this value, and in fact is often specified as zero. |
1820 | this value, and in fact is often specified as zero. |
1651 | |
1821 | |
1652 | Note also that there is an upper limit to how often a timer can fire (CPU |
1822 | Note also that there is an upper limit to how often a timer can fire (CPU |
1653 | speed for example), so if C<interval> is very small then timing stability |
1823 | speed for example), so if C<interval> is very small then timing stability |
1654 | will of course deteriorate. Libev itself tries to be exact to be about one |
1824 | will of course deteriorate. Libev itself tries to be exact to be about one |
1655 | millisecond (if the OS supports it and the machine is fast enough). |
1825 | millisecond (if the OS supports it and the machine is fast enough). |
1656 | |
1826 | |
1657 | =item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) |
1827 | =item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback) |
1658 | |
1828 | |
1659 | In this mode the values for C<interval> and C<at> are both being |
1829 | In this mode the values for C<interval> and C<offset> are both being |
1660 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1830 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1661 | reschedule callback will be called with the watcher as first, and the |
1831 | reschedule callback will be called with the watcher as first, and the |
1662 | current time as second argument. |
1832 | current time as second argument. |
1663 | |
1833 | |
1664 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, |
1834 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever, |
1665 | ever, or make ANY event loop modifications whatsoever>. |
1835 | or make ANY other event loop modifications whatsoever, unless explicitly |
|
|
1836 | allowed by documentation here>. |
1666 | |
1837 | |
1667 | If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop |
1838 | If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop |
1668 | it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the |
1839 | it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the |
1669 | only event loop modification you are allowed to do). |
1840 | only event loop modification you are allowed to do). |
1670 | |
1841 | |
… | |
… | |
1700 | a different time than the last time it was called (e.g. in a crond like |
1871 | a different time than the last time it was called (e.g. in a crond like |
1701 | program when the crontabs have changed). |
1872 | program when the crontabs have changed). |
1702 | |
1873 | |
1703 | =item ev_tstamp ev_periodic_at (ev_periodic *) |
1874 | =item ev_tstamp ev_periodic_at (ev_periodic *) |
1704 | |
1875 | |
1705 | When active, returns the absolute time that the watcher is supposed to |
1876 | When active, returns the absolute time that the watcher is supposed |
1706 | trigger next. |
1877 | to trigger next. This is not the same as the C<offset> argument to |
|
|
1878 | C<ev_periodic_set>, but indeed works even in interval and manual |
|
|
1879 | rescheduling modes. |
1707 | |
1880 | |
1708 | =item ev_tstamp offset [read-write] |
1881 | =item ev_tstamp offset [read-write] |
1709 | |
1882 | |
1710 | When repeating, this contains the offset value, otherwise this is the |
1883 | When repeating, this contains the offset value, otherwise this is the |
1711 | absolute point in time (the C<at> value passed to C<ev_periodic_set>). |
1884 | absolute point in time (the C<offset> value passed to C<ev_periodic_set>, |
|
|
1885 | although libev might modify this value for better numerical stability). |
1712 | |
1886 | |
1713 | Can be modified any time, but changes only take effect when the periodic |
1887 | Can be modified any time, but changes only take effect when the periodic |
1714 | timer fires or C<ev_periodic_again> is being called. |
1888 | timer fires or C<ev_periodic_again> is being called. |
1715 | |
1889 | |
1716 | =item ev_tstamp interval [read-write] |
1890 | =item ev_tstamp interval [read-write] |
… | |
… | |
1922 | |
2096 | |
1923 | |
2097 | |
1924 | =head2 C<ev_stat> - did the file attributes just change? |
2098 | =head2 C<ev_stat> - did the file attributes just change? |
1925 | |
2099 | |
1926 | This watches a file system path for attribute changes. That is, it calls |
2100 | This watches a file system path for attribute changes. That is, it calls |
1927 | C<stat> regularly (or when the OS says it changed) and sees if it changed |
2101 | C<stat> on that path in regular intervals (or when the OS says it changed) |
1928 | compared to the last time, invoking the callback if it did. |
2102 | and sees if it changed compared to the last time, invoking the callback if |
|
|
2103 | it did. |
1929 | |
2104 | |
1930 | The path does not need to exist: changing from "path exists" to "path does |
2105 | The path does not need to exist: changing from "path exists" to "path does |
1931 | not exist" is a status change like any other. The condition "path does |
2106 | not exist" is a status change like any other. The condition "path does not |
1932 | not exist" is signified by the C<st_nlink> field being zero (which is |
2107 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
1933 | otherwise always forced to be at least one) and all the other fields of |
2108 | C<st_nlink> field being zero (which is otherwise always forced to be at |
1934 | the stat buffer having unspecified contents. |
2109 | least one) and all the other fields of the stat buffer having unspecified |
|
|
2110 | contents. |
1935 | |
2111 | |
1936 | The path I<should> be absolute and I<must not> end in a slash. If it is |
2112 | The path I<must not> end in a slash or contain special components such as |
|
|
2113 | C<.> or C<..>. The path I<should> be absolute: If it is relative and |
1937 | relative and your working directory changes, the behaviour is undefined. |
2114 | your working directory changes, then the behaviour is undefined. |
1938 | |
2115 | |
1939 | Since there is no standard kernel interface to do this, the portable |
2116 | Since there is no portable change notification interface available, the |
1940 | implementation simply calls C<stat (2)> regularly on the path to see if |
2117 | portable implementation simply calls C<stat(2)> regularly on the path |
1941 | it changed somehow. You can specify a recommended polling interval for |
2118 | to see if it changed somehow. You can specify a recommended polling |
1942 | this case. If you specify a polling interval of C<0> (highly recommended!) |
2119 | interval for this case. If you specify a polling interval of C<0> (highly |
1943 | then a I<suitable, unspecified default> value will be used (which |
2120 | recommended!) then a I<suitable, unspecified default> value will be used |
1944 | you can expect to be around five seconds, although this might change |
2121 | (which you can expect to be around five seconds, although this might |
1945 | dynamically). Libev will also impose a minimum interval which is currently |
2122 | change dynamically). Libev will also impose a minimum interval which is |
1946 | around C<0.1>, but thats usually overkill. |
2123 | currently around C<0.1>, but that's usually overkill. |
1947 | |
2124 | |
1948 | This watcher type is not meant for massive numbers of stat watchers, |
2125 | This watcher type is not meant for massive numbers of stat watchers, |
1949 | as even with OS-supported change notifications, this can be |
2126 | as even with OS-supported change notifications, this can be |
1950 | resource-intensive. |
2127 | resource-intensive. |
1951 | |
2128 | |
1952 | At the time of this writing, the only OS-specific interface implemented |
2129 | At the time of this writing, the only OS-specific interface implemented |
1953 | is the Linux inotify interface (implementing kqueue support is left as |
2130 | is the Linux inotify interface (implementing kqueue support is left as an |
1954 | an exercise for the reader. Note, however, that the author sees no way |
2131 | exercise for the reader. Note, however, that the author sees no way of |
1955 | of implementing C<ev_stat> semantics with kqueue). |
2132 | implementing C<ev_stat> semantics with kqueue, except as a hint). |
1956 | |
2133 | |
1957 | =head3 ABI Issues (Largefile Support) |
2134 | =head3 ABI Issues (Largefile Support) |
1958 | |
2135 | |
1959 | Libev by default (unless the user overrides this) uses the default |
2136 | Libev by default (unless the user overrides this) uses the default |
1960 | compilation environment, which means that on systems with large file |
2137 | compilation environment, which means that on systems with large file |
1961 | support disabled by default, you get the 32 bit version of the stat |
2138 | support disabled by default, you get the 32 bit version of the stat |
1962 | structure. When using the library from programs that change the ABI to |
2139 | structure. When using the library from programs that change the ABI to |
1963 | use 64 bit file offsets the programs will fail. In that case you have to |
2140 | use 64 bit file offsets the programs will fail. In that case you have to |
1964 | compile libev with the same flags to get binary compatibility. This is |
2141 | compile libev with the same flags to get binary compatibility. This is |
1965 | obviously the case with any flags that change the ABI, but the problem is |
2142 | obviously the case with any flags that change the ABI, but the problem is |
1966 | most noticeably disabled with ev_stat and large file support. |
2143 | most noticeably displayed with ev_stat and large file support. |
1967 | |
2144 | |
1968 | The solution for this is to lobby your distribution maker to make large |
2145 | The solution for this is to lobby your distribution maker to make large |
1969 | file interfaces available by default (as e.g. FreeBSD does) and not |
2146 | file interfaces available by default (as e.g. FreeBSD does) and not |
1970 | optional. Libev cannot simply switch on large file support because it has |
2147 | optional. Libev cannot simply switch on large file support because it has |
1971 | to exchange stat structures with application programs compiled using the |
2148 | to exchange stat structures with application programs compiled using the |
1972 | default compilation environment. |
2149 | default compilation environment. |
1973 | |
2150 | |
1974 | =head3 Inotify and Kqueue |
2151 | =head3 Inotify and Kqueue |
1975 | |
2152 | |
1976 | When C<inotify (7)> support has been compiled into libev (generally |
2153 | When C<inotify (7)> support has been compiled into libev and present at |
1977 | only available with Linux 2.6.25 or above due to bugs in earlier |
2154 | runtime, it will be used to speed up change detection where possible. The |
1978 | implementations) and present at runtime, it will be used to speed up |
2155 | inotify descriptor will be created lazily when the first C<ev_stat> |
1979 | change detection where possible. The inotify descriptor will be created |
2156 | watcher is being started. |
1980 | lazily when the first C<ev_stat> watcher is being started. |
|
|
1981 | |
2157 | |
1982 | Inotify presence does not change the semantics of C<ev_stat> watchers |
2158 | Inotify presence does not change the semantics of C<ev_stat> watchers |
1983 | except that changes might be detected earlier, and in some cases, to avoid |
2159 | except that changes might be detected earlier, and in some cases, to avoid |
1984 | making regular C<stat> calls. Even in the presence of inotify support |
2160 | making regular C<stat> calls. Even in the presence of inotify support |
1985 | there are many cases where libev has to resort to regular C<stat> polling, |
2161 | there are many cases where libev has to resort to regular C<stat> polling, |
1986 | but as long as the path exists, libev usually gets away without polling. |
2162 | but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too |
|
|
2163 | many bugs), the path exists (i.e. stat succeeds), and the path resides on |
|
|
2164 | a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and |
|
|
2165 | xfs are fully working) libev usually gets away without polling. |
1987 | |
2166 | |
1988 | There is no support for kqueue, as apparently it cannot be used to |
2167 | There is no support for kqueue, as apparently it cannot be used to |
1989 | implement this functionality, due to the requirement of having a file |
2168 | implement this functionality, due to the requirement of having a file |
1990 | descriptor open on the object at all times, and detecting renames, unlinks |
2169 | descriptor open on the object at all times, and detecting renames, unlinks |
1991 | etc. is difficult. |
2170 | etc. is difficult. |
1992 | |
2171 | |
|
|
2172 | =head3 C<stat ()> is a synchronous operation |
|
|
2173 | |
|
|
2174 | Libev doesn't normally do any kind of I/O itself, and so is not blocking |
|
|
2175 | the process. The exception are C<ev_stat> watchers - those call C<stat |
|
|
2176 | ()>, which is a synchronous operation. |
|
|
2177 | |
|
|
2178 | For local paths, this usually doesn't matter: unless the system is very |
|
|
2179 | busy or the intervals between stat's are large, a stat call will be fast, |
|
|
2180 | as the path data is usually in memory already (except when starting the |
|
|
2181 | watcher). |
|
|
2182 | |
|
|
2183 | For networked file systems, calling C<stat ()> can block an indefinite |
|
|
2184 | time due to network issues, and even under good conditions, a stat call |
|
|
2185 | often takes multiple milliseconds. |
|
|
2186 | |
|
|
2187 | Therefore, it is best to avoid using C<ev_stat> watchers on networked |
|
|
2188 | paths, although this is fully supported by libev. |
|
|
2189 | |
1993 | =head3 The special problem of stat time resolution |
2190 | =head3 The special problem of stat time resolution |
1994 | |
2191 | |
1995 | The C<stat ()> system call only supports full-second resolution portably, and |
2192 | The C<stat ()> system call only supports full-second resolution portably, |
1996 | even on systems where the resolution is higher, most file systems still |
2193 | and even on systems where the resolution is higher, most file systems |
1997 | only support whole seconds. |
2194 | still only support whole seconds. |
1998 | |
2195 | |
1999 | That means that, if the time is the only thing that changes, you can |
2196 | That means that, if the time is the only thing that changes, you can |
2000 | easily miss updates: on the first update, C<ev_stat> detects a change and |
2197 | easily miss updates: on the first update, C<ev_stat> detects a change and |
2001 | calls your callback, which does something. When there is another update |
2198 | calls your callback, which does something. When there is another update |
2002 | within the same second, C<ev_stat> will be unable to detect unless the |
2199 | within the same second, C<ev_stat> will be unable to detect unless the |
… | |
… | |
2145 | |
2342 | |
2146 | =head3 Watcher-Specific Functions and Data Members |
2343 | =head3 Watcher-Specific Functions and Data Members |
2147 | |
2344 | |
2148 | =over 4 |
2345 | =over 4 |
2149 | |
2346 | |
2150 | =item ev_idle_init (ev_signal *, callback) |
2347 | =item ev_idle_init (ev_idle *, callback) |
2151 | |
2348 | |
2152 | Initialises and configures the idle watcher - it has no parameters of any |
2349 | Initialises and configures the idle watcher - it has no parameters of any |
2153 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
2350 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
2154 | believe me. |
2351 | believe me. |
2155 | |
2352 | |
… | |
… | |
2394 | some fds have to be watched and handled very quickly (with low latency), |
2591 | some fds have to be watched and handled very quickly (with low latency), |
2395 | and even priorities and idle watchers might have too much overhead. In |
2592 | and even priorities and idle watchers might have too much overhead. In |
2396 | this case you would put all the high priority stuff in one loop and all |
2593 | this case you would put all the high priority stuff in one loop and all |
2397 | the rest in a second one, and embed the second one in the first. |
2594 | the rest in a second one, and embed the second one in the first. |
2398 | |
2595 | |
2399 | As long as the watcher is active, the callback will be invoked every time |
2596 | As long as the watcher is active, the callback will be invoked every |
2400 | there might be events pending in the embedded loop. The callback must then |
2597 | time there might be events pending in the embedded loop. The callback |
2401 | call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke |
2598 | must then call C<ev_embed_sweep (mainloop, watcher)> to make a single |
2402 | their callbacks (you could also start an idle watcher to give the embedded |
2599 | sweep and invoke their callbacks (the callback doesn't need to invoke the |
2403 | loop strictly lower priority for example). You can also set the callback |
2600 | C<ev_embed_sweep> function directly, it could also start an idle watcher |
2404 | to C<0>, in which case the embed watcher will automatically execute the |
2601 | to give the embedded loop strictly lower priority for example). |
2405 | embedded loop sweep. |
|
|
2406 | |
2602 | |
2407 | As long as the watcher is started it will automatically handle events. The |
2603 | You can also set the callback to C<0>, in which case the embed watcher |
2408 | callback will be invoked whenever some events have been handled. You can |
2604 | will automatically execute the embedded loop sweep whenever necessary. |
2409 | set the callback to C<0> to avoid having to specify one if you are not |
|
|
2410 | interested in that. |
|
|
2411 | |
2605 | |
2412 | Also, there have not currently been made special provisions for forking: |
2606 | Fork detection will be handled transparently while the C<ev_embed> watcher |
2413 | when you fork, you not only have to call C<ev_loop_fork> on both loops, |
2607 | is active, i.e., the embedded loop will automatically be forked when the |
2414 | but you will also have to stop and restart any C<ev_embed> watchers |
2608 | embedding loop forks. In other cases, the user is responsible for calling |
2415 | yourself - but you can use a fork watcher to handle this automatically, |
2609 | C<ev_loop_fork> on the embedded loop. |
2416 | and future versions of libev might do just that. |
|
|
2417 | |
2610 | |
2418 | Unfortunately, not all backends are embeddable: only the ones returned by |
2611 | Unfortunately, not all backends are embeddable: only the ones returned by |
2419 | C<ev_embeddable_backends> are, which, unfortunately, does not include any |
2612 | C<ev_embeddable_backends> are, which, unfortunately, does not include any |
2420 | portable one. |
2613 | portable one. |
2421 | |
2614 | |
… | |
… | |
2641 | =over 4 |
2834 | =over 4 |
2642 | |
2835 | |
2643 | =item ev_async_init (ev_async *, callback) |
2836 | =item ev_async_init (ev_async *, callback) |
2644 | |
2837 | |
2645 | Initialises and configures the async watcher - it has no parameters of any |
2838 | Initialises and configures the async watcher - it has no parameters of any |
2646 | kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless, |
2839 | kind. There is a C<ev_async_set> macro, but using it is utterly pointless, |
2647 | trust me. |
2840 | trust me. |
2648 | |
2841 | |
2649 | =item ev_async_send (loop, ev_async *) |
2842 | =item ev_async_send (loop, ev_async *) |
2650 | |
2843 | |
2651 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
2844 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
2652 | an C<EV_ASYNC> event on the watcher into the event loop. Unlike |
2845 | an C<EV_ASYNC> event on the watcher into the event loop. Unlike |
2653 | C<ev_feed_event>, this call is safe to do from other threads, signal or |
2846 | C<ev_feed_event>, this call is safe to do from other threads, signal or |
2654 | similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding |
2847 | similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding |
2655 | section below on what exactly this means). |
2848 | section below on what exactly this means). |
2656 | |
2849 | |
|
|
2850 | Note that, as with other watchers in libev, multiple events might get |
|
|
2851 | compressed into a single callback invocation (another way to look at this |
|
|
2852 | is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, |
|
|
2853 | reset when the event loop detects that). |
|
|
2854 | |
2657 | This call incurs the overhead of a system call only once per loop iteration, |
2855 | This call incurs the overhead of a system call only once per event loop |
2658 | so while the overhead might be noticeable, it doesn't apply to repeated |
2856 | iteration, so while the overhead might be noticeable, it doesn't apply to |
2659 | calls to C<ev_async_send>. |
2857 | repeated calls to C<ev_async_send> for the same event loop. |
2660 | |
2858 | |
2661 | =item bool = ev_async_pending (ev_async *) |
2859 | =item bool = ev_async_pending (ev_async *) |
2662 | |
2860 | |
2663 | Returns a non-zero value when C<ev_async_send> has been called on the |
2861 | Returns a non-zero value when C<ev_async_send> has been called on the |
2664 | watcher but the event has not yet been processed (or even noted) by the |
2862 | watcher but the event has not yet been processed (or even noted) by the |
… | |
… | |
2667 | C<ev_async_send> sets a flag in the watcher and wakes up the loop. When |
2865 | C<ev_async_send> sets a flag in the watcher and wakes up the loop. When |
2668 | the loop iterates next and checks for the watcher to have become active, |
2866 | the loop iterates next and checks for the watcher to have become active, |
2669 | it will reset the flag again. C<ev_async_pending> can be used to very |
2867 | it will reset the flag again. C<ev_async_pending> can be used to very |
2670 | quickly check whether invoking the loop might be a good idea. |
2868 | quickly check whether invoking the loop might be a good idea. |
2671 | |
2869 | |
2672 | Not that this does I<not> check whether the watcher itself is pending, only |
2870 | Not that this does I<not> check whether the watcher itself is pending, |
2673 | whether it has been requested to make this watcher pending. |
2871 | only whether it has been requested to make this watcher pending: there |
|
|
2872 | is a time window between the event loop checking and resetting the async |
|
|
2873 | notification, and the callback being invoked. |
2674 | |
2874 | |
2675 | =back |
2875 | =back |
2676 | |
2876 | |
2677 | |
2877 | |
2678 | =head1 OTHER FUNCTIONS |
2878 | =head1 OTHER FUNCTIONS |
… | |
… | |
2857 | |
3057 | |
2858 | myclass obj; |
3058 | myclass obj; |
2859 | ev::io iow; |
3059 | ev::io iow; |
2860 | iow.set <myclass, &myclass::io_cb> (&obj); |
3060 | iow.set <myclass, &myclass::io_cb> (&obj); |
2861 | |
3061 | |
|
|
3062 | =item w->set (object *) |
|
|
3063 | |
|
|
3064 | This is an B<experimental> feature that might go away in a future version. |
|
|
3065 | |
|
|
3066 | This is a variation of a method callback - leaving out the method to call |
|
|
3067 | will default the method to C<operator ()>, which makes it possible to use |
|
|
3068 | functor objects without having to manually specify the C<operator ()> all |
|
|
3069 | the time. Incidentally, you can then also leave out the template argument |
|
|
3070 | list. |
|
|
3071 | |
|
|
3072 | The C<operator ()> method prototype must be C<void operator ()(watcher &w, |
|
|
3073 | int revents)>. |
|
|
3074 | |
|
|
3075 | See the method-C<set> above for more details. |
|
|
3076 | |
|
|
3077 | Example: use a functor object as callback. |
|
|
3078 | |
|
|
3079 | struct myfunctor |
|
|
3080 | { |
|
|
3081 | void operator() (ev::io &w, int revents) |
|
|
3082 | { |
|
|
3083 | ... |
|
|
3084 | } |
|
|
3085 | } |
|
|
3086 | |
|
|
3087 | myfunctor f; |
|
|
3088 | |
|
|
3089 | ev::io w; |
|
|
3090 | w.set (&f); |
|
|
3091 | |
2862 | =item w->set<function> (void *data = 0) |
3092 | =item w->set<function> (void *data = 0) |
2863 | |
3093 | |
2864 | Also sets a callback, but uses a static method or plain function as |
3094 | Also sets a callback, but uses a static method or plain function as |
2865 | callback. The optional C<data> argument will be stored in the watcher's |
3095 | callback. The optional C<data> argument will be stored in the watcher's |
2866 | C<data> member and is free for you to use. |
3096 | C<data> member and is free for you to use. |
… | |
… | |
2952 | L<http://software.schmorp.de/pkg/EV>. |
3182 | L<http://software.schmorp.de/pkg/EV>. |
2953 | |
3183 | |
2954 | =item Python |
3184 | =item Python |
2955 | |
3185 | |
2956 | Python bindings can be found at L<http://code.google.com/p/pyev/>. It |
3186 | Python bindings can be found at L<http://code.google.com/p/pyev/>. It |
2957 | seems to be quite complete and well-documented. Note, however, that the |
3187 | seems to be quite complete and well-documented. |
2958 | patch they require for libev is outright dangerous as it breaks the ABI |
|
|
2959 | for everybody else, and therefore, should never be applied in an installed |
|
|
2960 | libev (if python requires an incompatible ABI then it needs to embed |
|
|
2961 | libev). |
|
|
2962 | |
3188 | |
2963 | =item Ruby |
3189 | =item Ruby |
2964 | |
3190 | |
2965 | Tony Arcieri has written a ruby extension that offers access to a subset |
3191 | Tony Arcieri has written a ruby extension that offers access to a subset |
2966 | of the libev API and adds file handle abstractions, asynchronous DNS and |
3192 | of the libev API and adds file handle abstractions, asynchronous DNS and |
2967 | more on top of it. It can be found via gem servers. Its homepage is at |
3193 | more on top of it. It can be found via gem servers. Its homepage is at |
2968 | L<http://rev.rubyforge.org/>. |
3194 | L<http://rev.rubyforge.org/>. |
|
|
3195 | |
|
|
3196 | Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190> |
|
|
3197 | makes rev work even on mingw. |
|
|
3198 | |
|
|
3199 | =item Haskell |
|
|
3200 | |
|
|
3201 | A haskell binding to libev is available at |
|
|
3202 | L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. |
2969 | |
3203 | |
2970 | =item D |
3204 | =item D |
2971 | |
3205 | |
2972 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
3206 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
2973 | be found at L<http://proj.llucax.com.ar/wiki/evd>. |
3207 | be found at L<http://proj.llucax.com.ar/wiki/evd>. |
… | |
… | |
3084 | |
3318 | |
3085 | #define EV_STANDALONE 1 |
3319 | #define EV_STANDALONE 1 |
3086 | #include "ev.h" |
3320 | #include "ev.h" |
3087 | |
3321 | |
3088 | Both header files and implementation files can be compiled with a C++ |
3322 | Both header files and implementation files can be compiled with a C++ |
3089 | compiler (at least, thats a stated goal, and breakage will be treated |
3323 | compiler (at least, that's a stated goal, and breakage will be treated |
3090 | as a bug). |
3324 | as a bug). |
3091 | |
3325 | |
3092 | You need the following files in your source tree, or in a directory |
3326 | You need the following files in your source tree, or in a directory |
3093 | in your include path (e.g. in libev/ when using -Ilibev): |
3327 | in your include path (e.g. in libev/ when using -Ilibev): |
3094 | |
3328 | |
… | |
… | |
3150 | keeps libev from including F<config.h>, and it also defines dummy |
3384 | keeps libev from including F<config.h>, and it also defines dummy |
3151 | implementations for some libevent functions (such as logging, which is not |
3385 | implementations for some libevent functions (such as logging, which is not |
3152 | supported). It will also not define any of the structs usually found in |
3386 | supported). It will also not define any of the structs usually found in |
3153 | F<event.h> that are not directly supported by the libev core alone. |
3387 | F<event.h> that are not directly supported by the libev core alone. |
3154 | |
3388 | |
|
|
3389 | In stanbdalone mode, libev will still try to automatically deduce the |
|
|
3390 | configuration, but has to be more conservative. |
|
|
3391 | |
3155 | =item EV_USE_MONOTONIC |
3392 | =item EV_USE_MONOTONIC |
3156 | |
3393 | |
3157 | If defined to be C<1>, libev will try to detect the availability of the |
3394 | If defined to be C<1>, libev will try to detect the availability of the |
3158 | monotonic clock option at both compile time and runtime. Otherwise no use |
3395 | monotonic clock option at both compile time and runtime. Otherwise no |
3159 | of the monotonic clock option will be attempted. If you enable this, you |
3396 | use of the monotonic clock option will be attempted. If you enable this, |
3160 | usually have to link against librt or something similar. Enabling it when |
3397 | you usually have to link against librt or something similar. Enabling it |
3161 | the functionality isn't available is safe, though, although you have |
3398 | when the functionality isn't available is safe, though, although you have |
3162 | to make sure you link against any libraries where the C<clock_gettime> |
3399 | to make sure you link against any libraries where the C<clock_gettime> |
3163 | function is hiding in (often F<-lrt>). |
3400 | function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>. |
3164 | |
3401 | |
3165 | =item EV_USE_REALTIME |
3402 | =item EV_USE_REALTIME |
3166 | |
3403 | |
3167 | If defined to be C<1>, libev will try to detect the availability of the |
3404 | If defined to be C<1>, libev will try to detect the availability of the |
3168 | real-time clock option at compile time (and assume its availability at |
3405 | real-time clock option at compile time (and assume its availability |
3169 | runtime if successful). Otherwise no use of the real-time clock option will |
3406 | at runtime if successful). Otherwise no use of the real-time clock |
3170 | be attempted. This effectively replaces C<gettimeofday> by C<clock_get |
3407 | option will be attempted. This effectively replaces C<gettimeofday> |
3171 | (CLOCK_REALTIME, ...)> and will not normally affect correctness. See the |
3408 | by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect |
3172 | note about libraries in the description of C<EV_USE_MONOTONIC>, though. |
3409 | correctness. See the note about libraries in the description of |
|
|
3410 | C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of |
|
|
3411 | C<EV_USE_CLOCK_SYSCALL>. |
|
|
3412 | |
|
|
3413 | =item EV_USE_CLOCK_SYSCALL |
|
|
3414 | |
|
|
3415 | If defined to be C<1>, libev will try to use a direct syscall instead |
|
|
3416 | of calling the system-provided C<clock_gettime> function. This option |
|
|
3417 | exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt> |
|
|
3418 | unconditionally pulls in C<libpthread>, slowing down single-threaded |
|
|
3419 | programs needlessly. Using a direct syscall is slightly slower (in |
|
|
3420 | theory), because no optimised vdso implementation can be used, but avoids |
|
|
3421 | the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or |
|
|
3422 | higher, as it simplifies linking (no need for C<-lrt>). |
3173 | |
3423 | |
3174 | =item EV_USE_NANOSLEEP |
3424 | =item EV_USE_NANOSLEEP |
3175 | |
3425 | |
3176 | If defined to be C<1>, libev will assume that C<nanosleep ()> is available |
3426 | If defined to be C<1>, libev will assume that C<nanosleep ()> is available |
3177 | and will use it for delays. Otherwise it will use C<select ()>. |
3427 | and will use it for delays. Otherwise it will use C<select ()>. |
… | |
… | |
3193 | |
3443 | |
3194 | =item EV_SELECT_USE_FD_SET |
3444 | =item EV_SELECT_USE_FD_SET |
3195 | |
3445 | |
3196 | If defined to C<1>, then the select backend will use the system C<fd_set> |
3446 | If defined to C<1>, then the select backend will use the system C<fd_set> |
3197 | structure. This is useful if libev doesn't compile due to a missing |
3447 | structure. This is useful if libev doesn't compile due to a missing |
3198 | C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on |
3448 | C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout |
3199 | exotic systems. This usually limits the range of file descriptors to some |
3449 | on exotic systems. This usually limits the range of file descriptors to |
3200 | low limit such as 1024 or might have other limitations (winsocket only |
3450 | some low limit such as 1024 or might have other limitations (winsocket |
3201 | allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might |
3451 | only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, |
3202 | influence the size of the C<fd_set> used. |
3452 | configures the maximum size of the C<fd_set>. |
3203 | |
3453 | |
3204 | =item EV_SELECT_IS_WINSOCKET |
3454 | =item EV_SELECT_IS_WINSOCKET |
3205 | |
3455 | |
3206 | When defined to C<1>, the select backend will assume that |
3456 | When defined to C<1>, the select backend will assume that |
3207 | select/socket/connect etc. don't understand file descriptors but |
3457 | select/socket/connect etc. don't understand file descriptors but |
… | |
… | |
3566 | loop, as long as you don't confuse yourself). The only exception is that |
3816 | loop, as long as you don't confuse yourself). The only exception is that |
3567 | you must not do this from C<ev_periodic> reschedule callbacks. |
3817 | you must not do this from C<ev_periodic> reschedule callbacks. |
3568 | |
3818 | |
3569 | Care has been taken to ensure that libev does not keep local state inside |
3819 | Care has been taken to ensure that libev does not keep local state inside |
3570 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
3820 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
3571 | they do not clal any callbacks. |
3821 | they do not call any callbacks. |
3572 | |
3822 | |
3573 | =head2 COMPILER WARNINGS |
3823 | =head2 COMPILER WARNINGS |
3574 | |
3824 | |
3575 | Depending on your compiler and compiler settings, you might get no or a |
3825 | Depending on your compiler and compiler settings, you might get no or a |
3576 | lot of warnings when compiling libev code. Some people are apparently |
3826 | lot of warnings when compiling libev code. Some people are apparently |
… | |
… | |
3610 | ==2274== definitely lost: 0 bytes in 0 blocks. |
3860 | ==2274== definitely lost: 0 bytes in 0 blocks. |
3611 | ==2274== possibly lost: 0 bytes in 0 blocks. |
3861 | ==2274== possibly lost: 0 bytes in 0 blocks. |
3612 | ==2274== still reachable: 256 bytes in 1 blocks. |
3862 | ==2274== still reachable: 256 bytes in 1 blocks. |
3613 | |
3863 | |
3614 | Then there is no memory leak, just as memory accounted to global variables |
3864 | Then there is no memory leak, just as memory accounted to global variables |
3615 | is not a memleak - the memory is still being refernced, and didn't leak. |
3865 | is not a memleak - the memory is still being referenced, and didn't leak. |
3616 | |
3866 | |
3617 | Similarly, under some circumstances, valgrind might report kernel bugs |
3867 | Similarly, under some circumstances, valgrind might report kernel bugs |
3618 | as if it were a bug in libev (e.g. in realloc or in the poll backend, |
3868 | as if it were a bug in libev (e.g. in realloc or in the poll backend, |
3619 | although an acceptable workaround has been found here), or it might be |
3869 | although an acceptable workaround has been found here), or it might be |
3620 | confused. |
3870 | confused. |
… | |
… | |
3856 | involves iterating over all running async watchers or all signal numbers. |
4106 | involves iterating over all running async watchers or all signal numbers. |
3857 | |
4107 | |
3858 | =back |
4108 | =back |
3859 | |
4109 | |
3860 | |
4110 | |
|
|
4111 | =head1 GLOSSARY |
|
|
4112 | |
|
|
4113 | =over 4 |
|
|
4114 | |
|
|
4115 | =item active |
|
|
4116 | |
|
|
4117 | A watcher is active as long as it has been started (has been attached to |
|
|
4118 | an event loop) but not yet stopped (disassociated from the event loop). |
|
|
4119 | |
|
|
4120 | =item application |
|
|
4121 | |
|
|
4122 | In this document, an application is whatever is using libev. |
|
|
4123 | |
|
|
4124 | =item callback |
|
|
4125 | |
|
|
4126 | The address of a function that is called when some event has been |
|
|
4127 | detected. Callbacks are being passed the event loop, the watcher that |
|
|
4128 | received the event, and the actual event bitset. |
|
|
4129 | |
|
|
4130 | =item callback invocation |
|
|
4131 | |
|
|
4132 | The act of calling the callback associated with a watcher. |
|
|
4133 | |
|
|
4134 | =item event |
|
|
4135 | |
|
|
4136 | A change of state of some external event, such as data now being available |
|
|
4137 | for reading on a file descriptor, time having passed or simply not having |
|
|
4138 | any other events happening anymore. |
|
|
4139 | |
|
|
4140 | In libev, events are represented as single bits (such as C<EV_READ> or |
|
|
4141 | C<EV_TIMEOUT>). |
|
|
4142 | |
|
|
4143 | =item event library |
|
|
4144 | |
|
|
4145 | A software package implementing an event model and loop. |
|
|
4146 | |
|
|
4147 | =item event loop |
|
|
4148 | |
|
|
4149 | An entity that handles and processes external events and converts them |
|
|
4150 | into callback invocations. |
|
|
4151 | |
|
|
4152 | =item event model |
|
|
4153 | |
|
|
4154 | The model used to describe how an event loop handles and processes |
|
|
4155 | watchers and events. |
|
|
4156 | |
|
|
4157 | =item pending |
|
|
4158 | |
|
|
4159 | A watcher is pending as soon as the corresponding event has been detected, |
|
|
4160 | and stops being pending as soon as the watcher will be invoked or its |
|
|
4161 | pending status is explicitly cleared by the application. |
|
|
4162 | |
|
|
4163 | A watcher can be pending, but not active. Stopping a watcher also clears |
|
|
4164 | its pending status. |
|
|
4165 | |
|
|
4166 | =item real time |
|
|
4167 | |
|
|
4168 | The physical time that is observed. It is apparently strictly monotonic :) |
|
|
4169 | |
|
|
4170 | =item wall-clock time |
|
|
4171 | |
|
|
4172 | The time and date as shown on clocks. Unlike real time, it can actually |
|
|
4173 | be wrong and jump forwards and backwards, e.g. when the you adjust your |
|
|
4174 | clock. |
|
|
4175 | |
|
|
4176 | =item watcher |
|
|
4177 | |
|
|
4178 | A data structure that describes interest in certain events. Watchers need |
|
|
4179 | to be started (attached to an event loop) before they can receive events. |
|
|
4180 | |
|
|
4181 | =item watcher invocation |
|
|
4182 | |
|
|
4183 | The act of calling the callback associated with a watcher. |
|
|
4184 | |
|
|
4185 | =back |
|
|
4186 | |
3861 | =head1 AUTHOR |
4187 | =head1 AUTHOR |
3862 | |
4188 | |
3863 | Marc Lehmann <libev@schmorp.de>. |
4189 | Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. |
3864 | |
4190 | |