|
|
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 |
… | |
… | |
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> |
… | |
… | |
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 |
… | |
… | |
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 | |
… | |
… | |
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 loop 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 | |
… | |
… | |
1870 | callback (EV_P_ ev_timer *w, int revents) |
1908 | callback (EV_P_ ev_timer *w, int revents) |
1871 | { |
1909 | { |
1872 | // calculate when the timeout would happen |
1910 | // calculate when the timeout would happen |
1873 | ev_tstamp after = last_activity - ev_now (EV_A) + timeout; |
1911 | ev_tstamp after = last_activity - ev_now (EV_A) + timeout; |
1874 | |
1912 | |
1875 | // if negative, it means we the timeout already occured |
1913 | // if negative, it means we the timeout already occurred |
1876 | if (after < 0.) |
1914 | if (after < 0.) |
1877 | { |
1915 | { |
1878 | // timeout occurred, take action |
1916 | // timeout occurred, take action |
1879 | } |
1917 | } |
1880 | else |
1918 | else |
1881 | { |
1919 | { |
1882 | // callback was invoked, but there was some recent |
1920 | // callback was invoked, but there was some recent |
1883 | // activity. simply restart the timer to time out |
1921 | // activity. simply restart the timer to time out |
1884 | // after "after" seconds, which is the earliest time |
1922 | // after "after" seconds, which is the earliest time |
1885 | // the timeout can occur. |
1923 | // the timeout can occur. |
1886 | ev_timer_set (w, after, 0.); |
1924 | ev_timer_set (w, after, 0.); |
1887 | ev_timer_start (EV_A_ w); |
1925 | ev_timer_start (EV_A_ w); |
1888 | } |
1926 | } |
… | |
… | |
1898 | |
1936 | |
1899 | Otherwise, we now the earliest time at which the timeout would trigger, |
1937 | Otherwise, we now the earliest time at which the timeout would trigger, |
1900 | and simply start the timer with this timeout value. |
1938 | and simply start the timer with this timeout value. |
1901 | |
1939 | |
1902 | In other words, each time the callback is invoked it will check whether |
1940 | In other words, each time the callback is invoked it will check whether |
1903 | the timeout cocured. If not, it will simply reschedule itself to check |
1941 | the timeout occurred. If not, it will simply reschedule itself to check |
1904 | again at the earliest time it could time out. Rinse. Repeat. |
1942 | again at the earliest time it could time out. Rinse. Repeat. |
1905 | |
1943 | |
1906 | This scheme causes more callback invocations (about one every 60 seconds |
1944 | This scheme causes more callback invocations (about one every 60 seconds |
1907 | 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 |
1908 | libev to change the timeout. |
1946 | libev to change the timeout. |
… | |
… | |
1922 | if (activity detected) |
1960 | if (activity detected) |
1923 | last_activity = ev_now (EV_A); |
1961 | last_activity = ev_now (EV_A); |
1924 | |
1962 | |
1925 | When your timeout value changes, then the timeout can be changed by simply |
1963 | When your timeout value changes, then the timeout can be changed by simply |
1926 | providing a new value, stopping the timer and calling the callback, which |
1964 | providing a new value, stopping the timer and calling the callback, which |
1927 | will agaion do the right thing (for example, time out immediately :). |
1965 | will again do the right thing (for example, time out immediately :). |
1928 | |
1966 | |
1929 | timeout = new_value; |
1967 | timeout = new_value; |
1930 | ev_timer_stop (EV_A_ &timer); |
1968 | ev_timer_stop (EV_A_ &timer); |
1931 | callback (EV_A_ &timer, 0); |
1969 | callback (EV_A_ &timer, 0); |
1932 | |
1970 | |
… | |
… | |
2015 | |
2053 | |
2016 | The relative timeouts are calculated relative to the C<ev_now ()> |
2054 | The relative timeouts are calculated relative to the C<ev_now ()> |
2017 | 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 |
2018 | of the event triggering whatever timeout you are modifying/starting. If |
2056 | of the event triggering whatever timeout you are modifying/starting. If |
2019 | 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 |
2020 | 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: |
2021 | |
2060 | |
2022 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
2061 | ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.); |
2023 | |
2062 | |
2024 | 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 |
2025 | 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 |
2026 | ()>. |
2065 | ()>, although that will push the event time of all outstanding events |
|
|
2066 | further into the future. |
2027 | |
2067 | |
2028 | =head3 The special problem of unsynchronised clocks |
2068 | =head3 The special problem of unsynchronised clocks |
2029 | |
2069 | |
2030 | Modern systems have a variety of clocks - libev itself uses the normal |
2070 | Modern systems have a variety of clocks - libev itself uses the normal |
2031 | "wall clock" clock and, if available, the monotonic clock (to avoid time |
2071 | "wall clock" clock and, if available, the monotonic clock (to avoid time |
… | |
… | |
2094 | |
2134 | |
2095 | =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) |
2096 | |
2136 | |
2097 | =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) |
2098 | |
2138 | |
2099 | Configure the timer to trigger after C<after> seconds. If C<repeat> |
2139 | Configure the timer to trigger after C<after> seconds (fractional and |
2100 | 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 |
2101 | reached. If it is positive, then the timer will automatically be |
2141 | automatically be stopped once the timeout is reached. If it is positive, |
2102 | configured to trigger again C<repeat> seconds later, again, and again, |
2142 | then the timer will automatically be configured to trigger again C<repeat> |
2103 | until stopped manually. |
2143 | seconds later, again, and again, until stopped manually. |
2104 | |
2144 | |
2105 | 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 |
2106 | 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 |
2107 | trigger at exactly 10 second intervals. If, however, your program cannot |
2147 | trigger at exactly 10 second intervals. If, however, your program cannot |
2108 | 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 |
2109 | 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. |
2110 | |
2150 | |
2111 | =item ev_timer_again (loop, ev_timer *) |
2151 | =item ev_timer_again (loop, ev_timer *) |
2112 | |
2152 | |
2113 | This will act as if the timer timed out and restarts it again if it is |
2153 | This will act as if the timer timed out, and restarts it again if it is |
2114 | 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>. |
2115 | |
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 | |
2116 | If the timer is pending, its pending status is cleared. |
2162 | =item If the timer is pending, the pending status is always cleared. |
2117 | |
2163 | |
2118 | 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). |
2119 | |
2166 | |
2120 | 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 |
2121 | C<repeat> value), or reset the running timer to the C<repeat> value. |
2168 | and start the timer, if necessary. |
2122 | |
2169 | |
|
|
2170 | =back |
|
|
2171 | |
2123 | 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 |
2124 | usage example. |
2173 | usage example. |
2125 | |
2174 | |
2126 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2175 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2127 | |
2176 | |
2128 | 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, |
… | |
… | |
2181 | 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 |
2182 | (and unfortunately a bit complex). |
2231 | (and unfortunately a bit complex). |
2183 | |
2232 | |
2184 | 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 |
2185 | 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 |
2186 | (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 |
2187 | 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 |
2188 | 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 |
2189 | wrist-watch). |
2238 | wrist-watch). |
2190 | |
2239 | |
2191 | 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 |
… | |
… | |
2196 | 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 |
2197 | it, as it uses a relative timeout). |
2246 | it, as it uses a relative timeout). |
2198 | |
2247 | |
2199 | 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 |
2200 | 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 |
2201 | 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> |
2202 | those cannot react to time jumps. |
2251 | watchers, as those cannot react to time jumps. |
2203 | |
2252 | |
2204 | 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 |
2205 | 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 |
2206 | 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 |
2207 | 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 |
… | |
… | |
2293 | |
2342 | |
2294 | 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 |
2295 | equal to the passed C<now> value >>. |
2344 | equal to the passed C<now> value >>. |
2296 | |
2345 | |
2297 | 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 |
2298 | 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 |
2299 | 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 |
2300 | 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 |
2301 | 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). |
2302 | |
2369 | |
2303 | =back |
2370 | =back |
2304 | |
2371 | |
2305 | =item ev_periodic_again (loop, ev_periodic *) |
2372 | =item ev_periodic_again (loop, ev_periodic *) |
2306 | |
2373 | |
… | |
… | |
2371 | |
2438 | |
2372 | ev_periodic hourly_tick; |
2439 | ev_periodic hourly_tick; |
2373 | ev_periodic_init (&hourly_tick, clock_cb, |
2440 | ev_periodic_init (&hourly_tick, clock_cb, |
2374 | fmod (ev_now (loop), 3600.), 3600., 0); |
2441 | fmod (ev_now (loop), 3600.), 3600., 0); |
2375 | ev_periodic_start (loop, &hourly_tick); |
2442 | ev_periodic_start (loop, &hourly_tick); |
2376 | |
2443 | |
2377 | |
2444 | |
2378 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2445 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2379 | |
2446 | |
2380 | 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 |
2381 | 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 |
… | |
… | |
2391 | 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 |
2392 | 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 |
2393 | 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 |
2394 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2461 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2395 | |
2462 | |
2396 | 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 |
2397 | 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 |
2398 | 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. |
2399 | |
2466 | |
2400 | If possible and supported, libev will install its handlers with |
2467 | If possible and supported, libev will install its handlers with |
2401 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2468 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2402 | 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 |
2403 | 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 |
… | |
… | |
2588 | |
2655 | |
2589 | =head2 C<ev_stat> - did the file attributes just change? |
2656 | =head2 C<ev_stat> - did the file attributes just change? |
2590 | |
2657 | |
2591 | 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 |
2592 | 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) |
2593 | 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 |
2594 | 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. |
2595 | |
2663 | |
2596 | 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 |
2597 | 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 |
2598 | 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 |
2599 | 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 |
… | |
… | |
2829 | Apart from keeping your process non-blocking (which is a useful |
2897 | Apart from keeping your process non-blocking (which is a useful |
2830 | 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 |
2831 | "pseudo-background processing", or delay processing stuff to after the |
2899 | "pseudo-background processing", or delay processing stuff to after the |
2832 | event loop has handled all outstanding events. |
2900 | event loop has handled all outstanding events. |
2833 | |
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 | |
2834 | =head3 Watcher-Specific Functions and Data Members |
2916 | =head3 Watcher-Specific Functions and Data Members |
2835 | |
2917 | |
2836 | =over 4 |
2918 | =over 4 |
2837 | |
2919 | |
2838 | =item ev_idle_init (ev_idle *, callback) |
2920 | =item ev_idle_init (ev_idle *, callback) |
… | |
… | |
2849 | callback, free it. Also, use no error checking, as usual. |
2931 | callback, free it. Also, use no error checking, as usual. |
2850 | |
2932 | |
2851 | static void |
2933 | static void |
2852 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2934 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2853 | { |
2935 | { |
|
|
2936 | // stop the watcher |
|
|
2937 | ev_idle_stop (loop, w); |
|
|
2938 | |
|
|
2939 | // now we can free it |
2854 | free (w); |
2940 | free (w); |
|
|
2941 | |
2855 | // now do something you wanted to do when the program has |
2942 | // now do something you wanted to do when the program has |
2856 | // no longer anything immediate to do. |
2943 | // no longer anything immediate to do. |
2857 | } |
2944 | } |
2858 | |
2945 | |
2859 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
2946 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
… | |
… | |
2861 | ev_idle_start (loop, idle_watcher); |
2948 | ev_idle_start (loop, idle_watcher); |
2862 | |
2949 | |
2863 | |
2950 | |
2864 | =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! |
2865 | |
2952 | |
2866 | 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: |
2867 | prepare watchers get invoked before the process blocks and check watchers |
2954 | prepare watchers get invoked before the process blocks and check watchers |
2868 | afterwards. |
2955 | afterwards. |
2869 | |
2956 | |
2870 | 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 |
2871 | 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 |
2872 | watchers. Other loops than the current one are fine, however. The |
2959 | C<ev_check> watchers. Other loops than the current one are fine, |
2873 | 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 |
2874 | 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 |
2875 | 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 |
2876 | called in pairs bracketing the blocking call. |
2963 | kind they will always be called in pairs bracketing the blocking call. |
2877 | |
2964 | |
2878 | 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 |
2879 | 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 |
2880 | variable changes, implement your own watchers, integrate net-snmp or a |
2967 | variable changes, implement your own watchers, integrate net-snmp or a |
2881 | coroutine library and lots more. They are also occasionally useful if |
2968 | coroutine library and lots more. They are also occasionally useful if |
… | |
… | |
2899 | 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 |
2900 | 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 |
2901 | loop from blocking if lower-priority coroutines are active, thus mapping |
2988 | loop from blocking if lower-priority coroutines are active, thus mapping |
2902 | low-priority coroutines to idle/background tasks). |
2989 | low-priority coroutines to idle/background tasks). |
2903 | |
2990 | |
2904 | 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 |
2905 | 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 |
2906 | 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). |
2907 | |
2995 | |
2908 | 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 |
2909 | activate ("feed") events into libev. While libev fully supports this, they |
2997 | activate ("feed") events into libev. While libev fully supports this, they |
2910 | 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 |
2911 | 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 |
2912 | 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 |
2913 | 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 |
2914 | 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. |
2915 | |
3022 | |
2916 | =head3 Watcher-Specific Functions and Data Members |
3023 | =head3 Watcher-Specific Functions and Data Members |
2917 | |
3024 | |
2918 | =over 4 |
3025 | =over 4 |
2919 | |
3026 | |
… | |
… | |
3120 | |
3227 | |
3121 | =over 4 |
3228 | =over 4 |
3122 | |
3229 | |
3123 | =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) |
3124 | |
3231 | |
3125 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
3232 | =item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop) |
3126 | |
3233 | |
3127 | Configures the watcher to embed the given loop, which must be |
3234 | Configures the watcher to embed the given loop, which must be |
3128 | 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 |
3129 | invoked automatically, otherwise it is the responsibility of the callback |
3236 | invoked automatically, otherwise it is the responsibility of the callback |
3130 | 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, |
… | |
… | |
3151 | used). |
3258 | used). |
3152 | |
3259 | |
3153 | struct ev_loop *loop_hi = ev_default_init (0); |
3260 | struct ev_loop *loop_hi = ev_default_init (0); |
3154 | struct ev_loop *loop_lo = 0; |
3261 | struct ev_loop *loop_lo = 0; |
3155 | ev_embed embed; |
3262 | ev_embed embed; |
3156 | |
3263 | |
3157 | // see if there is a chance of getting one that works |
3264 | // see if there is a chance of getting one that works |
3158 | // (remember that a flags value of 0 means autodetection) |
3265 | // (remember that a flags value of 0 means autodetection) |
3159 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3266 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3160 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3267 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3161 | : 0; |
3268 | : 0; |
… | |
… | |
3175 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3282 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3176 | |
3283 | |
3177 | struct ev_loop *loop = ev_default_init (0); |
3284 | struct ev_loop *loop = ev_default_init (0); |
3178 | struct ev_loop *loop_socket = 0; |
3285 | struct ev_loop *loop_socket = 0; |
3179 | ev_embed embed; |
3286 | ev_embed embed; |
3180 | |
3287 | |
3181 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3288 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3182 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3289 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3183 | { |
3290 | { |
3184 | ev_embed_init (&embed, 0, loop_socket); |
3291 | ev_embed_init (&embed, 0, loop_socket); |
3185 | ev_embed_start (loop, &embed); |
3292 | ev_embed_start (loop, &embed); |
… | |
… | |
3193 | |
3300 | |
3194 | =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 |
3195 | |
3302 | |
3196 | 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 |
3197 | 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 |
3198 | 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 |
3199 | 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 |
3200 | 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 |
3201 | 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, |
3202 | handlers will be invoked, too, of course. |
3309 | of course. |
3203 | |
3310 | |
3204 | =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? |
3205 | |
3312 | |
3206 | 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 |
3207 | 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 |
3208 | sequence should be handled by libev without any problems. |
3315 | sequence should be handled by libev without any problems. |
3209 | |
3316 | |
3210 | This changes when the application actually wants to do event handling |
3317 | This changes when the application actually wants to do event handling |
3211 | 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 |
… | |
… | |
3300 | 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. |
3301 | |
3408 | |
3302 | 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, |
3303 | too, are asynchronous in nature, and signals, too, will be compressed |
3410 | too, are asynchronous in nature, and signals, too, will be compressed |
3304 | (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 |
3305 | 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 |
3306 | 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 |
3307 | 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, |
3308 | even without knowing which loop owns the signal. |
3415 | even without knowing which loop owns the signal. |
3309 | |
3416 | |
3310 | =head3 Queueing |
3417 | =head3 Queueing |
… | |
… | |
3449 | |
3556 | |
3450 | There are some other functions of possible interest. Described. Here. Now. |
3557 | There are some other functions of possible interest. Described. Here. Now. |
3451 | |
3558 | |
3452 | =over 4 |
3559 | =over 4 |
3453 | |
3560 | |
3454 | =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) |
3455 | |
3562 | |
3456 | 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 |
3457 | callback on whichever event happens first and automatically stops both |
3564 | callback on whichever event happens first and automatically stops both |
3458 | 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 |
3459 | 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 |
… | |
… | |
3601 | already been invoked. |
3708 | already been invoked. |
3602 | |
3709 | |
3603 | A common way around all these issues is to make sure that |
3710 | A common way around all these issues is to make sure that |
3604 | C<start_new_request> I<always> returns before the callback is invoked. If |
3711 | C<start_new_request> I<always> returns before the callback is invoked. If |
3605 | C<start_new_request> immediately knows the result, it can artificially |
3712 | C<start_new_request> immediately knows the result, it can artificially |
3606 | delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher |
3713 | delay invoking the callback by using a C<prepare> or C<idle> watcher for |
3607 | for example, or more sneakily, by reusing an existing (stopped) watcher |
3714 | example, or more sneakily, by reusing an existing (stopped) watcher and |
3608 | and pushing it into the pending queue: |
3715 | pushing it into the pending queue: |
3609 | |
3716 | |
3610 | ev_set_cb (watcher, callback); |
3717 | ev_set_cb (watcher, callback); |
3611 | ev_feed_event (EV_A_ watcher, 0); |
3718 | ev_feed_event (EV_A_ watcher, 0); |
3612 | |
3719 | |
3613 | This way, C<start_new_request> can safely return before the callback is |
3720 | This way, C<start_new_request> can safely return before the callback is |
… | |
… | |
3621 | |
3728 | |
3622 | 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 |
3623 | 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 |
3624 | 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 |
3625 | 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 |
3626 | 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. |
3627 | |
3734 | |
3628 | 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> |
3629 | 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 |
3630 | triggered, using C<EVRUN_ONCE>: |
3737 | triggered, using C<EVRUN_ONCE>: |
3631 | |
3738 | |
… | |
… | |
3633 | int exit_main_loop = 0; |
3740 | int exit_main_loop = 0; |
3634 | |
3741 | |
3635 | while (!exit_main_loop) |
3742 | while (!exit_main_loop) |
3636 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3743 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3637 | |
3744 | |
3638 | // in a model watcher |
3745 | // in a modal watcher |
3639 | int exit_nested_loop = 0; |
3746 | int exit_nested_loop = 0; |
3640 | |
3747 | |
3641 | while (!exit_nested_loop) |
3748 | while (!exit_nested_loop) |
3642 | ev_run (EV_A_ EVRUN_ONCE); |
3749 | ev_run (EV_A_ EVRUN_ONCE); |
3643 | |
3750 | |
… | |
… | |
3817 | called): |
3924 | called): |
3818 | |
3925 | |
3819 | void |
3926 | void |
3820 | wait_for_event (ev_watcher *w) |
3927 | wait_for_event (ev_watcher *w) |
3821 | { |
3928 | { |
3822 | ev_cb_set (w) = current_coro; |
3929 | ev_set_cb (w, current_coro); |
3823 | switch_to (libev_coro); |
3930 | switch_to (libev_coro); |
3824 | } |
3931 | } |
3825 | |
3932 | |
3826 | That basically suspends the coroutine inside C<wait_for_event> and |
3933 | That basically suspends the coroutine inside C<wait_for_event> and |
3827 | continues the libev coroutine, which, when appropriate, switches back to |
3934 | continues the libev coroutine, which, when appropriate, switches back to |
3828 | this or any other coroutine. I am sure if you sue this your own :) |
3935 | this or any other coroutine. |
3829 | |
3936 | |
3830 | 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 - |
3831 | 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 |
3832 | 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 |
3833 | any waiters. |
3940 | any waiters. |
3834 | |
3941 | |
3835 | 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 |
3836 | 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: |
3837 | |
3944 | |
3838 | // my_ev.h |
3945 | // my_ev.h |
3839 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3946 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3840 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); |
3947 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb) |
3841 | #include "../libev/ev.h" |
3948 | #include "../libev/ev.h" |
3842 | |
3949 | |
3843 | // my_ev.c |
3950 | // my_ev.c |
3844 | #define EV_H "my_ev.h" |
3951 | #define EV_H "my_ev.h" |
3845 | #include "../libev/ev.c" |
3952 | #include "../libev/ev.c" |
… | |
… | |
3884 | |
3991 | |
3885 | =back |
3992 | =back |
3886 | |
3993 | |
3887 | =head1 C++ SUPPORT |
3994 | =head1 C++ SUPPORT |
3888 | |
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 | |
3889 | 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 |
3890 | 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 |
3891 | the callback model to a model using method callbacks on objects. |
4031 | the callback model to a model using method callbacks on objects. |
3892 | |
4032 | |
3893 | To use it, |
4033 | To use it, |
3894 | |
4034 | |
3895 | #include <ev++.h> |
4035 | #include <ev++.h> |
3896 | |
4036 | |
3897 | 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 |
3898 | 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 |
3899 | 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 |
… | |
… | |
3908 | 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 |
3909 | 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 |
3910 | 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 |
3911 | (preferably after implementing it). |
4051 | (preferably after implementing it). |
3912 | |
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 | |
3913 | 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: |
3914 | |
4058 | |
3915 | =over 4 |
4059 | =over 4 |
3916 | |
4060 | |
3917 | =item C<ev::READ>, C<ev::WRITE> etc. |
4061 | =item C<ev::READ>, C<ev::WRITE> etc. |
… | |
… | |
3926 | =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. |
3927 | |
4071 | |
3928 | 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 |
3929 | 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> |
3930 | 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 |
3931 | defines by many implementations. |
4075 | defined by many implementations. |
3932 | |
4076 | |
3933 | All of those classes have these methods: |
4077 | All of those classes have these methods: |
3934 | |
4078 | |
3935 | =over 4 |
4079 | =over 4 |
3936 | |
4080 | |
… | |
… | |
3998 | void operator() (ev::io &w, int revents) |
4142 | void operator() (ev::io &w, int revents) |
3999 | { |
4143 | { |
4000 | ... |
4144 | ... |
4001 | } |
4145 | } |
4002 | } |
4146 | } |
4003 | |
4147 | |
4004 | myfunctor f; |
4148 | myfunctor f; |
4005 | |
4149 | |
4006 | ev::io w; |
4150 | ev::io w; |
4007 | w.set (&f); |
4151 | w.set (&f); |
4008 | |
4152 | |
… | |
… | |
4026 | 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 |
4027 | do this when the watcher is inactive (and not pending either). |
4171 | do this when the watcher is inactive (and not pending either). |
4028 | |
4172 | |
4029 | =item w->set ([arguments]) |
4173 | =item w->set ([arguments]) |
4030 | |
4174 | |
4031 | 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>), |
4032 | 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 |
4033 | C counterpart, an active watcher gets automatically stopped and restarted |
4177 | must be called at least once. Unlike the C counterpart, an active watcher |
4034 | 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. |
4035 | |
4183 | |
4036 | =item w->start () |
4184 | =item w->start () |
4037 | |
4185 | |
4038 | 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 |
4039 | constructor already stores the event loop. |
4187 | constructor already stores the event loop. |
… | |
… | |
4143 | |
4291 | |
4144 | 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 |
4145 | 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 |
4146 | L<http://github.com/brimworks/lua-ev>. |
4294 | L<http://github.com/brimworks/lua-ev>. |
4147 | |
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 | |
4148 | =back |
4304 | =back |
4149 | |
4305 | |
4150 | |
4306 | |
4151 | =head1 MACRO MAGIC |
4307 | =head1 MACRO MAGIC |
4152 | |
4308 | |
… | |
… | |
4269 | ev_vars.h |
4425 | ev_vars.h |
4270 | ev_wrap.h |
4426 | ev_wrap.h |
4271 | |
4427 | |
4272 | ev_win32.c required on win32 platforms only |
4428 | ev_win32.c required on win32 platforms only |
4273 | |
4429 | |
4274 | ev_select.c only when select backend is enabled (which is enabled by default) |
4430 | ev_select.c only when select backend is enabled |
4275 | ev_poll.c only when poll backend is enabled (disabled by default) |
4431 | ev_poll.c only when poll backend is enabled |
4276 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
4432 | ev_epoll.c only when the epoll backend is enabled |
4277 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
4433 | ev_kqueue.c only when the kqueue backend is enabled |
4278 | 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 |
4279 | |
4435 | |
4280 | 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 |
4281 | to compile this single file. |
4437 | to compile this single file. |
4282 | |
4438 | |
4283 | =head3 LIBEVENT COMPATIBILITY API |
4439 | =head3 LIBEVENT COMPATIBILITY API |
… | |
… | |
4450 | |
4606 | |
4451 | 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 |
4452 | 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 |
4453 | file descriptors again. Note that the replacement function has to close |
4609 | file descriptors again. Note that the replacement function has to close |
4454 | 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. |
4455 | |
4618 | |
4456 | =item EV_USE_POLL |
4619 | =item EV_USE_POLL |
4457 | |
4620 | |
4458 | 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) |
4459 | backend. Otherwise it will be enabled on non-win32 platforms. It |
4622 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
4495 | 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 |
4496 | 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 |
4497 | 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 |
4498 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4661 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4499 | |
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 | |
4500 | =item EV_ATOMIC_T |
4677 | =item EV_ATOMIC_T |
4501 | |
4678 | |
4502 | 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 |
4503 | access is atomic and serialised with respect to other threads or signal |
4680 | access is atomic with respect to other threads or signal contexts. No |
4504 | contexts. No such type is easily found in the C language, so you can |
4681 | such type is easily found in the C language, so you can provide your own |
4505 | provide your own type that you know is safe for your purposes. It is used |
4682 | type that you know is safe for your purposes. It is used both for signal |
4506 | both for signal handler "locking" as well as for signal and thread safety |
4683 | handler "locking" as well as for signal and thread safety in C<ev_async> |
4507 | in C<ev_async> watchers. |
4684 | watchers. |
4508 | |
4685 | |
4509 | 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> |
4510 | (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. |
4511 | although strictly speaking using a type that also implies a memory fence |
|
|
4512 | is required. |
|
|
4513 | |
4688 | |
4514 | =item EV_H (h) |
4689 | =item EV_H (h) |
4515 | |
4690 | |
4516 | The name of the F<ev.h> header file used to include it. The default if |
4691 | The name of the F<ev.h> header file used to include it. The default if |
4517 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
4692 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
… | |
… | |
4590 | #define EV_USE_POLL 1 |
4765 | #define EV_USE_POLL 1 |
4591 | #define EV_CHILD_ENABLE 1 |
4766 | #define EV_CHILD_ENABLE 1 |
4592 | #define EV_ASYNC_ENABLE 1 |
4767 | #define EV_ASYNC_ENABLE 1 |
4593 | |
4768 | |
4594 | 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 |
4595 | values: |
4770 | values (by default, all of these are enabled): |
4596 | |
4771 | |
4597 | =over 4 |
4772 | =over 4 |
4598 | |
4773 | |
4599 | =item C<1> - faster/larger code |
4774 | =item C<1> - faster/larger code |
4600 | |
4775 | |
… | |
… | |
4604 | code size by roughly 30% on amd64). |
4779 | code size by roughly 30% on amd64). |
4605 | |
4780 | |
4606 | 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 |
4607 | 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 |
4608 | 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>). |
4609 | |
4787 | |
4610 | =item C<2> - faster/larger data structures |
4788 | =item C<2> - faster/larger data structures |
4611 | |
4789 | |
4612 | 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 |
4613 | 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 |
4614 | 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 |
4615 | runtime. |
4793 | runtime. |
|
|
4794 | |
|
|
4795 | The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler |
|
|
4796 | (e.g. gcc with C<-Os>). |
4616 | |
4797 | |
4617 | =item C<4> - full API configuration |
4798 | =item C<4> - full API configuration |
4618 | |
4799 | |
4619 | 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 |
4620 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
4801 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
… | |
… | |
4662 | when you embed libev, only want to use libev functions in a single file, |
4843 | when you embed libev, only want to use libev functions in a single file, |
4663 | and do not want its identifiers to be visible. |
4844 | and do not want its identifiers to be visible. |
4664 | |
4845 | |
4665 | To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that |
4846 | To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that |
4666 | wants to use libev. |
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. |
4667 | |
4851 | |
4668 | =item EV_AVOID_STDIO |
4852 | =item EV_AVOID_STDIO |
4669 | |
4853 | |
4670 | 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 |
4671 | functions (printf, scanf, perror etc.). This will increase the code size |
4855 | functions (printf, scanf, perror etc.). This will increase the code size |
… | |
… | |
4876 | 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 |
4877 | watcher callback into the event loop interested in the signal. |
5061 | watcher callback into the event loop interested in the signal. |
4878 | |
5062 | |
4879 | =back |
5063 | =back |
4880 | |
5064 | |
4881 | See also L<THREAD LOCKING EXAMPLE>. |
5065 | See also L</THREAD LOCKING EXAMPLE>. |
4882 | |
5066 | |
4883 | =head3 COROUTINES |
5067 | =head3 COROUTINES |
4884 | |
5068 | |
4885 | Libev is very accommodating to coroutines ("cooperative threads"): |
5069 | Libev is very accommodating to coroutines ("cooperative threads"): |
4886 | libev fully supports nesting calls to its functions from different |
5070 | libev fully supports nesting calls to its functions from different |
… | |
… | |
5155 | 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 |
5156 | 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 |
5157 | callback: The watcher callbacks have different type signatures, but libev |
5341 | callback: The watcher callbacks have different type signatures, but libev |
5158 | calls them using an C<ev_watcher *> internally. |
5342 | calls them using an C<ev_watcher *> internally. |
5159 | |
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 | |
5160 | =item pointer accesses must be thread-atomic |
5349 | =item pointer accesses must be thread-atomic |
5161 | |
5350 | |
5162 | 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 |
5163 | 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. |
5164 | |
5353 | |
… | |
… | |
5177 | thread" or will block signals process-wide, both behaviours would |
5366 | thread" or will block signals process-wide, both behaviours would |
5178 | be compatible with libev. Interaction between C<sigprocmask> and |
5367 | be compatible with libev. Interaction between C<sigprocmask> and |
5179 | C<pthread_sigmask> could complicate things, however. |
5368 | C<pthread_sigmask> could complicate things, however. |
5180 | |
5369 | |
5181 | 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 |
5182 | 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 |
5183 | well. |
5372 | thread as well. |
5184 | |
5373 | |
5185 | =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 |
5186 | |
5375 | |
5187 | 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 |
5188 | 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 |
… | |
… | |
5292 | =over 4 |
5481 | =over 4 |
5293 | |
5482 | |
5294 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5483 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5295 | |
5484 | |
5296 | The backward compatibility mechanism can be controlled by |
5485 | The backward compatibility mechanism can be controlled by |
5297 | 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> |
5298 | section. |
5487 | section. |
5299 | |
5488 | |
5300 | =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 |
5301 | |
5490 | |
5302 | 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: |
… | |
… | |
5345 | =over 4 |
5534 | =over 4 |
5346 | |
5535 | |
5347 | =item active |
5536 | =item active |
5348 | |
5537 | |
5349 | 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. |
5350 | See L<WATCHER STATES> for details. |
5539 | See L</WATCHER STATES> for details. |
5351 | |
5540 | |
5352 | =item application |
5541 | =item application |
5353 | |
5542 | |
5354 | In this document, an application is whatever is using libev. |
5543 | In this document, an application is whatever is using libev. |
5355 | |
5544 | |
… | |
… | |
5391 | watchers and events. |
5580 | watchers and events. |
5392 | |
5581 | |
5393 | =item pending |
5582 | =item pending |
5394 | |
5583 | |
5395 | 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 |
5396 | detected. See L<WATCHER STATES> for details. |
5585 | detected. See L</WATCHER STATES> for details. |
5397 | |
5586 | |
5398 | =item real time |
5587 | =item real time |
5399 | |
5588 | |
5400 | The physical time that is observed. It is apparently strictly monotonic :) |
5589 | The physical time that is observed. It is apparently strictly monotonic :) |
5401 | |
5590 | |