|
|
1 | =encoding utf-8 |
|
|
2 | |
1 | =head1 NAME |
3 | =head1 NAME |
2 | |
4 | |
3 | libev - a high performance full-featured event loop written in C |
5 | libev - a high performance full-featured event loop written in C |
4 | |
6 | |
5 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
… | |
… | |
82 | |
84 | |
83 | =head1 WHAT TO READ WHEN IN A HURRY |
85 | =head1 WHAT TO READ WHEN IN A HURRY |
84 | |
86 | |
85 | This manual tries to be very detailed, but unfortunately, this also makes |
87 | This manual tries to be very detailed, but unfortunately, this also makes |
86 | it very long. If you just want to know the basics of libev, I suggest |
88 | it very long. If you just want to know the basics of libev, I suggest |
87 | reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and |
89 | reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and |
88 | look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and |
90 | look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and |
89 | C<ev_timer> sections in L<WATCHER TYPES>. |
91 | C<ev_timer> sections in L</WATCHER TYPES>. |
90 | |
92 | |
91 | =head1 ABOUT LIBEV |
93 | =head1 ABOUT LIBEV |
92 | |
94 | |
93 | Libev is an event loop: you register interest in certain events (such as a |
95 | Libev is an event loop: you register interest in certain events (such as a |
94 | file descriptor being readable or a timeout occurring), and it will manage |
96 | file descriptor being readable or a timeout occurring), and it will manage |
… | |
… | |
174 | =item ev_tstamp ev_time () |
176 | =item ev_tstamp ev_time () |
175 | |
177 | |
176 | Returns the current time as libev would use it. Please note that the |
178 | Returns the current time as libev would use it. Please note that the |
177 | C<ev_now> function is usually faster and also often returns the timestamp |
179 | C<ev_now> function is usually faster and also often returns the timestamp |
178 | you actually want to know. Also interesting is the combination of |
180 | you actually want to know. Also interesting is the combination of |
179 | C<ev_update_now> and C<ev_now>. |
181 | C<ev_now_update> and C<ev_now>. |
180 | |
182 | |
181 | =item ev_sleep (ev_tstamp interval) |
183 | =item ev_sleep (ev_tstamp interval) |
182 | |
184 | |
183 | Sleep for the given interval: The current thread will be blocked |
185 | Sleep for the given interval: The current thread will be blocked |
184 | until either it is interrupted or the given time interval has |
186 | until either it is interrupted or the given time interval has |
… | |
… | |
247 | the current system, you would need to look at C<ev_embeddable_backends () |
249 | the current system, you would need to look at C<ev_embeddable_backends () |
248 | & ev_supported_backends ()>, likewise for recommended ones. |
250 | & ev_supported_backends ()>, likewise for recommended ones. |
249 | |
251 | |
250 | See the description of C<ev_embed> watchers for more info. |
252 | See the description of C<ev_embed> watchers for more info. |
251 | |
253 | |
252 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) |
254 | =item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ()) |
253 | |
255 | |
254 | Sets the allocation function to use (the prototype is similar - the |
256 | Sets the allocation function to use (the prototype is similar - the |
255 | semantics are identical to the C<realloc> C89/SuS/POSIX function). It is |
257 | semantics are identical to the C<realloc> C89/SuS/POSIX function). It is |
256 | used to allocate and free memory (no surprises here). If it returns zero |
258 | used to allocate and free memory (no surprises here). If it returns zero |
257 | when memory needs to be allocated (C<size != 0>), the library might abort |
259 | when memory needs to be allocated (C<size != 0>), the library might abort |
… | |
… | |
263 | |
265 | |
264 | You could override this function in high-availability programs to, say, |
266 | You could override this function in high-availability programs to, say, |
265 | free some memory if it cannot allocate memory, to use a special allocator, |
267 | free some memory if it cannot allocate memory, to use a special allocator, |
266 | or even to sleep a while and retry until some memory is available. |
268 | or even to sleep a while and retry until some memory is available. |
267 | |
269 | |
|
|
270 | Example: The following is the C<realloc> function that libev itself uses |
|
|
271 | which should work with C<realloc> and C<free> functions of all kinds and |
|
|
272 | is probably a good basis for your own implementation. |
|
|
273 | |
|
|
274 | static void * |
|
|
275 | ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT |
|
|
276 | { |
|
|
277 | if (size) |
|
|
278 | return realloc (ptr, size); |
|
|
279 | |
|
|
280 | free (ptr); |
|
|
281 | return 0; |
|
|
282 | } |
|
|
283 | |
268 | Example: Replace the libev allocator with one that waits a bit and then |
284 | Example: Replace the libev allocator with one that waits a bit and then |
269 | retries (example requires a standards-compliant C<realloc>). |
285 | retries. |
270 | |
286 | |
271 | static void * |
287 | static void * |
272 | persistent_realloc (void *ptr, size_t size) |
288 | persistent_realloc (void *ptr, size_t size) |
273 | { |
289 | { |
|
|
290 | if (!size) |
|
|
291 | { |
|
|
292 | free (ptr); |
|
|
293 | return 0; |
|
|
294 | } |
|
|
295 | |
274 | for (;;) |
296 | for (;;) |
275 | { |
297 | { |
276 | void *newptr = realloc (ptr, size); |
298 | void *newptr = realloc (ptr, size); |
277 | |
299 | |
278 | if (newptr) |
300 | if (newptr) |
… | |
… | |
283 | } |
305 | } |
284 | |
306 | |
285 | ... |
307 | ... |
286 | ev_set_allocator (persistent_realloc); |
308 | ev_set_allocator (persistent_realloc); |
287 | |
309 | |
288 | =item ev_set_syserr_cb (void (*cb)(const char *msg)) |
310 | =item ev_set_syserr_cb (void (*cb)(const char *msg) throw ()) |
289 | |
311 | |
290 | Set the callback function to call on a retryable system call error (such |
312 | Set the callback function to call on a retryable system call error (such |
291 | as failed select, poll, epoll_wait). The message is a printable string |
313 | as failed select, poll, epoll_wait). The message is a printable string |
292 | indicating the system call or subsystem causing the problem. If this |
314 | indicating the system call or subsystem causing the problem. If this |
293 | callback is set, then libev will expect it to remedy the situation, no |
315 | callback is set, then libev will expect it to remedy the situation, no |
… | |
… | |
396 | |
418 | |
397 | If this flag bit is or'ed into the flag value (or the program runs setuid |
419 | If this flag bit is or'ed into the flag value (or the program runs setuid |
398 | or setgid) then libev will I<not> look at the environment variable |
420 | or setgid) then libev will I<not> look at the environment variable |
399 | C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will |
421 | C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will |
400 | override the flags completely if it is found in the environment. This is |
422 | override the flags completely if it is found in the environment. This is |
401 | useful to try out specific backends to test their performance, or to work |
423 | useful to try out specific backends to test their performance, to work |
402 | around bugs. |
424 | around bugs, or to make libev threadsafe (accessing environment variables |
|
|
425 | cannot be done in a threadsafe way, but usually it works if no other |
|
|
426 | thread modifies them). |
403 | |
427 | |
404 | =item C<EVFLAG_FORKCHECK> |
428 | =item C<EVFLAG_FORKCHECK> |
405 | |
429 | |
406 | Instead of calling C<ev_loop_fork> manually after a fork, you can also |
430 | Instead of calling C<ev_loop_fork> manually after a fork, you can also |
407 | make libev check for a fork in each iteration by enabling this flag. |
431 | make libev check for a fork in each iteration by enabling this flag. |
408 | |
432 | |
409 | This works by calling C<getpid ()> on every iteration of the loop, |
433 | This works by calling C<getpid ()> on every iteration of the loop, |
410 | and thus this might slow down your event loop if you do a lot of loop |
434 | and thus this might slow down your event loop if you do a lot of loop |
411 | iterations and little real work, but is usually not noticeable (on my |
435 | iterations and little real work, but is usually not noticeable (on my |
412 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence |
436 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn |
413 | without a system call and thus I<very> fast, but my GNU/Linux system also has |
437 | sequence without a system call and thus I<very> fast, but my GNU/Linux |
414 | C<pthread_atfork> which is even faster). |
438 | system also has C<pthread_atfork> which is even faster). (Update: glibc |
|
|
439 | versions 2.25 apparently removed the C<getpid> optimisation again). |
415 | |
440 | |
416 | The big advantage of this flag is that you can forget about fork (and |
441 | The big advantage of this flag is that you can forget about fork (and |
417 | forget about forgetting to tell libev about forking) when you use this |
442 | forget about forgetting to tell libev about forking, although you still |
418 | flag. |
443 | have to ignore C<SIGPIPE>) when you use this flag. |
419 | |
444 | |
420 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
445 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
421 | environment variable. |
446 | environment variable. |
422 | |
447 | |
423 | =item C<EVFLAG_NOINOTIFY> |
448 | =item C<EVFLAG_NOINOTIFY> |
… | |
… | |
441 | example) that can't properly initialise their signal masks. |
466 | example) that can't properly initialise their signal masks. |
442 | |
467 | |
443 | =item C<EVFLAG_NOSIGMASK> |
468 | =item C<EVFLAG_NOSIGMASK> |
444 | |
469 | |
445 | When this flag is specified, then libev will avoid to modify the signal |
470 | When this flag is specified, then libev will avoid to modify the signal |
446 | mask. Specifically, this means you ahve to make sure signals are unblocked |
471 | mask. Specifically, this means you have to make sure signals are unblocked |
447 | when you want to receive them. |
472 | when you want to receive them. |
448 | |
473 | |
449 | This behaviour is useful when you want to do your own signal handling, or |
474 | This behaviour is useful when you want to do your own signal handling, or |
450 | want to handle signals only in specific threads and want to avoid libev |
475 | want to handle signals only in specific threads and want to avoid libev |
451 | unblocking the signals. |
476 | unblocking the signals. |
… | |
… | |
512 | totally I<different> file descriptors (even already closed ones, so |
537 | totally I<different> file descriptors (even already closed ones, so |
513 | one cannot even remove them from the set) than registered in the set |
538 | one cannot even remove them from the set) than registered in the set |
514 | (especially on SMP systems). Libev tries to counter these spurious |
539 | (especially on SMP systems). Libev tries to counter these spurious |
515 | notifications by employing an additional generation counter and comparing |
540 | notifications by employing an additional generation counter and comparing |
516 | that against the events to filter out spurious ones, recreating the set |
541 | that against the events to filter out spurious ones, recreating the set |
517 | when required. Epoll also errornously rounds down timeouts, but gives you |
542 | when required. Epoll also erroneously rounds down timeouts, but gives you |
518 | no way to know when and by how much, so sometimes you have to busy-wait |
543 | no way to know when and by how much, so sometimes you have to busy-wait |
519 | because epoll returns immediately despite a nonzero timeout. And last |
544 | because epoll returns immediately despite a nonzero timeout. And last |
520 | not least, it also refuses to work with some file descriptors which work |
545 | not least, it also refuses to work with some file descriptors which work |
521 | perfectly fine with C<select> (files, many character devices...). |
546 | perfectly fine with C<select> (files, many character devices...). |
522 | |
547 | |
… | |
… | |
567 | |
592 | |
568 | It scales in the same way as the epoll backend, but the interface to the |
593 | It scales in the same way as the epoll backend, but the interface to the |
569 | kernel is more efficient (which says nothing about its actual speed, of |
594 | kernel is more efficient (which says nothing about its actual speed, of |
570 | course). While stopping, setting and starting an I/O watcher does never |
595 | course). While stopping, setting and starting an I/O watcher does never |
571 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
596 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
572 | two event changes per incident. Support for C<fork ()> is very bad (but |
597 | two event changes per incident. Support for C<fork ()> is very bad (you |
573 | sane, unlike epoll) and it drops fds silently in similarly hard-to-detect |
598 | might have to leak fd's on fork, but it's more sane than epoll) and it |
574 | cases |
599 | drops fds silently in similarly hard-to-detect cases. |
575 | |
600 | |
576 | This backend usually performs well under most conditions. |
601 | This backend usually performs well under most conditions. |
577 | |
602 | |
578 | While nominally embeddable in other event loops, this doesn't work |
603 | While nominally embeddable in other event loops, this doesn't work |
579 | everywhere, so you might need to test for this. And since it is broken |
604 | everywhere, so you might need to test for this. And since it is broken |
… | |
… | |
608 | among the OS-specific backends (I vastly prefer correctness over speed |
633 | among the OS-specific backends (I vastly prefer correctness over speed |
609 | hacks). |
634 | hacks). |
610 | |
635 | |
611 | On the negative side, the interface is I<bizarre> - so bizarre that |
636 | On the negative side, the interface is I<bizarre> - so bizarre that |
612 | even sun itself gets it wrong in their code examples: The event polling |
637 | even sun itself gets it wrong in their code examples: The event polling |
613 | function sometimes returning events to the caller even though an error |
638 | function sometimes returns events to the caller even though an error |
614 | occurred, but with no indication whether it has done so or not (yes, it's |
639 | occurred, but with no indication whether it has done so or not (yes, it's |
615 | even documented that way) - deadly for edge-triggered interfaces where |
640 | even documented that way) - deadly for edge-triggered interfaces where you |
616 | you absolutely have to know whether an event occurred or not because you |
641 | absolutely have to know whether an event occurred or not because you have |
617 | have to re-arm the watcher. |
642 | to re-arm the watcher. |
618 | |
643 | |
619 | Fortunately libev seems to be able to work around these idiocies. |
644 | Fortunately libev seems to be able to work around these idiocies. |
620 | |
645 | |
621 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
646 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
622 | C<EVBACKEND_POLL>. |
647 | C<EVBACKEND_POLL>. |
… | |
… | |
678 | If you need dynamically allocated loops it is better to use C<ev_loop_new> |
703 | If you need dynamically allocated loops it is better to use C<ev_loop_new> |
679 | and C<ev_loop_destroy>. |
704 | and C<ev_loop_destroy>. |
680 | |
705 | |
681 | =item ev_loop_fork (loop) |
706 | =item ev_loop_fork (loop) |
682 | |
707 | |
683 | This function sets a flag that causes subsequent C<ev_run> iterations to |
708 | This function sets a flag that causes subsequent C<ev_run> iterations |
684 | reinitialise the kernel state for backends that have one. Despite the |
709 | to reinitialise the kernel state for backends that have one. Despite |
685 | name, you can call it anytime, but it makes most sense after forking, in |
710 | the name, you can call it anytime you are allowed to start or stop |
686 | the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the |
711 | watchers (except inside an C<ev_prepare> callback), but it makes most |
|
|
712 | sense after forking, in the child process. You I<must> call it (or use |
687 | child before resuming or calling C<ev_run>. |
713 | C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>. |
688 | |
714 | |
|
|
715 | In addition, if you want to reuse a loop (via this function or |
|
|
716 | C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>. |
|
|
717 | |
689 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
718 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
690 | a fork, I<even if you do not plan to use the loop in the parent>. This is |
719 | a fork, I<even if you do not plan to use the loop in the parent>. This is |
691 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
720 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
692 | during fork. |
721 | during fork. |
693 | |
722 | |
694 | On the other hand, you only need to call this function in the child |
723 | On the other hand, you only need to call this function in the child |
… | |
… | |
764 | |
793 | |
765 | This function is rarely useful, but when some event callback runs for a |
794 | This function is rarely useful, but when some event callback runs for a |
766 | very long time without entering the event loop, updating libev's idea of |
795 | very long time without entering the event loop, updating libev's idea of |
767 | the current time is a good idea. |
796 | the current time is a good idea. |
768 | |
797 | |
769 | See also L<The special problem of time updates> in the C<ev_timer> section. |
798 | See also L</The special problem of time updates> in the C<ev_timer> section. |
770 | |
799 | |
771 | =item ev_suspend (loop) |
800 | =item ev_suspend (loop) |
772 | |
801 | |
773 | =item ev_resume (loop) |
802 | =item ev_resume (loop) |
774 | |
803 | |
… | |
… | |
792 | without a previous call to C<ev_suspend>. |
821 | without a previous call to C<ev_suspend>. |
793 | |
822 | |
794 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
823 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
795 | event loop time (see C<ev_now_update>). |
824 | event loop time (see C<ev_now_update>). |
796 | |
825 | |
797 | =item ev_run (loop, int flags) |
826 | =item bool ev_run (loop, int flags) |
798 | |
827 | |
799 | Finally, this is it, the event handler. This function usually is called |
828 | Finally, this is it, the event handler. This function usually is called |
800 | after you have initialised all your watchers and you want to start |
829 | after you have initialised all your watchers and you want to start |
801 | handling events. It will ask the operating system for any new events, call |
830 | handling events. It will ask the operating system for any new events, call |
802 | the watcher callbacks, an then repeat the whole process indefinitely: This |
831 | the watcher callbacks, and then repeat the whole process indefinitely: This |
803 | is why event loops are called I<loops>. |
832 | is why event loops are called I<loops>. |
804 | |
833 | |
805 | If the flags argument is specified as C<0>, it will keep handling events |
834 | If the flags argument is specified as C<0>, it will keep handling events |
806 | until either no event watchers are active anymore or C<ev_break> was |
835 | until either no event watchers are active anymore or C<ev_break> was |
807 | called. |
836 | called. |
|
|
837 | |
|
|
838 | The return value is false if there are no more active watchers (which |
|
|
839 | usually means "all jobs done" or "deadlock"), and true in all other cases |
|
|
840 | (which usually means " you should call C<ev_run> again"). |
808 | |
841 | |
809 | Please note that an explicit C<ev_break> is usually better than |
842 | Please note that an explicit C<ev_break> is usually better than |
810 | relying on all watchers to be stopped when deciding when a program has |
843 | relying on all watchers to be stopped when deciding when a program has |
811 | finished (especially in interactive programs), but having a program |
844 | finished (especially in interactive programs), but having a program |
812 | that automatically loops as long as it has to and no longer by virtue |
845 | that automatically loops as long as it has to and no longer by virtue |
813 | of relying on its watchers stopping correctly, that is truly a thing of |
846 | of relying on its watchers stopping correctly, that is truly a thing of |
814 | beauty. |
847 | beauty. |
815 | |
848 | |
816 | This function is also I<mostly> exception-safe - you can break out of |
849 | This function is I<mostly> exception-safe - you can break out of a |
817 | a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++ |
850 | C<ev_run> call by calling C<longjmp> in a callback, throwing a C++ |
818 | exception and so on. This does not decrement the C<ev_depth> value, nor |
851 | exception and so on. This does not decrement the C<ev_depth> value, nor |
819 | will it clear any outstanding C<EVBREAK_ONE> breaks. |
852 | will it clear any outstanding C<EVBREAK_ONE> breaks. |
820 | |
853 | |
821 | A flags value of C<EVRUN_NOWAIT> will look for new events, will handle |
854 | A flags value of C<EVRUN_NOWAIT> will look for new events, will handle |
822 | those events and any already outstanding ones, but will not wait and |
855 | those events and any already outstanding ones, but will not wait and |
… | |
… | |
1012 | invoke the actual watchers inside another context (another thread etc.). |
1045 | invoke the actual watchers inside another context (another thread etc.). |
1013 | |
1046 | |
1014 | If you want to reset the callback, use C<ev_invoke_pending> as new |
1047 | If you want to reset the callback, use C<ev_invoke_pending> as new |
1015 | callback. |
1048 | callback. |
1016 | |
1049 | |
1017 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) |
1050 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ()) |
1018 | |
1051 | |
1019 | Sometimes you want to share the same loop between multiple threads. This |
1052 | Sometimes you want to share the same loop between multiple threads. This |
1020 | can be done relatively simply by putting mutex_lock/unlock calls around |
1053 | can be done relatively simply by putting mutex_lock/unlock calls around |
1021 | each call to a libev function. |
1054 | each call to a libev function. |
1022 | |
1055 | |
1023 | However, C<ev_run> can run an indefinite time, so it is not feasible |
1056 | However, C<ev_run> can run an indefinite time, so it is not feasible |
1024 | to wait for it to return. One way around this is to wake up the event |
1057 | to wait for it to return. One way around this is to wake up the event |
1025 | loop via C<ev_break> and C<av_async_send>, another way is to set these |
1058 | loop via C<ev_break> and C<ev_async_send>, another way is to set these |
1026 | I<release> and I<acquire> callbacks on the loop. |
1059 | I<release> and I<acquire> callbacks on the loop. |
1027 | |
1060 | |
1028 | When set, then C<release> will be called just before the thread is |
1061 | When set, then C<release> will be called just before the thread is |
1029 | suspended waiting for new events, and C<acquire> is called just |
1062 | suspended waiting for new events, and C<acquire> is called just |
1030 | afterwards. |
1063 | afterwards. |
… | |
… | |
1170 | |
1203 | |
1171 | =item C<EV_PREPARE> |
1204 | =item C<EV_PREPARE> |
1172 | |
1205 | |
1173 | =item C<EV_CHECK> |
1206 | =item C<EV_CHECK> |
1174 | |
1207 | |
1175 | All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts |
1208 | All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to |
1176 | to gather new events, and all C<ev_check> watchers are invoked just after |
1209 | gather new events, and all C<ev_check> watchers are queued (not invoked) |
1177 | C<ev_run> has gathered them, but before it invokes any callbacks for any |
1210 | just after C<ev_run> has gathered them, but before it queues any callbacks |
|
|
1211 | for any received events. That means C<ev_prepare> watchers are the last |
|
|
1212 | watchers invoked before the event loop sleeps or polls for new events, and |
|
|
1213 | C<ev_check> watchers will be invoked before any other watchers of the same |
|
|
1214 | or lower priority within an event loop iteration. |
|
|
1215 | |
1178 | received events. Callbacks of both watcher types can start and stop as |
1216 | Callbacks of both watcher types can start and stop as many watchers as |
1179 | many watchers as they want, and all of them will be taken into account |
1217 | they want, and all of them will be taken into account (for example, a |
1180 | (for example, a C<ev_prepare> watcher might start an idle watcher to keep |
1218 | C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from |
1181 | C<ev_run> from blocking). |
1219 | blocking). |
1182 | |
1220 | |
1183 | =item C<EV_EMBED> |
1221 | =item C<EV_EMBED> |
1184 | |
1222 | |
1185 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1223 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1186 | |
1224 | |
… | |
… | |
1309 | |
1347 | |
1310 | =item callback ev_cb (ev_TYPE *watcher) |
1348 | =item callback ev_cb (ev_TYPE *watcher) |
1311 | |
1349 | |
1312 | Returns the callback currently set on the watcher. |
1350 | Returns the callback currently set on the watcher. |
1313 | |
1351 | |
1314 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1352 | =item ev_set_cb (ev_TYPE *watcher, callback) |
1315 | |
1353 | |
1316 | Change the callback. You can change the callback at virtually any time |
1354 | Change the callback. You can change the callback at virtually any time |
1317 | (modulo threads). |
1355 | (modulo threads). |
1318 | |
1356 | |
1319 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
1357 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
… | |
… | |
1337 | or might not have been clamped to the valid range. |
1375 | or might not have been clamped to the valid range. |
1338 | |
1376 | |
1339 | The default priority used by watchers when no priority has been set is |
1377 | The default priority used by watchers when no priority has been set is |
1340 | always C<0>, which is supposed to not be too high and not be too low :). |
1378 | always C<0>, which is supposed to not be too high and not be too low :). |
1341 | |
1379 | |
1342 | See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1380 | See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1343 | priorities. |
1381 | priorities. |
1344 | |
1382 | |
1345 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1383 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1346 | |
1384 | |
1347 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
1385 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
… | |
… | |
1372 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
1410 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
1373 | functions that do not need a watcher. |
1411 | functions that do not need a watcher. |
1374 | |
1412 | |
1375 | =back |
1413 | =back |
1376 | |
1414 | |
1377 | See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR |
1415 | See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR |
1378 | OWN COMPOSITE WATCHERS> idioms. |
1416 | OWN COMPOSITE WATCHERS> idioms. |
1379 | |
1417 | |
1380 | =head2 WATCHER STATES |
1418 | =head2 WATCHER STATES |
1381 | |
1419 | |
1382 | There are various watcher states mentioned throughout this manual - |
1420 | There are various watcher states mentioned throughout this manual - |
… | |
… | |
1384 | transition between them will be described in more detail - and while these |
1422 | transition between them will be described in more detail - and while these |
1385 | rules might look complicated, they usually do "the right thing". |
1423 | rules might look complicated, they usually do "the right thing". |
1386 | |
1424 | |
1387 | =over 4 |
1425 | =over 4 |
1388 | |
1426 | |
1389 | =item initialiased |
1427 | =item initialised |
1390 | |
1428 | |
1391 | Before a watcher can be registered with the event looop it has to be |
1429 | Before a watcher can be registered with the event loop it has to be |
1392 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
1430 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
1393 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1431 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1394 | |
1432 | |
1395 | In this state it is simply some block of memory that is suitable for |
1433 | In this state it is simply some block of memory that is suitable for |
1396 | use in an event loop. It can be moved around, freed, reused etc. at |
1434 | use in an event loop. It can be moved around, freed, reused etc. at |
… | |
… | |
1771 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1809 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1772 | monotonic clock option helps a lot here). |
1810 | monotonic clock option helps a lot here). |
1773 | |
1811 | |
1774 | The callback is guaranteed to be invoked only I<after> its timeout has |
1812 | The callback is guaranteed to be invoked only I<after> its timeout has |
1775 | passed (not I<at>, so on systems with very low-resolution clocks this |
1813 | passed (not I<at>, so on systems with very low-resolution clocks this |
1776 | might introduce a small delay). If multiple timers become ready during the |
1814 | might introduce a small delay, see "the special problem of being too |
|
|
1815 | early", below). If multiple timers become ready during the same loop |
1777 | same loop iteration then the ones with earlier time-out values are invoked |
1816 | iteration then the ones with earlier time-out values are invoked before |
1778 | before ones of the same priority with later time-out values (but this is |
1817 | ones of the same priority with later time-out values (but this is no |
1779 | no longer true when a callback calls C<ev_run> recursively). |
1818 | longer true when a callback calls C<ev_run> recursively). |
1780 | |
1819 | |
1781 | =head3 Be smart about timeouts |
1820 | =head3 Be smart about timeouts |
1782 | |
1821 | |
1783 | Many real-world problems involve some kind of timeout, usually for error |
1822 | Many real-world problems involve some kind of timeout, usually for error |
1784 | recovery. A typical example is an HTTP request - if the other side hangs, |
1823 | recovery. A typical example is an HTTP request - if the other side hangs, |
… | |
… | |
1859 | |
1898 | |
1860 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
1899 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
1861 | but remember the time of last activity, and check for a real timeout only |
1900 | but remember the time of last activity, and check for a real timeout only |
1862 | within the callback: |
1901 | within the callback: |
1863 | |
1902 | |
|
|
1903 | ev_tstamp timeout = 60.; |
1864 | ev_tstamp last_activity; // time of last activity |
1904 | ev_tstamp last_activity; // time of last activity |
|
|
1905 | ev_timer timer; |
1865 | |
1906 | |
1866 | static void |
1907 | static void |
1867 | callback (EV_P_ ev_timer *w, int revents) |
1908 | callback (EV_P_ ev_timer *w, int revents) |
1868 | { |
1909 | { |
1869 | ev_tstamp now = ev_now (EV_A); |
1910 | // calculate when the timeout would happen |
1870 | ev_tstamp timeout = last_activity + 60.; |
1911 | ev_tstamp after = last_activity - ev_now (EV_A) + timeout; |
1871 | |
1912 | |
1872 | // if last_activity + 60. is older than now, we did time out |
1913 | // if negative, it means we the timeout already occurred |
1873 | if (timeout < now) |
1914 | if (after < 0.) |
1874 | { |
1915 | { |
1875 | // timeout occurred, take action |
1916 | // timeout occurred, take action |
1876 | } |
1917 | } |
1877 | else |
1918 | else |
1878 | { |
1919 | { |
1879 | // callback was invoked, but there was some activity, re-arm |
1920 | // callback was invoked, but there was some recent |
1880 | // the watcher to fire in last_activity + 60, which is |
1921 | // activity. simply restart the timer to time out |
1881 | // guaranteed to be in the future, so "again" is positive: |
1922 | // after "after" seconds, which is the earliest time |
1882 | w->repeat = timeout - now; |
1923 | // the timeout can occur. |
|
|
1924 | ev_timer_set (w, after, 0.); |
1883 | ev_timer_again (EV_A_ w); |
1925 | ev_timer_start (EV_A_ w); |
1884 | } |
1926 | } |
1885 | } |
1927 | } |
1886 | |
1928 | |
1887 | To summarise the callback: first calculate the real timeout (defined |
1929 | To summarise the callback: first calculate in how many seconds the |
1888 | as "60 seconds after the last activity"), then check if that time has |
1930 | timeout will occur (by calculating the absolute time when it would occur, |
1889 | been reached, which means something I<did>, in fact, time out. Otherwise |
1931 | C<last_activity + timeout>, and subtracting the current time, C<ev_now |
1890 | the callback was invoked too early (C<timeout> is in the future), so |
1932 | (EV_A)> from that). |
1891 | re-schedule the timer to fire at that future time, to see if maybe we have |
|
|
1892 | a timeout then. |
|
|
1893 | |
1933 | |
1894 | Note how C<ev_timer_again> is used, taking advantage of the |
1934 | If this value is negative, then we are already past the timeout, i.e. we |
1895 | C<ev_timer_again> optimisation when the timer is already running. |
1935 | timed out, and need to do whatever is needed in this case. |
|
|
1936 | |
|
|
1937 | Otherwise, we now the earliest time at which the timeout would trigger, |
|
|
1938 | and simply start the timer with this timeout value. |
|
|
1939 | |
|
|
1940 | In other words, each time the callback is invoked it will check whether |
|
|
1941 | the timeout occurred. If not, it will simply reschedule itself to check |
|
|
1942 | again at the earliest time it could time out. Rinse. Repeat. |
1896 | |
1943 | |
1897 | This scheme causes more callback invocations (about one every 60 seconds |
1944 | This scheme causes more callback invocations (about one every 60 seconds |
1898 | minus half the average time between activity), but virtually no calls to |
1945 | minus half the average time between activity), but virtually no calls to |
1899 | libev to change the timeout. |
1946 | libev to change the timeout. |
1900 | |
1947 | |
1901 | To start the timer, simply initialise the watcher and set C<last_activity> |
1948 | To start the machinery, simply initialise the watcher and set |
1902 | to the current time (meaning we just have some activity :), then call the |
1949 | C<last_activity> to the current time (meaning there was some activity just |
1903 | callback, which will "do the right thing" and start the timer: |
1950 | now), then call the callback, which will "do the right thing" and start |
|
|
1951 | the timer: |
1904 | |
1952 | |
|
|
1953 | last_activity = ev_now (EV_A); |
1905 | ev_init (timer, callback); |
1954 | ev_init (&timer, callback); |
1906 | last_activity = ev_now (loop); |
1955 | callback (EV_A_ &timer, 0); |
1907 | callback (loop, timer, EV_TIMER); |
|
|
1908 | |
1956 | |
1909 | And when there is some activity, simply store the current time in |
1957 | When there is some activity, simply store the current time in |
1910 | C<last_activity>, no libev calls at all: |
1958 | C<last_activity>, no libev calls at all: |
1911 | |
1959 | |
|
|
1960 | if (activity detected) |
1912 | last_activity = ev_now (loop); |
1961 | last_activity = ev_now (EV_A); |
|
|
1962 | |
|
|
1963 | When your timeout value changes, then the timeout can be changed by simply |
|
|
1964 | providing a new value, stopping the timer and calling the callback, which |
|
|
1965 | will again do the right thing (for example, time out immediately :). |
|
|
1966 | |
|
|
1967 | timeout = new_value; |
|
|
1968 | ev_timer_stop (EV_A_ &timer); |
|
|
1969 | callback (EV_A_ &timer, 0); |
1913 | |
1970 | |
1914 | This technique is slightly more complex, but in most cases where the |
1971 | This technique is slightly more complex, but in most cases where the |
1915 | time-out is unlikely to be triggered, much more efficient. |
1972 | time-out is unlikely to be triggered, much more efficient. |
1916 | |
|
|
1917 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
|
|
1918 | callback :) - just change the timeout and invoke the callback, which will |
|
|
1919 | fix things for you. |
|
|
1920 | |
1973 | |
1921 | =item 4. Wee, just use a double-linked list for your timeouts. |
1974 | =item 4. Wee, just use a double-linked list for your timeouts. |
1922 | |
1975 | |
1923 | If there is not one request, but many thousands (millions...), all |
1976 | If there is not one request, but many thousands (millions...), all |
1924 | employing some kind of timeout with the same timeout value, then one can |
1977 | employing some kind of timeout with the same timeout value, then one can |
… | |
… | |
1951 | Method #1 is almost always a bad idea, and buys you nothing. Method #4 is |
2004 | Method #1 is almost always a bad idea, and buys you nothing. Method #4 is |
1952 | rather complicated, but extremely efficient, something that really pays |
2005 | rather complicated, but extremely efficient, something that really pays |
1953 | off after the first million or so of active timers, i.e. it's usually |
2006 | off after the first million or so of active timers, i.e. it's usually |
1954 | overkill :) |
2007 | overkill :) |
1955 | |
2008 | |
|
|
2009 | =head3 The special problem of being too early |
|
|
2010 | |
|
|
2011 | If you ask a timer to call your callback after three seconds, then |
|
|
2012 | you expect it to be invoked after three seconds - but of course, this |
|
|
2013 | cannot be guaranteed to infinite precision. Less obviously, it cannot be |
|
|
2014 | guaranteed to any precision by libev - imagine somebody suspending the |
|
|
2015 | process with a STOP signal for a few hours for example. |
|
|
2016 | |
|
|
2017 | So, libev tries to invoke your callback as soon as possible I<after> the |
|
|
2018 | delay has occurred, but cannot guarantee this. |
|
|
2019 | |
|
|
2020 | A less obvious failure mode is calling your callback too early: many event |
|
|
2021 | loops compare timestamps with a "elapsed delay >= requested delay", but |
|
|
2022 | this can cause your callback to be invoked much earlier than you would |
|
|
2023 | expect. |
|
|
2024 | |
|
|
2025 | To see why, imagine a system with a clock that only offers full second |
|
|
2026 | resolution (think windows if you can't come up with a broken enough OS |
|
|
2027 | yourself). If you schedule a one-second timer at the time 500.9, then the |
|
|
2028 | event loop will schedule your timeout to elapse at a system time of 500 |
|
|
2029 | (500.9 truncated to the resolution) + 1, or 501. |
|
|
2030 | |
|
|
2031 | If an event library looks at the timeout 0.1s later, it will see "501 >= |
|
|
2032 | 501" and invoke the callback 0.1s after it was started, even though a |
|
|
2033 | one-second delay was requested - this is being "too early", despite best |
|
|
2034 | intentions. |
|
|
2035 | |
|
|
2036 | This is the reason why libev will never invoke the callback if the elapsed |
|
|
2037 | delay equals the requested delay, but only when the elapsed delay is |
|
|
2038 | larger than the requested delay. In the example above, libev would only invoke |
|
|
2039 | the callback at system time 502, or 1.1s after the timer was started. |
|
|
2040 | |
|
|
2041 | So, while libev cannot guarantee that your callback will be invoked |
|
|
2042 | exactly when requested, it I<can> and I<does> guarantee that the requested |
|
|
2043 | delay has actually elapsed, or in other words, it always errs on the "too |
|
|
2044 | late" side of things. |
|
|
2045 | |
1956 | =head3 The special problem of time updates |
2046 | =head3 The special problem of time updates |
1957 | |
2047 | |
1958 | Establishing the current time is a costly operation (it usually takes at |
2048 | Establishing the current time is a costly operation (it usually takes |
1959 | least two system calls): EV therefore updates its idea of the current |
2049 | at least one system call): EV therefore updates its idea of the current |
1960 | time only before and after C<ev_run> collects new events, which causes a |
2050 | time only before and after C<ev_run> collects new events, which causes a |
1961 | growing difference between C<ev_now ()> and C<ev_time ()> when handling |
2051 | growing difference between C<ev_now ()> and C<ev_time ()> when handling |
1962 | lots of events in one iteration. |
2052 | lots of events in one iteration. |
1963 | |
2053 | |
1964 | The relative timeouts are calculated relative to the C<ev_now ()> |
2054 | The relative timeouts are calculated relative to the C<ev_now ()> |
1965 | time. This is usually the right thing as this timestamp refers to the time |
2055 | time. This is usually the right thing as this timestamp refers to the time |
1966 | of the event triggering whatever timeout you are modifying/starting. If |
2056 | of the event triggering whatever timeout you are modifying/starting. If |
1967 | you suspect event processing to be delayed and you I<need> to base the |
2057 | you suspect event processing to be delayed and you I<need> to base the |
1968 | timeout on the current time, use something like this to adjust for this: |
2058 | timeout on the current time, use something like the following to adjust |
|
|
2059 | for it: |
1969 | |
2060 | |
1970 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
2061 | ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.); |
1971 | |
2062 | |
1972 | If the event loop is suspended for a long time, you can also force an |
2063 | If the event loop is suspended for a long time, you can also force an |
1973 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
2064 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1974 | ()>. |
2065 | ()>, although that will push the event time of all outstanding events |
|
|
2066 | further into the future. |
|
|
2067 | |
|
|
2068 | =head3 The special problem of unsynchronised clocks |
|
|
2069 | |
|
|
2070 | Modern systems have a variety of clocks - libev itself uses the normal |
|
|
2071 | "wall clock" clock and, if available, the monotonic clock (to avoid time |
|
|
2072 | jumps). |
|
|
2073 | |
|
|
2074 | Neither of these clocks is synchronised with each other or any other clock |
|
|
2075 | on the system, so C<ev_time ()> might return a considerably different time |
|
|
2076 | than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example, |
|
|
2077 | a call to C<gettimeofday> might return a second count that is one higher |
|
|
2078 | than a directly following call to C<time>. |
|
|
2079 | |
|
|
2080 | The moral of this is to only compare libev-related timestamps with |
|
|
2081 | C<ev_time ()> and C<ev_now ()>, at least if you want better precision than |
|
|
2082 | a second or so. |
|
|
2083 | |
|
|
2084 | One more problem arises due to this lack of synchronisation: if libev uses |
|
|
2085 | the system monotonic clock and you compare timestamps from C<ev_time> |
|
|
2086 | or C<ev_now> from when you started your timer and when your callback is |
|
|
2087 | invoked, you will find that sometimes the callback is a bit "early". |
|
|
2088 | |
|
|
2089 | This is because C<ev_timer>s work in real time, not wall clock time, so |
|
|
2090 | libev makes sure your callback is not invoked before the delay happened, |
|
|
2091 | I<measured according to the real time>, not the system clock. |
|
|
2092 | |
|
|
2093 | If your timeouts are based on a physical timescale (e.g. "time out this |
|
|
2094 | connection after 100 seconds") then this shouldn't bother you as it is |
|
|
2095 | exactly the right behaviour. |
|
|
2096 | |
|
|
2097 | If you want to compare wall clock/system timestamps to your timers, then |
|
|
2098 | you need to use C<ev_periodic>s, as these are based on the wall clock |
|
|
2099 | time, where your comparisons will always generate correct results. |
1975 | |
2100 | |
1976 | =head3 The special problems of suspended animation |
2101 | =head3 The special problems of suspended animation |
1977 | |
2102 | |
1978 | When you leave the server world it is quite customary to hit machines that |
2103 | When you leave the server world it is quite customary to hit machines that |
1979 | can suspend/hibernate - what happens to the clocks during such a suspend? |
2104 | can suspend/hibernate - what happens to the clocks during such a suspend? |
… | |
… | |
2009 | |
2134 | |
2010 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
2135 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
2011 | |
2136 | |
2012 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
2137 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
2013 | |
2138 | |
2014 | Configure the timer to trigger after C<after> seconds. If C<repeat> |
2139 | Configure the timer to trigger after C<after> seconds (fractional and |
2015 | is C<0.>, then it will automatically be stopped once the timeout is |
2140 | negative values are supported). If C<repeat> is C<0.>, then it will |
2016 | reached. If it is positive, then the timer will automatically be |
2141 | automatically be stopped once the timeout is reached. If it is positive, |
2017 | configured to trigger again C<repeat> seconds later, again, and again, |
2142 | then the timer will automatically be configured to trigger again C<repeat> |
2018 | until stopped manually. |
2143 | seconds later, again, and again, until stopped manually. |
2019 | |
2144 | |
2020 | The timer itself will do a best-effort at avoiding drift, that is, if |
2145 | The timer itself will do a best-effort at avoiding drift, that is, if |
2021 | you configure a timer to trigger every 10 seconds, then it will normally |
2146 | you configure a timer to trigger every 10 seconds, then it will normally |
2022 | trigger at exactly 10 second intervals. If, however, your program cannot |
2147 | trigger at exactly 10 second intervals. If, however, your program cannot |
2023 | keep up with the timer (because it takes longer than those 10 seconds to |
2148 | keep up with the timer (because it takes longer than those 10 seconds to |
2024 | do stuff) the timer will not fire more than once per event loop iteration. |
2149 | do stuff) the timer will not fire more than once per event loop iteration. |
2025 | |
2150 | |
2026 | =item ev_timer_again (loop, ev_timer *) |
2151 | =item ev_timer_again (loop, ev_timer *) |
2027 | |
2152 | |
2028 | This will act as if the timer timed out and restart it again if it is |
2153 | This will act as if the timer timed out, and restarts it again if it is |
2029 | repeating. The exact semantics are: |
2154 | repeating. It basically works like calling C<ev_timer_stop>, updating the |
|
|
2155 | timeout to the C<repeat> value and calling C<ev_timer_start>. |
2030 | |
2156 | |
|
|
2157 | The exact semantics are as in the following rules, all of which will be |
|
|
2158 | applied to the watcher: |
|
|
2159 | |
|
|
2160 | =over 4 |
|
|
2161 | |
2031 | If the timer is pending, its pending status is cleared. |
2162 | =item If the timer is pending, the pending status is always cleared. |
2032 | |
2163 | |
2033 | If the timer is started but non-repeating, stop it (as if it timed out). |
2164 | =item If the timer is started but non-repeating, stop it (as if it timed |
|
|
2165 | out, without invoking it). |
2034 | |
2166 | |
2035 | If the timer is repeating, either start it if necessary (with the |
2167 | =item If the timer is repeating, make the C<repeat> value the new timeout |
2036 | C<repeat> value), or reset the running timer to the C<repeat> value. |
2168 | and start the timer, if necessary. |
2037 | |
2169 | |
|
|
2170 | =back |
|
|
2171 | |
2038 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
2172 | This sounds a bit complicated, see L</Be smart about timeouts>, above, for a |
2039 | usage example. |
2173 | usage example. |
2040 | |
2174 | |
2041 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2175 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2042 | |
2176 | |
2043 | Returns the remaining time until a timer fires. If the timer is active, |
2177 | Returns the remaining time until a timer fires. If the timer is active, |
… | |
… | |
2096 | Periodic watchers are also timers of a kind, but they are very versatile |
2230 | Periodic watchers are also timers of a kind, but they are very versatile |
2097 | (and unfortunately a bit complex). |
2231 | (and unfortunately a bit complex). |
2098 | |
2232 | |
2099 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2233 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2100 | relative time, the physical time that passes) but on wall clock time |
2234 | relative time, the physical time that passes) but on wall clock time |
2101 | (absolute time, the thing you can read on your calender or clock). The |
2235 | (absolute time, the thing you can read on your calendar or clock). The |
2102 | difference is that wall clock time can run faster or slower than real |
2236 | difference is that wall clock time can run faster or slower than real |
2103 | time, and time jumps are not uncommon (e.g. when you adjust your |
2237 | time, and time jumps are not uncommon (e.g. when you adjust your |
2104 | wrist-watch). |
2238 | wrist-watch). |
2105 | |
2239 | |
2106 | You can tell a periodic watcher to trigger after some specific point |
2240 | You can tell a periodic watcher to trigger after some specific point |
… | |
… | |
2111 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
2245 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
2112 | it, as it uses a relative timeout). |
2246 | it, as it uses a relative timeout). |
2113 | |
2247 | |
2114 | C<ev_periodic> watchers can also be used to implement vastly more complex |
2248 | C<ev_periodic> watchers can also be used to implement vastly more complex |
2115 | timers, such as triggering an event on each "midnight, local time", or |
2249 | timers, such as triggering an event on each "midnight, local time", or |
2116 | other complicated rules. This cannot be done with C<ev_timer> watchers, as |
2250 | other complicated rules. This cannot easily be done with C<ev_timer> |
2117 | those cannot react to time jumps. |
2251 | watchers, as those cannot react to time jumps. |
2118 | |
2252 | |
2119 | As with timers, the callback is guaranteed to be invoked only when the |
2253 | As with timers, the callback is guaranteed to be invoked only when the |
2120 | point in time where it is supposed to trigger has passed. If multiple |
2254 | point in time where it is supposed to trigger has passed. If multiple |
2121 | timers become ready during the same loop iteration then the ones with |
2255 | timers become ready during the same loop iteration then the ones with |
2122 | earlier time-out values are invoked before ones with later time-out values |
2256 | earlier time-out values are invoked before ones with later time-out values |
… | |
… | |
2208 | |
2342 | |
2209 | NOTE: I<< This callback must always return a time that is higher than or |
2343 | NOTE: I<< This callback must always return a time that is higher than or |
2210 | equal to the passed C<now> value >>. |
2344 | equal to the passed C<now> value >>. |
2211 | |
2345 | |
2212 | This can be used to create very complex timers, such as a timer that |
2346 | This can be used to create very complex timers, such as a timer that |
2213 | triggers on "next midnight, local time". To do this, you would calculate the |
2347 | triggers on "next midnight, local time". To do this, you would calculate |
2214 | next midnight after C<now> and return the timestamp value for this. How |
2348 | the next midnight after C<now> and return the timestamp value for |
2215 | you do this is, again, up to you (but it is not trivial, which is the main |
2349 | this. Here is a (completely untested, no error checking) example on how to |
2216 | reason I omitted it as an example). |
2350 | do this: |
|
|
2351 | |
|
|
2352 | #include <time.h> |
|
|
2353 | |
|
|
2354 | static ev_tstamp |
|
|
2355 | my_rescheduler (ev_periodic *w, ev_tstamp now) |
|
|
2356 | { |
|
|
2357 | time_t tnow = (time_t)now; |
|
|
2358 | struct tm tm; |
|
|
2359 | localtime_r (&tnow, &tm); |
|
|
2360 | |
|
|
2361 | tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day |
|
|
2362 | ++tm.tm_mday; // midnight next day |
|
|
2363 | |
|
|
2364 | return mktime (&tm); |
|
|
2365 | } |
|
|
2366 | |
|
|
2367 | Note: this code might run into trouble on days that have more then two |
|
|
2368 | midnights (beginning and end). |
2217 | |
2369 | |
2218 | =back |
2370 | =back |
2219 | |
2371 | |
2220 | =item ev_periodic_again (loop, ev_periodic *) |
2372 | =item ev_periodic_again (loop, ev_periodic *) |
2221 | |
2373 | |
… | |
… | |
2286 | |
2438 | |
2287 | ev_periodic hourly_tick; |
2439 | ev_periodic hourly_tick; |
2288 | ev_periodic_init (&hourly_tick, clock_cb, |
2440 | ev_periodic_init (&hourly_tick, clock_cb, |
2289 | fmod (ev_now (loop), 3600.), 3600., 0); |
2441 | fmod (ev_now (loop), 3600.), 3600., 0); |
2290 | ev_periodic_start (loop, &hourly_tick); |
2442 | ev_periodic_start (loop, &hourly_tick); |
2291 | |
2443 | |
2292 | |
2444 | |
2293 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2445 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2294 | |
2446 | |
2295 | Signal watchers will trigger an event when the process receives a specific |
2447 | Signal watchers will trigger an event when the process receives a specific |
2296 | signal one or more times. Even though signals are very asynchronous, libev |
2448 | signal one or more times. Even though signals are very asynchronous, libev |
… | |
… | |
2306 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
2458 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
2307 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
2459 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
2308 | C<SIGINT> in both the default loop and another loop at the same time. At |
2460 | C<SIGINT> in both the default loop and another loop at the same time. At |
2309 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2461 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2310 | |
2462 | |
2311 | When the first watcher gets started will libev actually register something |
2463 | Only after the first watcher for a signal is started will libev actually |
2312 | with the kernel (thus it coexists with your own signal handlers as long as |
2464 | register something with the kernel. It thus coexists with your own signal |
2313 | you don't register any with libev for the same signal). |
2465 | handlers as long as you don't register any with libev for the same signal. |
2314 | |
2466 | |
2315 | If possible and supported, libev will install its handlers with |
2467 | If possible and supported, libev will install its handlers with |
2316 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2468 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2317 | not be unduly interrupted. If you have a problem with system calls getting |
2469 | not be unduly interrupted. If you have a problem with system calls getting |
2318 | interrupted by signals you can block all signals in an C<ev_check> watcher |
2470 | interrupted by signals you can block all signals in an C<ev_check> watcher |
… | |
… | |
2503 | |
2655 | |
2504 | =head2 C<ev_stat> - did the file attributes just change? |
2656 | =head2 C<ev_stat> - did the file attributes just change? |
2505 | |
2657 | |
2506 | This watches a file system path for attribute changes. That is, it calls |
2658 | This watches a file system path for attribute changes. That is, it calls |
2507 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2659 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2508 | and sees if it changed compared to the last time, invoking the callback if |
2660 | and sees if it changed compared to the last time, invoking the callback |
2509 | it did. |
2661 | if it did. Starting the watcher C<stat>'s the file, so only changes that |
|
|
2662 | happen after the watcher has been started will be reported. |
2510 | |
2663 | |
2511 | The path does not need to exist: changing from "path exists" to "path does |
2664 | The path does not need to exist: changing from "path exists" to "path does |
2512 | not exist" is a status change like any other. The condition "path does not |
2665 | not exist" is a status change like any other. The condition "path does not |
2513 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2666 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2514 | C<st_nlink> field being zero (which is otherwise always forced to be at |
2667 | C<st_nlink> field being zero (which is otherwise always forced to be at |
… | |
… | |
2744 | Apart from keeping your process non-blocking (which is a useful |
2897 | Apart from keeping your process non-blocking (which is a useful |
2745 | effect on its own sometimes), idle watchers are a good place to do |
2898 | effect on its own sometimes), idle watchers are a good place to do |
2746 | "pseudo-background processing", or delay processing stuff to after the |
2899 | "pseudo-background processing", or delay processing stuff to after the |
2747 | event loop has handled all outstanding events. |
2900 | event loop has handled all outstanding events. |
2748 | |
2901 | |
|
|
2902 | =head3 Abusing an C<ev_idle> watcher for its side-effect |
|
|
2903 | |
|
|
2904 | As long as there is at least one active idle watcher, libev will never |
|
|
2905 | sleep unnecessarily. Or in other words, it will loop as fast as possible. |
|
|
2906 | For this to work, the idle watcher doesn't need to be invoked at all - the |
|
|
2907 | lowest priority will do. |
|
|
2908 | |
|
|
2909 | This mode of operation can be useful together with an C<ev_check> watcher, |
|
|
2910 | to do something on each event loop iteration - for example to balance load |
|
|
2911 | between different connections. |
|
|
2912 | |
|
|
2913 | See L</Abusing an ev_check watcher for its side-effect> for a longer |
|
|
2914 | example. |
|
|
2915 | |
2749 | =head3 Watcher-Specific Functions and Data Members |
2916 | =head3 Watcher-Specific Functions and Data Members |
2750 | |
2917 | |
2751 | =over 4 |
2918 | =over 4 |
2752 | |
2919 | |
2753 | =item ev_idle_init (ev_idle *, callback) |
2920 | =item ev_idle_init (ev_idle *, callback) |
… | |
… | |
2764 | callback, free it. Also, use no error checking, as usual. |
2931 | callback, free it. Also, use no error checking, as usual. |
2765 | |
2932 | |
2766 | static void |
2933 | static void |
2767 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2934 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2768 | { |
2935 | { |
|
|
2936 | // stop the watcher |
|
|
2937 | ev_idle_stop (loop, w); |
|
|
2938 | |
|
|
2939 | // now we can free it |
2769 | free (w); |
2940 | free (w); |
|
|
2941 | |
2770 | // now do something you wanted to do when the program has |
2942 | // now do something you wanted to do when the program has |
2771 | // no longer anything immediate to do. |
2943 | // no longer anything immediate to do. |
2772 | } |
2944 | } |
2773 | |
2945 | |
2774 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
2946 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
… | |
… | |
2776 | ev_idle_start (loop, idle_watcher); |
2948 | ev_idle_start (loop, idle_watcher); |
2777 | |
2949 | |
2778 | |
2950 | |
2779 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2951 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2780 | |
2952 | |
2781 | Prepare and check watchers are usually (but not always) used in pairs: |
2953 | Prepare and check watchers are often (but not always) used in pairs: |
2782 | prepare watchers get invoked before the process blocks and check watchers |
2954 | prepare watchers get invoked before the process blocks and check watchers |
2783 | afterwards. |
2955 | afterwards. |
2784 | |
2956 | |
2785 | You I<must not> call C<ev_run> or similar functions that enter |
2957 | You I<must not> call C<ev_run> (or similar functions that enter the |
2786 | the current event loop from either C<ev_prepare> or C<ev_check> |
2958 | current event loop) or C<ev_loop_fork> from either C<ev_prepare> or |
2787 | watchers. Other loops than the current one are fine, however. The |
2959 | C<ev_check> watchers. Other loops than the current one are fine, |
2788 | rationale behind this is that you do not need to check for recursion in |
2960 | however. The rationale behind this is that you do not need to check |
2789 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
2961 | for recursion in those watchers, i.e. the sequence will always be |
2790 | C<ev_check> so if you have one watcher of each kind they will always be |
2962 | C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each |
2791 | called in pairs bracketing the blocking call. |
2963 | kind they will always be called in pairs bracketing the blocking call. |
2792 | |
2964 | |
2793 | Their main purpose is to integrate other event mechanisms into libev and |
2965 | Their main purpose is to integrate other event mechanisms into libev and |
2794 | their use is somewhat advanced. They could be used, for example, to track |
2966 | their use is somewhat advanced. They could be used, for example, to track |
2795 | variable changes, implement your own watchers, integrate net-snmp or a |
2967 | variable changes, implement your own watchers, integrate net-snmp or a |
2796 | coroutine library and lots more. They are also occasionally useful if |
2968 | coroutine library and lots more. They are also occasionally useful if |
… | |
… | |
2814 | with priority higher than or equal to the event loop and one coroutine |
2986 | with priority higher than or equal to the event loop and one coroutine |
2815 | of lower priority, but only once, using idle watchers to keep the event |
2987 | of lower priority, but only once, using idle watchers to keep the event |
2816 | loop from blocking if lower-priority coroutines are active, thus mapping |
2988 | loop from blocking if lower-priority coroutines are active, thus mapping |
2817 | low-priority coroutines to idle/background tasks). |
2989 | low-priority coroutines to idle/background tasks). |
2818 | |
2990 | |
2819 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
2991 | When used for this purpose, it is recommended to give C<ev_check> watchers |
2820 | priority, to ensure that they are being run before any other watchers |
2992 | highest (C<EV_MAXPRI>) priority, to ensure that they are being run before |
2821 | after the poll (this doesn't matter for C<ev_prepare> watchers). |
2993 | any other watchers after the poll (this doesn't matter for C<ev_prepare> |
|
|
2994 | watchers). |
2822 | |
2995 | |
2823 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
2996 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
2824 | activate ("feed") events into libev. While libev fully supports this, they |
2997 | activate ("feed") events into libev. While libev fully supports this, they |
2825 | might get executed before other C<ev_check> watchers did their job. As |
2998 | might get executed before other C<ev_check> watchers did their job. As |
2826 | C<ev_check> watchers are often used to embed other (non-libev) event |
2999 | C<ev_check> watchers are often used to embed other (non-libev) event |
2827 | loops those other event loops might be in an unusable state until their |
3000 | loops those other event loops might be in an unusable state until their |
2828 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
3001 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
2829 | others). |
3002 | others). |
|
|
3003 | |
|
|
3004 | =head3 Abusing an C<ev_check> watcher for its side-effect |
|
|
3005 | |
|
|
3006 | C<ev_check> (and less often also C<ev_prepare>) watchers can also be |
|
|
3007 | useful because they are called once per event loop iteration. For |
|
|
3008 | example, if you want to handle a large number of connections fairly, you |
|
|
3009 | normally only do a bit of work for each active connection, and if there |
|
|
3010 | is more work to do, you wait for the next event loop iteration, so other |
|
|
3011 | connections have a chance of making progress. |
|
|
3012 | |
|
|
3013 | Using an C<ev_check> watcher is almost enough: it will be called on the |
|
|
3014 | next event loop iteration. However, that isn't as soon as possible - |
|
|
3015 | without external events, your C<ev_check> watcher will not be invoked. |
|
|
3016 | |
|
|
3017 | This is where C<ev_idle> watchers come in handy - all you need is a |
|
|
3018 | single global idle watcher that is active as long as you have one active |
|
|
3019 | C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop |
|
|
3020 | will not sleep, and the C<ev_check> watcher makes sure a callback gets |
|
|
3021 | invoked. Neither watcher alone can do that. |
2830 | |
3022 | |
2831 | =head3 Watcher-Specific Functions and Data Members |
3023 | =head3 Watcher-Specific Functions and Data Members |
2832 | |
3024 | |
2833 | =over 4 |
3025 | =over 4 |
2834 | |
3026 | |
… | |
… | |
3035 | |
3227 | |
3036 | =over 4 |
3228 | =over 4 |
3037 | |
3229 | |
3038 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3230 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3039 | |
3231 | |
3040 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
3232 | =item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop) |
3041 | |
3233 | |
3042 | Configures the watcher to embed the given loop, which must be |
3234 | Configures the watcher to embed the given loop, which must be |
3043 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3235 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3044 | invoked automatically, otherwise it is the responsibility of the callback |
3236 | invoked automatically, otherwise it is the responsibility of the callback |
3045 | to invoke it (it will continue to be called until the sweep has been done, |
3237 | to invoke it (it will continue to be called until the sweep has been done, |
… | |
… | |
3066 | used). |
3258 | used). |
3067 | |
3259 | |
3068 | struct ev_loop *loop_hi = ev_default_init (0); |
3260 | struct ev_loop *loop_hi = ev_default_init (0); |
3069 | struct ev_loop *loop_lo = 0; |
3261 | struct ev_loop *loop_lo = 0; |
3070 | ev_embed embed; |
3262 | ev_embed embed; |
3071 | |
3263 | |
3072 | // see if there is a chance of getting one that works |
3264 | // see if there is a chance of getting one that works |
3073 | // (remember that a flags value of 0 means autodetection) |
3265 | // (remember that a flags value of 0 means autodetection) |
3074 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3266 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3075 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3267 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3076 | : 0; |
3268 | : 0; |
… | |
… | |
3090 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3282 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3091 | |
3283 | |
3092 | struct ev_loop *loop = ev_default_init (0); |
3284 | struct ev_loop *loop = ev_default_init (0); |
3093 | struct ev_loop *loop_socket = 0; |
3285 | struct ev_loop *loop_socket = 0; |
3094 | ev_embed embed; |
3286 | ev_embed embed; |
3095 | |
3287 | |
3096 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3288 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3097 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3289 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3098 | { |
3290 | { |
3099 | ev_embed_init (&embed, 0, loop_socket); |
3291 | ev_embed_init (&embed, 0, loop_socket); |
3100 | ev_embed_start (loop, &embed); |
3292 | ev_embed_start (loop, &embed); |
… | |
… | |
3108 | |
3300 | |
3109 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3301 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3110 | |
3302 | |
3111 | Fork watchers are called when a C<fork ()> was detected (usually because |
3303 | Fork watchers are called when a C<fork ()> was detected (usually because |
3112 | whoever is a good citizen cared to tell libev about it by calling |
3304 | whoever is a good citizen cared to tell libev about it by calling |
3113 | C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the |
3305 | C<ev_loop_fork>). The invocation is done before the event loop blocks next |
3114 | event loop blocks next and before C<ev_check> watchers are being called, |
3306 | and before C<ev_check> watchers are being called, and only in the child |
3115 | and only in the child after the fork. If whoever good citizen calling |
3307 | after the fork. If whoever good citizen calling C<ev_default_fork> cheats |
3116 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
3308 | and calls it in the wrong process, the fork handlers will be invoked, too, |
3117 | handlers will be invoked, too, of course. |
3309 | of course. |
3118 | |
3310 | |
3119 | =head3 The special problem of life after fork - how is it possible? |
3311 | =head3 The special problem of life after fork - how is it possible? |
3120 | |
3312 | |
3121 | Most uses of C<fork()> consist of forking, then some simple calls to set |
3313 | Most uses of C<fork ()> consist of forking, then some simple calls to set |
3122 | up/change the process environment, followed by a call to C<exec()>. This |
3314 | up/change the process environment, followed by a call to C<exec()>. This |
3123 | sequence should be handled by libev without any problems. |
3315 | sequence should be handled by libev without any problems. |
3124 | |
3316 | |
3125 | This changes when the application actually wants to do event handling |
3317 | This changes when the application actually wants to do event handling |
3126 | in the child, or both parent in child, in effect "continuing" after the |
3318 | in the child, or both parent in child, in effect "continuing" after the |
… | |
… | |
3215 | it by calling C<ev_async_send>, which is thread- and signal safe. |
3407 | it by calling C<ev_async_send>, which is thread- and signal safe. |
3216 | |
3408 | |
3217 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3409 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3218 | too, are asynchronous in nature, and signals, too, will be compressed |
3410 | too, are asynchronous in nature, and signals, too, will be compressed |
3219 | (i.e. the number of callback invocations may be less than the number of |
3411 | (i.e. the number of callback invocations may be less than the number of |
3220 | C<ev_async_sent> calls). In fact, you could use signal watchers as a kind |
3412 | C<ev_async_send> calls). In fact, you could use signal watchers as a kind |
3221 | of "global async watchers" by using a watcher on an otherwise unused |
3413 | of "global async watchers" by using a watcher on an otherwise unused |
3222 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3414 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3223 | even without knowing which loop owns the signal. |
3415 | even without knowing which loop owns the signal. |
3224 | |
|
|
3225 | Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not |
|
|
3226 | just the default loop. |
|
|
3227 | |
3416 | |
3228 | =head3 Queueing |
3417 | =head3 Queueing |
3229 | |
3418 | |
3230 | C<ev_async> does not support queueing of data in any way. The reason |
3419 | C<ev_async> does not support queueing of data in any way. The reason |
3231 | is that the author does not know of a simple (or any) algorithm for a |
3420 | is that the author does not know of a simple (or any) algorithm for a |
… | |
… | |
3331 | Unlike C<ev_feed_event>, this call is safe to do from other threads, |
3520 | Unlike C<ev_feed_event>, this call is safe to do from other threads, |
3332 | signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the |
3521 | signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the |
3333 | embedding section below on what exactly this means). |
3522 | embedding section below on what exactly this means). |
3334 | |
3523 | |
3335 | Note that, as with other watchers in libev, multiple events might get |
3524 | Note that, as with other watchers in libev, multiple events might get |
3336 | compressed into a single callback invocation (another way to look at this |
3525 | compressed into a single callback invocation (another way to look at |
3337 | is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, |
3526 | this is that C<ev_async> watchers are level-triggered: they are set on |
3338 | reset when the event loop detects that). |
3527 | C<ev_async_send>, reset when the event loop detects that). |
3339 | |
3528 | |
3340 | This call incurs the overhead of a system call only once per event loop |
3529 | This call incurs the overhead of at most one extra system call per event |
3341 | iteration, so while the overhead might be noticeable, it doesn't apply to |
3530 | loop iteration, if the event loop is blocked, and no syscall at all if |
3342 | repeated calls to C<ev_async_send> for the same event loop. |
3531 | the event loop (or your program) is processing events. That means that |
|
|
3532 | repeated calls are basically free (there is no need to avoid calls for |
|
|
3533 | performance reasons) and that the overhead becomes smaller (typically |
|
|
3534 | zero) under load. |
3343 | |
3535 | |
3344 | =item bool = ev_async_pending (ev_async *) |
3536 | =item bool = ev_async_pending (ev_async *) |
3345 | |
3537 | |
3346 | Returns a non-zero value when C<ev_async_send> has been called on the |
3538 | Returns a non-zero value when C<ev_async_send> has been called on the |
3347 | watcher but the event has not yet been processed (or even noted) by the |
3539 | watcher but the event has not yet been processed (or even noted) by the |
… | |
… | |
3364 | |
3556 | |
3365 | There are some other functions of possible interest. Described. Here. Now. |
3557 | There are some other functions of possible interest. Described. Here. Now. |
3366 | |
3558 | |
3367 | =over 4 |
3559 | =over 4 |
3368 | |
3560 | |
3369 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
3561 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg) |
3370 | |
3562 | |
3371 | This function combines a simple timer and an I/O watcher, calls your |
3563 | This function combines a simple timer and an I/O watcher, calls your |
3372 | callback on whichever event happens first and automatically stops both |
3564 | callback on whichever event happens first and automatically stops both |
3373 | watchers. This is useful if you want to wait for a single event on an fd |
3565 | watchers. This is useful if you want to wait for a single event on an fd |
3374 | or timeout without having to allocate/configure/start/stop/free one or |
3566 | or timeout without having to allocate/configure/start/stop/free one or |
… | |
… | |
3402 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3594 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3403 | |
3595 | |
3404 | =item ev_feed_fd_event (loop, int fd, int revents) |
3596 | =item ev_feed_fd_event (loop, int fd, int revents) |
3405 | |
3597 | |
3406 | Feed an event on the given fd, as if a file descriptor backend detected |
3598 | Feed an event on the given fd, as if a file descriptor backend detected |
3407 | the given events it. |
3599 | the given events. |
3408 | |
3600 | |
3409 | =item ev_feed_signal_event (loop, int signum) |
3601 | =item ev_feed_signal_event (loop, int signum) |
3410 | |
3602 | |
3411 | Feed an event as if the given signal occurred. See also C<ev_feed_signal>, |
3603 | Feed an event as if the given signal occurred. See also C<ev_feed_signal>, |
3412 | which is async-safe. |
3604 | which is async-safe. |
… | |
… | |
3486 | { |
3678 | { |
3487 | struct my_biggy big = (struct my_biggy *) |
3679 | struct my_biggy big = (struct my_biggy *) |
3488 | (((char *)w) - offsetof (struct my_biggy, t2)); |
3680 | (((char *)w) - offsetof (struct my_biggy, t2)); |
3489 | } |
3681 | } |
3490 | |
3682 | |
|
|
3683 | =head2 AVOIDING FINISHING BEFORE RETURNING |
|
|
3684 | |
|
|
3685 | Often you have structures like this in event-based programs: |
|
|
3686 | |
|
|
3687 | callback () |
|
|
3688 | { |
|
|
3689 | free (request); |
|
|
3690 | } |
|
|
3691 | |
|
|
3692 | request = start_new_request (..., callback); |
|
|
3693 | |
|
|
3694 | The intent is to start some "lengthy" operation. The C<request> could be |
|
|
3695 | used to cancel the operation, or do other things with it. |
|
|
3696 | |
|
|
3697 | It's not uncommon to have code paths in C<start_new_request> that |
|
|
3698 | immediately invoke the callback, for example, to report errors. Or you add |
|
|
3699 | some caching layer that finds that it can skip the lengthy aspects of the |
|
|
3700 | operation and simply invoke the callback with the result. |
|
|
3701 | |
|
|
3702 | The problem here is that this will happen I<before> C<start_new_request> |
|
|
3703 | has returned, so C<request> is not set. |
|
|
3704 | |
|
|
3705 | Even if you pass the request by some safer means to the callback, you |
|
|
3706 | might want to do something to the request after starting it, such as |
|
|
3707 | canceling it, which probably isn't working so well when the callback has |
|
|
3708 | already been invoked. |
|
|
3709 | |
|
|
3710 | A common way around all these issues is to make sure that |
|
|
3711 | C<start_new_request> I<always> returns before the callback is invoked. If |
|
|
3712 | C<start_new_request> immediately knows the result, it can artificially |
|
|
3713 | delay invoking the callback by using a C<prepare> or C<idle> watcher for |
|
|
3714 | example, or more sneakily, by reusing an existing (stopped) watcher and |
|
|
3715 | pushing it into the pending queue: |
|
|
3716 | |
|
|
3717 | ev_set_cb (watcher, callback); |
|
|
3718 | ev_feed_event (EV_A_ watcher, 0); |
|
|
3719 | |
|
|
3720 | This way, C<start_new_request> can safely return before the callback is |
|
|
3721 | invoked, while not delaying callback invocation too much. |
|
|
3722 | |
3491 | =head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS |
3723 | =head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS |
3492 | |
3724 | |
3493 | Often (especially in GUI toolkits) there are places where you have |
3725 | Often (especially in GUI toolkits) there are places where you have |
3494 | I<modal> interaction, which is most easily implemented by recursively |
3726 | I<modal> interaction, which is most easily implemented by recursively |
3495 | invoking C<ev_run>. |
3727 | invoking C<ev_run>. |
3496 | |
3728 | |
3497 | This brings the problem of exiting - a callback might want to finish the |
3729 | This brings the problem of exiting - a callback might want to finish the |
3498 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3730 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3499 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3731 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3500 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3732 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3501 | other combination: In these cases, C<ev_break> will not work alone. |
3733 | other combination: In these cases, a simple C<ev_break> will not work. |
3502 | |
3734 | |
3503 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3735 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3504 | invocation, and use a loop around C<ev_run> until the condition is |
3736 | invocation, and use a loop around C<ev_run> until the condition is |
3505 | triggered, using C<EVRUN_ONCE>: |
3737 | triggered, using C<EVRUN_ONCE>: |
3506 | |
3738 | |
… | |
… | |
3508 | int exit_main_loop = 0; |
3740 | int exit_main_loop = 0; |
3509 | |
3741 | |
3510 | while (!exit_main_loop) |
3742 | while (!exit_main_loop) |
3511 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3743 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3512 | |
3744 | |
3513 | // in a model watcher |
3745 | // in a modal watcher |
3514 | int exit_nested_loop = 0; |
3746 | int exit_nested_loop = 0; |
3515 | |
3747 | |
3516 | while (!exit_nested_loop) |
3748 | while (!exit_nested_loop) |
3517 | ev_run (EV_A_ EVRUN_ONCE); |
3749 | ev_run (EV_A_ EVRUN_ONCE); |
3518 | |
3750 | |
… | |
… | |
3692 | called): |
3924 | called): |
3693 | |
3925 | |
3694 | void |
3926 | void |
3695 | wait_for_event (ev_watcher *w) |
3927 | wait_for_event (ev_watcher *w) |
3696 | { |
3928 | { |
3697 | ev_cb_set (w) = current_coro; |
3929 | ev_set_cb (w, current_coro); |
3698 | switch_to (libev_coro); |
3930 | switch_to (libev_coro); |
3699 | } |
3931 | } |
3700 | |
3932 | |
3701 | That basically suspends the coroutine inside C<wait_for_event> and |
3933 | That basically suspends the coroutine inside C<wait_for_event> and |
3702 | continues the libev coroutine, which, when appropriate, switches back to |
3934 | continues the libev coroutine, which, when appropriate, switches back to |
3703 | this or any other coroutine. I am sure if you sue this your own :) |
3935 | this or any other coroutine. |
3704 | |
3936 | |
3705 | You can do similar tricks if you have, say, threads with an event queue - |
3937 | You can do similar tricks if you have, say, threads with an event queue - |
3706 | instead of storing a coroutine, you store the queue object and instead of |
3938 | instead of storing a coroutine, you store the queue object and instead of |
3707 | switching to a coroutine, you push the watcher onto the queue and notify |
3939 | switching to a coroutine, you push the watcher onto the queue and notify |
3708 | any waiters. |
3940 | any waiters. |
3709 | |
3941 | |
3710 | To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two |
3942 | To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two |
3711 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3943 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3712 | |
3944 | |
3713 | // my_ev.h |
3945 | // my_ev.h |
3714 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3946 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3715 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); |
3947 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb) |
3716 | #include "../libev/ev.h" |
3948 | #include "../libev/ev.h" |
3717 | |
3949 | |
3718 | // my_ev.c |
3950 | // my_ev.c |
3719 | #define EV_H "my_ev.h" |
3951 | #define EV_H "my_ev.h" |
3720 | #include "../libev/ev.c" |
3952 | #include "../libev/ev.c" |
… | |
… | |
3759 | |
3991 | |
3760 | =back |
3992 | =back |
3761 | |
3993 | |
3762 | =head1 C++ SUPPORT |
3994 | =head1 C++ SUPPORT |
3763 | |
3995 | |
|
|
3996 | =head2 C API |
|
|
3997 | |
|
|
3998 | The normal C API should work fine when used from C++: both ev.h and the |
|
|
3999 | libev sources can be compiled as C++. Therefore, code that uses the C API |
|
|
4000 | will work fine. |
|
|
4001 | |
|
|
4002 | Proper exception specifications might have to be added to callbacks passed |
|
|
4003 | to libev: exceptions may be thrown only from watcher callbacks, all other |
|
|
4004 | callbacks (allocator, syserr, loop acquire/release and periodic reschedule |
|
|
4005 | callbacks) must not throw exceptions, and might need a C<noexcept> |
|
|
4006 | specification. If you have code that needs to be compiled as both C and |
|
|
4007 | C++ you can use the C<EV_NOEXCEPT> macro for this: |
|
|
4008 | |
|
|
4009 | static void |
|
|
4010 | fatal_error (const char *msg) EV_NOEXCEPT |
|
|
4011 | { |
|
|
4012 | perror (msg); |
|
|
4013 | abort (); |
|
|
4014 | } |
|
|
4015 | |
|
|
4016 | ... |
|
|
4017 | ev_set_syserr_cb (fatal_error); |
|
|
4018 | |
|
|
4019 | The only API functions that can currently throw exceptions are C<ev_run>, |
|
|
4020 | C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter |
|
|
4021 | because it runs cleanup watchers). |
|
|
4022 | |
|
|
4023 | Throwing exceptions in watcher callbacks is only supported if libev itself |
|
|
4024 | is compiled with a C++ compiler or your C and C++ environments allow |
|
|
4025 | throwing exceptions through C libraries (most do). |
|
|
4026 | |
|
|
4027 | =head2 C++ API |
|
|
4028 | |
3764 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
4029 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
3765 | you to use some convenience methods to start/stop watchers and also change |
4030 | you to use some convenience methods to start/stop watchers and also change |
3766 | the callback model to a model using method callbacks on objects. |
4031 | the callback model to a model using method callbacks on objects. |
3767 | |
4032 | |
3768 | To use it, |
4033 | To use it, |
3769 | |
4034 | |
3770 | #include <ev++.h> |
4035 | #include <ev++.h> |
3771 | |
4036 | |
3772 | This automatically includes F<ev.h> and puts all of its definitions (many |
4037 | This automatically includes F<ev.h> and puts all of its definitions (many |
3773 | of them macros) into the global namespace. All C++ specific things are |
4038 | of them macros) into the global namespace. All C++ specific things are |
3774 | put into the C<ev> namespace. It should support all the same embedding |
4039 | put into the C<ev> namespace. It should support all the same embedding |
… | |
… | |
3783 | with C<operator ()> can be used as callbacks. Other types should be easy |
4048 | with C<operator ()> can be used as callbacks. Other types should be easy |
3784 | to add as long as they only need one additional pointer for context. If |
4049 | to add as long as they only need one additional pointer for context. If |
3785 | you need support for other types of functors please contact the author |
4050 | you need support for other types of functors please contact the author |
3786 | (preferably after implementing it). |
4051 | (preferably after implementing it). |
3787 | |
4052 | |
|
|
4053 | For all this to work, your C++ compiler either has to use the same calling |
|
|
4054 | conventions as your C compiler (for static member functions), or you have |
|
|
4055 | to embed libev and compile libev itself as C++. |
|
|
4056 | |
3788 | Here is a list of things available in the C<ev> namespace: |
4057 | Here is a list of things available in the C<ev> namespace: |
3789 | |
4058 | |
3790 | =over 4 |
4059 | =over 4 |
3791 | |
4060 | |
3792 | =item C<ev::READ>, C<ev::WRITE> etc. |
4061 | =item C<ev::READ>, C<ev::WRITE> etc. |
… | |
… | |
3801 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
4070 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
3802 | |
4071 | |
3803 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
4072 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
3804 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
4073 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
3805 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
4074 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
3806 | defines by many implementations. |
4075 | defined by many implementations. |
3807 | |
4076 | |
3808 | All of those classes have these methods: |
4077 | All of those classes have these methods: |
3809 | |
4078 | |
3810 | =over 4 |
4079 | =over 4 |
3811 | |
4080 | |
… | |
… | |
3873 | void operator() (ev::io &w, int revents) |
4142 | void operator() (ev::io &w, int revents) |
3874 | { |
4143 | { |
3875 | ... |
4144 | ... |
3876 | } |
4145 | } |
3877 | } |
4146 | } |
3878 | |
4147 | |
3879 | myfunctor f; |
4148 | myfunctor f; |
3880 | |
4149 | |
3881 | ev::io w; |
4150 | ev::io w; |
3882 | w.set (&f); |
4151 | w.set (&f); |
3883 | |
4152 | |
… | |
… | |
3901 | Associates a different C<struct ev_loop> with this watcher. You can only |
4170 | Associates a different C<struct ev_loop> with this watcher. You can only |
3902 | do this when the watcher is inactive (and not pending either). |
4171 | do this when the watcher is inactive (and not pending either). |
3903 | |
4172 | |
3904 | =item w->set ([arguments]) |
4173 | =item w->set ([arguments]) |
3905 | |
4174 | |
3906 | Basically the same as C<ev_TYPE_set>, with the same arguments. Either this |
4175 | Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>), |
3907 | method or a suitable start method must be called at least once. Unlike the |
4176 | with the same arguments. Either this method or a suitable start method |
3908 | C counterpart, an active watcher gets automatically stopped and restarted |
4177 | must be called at least once. Unlike the C counterpart, an active watcher |
3909 | when reconfiguring it with this method. |
4178 | gets automatically stopped and restarted when reconfiguring it with this |
|
|
4179 | method. |
|
|
4180 | |
|
|
4181 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
|
|
4182 | clashing with the C<set (loop)> method. |
3910 | |
4183 | |
3911 | =item w->start () |
4184 | =item w->start () |
3912 | |
4185 | |
3913 | Starts the watcher. Note that there is no C<loop> argument, as the |
4186 | Starts the watcher. Note that there is no C<loop> argument, as the |
3914 | constructor already stores the event loop. |
4187 | constructor already stores the event loop. |
… | |
… | |
3944 | watchers in the constructor. |
4217 | watchers in the constructor. |
3945 | |
4218 | |
3946 | class myclass |
4219 | class myclass |
3947 | { |
4220 | { |
3948 | ev::io io ; void io_cb (ev::io &w, int revents); |
4221 | ev::io io ; void io_cb (ev::io &w, int revents); |
3949 | ev::io2 io2 ; void io2_cb (ev::io &w, int revents); |
4222 | ev::io io2 ; void io2_cb (ev::io &w, int revents); |
3950 | ev::idle idle; void idle_cb (ev::idle &w, int revents); |
4223 | ev::idle idle; void idle_cb (ev::idle &w, int revents); |
3951 | |
4224 | |
3952 | myclass (int fd) |
4225 | myclass (int fd) |
3953 | { |
4226 | { |
3954 | io .set <myclass, &myclass::io_cb > (this); |
4227 | io .set <myclass, &myclass::io_cb > (this); |
… | |
… | |
4005 | L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. |
4278 | L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. |
4006 | |
4279 | |
4007 | =item D |
4280 | =item D |
4008 | |
4281 | |
4009 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
4282 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
4010 | be found at L<http://proj.llucax.com.ar/wiki/evd>. |
4283 | be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>. |
4011 | |
4284 | |
4012 | =item Ocaml |
4285 | =item Ocaml |
4013 | |
4286 | |
4014 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
4287 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
4015 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
4288 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
… | |
… | |
4018 | |
4291 | |
4019 | Brian Maher has written a partial interface to libev for lua (at the |
4292 | Brian Maher has written a partial interface to libev for lua (at the |
4020 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4293 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4021 | L<http://github.com/brimworks/lua-ev>. |
4294 | L<http://github.com/brimworks/lua-ev>. |
4022 | |
4295 | |
|
|
4296 | =item Javascript |
|
|
4297 | |
|
|
4298 | Node.js (L<http://nodejs.org>) uses libev as the underlying event library. |
|
|
4299 | |
|
|
4300 | =item Others |
|
|
4301 | |
|
|
4302 | There are others, and I stopped counting. |
|
|
4303 | |
4023 | =back |
4304 | =back |
4024 | |
4305 | |
4025 | |
4306 | |
4026 | =head1 MACRO MAGIC |
4307 | =head1 MACRO MAGIC |
4027 | |
4308 | |
… | |
… | |
4063 | suitable for use with C<EV_A>. |
4344 | suitable for use with C<EV_A>. |
4064 | |
4345 | |
4065 | =item C<EV_DEFAULT>, C<EV_DEFAULT_> |
4346 | =item C<EV_DEFAULT>, C<EV_DEFAULT_> |
4066 | |
4347 | |
4067 | Similar to the other two macros, this gives you the value of the default |
4348 | Similar to the other two macros, this gives you the value of the default |
4068 | loop, if multiple loops are supported ("ev loop default"). |
4349 | loop, if multiple loops are supported ("ev loop default"). The default loop |
|
|
4350 | will be initialised if it isn't already initialised. |
|
|
4351 | |
|
|
4352 | For non-multiplicity builds, these macros do nothing, so you always have |
|
|
4353 | to initialise the loop somewhere. |
4069 | |
4354 | |
4070 | =item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> |
4355 | =item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> |
4071 | |
4356 | |
4072 | Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the |
4357 | Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the |
4073 | default loop has been initialised (C<UC> == unchecked). Their behaviour |
4358 | default loop has been initialised (C<UC> == unchecked). Their behaviour |
… | |
… | |
4140 | ev_vars.h |
4425 | ev_vars.h |
4141 | ev_wrap.h |
4426 | ev_wrap.h |
4142 | |
4427 | |
4143 | ev_win32.c required on win32 platforms only |
4428 | ev_win32.c required on win32 platforms only |
4144 | |
4429 | |
4145 | ev_select.c only when select backend is enabled (which is enabled by default) |
4430 | ev_select.c only when select backend is enabled |
4146 | ev_poll.c only when poll backend is enabled (disabled by default) |
4431 | ev_poll.c only when poll backend is enabled |
4147 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
4432 | ev_epoll.c only when the epoll backend is enabled |
4148 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
4433 | ev_kqueue.c only when the kqueue backend is enabled |
4149 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
4434 | ev_port.c only when the solaris port backend is enabled |
4150 | |
4435 | |
4151 | F<ev.c> includes the backend files directly when enabled, so you only need |
4436 | F<ev.c> includes the backend files directly when enabled, so you only need |
4152 | to compile this single file. |
4437 | to compile this single file. |
4153 | |
4438 | |
4154 | =head3 LIBEVENT COMPATIBILITY API |
4439 | =head3 LIBEVENT COMPATIBILITY API |
… | |
… | |
4321 | |
4606 | |
4322 | If programs implement their own fd to handle mapping on win32, then this |
4607 | If programs implement their own fd to handle mapping on win32, then this |
4323 | macro can be used to override the C<close> function, useful to unregister |
4608 | macro can be used to override the C<close> function, useful to unregister |
4324 | file descriptors again. Note that the replacement function has to close |
4609 | file descriptors again. Note that the replacement function has to close |
4325 | the underlying OS handle. |
4610 | the underlying OS handle. |
|
|
4611 | |
|
|
4612 | =item EV_USE_WSASOCKET |
|
|
4613 | |
|
|
4614 | If defined to be C<1>, libev will use C<WSASocket> to create its internal |
|
|
4615 | communication socket, which works better in some environments. Otherwise, |
|
|
4616 | the normal C<socket> function will be used, which works better in other |
|
|
4617 | environments. |
4326 | |
4618 | |
4327 | =item EV_USE_POLL |
4619 | =item EV_USE_POLL |
4328 | |
4620 | |
4329 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4621 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4330 | backend. Otherwise it will be enabled on non-win32 platforms. It |
4622 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
4366 | If defined to be C<1>, libev will compile in support for the Linux inotify |
4658 | If defined to be C<1>, libev will compile in support for the Linux inotify |
4367 | interface to speed up C<ev_stat> watchers. Its actual availability will |
4659 | interface to speed up C<ev_stat> watchers. Its actual availability will |
4368 | be detected at runtime. If undefined, it will be enabled if the headers |
4660 | be detected at runtime. If undefined, it will be enabled if the headers |
4369 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4661 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4370 | |
4662 | |
|
|
4663 | =item EV_NO_SMP |
|
|
4664 | |
|
|
4665 | If defined to be C<1>, libev will assume that memory is always coherent |
|
|
4666 | between threads, that is, threads can be used, but threads never run on |
|
|
4667 | different cpus (or different cpu cores). This reduces dependencies |
|
|
4668 | and makes libev faster. |
|
|
4669 | |
|
|
4670 | =item EV_NO_THREADS |
|
|
4671 | |
|
|
4672 | If defined to be C<1>, libev will assume that it will never be called from |
|
|
4673 | different threads (that includes signal handlers), which is a stronger |
|
|
4674 | assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes |
|
|
4675 | libev faster. |
|
|
4676 | |
4371 | =item EV_ATOMIC_T |
4677 | =item EV_ATOMIC_T |
4372 | |
4678 | |
4373 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4679 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4374 | access is atomic with respect to other threads or signal contexts. No such |
4680 | access is atomic with respect to other threads or signal contexts. No |
4375 | type is easily found in the C language, so you can provide your own type |
4681 | such type is easily found in the C language, so you can provide your own |
4376 | that you know is safe for your purposes. It is used both for signal handler "locking" |
4682 | type that you know is safe for your purposes. It is used both for signal |
4377 | as well as for signal and thread safety in C<ev_async> watchers. |
4683 | handler "locking" as well as for signal and thread safety in C<ev_async> |
|
|
4684 | watchers. |
4378 | |
4685 | |
4379 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4686 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4380 | (from F<signal.h>), which is usually good enough on most platforms. |
4687 | (from F<signal.h>), which is usually good enough on most platforms. |
4381 | |
4688 | |
4382 | =item EV_H (h) |
4689 | =item EV_H (h) |
… | |
… | |
4409 | will have the C<struct ev_loop *> as first argument, and you can create |
4716 | will have the C<struct ev_loop *> as first argument, and you can create |
4410 | additional independent event loops. Otherwise there will be no support |
4717 | additional independent event loops. Otherwise there will be no support |
4411 | for multiple event loops and there is no first event loop pointer |
4718 | for multiple event loops and there is no first event loop pointer |
4412 | argument. Instead, all functions act on the single default loop. |
4719 | argument. Instead, all functions act on the single default loop. |
4413 | |
4720 | |
|
|
4721 | Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a |
|
|
4722 | default loop when multiplicity is switched off - you always have to |
|
|
4723 | initialise the loop manually in this case. |
|
|
4724 | |
4414 | =item EV_MINPRI |
4725 | =item EV_MINPRI |
4415 | |
4726 | |
4416 | =item EV_MAXPRI |
4727 | =item EV_MAXPRI |
4417 | |
4728 | |
4418 | The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to |
4729 | The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to |
… | |
… | |
4454 | #define EV_USE_POLL 1 |
4765 | #define EV_USE_POLL 1 |
4455 | #define EV_CHILD_ENABLE 1 |
4766 | #define EV_CHILD_ENABLE 1 |
4456 | #define EV_ASYNC_ENABLE 1 |
4767 | #define EV_ASYNC_ENABLE 1 |
4457 | |
4768 | |
4458 | The actual value is a bitset, it can be a combination of the following |
4769 | The actual value is a bitset, it can be a combination of the following |
4459 | values: |
4770 | values (by default, all of these are enabled): |
4460 | |
4771 | |
4461 | =over 4 |
4772 | =over 4 |
4462 | |
4773 | |
4463 | =item C<1> - faster/larger code |
4774 | =item C<1> - faster/larger code |
4464 | |
4775 | |
… | |
… | |
4468 | code size by roughly 30% on amd64). |
4779 | code size by roughly 30% on amd64). |
4469 | |
4780 | |
4470 | When optimising for size, use of compiler flags such as C<-Os> with |
4781 | When optimising for size, use of compiler flags such as C<-Os> with |
4471 | gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of |
4782 | gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of |
4472 | assertions. |
4783 | assertions. |
|
|
4784 | |
|
|
4785 | The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler |
|
|
4786 | (e.g. gcc with C<-Os>). |
4473 | |
4787 | |
4474 | =item C<2> - faster/larger data structures |
4788 | =item C<2> - faster/larger data structures |
4475 | |
4789 | |
4476 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
4790 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
4477 | hash table sizes and so on. This will usually further increase code size |
4791 | hash table sizes and so on. This will usually further increase code size |
4478 | and can additionally have an effect on the size of data structures at |
4792 | and can additionally have an effect on the size of data structures at |
4479 | runtime. |
4793 | runtime. |
4480 | |
4794 | |
|
|
4795 | The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler |
|
|
4796 | (e.g. gcc with C<-Os>). |
|
|
4797 | |
4481 | =item C<4> - full API configuration |
4798 | =item C<4> - full API configuration |
4482 | |
4799 | |
4483 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
4800 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
4484 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
4801 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
4485 | |
4802 | |
… | |
… | |
4515 | |
4832 | |
4516 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
4833 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
4517 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
4834 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
4518 | your program might be left out as well - a binary starting a timer and an |
4835 | your program might be left out as well - a binary starting a timer and an |
4519 | I/O watcher then might come out at only 5Kb. |
4836 | I/O watcher then might come out at only 5Kb. |
|
|
4837 | |
|
|
4838 | =item EV_API_STATIC |
|
|
4839 | |
|
|
4840 | If this symbol is defined (by default it is not), then all identifiers |
|
|
4841 | will have static linkage. This means that libev will not export any |
|
|
4842 | identifiers, and you cannot link against libev anymore. This can be useful |
|
|
4843 | when you embed libev, only want to use libev functions in a single file, |
|
|
4844 | and do not want its identifiers to be visible. |
|
|
4845 | |
|
|
4846 | To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that |
|
|
4847 | wants to use libev. |
|
|
4848 | |
|
|
4849 | This option only works when libev is compiled with a C compiler, as C++ |
|
|
4850 | doesn't support the required declaration syntax. |
4520 | |
4851 | |
4521 | =item EV_AVOID_STDIO |
4852 | =item EV_AVOID_STDIO |
4522 | |
4853 | |
4523 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
4854 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
4524 | functions (printf, scanf, perror etc.). This will increase the code size |
4855 | functions (printf, scanf, perror etc.). This will increase the code size |
… | |
… | |
4729 | default loop and triggering an C<ev_async> watcher from the default loop |
5060 | default loop and triggering an C<ev_async> watcher from the default loop |
4730 | watcher callback into the event loop interested in the signal. |
5061 | watcher callback into the event loop interested in the signal. |
4731 | |
5062 | |
4732 | =back |
5063 | =back |
4733 | |
5064 | |
4734 | See also L<THREAD LOCKING EXAMPLE>. |
5065 | See also L</THREAD LOCKING EXAMPLE>. |
4735 | |
5066 | |
4736 | =head3 COROUTINES |
5067 | =head3 COROUTINES |
4737 | |
5068 | |
4738 | Libev is very accommodating to coroutines ("cooperative threads"): |
5069 | Libev is very accommodating to coroutines ("cooperative threads"): |
4739 | libev fully supports nesting calls to its functions from different |
5070 | libev fully supports nesting calls to its functions from different |
… | |
… | |
4904 | requires, and its I/O model is fundamentally incompatible with the POSIX |
5235 | requires, and its I/O model is fundamentally incompatible with the POSIX |
4905 | model. Libev still offers limited functionality on this platform in |
5236 | model. Libev still offers limited functionality on this platform in |
4906 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
5237 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
4907 | descriptors. This only applies when using Win32 natively, not when using |
5238 | descriptors. This only applies when using Win32 natively, not when using |
4908 | e.g. cygwin. Actually, it only applies to the microsofts own compilers, |
5239 | e.g. cygwin. Actually, it only applies to the microsofts own compilers, |
4909 | as every compielr comes with a slightly differently broken/incompatible |
5240 | as every compiler comes with a slightly differently broken/incompatible |
4910 | environment. |
5241 | environment. |
4911 | |
5242 | |
4912 | Lifting these limitations would basically require the full |
5243 | Lifting these limitations would basically require the full |
4913 | re-implementation of the I/O system. If you are into this kind of thing, |
5244 | re-implementation of the I/O system. If you are into this kind of thing, |
4914 | then note that glib does exactly that for you in a very portable way (note |
5245 | then note that glib does exactly that for you in a very portable way (note |
… | |
… | |
5008 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
5339 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
5009 | assumes that the same (machine) code can be used to call any watcher |
5340 | assumes that the same (machine) code can be used to call any watcher |
5010 | callback: The watcher callbacks have different type signatures, but libev |
5341 | callback: The watcher callbacks have different type signatures, but libev |
5011 | calls them using an C<ev_watcher *> internally. |
5342 | calls them using an C<ev_watcher *> internally. |
5012 | |
5343 | |
|
|
5344 | =item null pointers and integer zero are represented by 0 bytes |
|
|
5345 | |
|
|
5346 | Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and |
|
|
5347 | relies on this setting pointers and integers to null. |
|
|
5348 | |
5013 | =item pointer accesses must be thread-atomic |
5349 | =item pointer accesses must be thread-atomic |
5014 | |
5350 | |
5015 | Accessing a pointer value must be atomic, it must both be readable and |
5351 | Accessing a pointer value must be atomic, it must both be readable and |
5016 | writable in one piece - this is the case on all current architectures. |
5352 | writable in one piece - this is the case on all current architectures. |
5017 | |
5353 | |
… | |
… | |
5030 | thread" or will block signals process-wide, both behaviours would |
5366 | thread" or will block signals process-wide, both behaviours would |
5031 | be compatible with libev. Interaction between C<sigprocmask> and |
5367 | be compatible with libev. Interaction between C<sigprocmask> and |
5032 | C<pthread_sigmask> could complicate things, however. |
5368 | C<pthread_sigmask> could complicate things, however. |
5033 | |
5369 | |
5034 | The most portable way to handle signals is to block signals in all threads |
5370 | The most portable way to handle signals is to block signals in all threads |
5035 | except the initial one, and run the default loop in the initial thread as |
5371 | except the initial one, and run the signal handling loop in the initial |
5036 | well. |
5372 | thread as well. |
5037 | |
5373 | |
5038 | =item C<long> must be large enough for common memory allocation sizes |
5374 | =item C<long> must be large enough for common memory allocation sizes |
5039 | |
5375 | |
5040 | To improve portability and simplify its API, libev uses C<long> internally |
5376 | To improve portability and simplify its API, libev uses C<long> internally |
5041 | instead of C<size_t> when allocating its data structures. On non-POSIX |
5377 | instead of C<size_t> when allocating its data structures. On non-POSIX |
… | |
… | |
5047 | |
5383 | |
5048 | The type C<double> is used to represent timestamps. It is required to |
5384 | The type C<double> is used to represent timestamps. It is required to |
5049 | have at least 51 bits of mantissa (and 9 bits of exponent), which is |
5385 | have at least 51 bits of mantissa (and 9 bits of exponent), which is |
5050 | good enough for at least into the year 4000 with millisecond accuracy |
5386 | good enough for at least into the year 4000 with millisecond accuracy |
5051 | (the design goal for libev). This requirement is overfulfilled by |
5387 | (the design goal for libev). This requirement is overfulfilled by |
5052 | implementations using IEEE 754, which is basically all existing ones. With |
5388 | implementations using IEEE 754, which is basically all existing ones. |
|
|
5389 | |
5053 | IEEE 754 doubles, you get microsecond accuracy until at least 2200. |
5390 | With IEEE 754 doubles, you get microsecond accuracy until at least the |
|
|
5391 | year 2255 (and millisecond accuracy till the year 287396 - by then, libev |
|
|
5392 | is either obsolete or somebody patched it to use C<long double> or |
|
|
5393 | something like that, just kidding). |
5054 | |
5394 | |
5055 | =back |
5395 | =back |
5056 | |
5396 | |
5057 | If you know of other additional requirements drop me a note. |
5397 | If you know of other additional requirements drop me a note. |
5058 | |
5398 | |
… | |
… | |
5120 | =item Processing ev_async_send: O(number_of_async_watchers) |
5460 | =item Processing ev_async_send: O(number_of_async_watchers) |
5121 | |
5461 | |
5122 | =item Processing signals: O(max_signal_number) |
5462 | =item Processing signals: O(max_signal_number) |
5123 | |
5463 | |
5124 | Sending involves a system call I<iff> there were no other C<ev_async_send> |
5464 | Sending involves a system call I<iff> there were no other C<ev_async_send> |
5125 | calls in the current loop iteration. Checking for async and signal events |
5465 | calls in the current loop iteration and the loop is currently |
|
|
5466 | blocked. Checking for async and signal events involves iterating over all |
5126 | involves iterating over all running async watchers or all signal numbers. |
5467 | running async watchers or all signal numbers. |
5127 | |
5468 | |
5128 | =back |
5469 | =back |
5129 | |
5470 | |
5130 | |
5471 | |
5131 | =head1 PORTING FROM LIBEV 3.X TO 4.X |
5472 | =head1 PORTING FROM LIBEV 3.X TO 4.X |
… | |
… | |
5140 | =over 4 |
5481 | =over 4 |
5141 | |
5482 | |
5142 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5483 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5143 | |
5484 | |
5144 | The backward compatibility mechanism can be controlled by |
5485 | The backward compatibility mechanism can be controlled by |
5145 | C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> |
5486 | C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING> |
5146 | section. |
5487 | section. |
5147 | |
5488 | |
5148 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5489 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5149 | |
5490 | |
5150 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
5491 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
… | |
… | |
5193 | =over 4 |
5534 | =over 4 |
5194 | |
5535 | |
5195 | =item active |
5536 | =item active |
5196 | |
5537 | |
5197 | A watcher is active as long as it has been started and not yet stopped. |
5538 | A watcher is active as long as it has been started and not yet stopped. |
5198 | See L<WATCHER STATES> for details. |
5539 | See L</WATCHER STATES> for details. |
5199 | |
5540 | |
5200 | =item application |
5541 | =item application |
5201 | |
5542 | |
5202 | In this document, an application is whatever is using libev. |
5543 | In this document, an application is whatever is using libev. |
5203 | |
5544 | |
… | |
… | |
5239 | watchers and events. |
5580 | watchers and events. |
5240 | |
5581 | |
5241 | =item pending |
5582 | =item pending |
5242 | |
5583 | |
5243 | A watcher is pending as soon as the corresponding event has been |
5584 | A watcher is pending as soon as the corresponding event has been |
5244 | detected. See L<WATCHER STATES> for details. |
5585 | detected. See L</WATCHER STATES> for details. |
5245 | |
5586 | |
5246 | =item real time |
5587 | =item real time |
5247 | |
5588 | |
5248 | The physical time that is observed. It is apparently strictly monotonic :) |
5589 | The physical time that is observed. It is apparently strictly monotonic :) |
5249 | |
5590 | |