|
|
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 |
… | |
… | |
283 | } |
285 | } |
284 | |
286 | |
285 | ... |
287 | ... |
286 | ev_set_allocator (persistent_realloc); |
288 | ev_set_allocator (persistent_realloc); |
287 | |
289 | |
288 | =item ev_set_syserr_cb (void (*cb)(const char *msg)) |
290 | =item ev_set_syserr_cb (void (*cb)(const char *msg) throw ()) |
289 | |
291 | |
290 | Set the callback function to call on a retryable system call error (such |
292 | 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 |
293 | as failed select, poll, epoll_wait). The message is a printable string |
292 | indicating the system call or subsystem causing the problem. If this |
294 | 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 |
295 | callback is set, then libev will expect it to remedy the situation, no |
… | |
… | |
396 | |
398 | |
397 | If this flag bit is or'ed into the flag value (or the program runs setuid |
399 | 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 |
400 | or setgid) then libev will I<not> look at the environment variable |
399 | C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will |
401 | C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will |
400 | override the flags completely if it is found in the environment. This is |
402 | 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 |
403 | useful to try out specific backends to test their performance, to work |
402 | around bugs. |
404 | around bugs, or to make libev threadsafe (accessing environment variables |
|
|
405 | cannot be done in a threadsafe way, but usually it works if no other |
|
|
406 | thread modifies them). |
403 | |
407 | |
404 | =item C<EVFLAG_FORKCHECK> |
408 | =item C<EVFLAG_FORKCHECK> |
405 | |
409 | |
406 | Instead of calling C<ev_loop_fork> manually after a fork, you can also |
410 | 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. |
411 | make libev check for a fork in each iteration by enabling this flag. |
408 | |
412 | |
409 | This works by calling C<getpid ()> on every iteration of the loop, |
413 | 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 |
414 | 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 |
415 | 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 |
416 | 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 |
417 | sequence without a system call and thus I<very> fast, but my GNU/Linux |
414 | C<pthread_atfork> which is even faster). |
418 | system also has C<pthread_atfork> which is even faster). (Update: glibc |
|
|
419 | versions 2.25 apparently removed the C<getpid> optimisation again). |
415 | |
420 | |
416 | The big advantage of this flag is that you can forget about fork (and |
421 | 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 |
422 | forget about forgetting to tell libev about forking, although you still |
418 | flag. |
423 | have to ignore C<SIGPIPE>) when you use this flag. |
419 | |
424 | |
420 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
425 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
421 | environment variable. |
426 | environment variable. |
422 | |
427 | |
423 | =item C<EVFLAG_NOINOTIFY> |
428 | =item C<EVFLAG_NOINOTIFY> |
… | |
… | |
567 | |
572 | |
568 | It scales in the same way as the epoll backend, but the interface to the |
573 | 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 |
574 | 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 |
575 | 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 |
576 | 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 |
577 | 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 |
578 | might have to leak fd's on fork, but it's more sane than epoll) and it |
574 | cases |
579 | drops fds silently in similarly hard-to-detect cases. |
575 | |
580 | |
576 | This backend usually performs well under most conditions. |
581 | This backend usually performs well under most conditions. |
577 | |
582 | |
578 | While nominally embeddable in other event loops, this doesn't work |
583 | 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 |
584 | 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> |
683 | If you need dynamically allocated loops it is better to use C<ev_loop_new> |
679 | and C<ev_loop_destroy>. |
684 | and C<ev_loop_destroy>. |
680 | |
685 | |
681 | =item ev_loop_fork (loop) |
686 | =item ev_loop_fork (loop) |
682 | |
687 | |
683 | This function sets a flag that causes subsequent C<ev_run> iterations to |
688 | This function sets a flag that causes subsequent C<ev_run> iterations |
684 | reinitialise the kernel state for backends that have one. Despite the |
689 | 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 |
690 | 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 |
691 | watchers (except inside an C<ev_prepare> callback), but it makes most |
|
|
692 | sense after forking, in the child process. You I<must> call it (or use |
687 | child before resuming or calling C<ev_run>. |
693 | C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>. |
688 | |
694 | |
|
|
695 | In addition, if you want to reuse a loop (via this function or |
|
|
696 | C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>. |
|
|
697 | |
689 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
698 | 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 |
699 | 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 |
700 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
692 | during fork. |
701 | during fork. |
693 | |
702 | |
694 | On the other hand, you only need to call this function in the child |
703 | On the other hand, you only need to call this function in the child |
… | |
… | |
764 | |
773 | |
765 | This function is rarely useful, but when some event callback runs for a |
774 | 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 |
775 | very long time without entering the event loop, updating libev's idea of |
767 | the current time is a good idea. |
776 | the current time is a good idea. |
768 | |
777 | |
769 | See also L<The special problem of time updates> in the C<ev_timer> section. |
778 | See also L</The special problem of time updates> in the C<ev_timer> section. |
770 | |
779 | |
771 | =item ev_suspend (loop) |
780 | =item ev_suspend (loop) |
772 | |
781 | |
773 | =item ev_resume (loop) |
782 | =item ev_resume (loop) |
774 | |
783 | |
… | |
… | |
792 | without a previous call to C<ev_suspend>. |
801 | without a previous call to C<ev_suspend>. |
793 | |
802 | |
794 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
803 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
795 | event loop time (see C<ev_now_update>). |
804 | event loop time (see C<ev_now_update>). |
796 | |
805 | |
797 | =item ev_run (loop, int flags) |
806 | =item bool ev_run (loop, int flags) |
798 | |
807 | |
799 | Finally, this is it, the event handler. This function usually is called |
808 | 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 |
809 | 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 |
810 | 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 |
811 | the watcher callbacks, and then repeat the whole process indefinitely: This |
803 | is why event loops are called I<loops>. |
812 | is why event loops are called I<loops>. |
804 | |
813 | |
805 | If the flags argument is specified as C<0>, it will keep handling events |
814 | 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 |
815 | until either no event watchers are active anymore or C<ev_break> was |
807 | called. |
816 | called. |
|
|
817 | |
|
|
818 | The return value is false if there are no more active watchers (which |
|
|
819 | usually means "all jobs done" or "deadlock"), and true in all other cases |
|
|
820 | (which usually means " you should call C<ev_run> again"). |
808 | |
821 | |
809 | Please note that an explicit C<ev_break> is usually better than |
822 | 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 |
823 | relying on all watchers to be stopped when deciding when a program has |
811 | finished (especially in interactive programs), but having a program |
824 | finished (especially in interactive programs), but having a program |
812 | that automatically loops as long as it has to and no longer by virtue |
825 | 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 |
826 | of relying on its watchers stopping correctly, that is truly a thing of |
814 | beauty. |
827 | beauty. |
815 | |
828 | |
816 | This function is also I<mostly> exception-safe - you can break out of |
829 | 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++ |
830 | 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 |
831 | exception and so on. This does not decrement the C<ev_depth> value, nor |
819 | will it clear any outstanding C<EVBREAK_ONE> breaks. |
832 | will it clear any outstanding C<EVBREAK_ONE> breaks. |
820 | |
833 | |
821 | A flags value of C<EVRUN_NOWAIT> will look for new events, will handle |
834 | 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 |
835 | those events and any already outstanding ones, but will not wait and |
… | |
… | |
1012 | invoke the actual watchers inside another context (another thread etc.). |
1025 | invoke the actual watchers inside another context (another thread etc.). |
1013 | |
1026 | |
1014 | If you want to reset the callback, use C<ev_invoke_pending> as new |
1027 | If you want to reset the callback, use C<ev_invoke_pending> as new |
1015 | callback. |
1028 | callback. |
1016 | |
1029 | |
1017 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) |
1030 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ()) |
1018 | |
1031 | |
1019 | Sometimes you want to share the same loop between multiple threads. This |
1032 | 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 |
1033 | can be done relatively simply by putting mutex_lock/unlock calls around |
1021 | each call to a libev function. |
1034 | each call to a libev function. |
1022 | |
1035 | |
… | |
… | |
1170 | |
1183 | |
1171 | =item C<EV_PREPARE> |
1184 | =item C<EV_PREPARE> |
1172 | |
1185 | |
1173 | =item C<EV_CHECK> |
1186 | =item C<EV_CHECK> |
1174 | |
1187 | |
1175 | All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts |
1188 | 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 |
1189 | 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 |
1190 | just after C<ev_run> has gathered them, but before it queues any callbacks |
|
|
1191 | for any received events. That means C<ev_prepare> watchers are the last |
|
|
1192 | watchers invoked before the event loop sleeps or polls for new events, and |
|
|
1193 | C<ev_check> watchers will be invoked before any other watchers of the same |
|
|
1194 | or lower priority within an event loop iteration. |
|
|
1195 | |
1178 | received events. Callbacks of both watcher types can start and stop as |
1196 | 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 |
1197 | 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 |
1198 | C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from |
1181 | C<ev_run> from blocking). |
1199 | blocking). |
1182 | |
1200 | |
1183 | =item C<EV_EMBED> |
1201 | =item C<EV_EMBED> |
1184 | |
1202 | |
1185 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1203 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1186 | |
1204 | |
… | |
… | |
1309 | |
1327 | |
1310 | =item callback ev_cb (ev_TYPE *watcher) |
1328 | =item callback ev_cb (ev_TYPE *watcher) |
1311 | |
1329 | |
1312 | Returns the callback currently set on the watcher. |
1330 | Returns the callback currently set on the watcher. |
1313 | |
1331 | |
1314 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1332 | =item ev_set_cb (ev_TYPE *watcher, callback) |
1315 | |
1333 | |
1316 | Change the callback. You can change the callback at virtually any time |
1334 | Change the callback. You can change the callback at virtually any time |
1317 | (modulo threads). |
1335 | (modulo threads). |
1318 | |
1336 | |
1319 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
1337 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
… | |
… | |
1337 | or might not have been clamped to the valid range. |
1355 | or might not have been clamped to the valid range. |
1338 | |
1356 | |
1339 | The default priority used by watchers when no priority has been set is |
1357 | 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 :). |
1358 | always C<0>, which is supposed to not be too high and not be too low :). |
1341 | |
1359 | |
1342 | See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1360 | See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1343 | priorities. |
1361 | priorities. |
1344 | |
1362 | |
1345 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1363 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1346 | |
1364 | |
1347 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
1365 | 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 |
1390 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
1373 | functions that do not need a watcher. |
1391 | functions that do not need a watcher. |
1374 | |
1392 | |
1375 | =back |
1393 | =back |
1376 | |
1394 | |
1377 | See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR |
1395 | See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR |
1378 | OWN COMPOSITE WATCHERS> idioms. |
1396 | OWN COMPOSITE WATCHERS> idioms. |
1379 | |
1397 | |
1380 | =head2 WATCHER STATES |
1398 | =head2 WATCHER STATES |
1381 | |
1399 | |
1382 | There are various watcher states mentioned throughout this manual - |
1400 | There are various watcher states mentioned throughout this manual - |
… | |
… | |
1384 | transition between them will be described in more detail - and while these |
1402 | transition between them will be described in more detail - and while these |
1385 | rules might look complicated, they usually do "the right thing". |
1403 | rules might look complicated, they usually do "the right thing". |
1386 | |
1404 | |
1387 | =over 4 |
1405 | =over 4 |
1388 | |
1406 | |
1389 | =item initialiased |
1407 | =item initialised |
1390 | |
1408 | |
1391 | Before a watcher can be registered with the event loop it has to be |
1409 | 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 |
1410 | 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. |
1411 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1394 | |
1412 | |
… | |
… | |
1860 | |
1878 | |
1861 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
1879 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
1862 | but remember the time of last activity, and check for a real timeout only |
1880 | but remember the time of last activity, and check for a real timeout only |
1863 | within the callback: |
1881 | within the callback: |
1864 | |
1882 | |
|
|
1883 | ev_tstamp timeout = 60.; |
1865 | ev_tstamp last_activity; // time of last activity |
1884 | ev_tstamp last_activity; // time of last activity |
|
|
1885 | ev_timer timer; |
1866 | |
1886 | |
1867 | static void |
1887 | static void |
1868 | callback (EV_P_ ev_timer *w, int revents) |
1888 | callback (EV_P_ ev_timer *w, int revents) |
1869 | { |
1889 | { |
1870 | ev_tstamp now = ev_now (EV_A); |
1890 | // calculate when the timeout would happen |
1871 | ev_tstamp timeout = last_activity + 60.; |
1891 | ev_tstamp after = last_activity - ev_now (EV_A) + timeout; |
1872 | |
1892 | |
1873 | // if last_activity + 60. is older than now, we did time out |
1893 | // if negative, it means we the timeout already occurred |
1874 | if (timeout < now) |
1894 | if (after < 0.) |
1875 | { |
1895 | { |
1876 | // timeout occurred, take action |
1896 | // timeout occurred, take action |
1877 | } |
1897 | } |
1878 | else |
1898 | else |
1879 | { |
1899 | { |
1880 | // callback was invoked, but there was some activity, re-arm |
1900 | // callback was invoked, but there was some recent |
1881 | // the watcher to fire in last_activity + 60, which is |
1901 | // activity. simply restart the timer to time out |
1882 | // guaranteed to be in the future, so "again" is positive: |
1902 | // after "after" seconds, which is the earliest time |
1883 | w->repeat = timeout - now; |
1903 | // the timeout can occur. |
|
|
1904 | ev_timer_set (w, after, 0.); |
1884 | ev_timer_again (EV_A_ w); |
1905 | ev_timer_start (EV_A_ w); |
1885 | } |
1906 | } |
1886 | } |
1907 | } |
1887 | |
1908 | |
1888 | To summarise the callback: first calculate the real timeout (defined |
1909 | To summarise the callback: first calculate in how many seconds the |
1889 | as "60 seconds after the last activity"), then check if that time has |
1910 | timeout will occur (by calculating the absolute time when it would occur, |
1890 | been reached, which means something I<did>, in fact, time out. Otherwise |
1911 | C<last_activity + timeout>, and subtracting the current time, C<ev_now |
1891 | the callback was invoked too early (C<timeout> is in the future), so |
1912 | (EV_A)> from that). |
1892 | re-schedule the timer to fire at that future time, to see if maybe we have |
|
|
1893 | a timeout then. |
|
|
1894 | |
1913 | |
1895 | Note how C<ev_timer_again> is used, taking advantage of the |
1914 | If this value is negative, then we are already past the timeout, i.e. we |
1896 | C<ev_timer_again> optimisation when the timer is already running. |
1915 | timed out, and need to do whatever is needed in this case. |
|
|
1916 | |
|
|
1917 | Otherwise, we now the earliest time at which the timeout would trigger, |
|
|
1918 | and simply start the timer with this timeout value. |
|
|
1919 | |
|
|
1920 | In other words, each time the callback is invoked it will check whether |
|
|
1921 | the timeout occurred. If not, it will simply reschedule itself to check |
|
|
1922 | again at the earliest time it could time out. Rinse. Repeat. |
1897 | |
1923 | |
1898 | This scheme causes more callback invocations (about one every 60 seconds |
1924 | This scheme causes more callback invocations (about one every 60 seconds |
1899 | minus half the average time between activity), but virtually no calls to |
1925 | minus half the average time between activity), but virtually no calls to |
1900 | libev to change the timeout. |
1926 | libev to change the timeout. |
1901 | |
1927 | |
1902 | To start the timer, simply initialise the watcher and set C<last_activity> |
1928 | To start the machinery, simply initialise the watcher and set |
1903 | to the current time (meaning we just have some activity :), then call the |
1929 | C<last_activity> to the current time (meaning there was some activity just |
1904 | callback, which will "do the right thing" and start the timer: |
1930 | now), then call the callback, which will "do the right thing" and start |
|
|
1931 | the timer: |
1905 | |
1932 | |
|
|
1933 | last_activity = ev_now (EV_A); |
1906 | ev_init (timer, callback); |
1934 | ev_init (&timer, callback); |
1907 | last_activity = ev_now (loop); |
1935 | callback (EV_A_ &timer, 0); |
1908 | callback (loop, timer, EV_TIMER); |
|
|
1909 | |
1936 | |
1910 | And when there is some activity, simply store the current time in |
1937 | When there is some activity, simply store the current time in |
1911 | C<last_activity>, no libev calls at all: |
1938 | C<last_activity>, no libev calls at all: |
1912 | |
1939 | |
|
|
1940 | if (activity detected) |
1913 | last_activity = ev_now (loop); |
1941 | last_activity = ev_now (EV_A); |
|
|
1942 | |
|
|
1943 | When your timeout value changes, then the timeout can be changed by simply |
|
|
1944 | providing a new value, stopping the timer and calling the callback, which |
|
|
1945 | will again do the right thing (for example, time out immediately :). |
|
|
1946 | |
|
|
1947 | timeout = new_value; |
|
|
1948 | ev_timer_stop (EV_A_ &timer); |
|
|
1949 | callback (EV_A_ &timer, 0); |
1914 | |
1950 | |
1915 | This technique is slightly more complex, but in most cases where the |
1951 | This technique is slightly more complex, but in most cases where the |
1916 | time-out is unlikely to be triggered, much more efficient. |
1952 | time-out is unlikely to be triggered, much more efficient. |
1917 | |
|
|
1918 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
|
|
1919 | callback :) - just change the timeout and invoke the callback, which will |
|
|
1920 | fix things for you. |
|
|
1921 | |
1953 | |
1922 | =item 4. Wee, just use a double-linked list for your timeouts. |
1954 | =item 4. Wee, just use a double-linked list for your timeouts. |
1923 | |
1955 | |
1924 | If there is not one request, but many thousands (millions...), all |
1956 | If there is not one request, but many thousands (millions...), all |
1925 | employing some kind of timeout with the same timeout value, then one can |
1957 | employing some kind of timeout with the same timeout value, then one can |
… | |
… | |
2001 | |
2033 | |
2002 | The relative timeouts are calculated relative to the C<ev_now ()> |
2034 | The relative timeouts are calculated relative to the C<ev_now ()> |
2003 | time. This is usually the right thing as this timestamp refers to the time |
2035 | time. This is usually the right thing as this timestamp refers to the time |
2004 | of the event triggering whatever timeout you are modifying/starting. If |
2036 | of the event triggering whatever timeout you are modifying/starting. If |
2005 | you suspect event processing to be delayed and you I<need> to base the |
2037 | you suspect event processing to be delayed and you I<need> to base the |
2006 | timeout on the current time, use something like this to adjust for this: |
2038 | timeout on the current time, use something like the following to adjust |
|
|
2039 | for it: |
2007 | |
2040 | |
2008 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
2041 | ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.); |
2009 | |
2042 | |
2010 | If the event loop is suspended for a long time, you can also force an |
2043 | If the event loop is suspended for a long time, you can also force an |
2011 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
2044 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
2012 | ()>. |
2045 | ()>, although that will push the event time of all outstanding events |
|
|
2046 | further into the future. |
2013 | |
2047 | |
2014 | =head3 The special problem of unsynchronised clocks |
2048 | =head3 The special problem of unsynchronised clocks |
2015 | |
2049 | |
2016 | Modern systems have a variety of clocks - libev itself uses the normal |
2050 | Modern systems have a variety of clocks - libev itself uses the normal |
2017 | "wall clock" clock and, if available, the monotonic clock (to avoid time |
2051 | "wall clock" clock and, if available, the monotonic clock (to avoid time |
… | |
… | |
2080 | |
2114 | |
2081 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
2115 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
2082 | |
2116 | |
2083 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
2117 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
2084 | |
2118 | |
2085 | Configure the timer to trigger after C<after> seconds. If C<repeat> |
2119 | Configure the timer to trigger after C<after> seconds (fractional and |
2086 | is C<0.>, then it will automatically be stopped once the timeout is |
2120 | negative values are supported). If C<repeat> is C<0.>, then it will |
2087 | reached. If it is positive, then the timer will automatically be |
2121 | automatically be stopped once the timeout is reached. If it is positive, |
2088 | configured to trigger again C<repeat> seconds later, again, and again, |
2122 | then the timer will automatically be configured to trigger again C<repeat> |
2089 | until stopped manually. |
2123 | seconds later, again, and again, until stopped manually. |
2090 | |
2124 | |
2091 | The timer itself will do a best-effort at avoiding drift, that is, if |
2125 | The timer itself will do a best-effort at avoiding drift, that is, if |
2092 | you configure a timer to trigger every 10 seconds, then it will normally |
2126 | you configure a timer to trigger every 10 seconds, then it will normally |
2093 | trigger at exactly 10 second intervals. If, however, your program cannot |
2127 | trigger at exactly 10 second intervals. If, however, your program cannot |
2094 | keep up with the timer (because it takes longer than those 10 seconds to |
2128 | keep up with the timer (because it takes longer than those 10 seconds to |
2095 | do stuff) the timer will not fire more than once per event loop iteration. |
2129 | do stuff) the timer will not fire more than once per event loop iteration. |
2096 | |
2130 | |
2097 | =item ev_timer_again (loop, ev_timer *) |
2131 | =item ev_timer_again (loop, ev_timer *) |
2098 | |
2132 | |
2099 | This will act as if the timer timed out and restarts it again if it is |
2133 | This will act as if the timer timed out, and restarts it again if it is |
2100 | repeating. The exact semantics are: |
2134 | repeating. It basically works like calling C<ev_timer_stop>, updating the |
|
|
2135 | timeout to the C<repeat> value and calling C<ev_timer_start>. |
2101 | |
2136 | |
|
|
2137 | The exact semantics are as in the following rules, all of which will be |
|
|
2138 | applied to the watcher: |
|
|
2139 | |
|
|
2140 | =over 4 |
|
|
2141 | |
2102 | If the timer is pending, its pending status is cleared. |
2142 | =item If the timer is pending, the pending status is always cleared. |
2103 | |
2143 | |
2104 | If the timer is started but non-repeating, stop it (as if it timed out). |
2144 | =item If the timer is started but non-repeating, stop it (as if it timed |
|
|
2145 | out, without invoking it). |
2105 | |
2146 | |
2106 | If the timer is repeating, either start it if necessary (with the |
2147 | =item If the timer is repeating, make the C<repeat> value the new timeout |
2107 | C<repeat> value), or reset the running timer to the C<repeat> value. |
2148 | and start the timer, if necessary. |
2108 | |
2149 | |
|
|
2150 | =back |
|
|
2151 | |
2109 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
2152 | This sounds a bit complicated, see L</Be smart about timeouts>, above, for a |
2110 | usage example. |
2153 | usage example. |
2111 | |
2154 | |
2112 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2155 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2113 | |
2156 | |
2114 | Returns the remaining time until a timer fires. If the timer is active, |
2157 | Returns the remaining time until a timer fires. If the timer is active, |
… | |
… | |
2167 | Periodic watchers are also timers of a kind, but they are very versatile |
2210 | Periodic watchers are also timers of a kind, but they are very versatile |
2168 | (and unfortunately a bit complex). |
2211 | (and unfortunately a bit complex). |
2169 | |
2212 | |
2170 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2213 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2171 | relative time, the physical time that passes) but on wall clock time |
2214 | relative time, the physical time that passes) but on wall clock time |
2172 | (absolute time, the thing you can read on your calender or clock). The |
2215 | (absolute time, the thing you can read on your calendar or clock). The |
2173 | difference is that wall clock time can run faster or slower than real |
2216 | difference is that wall clock time can run faster or slower than real |
2174 | time, and time jumps are not uncommon (e.g. when you adjust your |
2217 | time, and time jumps are not uncommon (e.g. when you adjust your |
2175 | wrist-watch). |
2218 | wrist-watch). |
2176 | |
2219 | |
2177 | You can tell a periodic watcher to trigger after some specific point |
2220 | You can tell a periodic watcher to trigger after some specific point |
… | |
… | |
2182 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
2225 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
2183 | it, as it uses a relative timeout). |
2226 | it, as it uses a relative timeout). |
2184 | |
2227 | |
2185 | C<ev_periodic> watchers can also be used to implement vastly more complex |
2228 | C<ev_periodic> watchers can also be used to implement vastly more complex |
2186 | timers, such as triggering an event on each "midnight, local time", or |
2229 | timers, such as triggering an event on each "midnight, local time", or |
2187 | other complicated rules. This cannot be done with C<ev_timer> watchers, as |
2230 | other complicated rules. This cannot easily be done with C<ev_timer> |
2188 | those cannot react to time jumps. |
2231 | watchers, as those cannot react to time jumps. |
2189 | |
2232 | |
2190 | As with timers, the callback is guaranteed to be invoked only when the |
2233 | As with timers, the callback is guaranteed to be invoked only when the |
2191 | point in time where it is supposed to trigger has passed. If multiple |
2234 | point in time where it is supposed to trigger has passed. If multiple |
2192 | timers become ready during the same loop iteration then the ones with |
2235 | timers become ready during the same loop iteration then the ones with |
2193 | earlier time-out values are invoked before ones with later time-out values |
2236 | earlier time-out values are invoked before ones with later time-out values |
… | |
… | |
2279 | |
2322 | |
2280 | NOTE: I<< This callback must always return a time that is higher than or |
2323 | NOTE: I<< This callback must always return a time that is higher than or |
2281 | equal to the passed C<now> value >>. |
2324 | equal to the passed C<now> value >>. |
2282 | |
2325 | |
2283 | This can be used to create very complex timers, such as a timer that |
2326 | This can be used to create very complex timers, such as a timer that |
2284 | triggers on "next midnight, local time". To do this, you would calculate the |
2327 | triggers on "next midnight, local time". To do this, you would calculate |
2285 | next midnight after C<now> and return the timestamp value for this. How |
2328 | the next midnight after C<now> and return the timestamp value for |
2286 | you do this is, again, up to you (but it is not trivial, which is the main |
2329 | this. Here is a (completely untested, no error checking) example on how to |
2287 | reason I omitted it as an example). |
2330 | do this: |
|
|
2331 | |
|
|
2332 | #include <time.h> |
|
|
2333 | |
|
|
2334 | static ev_tstamp |
|
|
2335 | my_rescheduler (ev_periodic *w, ev_tstamp now) |
|
|
2336 | { |
|
|
2337 | time_t tnow = (time_t)now; |
|
|
2338 | struct tm tm; |
|
|
2339 | localtime_r (&tnow, &tm); |
|
|
2340 | |
|
|
2341 | tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day |
|
|
2342 | ++tm.tm_mday; // midnight next day |
|
|
2343 | |
|
|
2344 | return mktime (&tm); |
|
|
2345 | } |
|
|
2346 | |
|
|
2347 | Note: this code might run into trouble on days that have more then two |
|
|
2348 | midnights (beginning and end). |
2288 | |
2349 | |
2289 | =back |
2350 | =back |
2290 | |
2351 | |
2291 | =item ev_periodic_again (loop, ev_periodic *) |
2352 | =item ev_periodic_again (loop, ev_periodic *) |
2292 | |
2353 | |
… | |
… | |
2357 | |
2418 | |
2358 | ev_periodic hourly_tick; |
2419 | ev_periodic hourly_tick; |
2359 | ev_periodic_init (&hourly_tick, clock_cb, |
2420 | ev_periodic_init (&hourly_tick, clock_cb, |
2360 | fmod (ev_now (loop), 3600.), 3600., 0); |
2421 | fmod (ev_now (loop), 3600.), 3600., 0); |
2361 | ev_periodic_start (loop, &hourly_tick); |
2422 | ev_periodic_start (loop, &hourly_tick); |
2362 | |
2423 | |
2363 | |
2424 | |
2364 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2425 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2365 | |
2426 | |
2366 | Signal watchers will trigger an event when the process receives a specific |
2427 | Signal watchers will trigger an event when the process receives a specific |
2367 | signal one or more times. Even though signals are very asynchronous, libev |
2428 | signal one or more times. Even though signals are very asynchronous, libev |
… | |
… | |
2377 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
2438 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
2378 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
2439 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
2379 | C<SIGINT> in both the default loop and another loop at the same time. At |
2440 | C<SIGINT> in both the default loop and another loop at the same time. At |
2380 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2441 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2381 | |
2442 | |
2382 | When the first watcher gets started will libev actually register something |
2443 | Only after the first watcher for a signal is started will libev actually |
2383 | with the kernel (thus it coexists with your own signal handlers as long as |
2444 | register something with the kernel. It thus coexists with your own signal |
2384 | you don't register any with libev for the same signal). |
2445 | handlers as long as you don't register any with libev for the same signal. |
2385 | |
2446 | |
2386 | If possible and supported, libev will install its handlers with |
2447 | If possible and supported, libev will install its handlers with |
2387 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2448 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2388 | not be unduly interrupted. If you have a problem with system calls getting |
2449 | not be unduly interrupted. If you have a problem with system calls getting |
2389 | interrupted by signals you can block all signals in an C<ev_check> watcher |
2450 | interrupted by signals you can block all signals in an C<ev_check> watcher |
… | |
… | |
2574 | |
2635 | |
2575 | =head2 C<ev_stat> - did the file attributes just change? |
2636 | =head2 C<ev_stat> - did the file attributes just change? |
2576 | |
2637 | |
2577 | This watches a file system path for attribute changes. That is, it calls |
2638 | This watches a file system path for attribute changes. That is, it calls |
2578 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2639 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2579 | and sees if it changed compared to the last time, invoking the callback if |
2640 | and sees if it changed compared to the last time, invoking the callback |
2580 | it did. |
2641 | if it did. Starting the watcher C<stat>'s the file, so only changes that |
|
|
2642 | happen after the watcher has been started will be reported. |
2581 | |
2643 | |
2582 | The path does not need to exist: changing from "path exists" to "path does |
2644 | The path does not need to exist: changing from "path exists" to "path does |
2583 | not exist" is a status change like any other. The condition "path does not |
2645 | not exist" is a status change like any other. The condition "path does not |
2584 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2646 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2585 | C<st_nlink> field being zero (which is otherwise always forced to be at |
2647 | C<st_nlink> field being zero (which is otherwise always forced to be at |
… | |
… | |
2815 | Apart from keeping your process non-blocking (which is a useful |
2877 | Apart from keeping your process non-blocking (which is a useful |
2816 | effect on its own sometimes), idle watchers are a good place to do |
2878 | effect on its own sometimes), idle watchers are a good place to do |
2817 | "pseudo-background processing", or delay processing stuff to after the |
2879 | "pseudo-background processing", or delay processing stuff to after the |
2818 | event loop has handled all outstanding events. |
2880 | event loop has handled all outstanding events. |
2819 | |
2881 | |
|
|
2882 | =head3 Abusing an C<ev_idle> watcher for its side-effect |
|
|
2883 | |
|
|
2884 | As long as there is at least one active idle watcher, libev will never |
|
|
2885 | sleep unnecessarily. Or in other words, it will loop as fast as possible. |
|
|
2886 | For this to work, the idle watcher doesn't need to be invoked at all - the |
|
|
2887 | lowest priority will do. |
|
|
2888 | |
|
|
2889 | This mode of operation can be useful together with an C<ev_check> watcher, |
|
|
2890 | to do something on each event loop iteration - for example to balance load |
|
|
2891 | between different connections. |
|
|
2892 | |
|
|
2893 | See L</Abusing an ev_check watcher for its side-effect> for a longer |
|
|
2894 | example. |
|
|
2895 | |
2820 | =head3 Watcher-Specific Functions and Data Members |
2896 | =head3 Watcher-Specific Functions and Data Members |
2821 | |
2897 | |
2822 | =over 4 |
2898 | =over 4 |
2823 | |
2899 | |
2824 | =item ev_idle_init (ev_idle *, callback) |
2900 | =item ev_idle_init (ev_idle *, callback) |
… | |
… | |
2835 | callback, free it. Also, use no error checking, as usual. |
2911 | callback, free it. Also, use no error checking, as usual. |
2836 | |
2912 | |
2837 | static void |
2913 | static void |
2838 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2914 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2839 | { |
2915 | { |
|
|
2916 | // stop the watcher |
|
|
2917 | ev_idle_stop (loop, w); |
|
|
2918 | |
|
|
2919 | // now we can free it |
2840 | free (w); |
2920 | free (w); |
|
|
2921 | |
2841 | // now do something you wanted to do when the program has |
2922 | // now do something you wanted to do when the program has |
2842 | // no longer anything immediate to do. |
2923 | // no longer anything immediate to do. |
2843 | } |
2924 | } |
2844 | |
2925 | |
2845 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
2926 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
… | |
… | |
2847 | ev_idle_start (loop, idle_watcher); |
2928 | ev_idle_start (loop, idle_watcher); |
2848 | |
2929 | |
2849 | |
2930 | |
2850 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2931 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2851 | |
2932 | |
2852 | Prepare and check watchers are usually (but not always) used in pairs: |
2933 | Prepare and check watchers are often (but not always) used in pairs: |
2853 | prepare watchers get invoked before the process blocks and check watchers |
2934 | prepare watchers get invoked before the process blocks and check watchers |
2854 | afterwards. |
2935 | afterwards. |
2855 | |
2936 | |
2856 | You I<must not> call C<ev_run> or similar functions that enter |
2937 | You I<must not> call C<ev_run> (or similar functions that enter the |
2857 | the current event loop from either C<ev_prepare> or C<ev_check> |
2938 | current event loop) or C<ev_loop_fork> from either C<ev_prepare> or |
2858 | watchers. Other loops than the current one are fine, however. The |
2939 | C<ev_check> watchers. Other loops than the current one are fine, |
2859 | rationale behind this is that you do not need to check for recursion in |
2940 | however. The rationale behind this is that you do not need to check |
2860 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
2941 | for recursion in those watchers, i.e. the sequence will always be |
2861 | C<ev_check> so if you have one watcher of each kind they will always be |
2942 | C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each |
2862 | called in pairs bracketing the blocking call. |
2943 | kind they will always be called in pairs bracketing the blocking call. |
2863 | |
2944 | |
2864 | Their main purpose is to integrate other event mechanisms into libev and |
2945 | Their main purpose is to integrate other event mechanisms into libev and |
2865 | their use is somewhat advanced. They could be used, for example, to track |
2946 | their use is somewhat advanced. They could be used, for example, to track |
2866 | variable changes, implement your own watchers, integrate net-snmp or a |
2947 | variable changes, implement your own watchers, integrate net-snmp or a |
2867 | coroutine library and lots more. They are also occasionally useful if |
2948 | coroutine library and lots more. They are also occasionally useful if |
… | |
… | |
2885 | with priority higher than or equal to the event loop and one coroutine |
2966 | with priority higher than or equal to the event loop and one coroutine |
2886 | of lower priority, but only once, using idle watchers to keep the event |
2967 | of lower priority, but only once, using idle watchers to keep the event |
2887 | loop from blocking if lower-priority coroutines are active, thus mapping |
2968 | loop from blocking if lower-priority coroutines are active, thus mapping |
2888 | low-priority coroutines to idle/background tasks). |
2969 | low-priority coroutines to idle/background tasks). |
2889 | |
2970 | |
2890 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
2971 | When used for this purpose, it is recommended to give C<ev_check> watchers |
2891 | priority, to ensure that they are being run before any other watchers |
2972 | highest (C<EV_MAXPRI>) priority, to ensure that they are being run before |
2892 | after the poll (this doesn't matter for C<ev_prepare> watchers). |
2973 | any other watchers after the poll (this doesn't matter for C<ev_prepare> |
|
|
2974 | watchers). |
2893 | |
2975 | |
2894 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
2976 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
2895 | activate ("feed") events into libev. While libev fully supports this, they |
2977 | activate ("feed") events into libev. While libev fully supports this, they |
2896 | might get executed before other C<ev_check> watchers did their job. As |
2978 | might get executed before other C<ev_check> watchers did their job. As |
2897 | C<ev_check> watchers are often used to embed other (non-libev) event |
2979 | C<ev_check> watchers are often used to embed other (non-libev) event |
2898 | loops those other event loops might be in an unusable state until their |
2980 | loops those other event loops might be in an unusable state until their |
2899 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
2981 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
2900 | others). |
2982 | others). |
|
|
2983 | |
|
|
2984 | =head3 Abusing an C<ev_check> watcher for its side-effect |
|
|
2985 | |
|
|
2986 | C<ev_check> (and less often also C<ev_prepare>) watchers can also be |
|
|
2987 | useful because they are called once per event loop iteration. For |
|
|
2988 | example, if you want to handle a large number of connections fairly, you |
|
|
2989 | normally only do a bit of work for each active connection, and if there |
|
|
2990 | is more work to do, you wait for the next event loop iteration, so other |
|
|
2991 | connections have a chance of making progress. |
|
|
2992 | |
|
|
2993 | Using an C<ev_check> watcher is almost enough: it will be called on the |
|
|
2994 | next event loop iteration. However, that isn't as soon as possible - |
|
|
2995 | without external events, your C<ev_check> watcher will not be invoked. |
|
|
2996 | |
|
|
2997 | This is where C<ev_idle> watchers come in handy - all you need is a |
|
|
2998 | single global idle watcher that is active as long as you have one active |
|
|
2999 | C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop |
|
|
3000 | will not sleep, and the C<ev_check> watcher makes sure a callback gets |
|
|
3001 | invoked. Neither watcher alone can do that. |
2901 | |
3002 | |
2902 | =head3 Watcher-Specific Functions and Data Members |
3003 | =head3 Watcher-Specific Functions and Data Members |
2903 | |
3004 | |
2904 | =over 4 |
3005 | =over 4 |
2905 | |
3006 | |
… | |
… | |
3106 | |
3207 | |
3107 | =over 4 |
3208 | =over 4 |
3108 | |
3209 | |
3109 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3210 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3110 | |
3211 | |
3111 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
3212 | =item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop) |
3112 | |
3213 | |
3113 | Configures the watcher to embed the given loop, which must be |
3214 | Configures the watcher to embed the given loop, which must be |
3114 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3215 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3115 | invoked automatically, otherwise it is the responsibility of the callback |
3216 | invoked automatically, otherwise it is the responsibility of the callback |
3116 | to invoke it (it will continue to be called until the sweep has been done, |
3217 | to invoke it (it will continue to be called until the sweep has been done, |
… | |
… | |
3137 | used). |
3238 | used). |
3138 | |
3239 | |
3139 | struct ev_loop *loop_hi = ev_default_init (0); |
3240 | struct ev_loop *loop_hi = ev_default_init (0); |
3140 | struct ev_loop *loop_lo = 0; |
3241 | struct ev_loop *loop_lo = 0; |
3141 | ev_embed embed; |
3242 | ev_embed embed; |
3142 | |
3243 | |
3143 | // see if there is a chance of getting one that works |
3244 | // see if there is a chance of getting one that works |
3144 | // (remember that a flags value of 0 means autodetection) |
3245 | // (remember that a flags value of 0 means autodetection) |
3145 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3246 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3146 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3247 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3147 | : 0; |
3248 | : 0; |
… | |
… | |
3161 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3262 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3162 | |
3263 | |
3163 | struct ev_loop *loop = ev_default_init (0); |
3264 | struct ev_loop *loop = ev_default_init (0); |
3164 | struct ev_loop *loop_socket = 0; |
3265 | struct ev_loop *loop_socket = 0; |
3165 | ev_embed embed; |
3266 | ev_embed embed; |
3166 | |
3267 | |
3167 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3268 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3168 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3269 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3169 | { |
3270 | { |
3170 | ev_embed_init (&embed, 0, loop_socket); |
3271 | ev_embed_init (&embed, 0, loop_socket); |
3171 | ev_embed_start (loop, &embed); |
3272 | ev_embed_start (loop, &embed); |
… | |
… | |
3179 | |
3280 | |
3180 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3281 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3181 | |
3282 | |
3182 | Fork watchers are called when a C<fork ()> was detected (usually because |
3283 | Fork watchers are called when a C<fork ()> was detected (usually because |
3183 | whoever is a good citizen cared to tell libev about it by calling |
3284 | whoever is a good citizen cared to tell libev about it by calling |
3184 | C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the |
3285 | C<ev_loop_fork>). The invocation is done before the event loop blocks next |
3185 | event loop blocks next and before C<ev_check> watchers are being called, |
3286 | and before C<ev_check> watchers are being called, and only in the child |
3186 | and only in the child after the fork. If whoever good citizen calling |
3287 | after the fork. If whoever good citizen calling C<ev_default_fork> cheats |
3187 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
3288 | and calls it in the wrong process, the fork handlers will be invoked, too, |
3188 | handlers will be invoked, too, of course. |
3289 | of course. |
3189 | |
3290 | |
3190 | =head3 The special problem of life after fork - how is it possible? |
3291 | =head3 The special problem of life after fork - how is it possible? |
3191 | |
3292 | |
3192 | Most uses of C<fork()> consist of forking, then some simple calls to set |
3293 | Most uses of C<fork ()> consist of forking, then some simple calls to set |
3193 | up/change the process environment, followed by a call to C<exec()>. This |
3294 | up/change the process environment, followed by a call to C<exec()>. This |
3194 | sequence should be handled by libev without any problems. |
3295 | sequence should be handled by libev without any problems. |
3195 | |
3296 | |
3196 | This changes when the application actually wants to do event handling |
3297 | This changes when the application actually wants to do event handling |
3197 | in the child, or both parent in child, in effect "continuing" after the |
3298 | in the child, or both parent in child, in effect "continuing" after the |
… | |
… | |
3286 | it by calling C<ev_async_send>, which is thread- and signal safe. |
3387 | it by calling C<ev_async_send>, which is thread- and signal safe. |
3287 | |
3388 | |
3288 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3389 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3289 | too, are asynchronous in nature, and signals, too, will be compressed |
3390 | too, are asynchronous in nature, and signals, too, will be compressed |
3290 | (i.e. the number of callback invocations may be less than the number of |
3391 | (i.e. the number of callback invocations may be less than the number of |
3291 | C<ev_async_sent> calls). In fact, you could use signal watchers as a kind |
3392 | C<ev_async_send> calls). In fact, you could use signal watchers as a kind |
3292 | of "global async watchers" by using a watcher on an otherwise unused |
3393 | of "global async watchers" by using a watcher on an otherwise unused |
3293 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3394 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3294 | even without knowing which loop owns the signal. |
3395 | even without knowing which loop owns the signal. |
3295 | |
3396 | |
3296 | =head3 Queueing |
3397 | =head3 Queueing |
… | |
… | |
3435 | |
3536 | |
3436 | There are some other functions of possible interest. Described. Here. Now. |
3537 | There are some other functions of possible interest. Described. Here. Now. |
3437 | |
3538 | |
3438 | =over 4 |
3539 | =over 4 |
3439 | |
3540 | |
3440 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
3541 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg) |
3441 | |
3542 | |
3442 | This function combines a simple timer and an I/O watcher, calls your |
3543 | This function combines a simple timer and an I/O watcher, calls your |
3443 | callback on whichever event happens first and automatically stops both |
3544 | callback on whichever event happens first and automatically stops both |
3444 | watchers. This is useful if you want to wait for a single event on an fd |
3545 | watchers. This is useful if you want to wait for a single event on an fd |
3445 | or timeout without having to allocate/configure/start/stop/free one or |
3546 | or timeout without having to allocate/configure/start/stop/free one or |
… | |
… | |
3557 | { |
3658 | { |
3558 | struct my_biggy big = (struct my_biggy *) |
3659 | struct my_biggy big = (struct my_biggy *) |
3559 | (((char *)w) - offsetof (struct my_biggy, t2)); |
3660 | (((char *)w) - offsetof (struct my_biggy, t2)); |
3560 | } |
3661 | } |
3561 | |
3662 | |
|
|
3663 | =head2 AVOIDING FINISHING BEFORE RETURNING |
|
|
3664 | |
|
|
3665 | Often you have structures like this in event-based programs: |
|
|
3666 | |
|
|
3667 | callback () |
|
|
3668 | { |
|
|
3669 | free (request); |
|
|
3670 | } |
|
|
3671 | |
|
|
3672 | request = start_new_request (..., callback); |
|
|
3673 | |
|
|
3674 | The intent is to start some "lengthy" operation. The C<request> could be |
|
|
3675 | used to cancel the operation, or do other things with it. |
|
|
3676 | |
|
|
3677 | It's not uncommon to have code paths in C<start_new_request> that |
|
|
3678 | immediately invoke the callback, for example, to report errors. Or you add |
|
|
3679 | some caching layer that finds that it can skip the lengthy aspects of the |
|
|
3680 | operation and simply invoke the callback with the result. |
|
|
3681 | |
|
|
3682 | The problem here is that this will happen I<before> C<start_new_request> |
|
|
3683 | has returned, so C<request> is not set. |
|
|
3684 | |
|
|
3685 | Even if you pass the request by some safer means to the callback, you |
|
|
3686 | might want to do something to the request after starting it, such as |
|
|
3687 | canceling it, which probably isn't working so well when the callback has |
|
|
3688 | already been invoked. |
|
|
3689 | |
|
|
3690 | A common way around all these issues is to make sure that |
|
|
3691 | C<start_new_request> I<always> returns before the callback is invoked. If |
|
|
3692 | C<start_new_request> immediately knows the result, it can artificially |
|
|
3693 | delay invoking the callback by using a C<prepare> or C<idle> watcher for |
|
|
3694 | example, or more sneakily, by reusing an existing (stopped) watcher and |
|
|
3695 | pushing it into the pending queue: |
|
|
3696 | |
|
|
3697 | ev_set_cb (watcher, callback); |
|
|
3698 | ev_feed_event (EV_A_ watcher, 0); |
|
|
3699 | |
|
|
3700 | This way, C<start_new_request> can safely return before the callback is |
|
|
3701 | invoked, while not delaying callback invocation too much. |
|
|
3702 | |
3562 | =head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS |
3703 | =head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS |
3563 | |
3704 | |
3564 | Often (especially in GUI toolkits) there are places where you have |
3705 | Often (especially in GUI toolkits) there are places where you have |
3565 | I<modal> interaction, which is most easily implemented by recursively |
3706 | I<modal> interaction, which is most easily implemented by recursively |
3566 | invoking C<ev_run>. |
3707 | invoking C<ev_run>. |
3567 | |
3708 | |
3568 | This brings the problem of exiting - a callback might want to finish the |
3709 | This brings the problem of exiting - a callback might want to finish the |
3569 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3710 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3570 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3711 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3571 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3712 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3572 | other combination: In these cases, C<ev_break> will not work alone. |
3713 | other combination: In these cases, a simple C<ev_break> will not work. |
3573 | |
3714 | |
3574 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3715 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3575 | invocation, and use a loop around C<ev_run> until the condition is |
3716 | invocation, and use a loop around C<ev_run> until the condition is |
3576 | triggered, using C<EVRUN_ONCE>: |
3717 | triggered, using C<EVRUN_ONCE>: |
3577 | |
3718 | |
… | |
… | |
3579 | int exit_main_loop = 0; |
3720 | int exit_main_loop = 0; |
3580 | |
3721 | |
3581 | while (!exit_main_loop) |
3722 | while (!exit_main_loop) |
3582 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3723 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3583 | |
3724 | |
3584 | // in a model watcher |
3725 | // in a modal watcher |
3585 | int exit_nested_loop = 0; |
3726 | int exit_nested_loop = 0; |
3586 | |
3727 | |
3587 | while (!exit_nested_loop) |
3728 | while (!exit_nested_loop) |
3588 | ev_run (EV_A_ EVRUN_ONCE); |
3729 | ev_run (EV_A_ EVRUN_ONCE); |
3589 | |
3730 | |
… | |
… | |
3763 | called): |
3904 | called): |
3764 | |
3905 | |
3765 | void |
3906 | void |
3766 | wait_for_event (ev_watcher *w) |
3907 | wait_for_event (ev_watcher *w) |
3767 | { |
3908 | { |
3768 | ev_cb_set (w) = current_coro; |
3909 | ev_set_cb (w, current_coro); |
3769 | switch_to (libev_coro); |
3910 | switch_to (libev_coro); |
3770 | } |
3911 | } |
3771 | |
3912 | |
3772 | That basically suspends the coroutine inside C<wait_for_event> and |
3913 | That basically suspends the coroutine inside C<wait_for_event> and |
3773 | continues the libev coroutine, which, when appropriate, switches back to |
3914 | continues the libev coroutine, which, when appropriate, switches back to |
3774 | this or any other coroutine. I am sure if you sue this your own :) |
3915 | this or any other coroutine. |
3775 | |
3916 | |
3776 | You can do similar tricks if you have, say, threads with an event queue - |
3917 | You can do similar tricks if you have, say, threads with an event queue - |
3777 | instead of storing a coroutine, you store the queue object and instead of |
3918 | instead of storing a coroutine, you store the queue object and instead of |
3778 | switching to a coroutine, you push the watcher onto the queue and notify |
3919 | switching to a coroutine, you push the watcher onto the queue and notify |
3779 | any waiters. |
3920 | any waiters. |
3780 | |
3921 | |
3781 | To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two |
3922 | To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two |
3782 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3923 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3783 | |
3924 | |
3784 | // my_ev.h |
3925 | // my_ev.h |
3785 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3926 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3786 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); |
3927 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb) |
3787 | #include "../libev/ev.h" |
3928 | #include "../libev/ev.h" |
3788 | |
3929 | |
3789 | // my_ev.c |
3930 | // my_ev.c |
3790 | #define EV_H "my_ev.h" |
3931 | #define EV_H "my_ev.h" |
3791 | #include "../libev/ev.c" |
3932 | #include "../libev/ev.c" |
… | |
… | |
3830 | |
3971 | |
3831 | =back |
3972 | =back |
3832 | |
3973 | |
3833 | =head1 C++ SUPPORT |
3974 | =head1 C++ SUPPORT |
3834 | |
3975 | |
|
|
3976 | =head2 C API |
|
|
3977 | |
|
|
3978 | The normal C API should work fine when used from C++: both ev.h and the |
|
|
3979 | libev sources can be compiled as C++. Therefore, code that uses the C API |
|
|
3980 | will work fine. |
|
|
3981 | |
|
|
3982 | Proper exception specifications might have to be added to callbacks passed |
|
|
3983 | to libev: exceptions may be thrown only from watcher callbacks, all |
|
|
3984 | other callbacks (allocator, syserr, loop acquire/release and periodic |
|
|
3985 | reschedule callbacks) must not throw exceptions, and might need a C<throw |
|
|
3986 | ()> specification. If you have code that needs to be compiled as both C |
|
|
3987 | and C++ you can use the C<EV_THROW> macro for this: |
|
|
3988 | |
|
|
3989 | static void |
|
|
3990 | fatal_error (const char *msg) EV_THROW |
|
|
3991 | { |
|
|
3992 | perror (msg); |
|
|
3993 | abort (); |
|
|
3994 | } |
|
|
3995 | |
|
|
3996 | ... |
|
|
3997 | ev_set_syserr_cb (fatal_error); |
|
|
3998 | |
|
|
3999 | The only API functions that can currently throw exceptions are C<ev_run>, |
|
|
4000 | C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter |
|
|
4001 | because it runs cleanup watchers). |
|
|
4002 | |
|
|
4003 | Throwing exceptions in watcher callbacks is only supported if libev itself |
|
|
4004 | is compiled with a C++ compiler or your C and C++ environments allow |
|
|
4005 | throwing exceptions through C libraries (most do). |
|
|
4006 | |
|
|
4007 | =head2 C++ API |
|
|
4008 | |
3835 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
4009 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
3836 | you to use some convenience methods to start/stop watchers and also change |
4010 | you to use some convenience methods to start/stop watchers and also change |
3837 | the callback model to a model using method callbacks on objects. |
4011 | the callback model to a model using method callbacks on objects. |
3838 | |
4012 | |
3839 | To use it, |
4013 | To use it, |
3840 | |
4014 | |
3841 | #include <ev++.h> |
4015 | #include <ev++.h> |
3842 | |
4016 | |
3843 | This automatically includes F<ev.h> and puts all of its definitions (many |
4017 | This automatically includes F<ev.h> and puts all of its definitions (many |
3844 | of them macros) into the global namespace. All C++ specific things are |
4018 | of them macros) into the global namespace. All C++ specific things are |
3845 | put into the C<ev> namespace. It should support all the same embedding |
4019 | put into the C<ev> namespace. It should support all the same embedding |
… | |
… | |
3854 | with C<operator ()> can be used as callbacks. Other types should be easy |
4028 | with C<operator ()> can be used as callbacks. Other types should be easy |
3855 | to add as long as they only need one additional pointer for context. If |
4029 | to add as long as they only need one additional pointer for context. If |
3856 | you need support for other types of functors please contact the author |
4030 | you need support for other types of functors please contact the author |
3857 | (preferably after implementing it). |
4031 | (preferably after implementing it). |
3858 | |
4032 | |
|
|
4033 | For all this to work, your C++ compiler either has to use the same calling |
|
|
4034 | conventions as your C compiler (for static member functions), or you have |
|
|
4035 | to embed libev and compile libev itself as C++. |
|
|
4036 | |
3859 | Here is a list of things available in the C<ev> namespace: |
4037 | Here is a list of things available in the C<ev> namespace: |
3860 | |
4038 | |
3861 | =over 4 |
4039 | =over 4 |
3862 | |
4040 | |
3863 | =item C<ev::READ>, C<ev::WRITE> etc. |
4041 | =item C<ev::READ>, C<ev::WRITE> etc. |
… | |
… | |
3872 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
4050 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
3873 | |
4051 | |
3874 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
4052 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
3875 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
4053 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
3876 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
4054 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
3877 | defines by many implementations. |
4055 | defined by many implementations. |
3878 | |
4056 | |
3879 | All of those classes have these methods: |
4057 | All of those classes have these methods: |
3880 | |
4058 | |
3881 | =over 4 |
4059 | =over 4 |
3882 | |
4060 | |
… | |
… | |
3944 | void operator() (ev::io &w, int revents) |
4122 | void operator() (ev::io &w, int revents) |
3945 | { |
4123 | { |
3946 | ... |
4124 | ... |
3947 | } |
4125 | } |
3948 | } |
4126 | } |
3949 | |
4127 | |
3950 | myfunctor f; |
4128 | myfunctor f; |
3951 | |
4129 | |
3952 | ev::io w; |
4130 | ev::io w; |
3953 | w.set (&f); |
4131 | w.set (&f); |
3954 | |
4132 | |
… | |
… | |
3972 | Associates a different C<struct ev_loop> with this watcher. You can only |
4150 | Associates a different C<struct ev_loop> with this watcher. You can only |
3973 | do this when the watcher is inactive (and not pending either). |
4151 | do this when the watcher is inactive (and not pending either). |
3974 | |
4152 | |
3975 | =item w->set ([arguments]) |
4153 | =item w->set ([arguments]) |
3976 | |
4154 | |
3977 | Basically the same as C<ev_TYPE_set>, with the same arguments. Either this |
4155 | Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>), |
3978 | method or a suitable start method must be called at least once. Unlike the |
4156 | with the same arguments. Either this method or a suitable start method |
3979 | C counterpart, an active watcher gets automatically stopped and restarted |
4157 | must be called at least once. Unlike the C counterpart, an active watcher |
3980 | when reconfiguring it with this method. |
4158 | gets automatically stopped and restarted when reconfiguring it with this |
|
|
4159 | method. |
|
|
4160 | |
|
|
4161 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
|
|
4162 | clashing with the C<set (loop)> method. |
3981 | |
4163 | |
3982 | =item w->start () |
4164 | =item w->start () |
3983 | |
4165 | |
3984 | Starts the watcher. Note that there is no C<loop> argument, as the |
4166 | Starts the watcher. Note that there is no C<loop> argument, as the |
3985 | constructor already stores the event loop. |
4167 | constructor already stores the event loop. |
… | |
… | |
4089 | |
4271 | |
4090 | Brian Maher has written a partial interface to libev for lua (at the |
4272 | Brian Maher has written a partial interface to libev for lua (at the |
4091 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4273 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4092 | L<http://github.com/brimworks/lua-ev>. |
4274 | L<http://github.com/brimworks/lua-ev>. |
4093 | |
4275 | |
|
|
4276 | =item Javascript |
|
|
4277 | |
|
|
4278 | Node.js (L<http://nodejs.org>) uses libev as the underlying event library. |
|
|
4279 | |
|
|
4280 | =item Others |
|
|
4281 | |
|
|
4282 | There are others, and I stopped counting. |
|
|
4283 | |
4094 | =back |
4284 | =back |
4095 | |
4285 | |
4096 | |
4286 | |
4097 | =head1 MACRO MAGIC |
4287 | =head1 MACRO MAGIC |
4098 | |
4288 | |
… | |
… | |
4215 | ev_vars.h |
4405 | ev_vars.h |
4216 | ev_wrap.h |
4406 | ev_wrap.h |
4217 | |
4407 | |
4218 | ev_win32.c required on win32 platforms only |
4408 | ev_win32.c required on win32 platforms only |
4219 | |
4409 | |
4220 | ev_select.c only when select backend is enabled (which is enabled by default) |
4410 | ev_select.c only when select backend is enabled |
4221 | ev_poll.c only when poll backend is enabled (disabled by default) |
4411 | ev_poll.c only when poll backend is enabled |
4222 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
4412 | ev_epoll.c only when the epoll backend is enabled |
4223 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
4413 | ev_kqueue.c only when the kqueue backend is enabled |
4224 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
4414 | ev_port.c only when the solaris port backend is enabled |
4225 | |
4415 | |
4226 | F<ev.c> includes the backend files directly when enabled, so you only need |
4416 | F<ev.c> includes the backend files directly when enabled, so you only need |
4227 | to compile this single file. |
4417 | to compile this single file. |
4228 | |
4418 | |
4229 | =head3 LIBEVENT COMPATIBILITY API |
4419 | =head3 LIBEVENT COMPATIBILITY API |
… | |
… | |
4396 | |
4586 | |
4397 | If programs implement their own fd to handle mapping on win32, then this |
4587 | If programs implement their own fd to handle mapping on win32, then this |
4398 | macro can be used to override the C<close> function, useful to unregister |
4588 | macro can be used to override the C<close> function, useful to unregister |
4399 | file descriptors again. Note that the replacement function has to close |
4589 | file descriptors again. Note that the replacement function has to close |
4400 | the underlying OS handle. |
4590 | the underlying OS handle. |
|
|
4591 | |
|
|
4592 | =item EV_USE_WSASOCKET |
|
|
4593 | |
|
|
4594 | If defined to be C<1>, libev will use C<WSASocket> to create its internal |
|
|
4595 | communication socket, which works better in some environments. Otherwise, |
|
|
4596 | the normal C<socket> function will be used, which works better in other |
|
|
4597 | environments. |
4401 | |
4598 | |
4402 | =item EV_USE_POLL |
4599 | =item EV_USE_POLL |
4403 | |
4600 | |
4404 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4601 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4405 | backend. Otherwise it will be enabled on non-win32 platforms. It |
4602 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
4441 | If defined to be C<1>, libev will compile in support for the Linux inotify |
4638 | If defined to be C<1>, libev will compile in support for the Linux inotify |
4442 | interface to speed up C<ev_stat> watchers. Its actual availability will |
4639 | interface to speed up C<ev_stat> watchers. Its actual availability will |
4443 | be detected at runtime. If undefined, it will be enabled if the headers |
4640 | be detected at runtime. If undefined, it will be enabled if the headers |
4444 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4641 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4445 | |
4642 | |
|
|
4643 | =item EV_NO_SMP |
|
|
4644 | |
|
|
4645 | If defined to be C<1>, libev will assume that memory is always coherent |
|
|
4646 | between threads, that is, threads can be used, but threads never run on |
|
|
4647 | different cpus (or different cpu cores). This reduces dependencies |
|
|
4648 | and makes libev faster. |
|
|
4649 | |
|
|
4650 | =item EV_NO_THREADS |
|
|
4651 | |
|
|
4652 | If defined to be C<1>, libev will assume that it will never be called from |
|
|
4653 | different threads (that includes signal handlers), which is a stronger |
|
|
4654 | assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes |
|
|
4655 | libev faster. |
|
|
4656 | |
4446 | =item EV_ATOMIC_T |
4657 | =item EV_ATOMIC_T |
4447 | |
4658 | |
4448 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4659 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4449 | access is atomic and serialised with respect to other threads or signal |
4660 | access is atomic with respect to other threads or signal contexts. No |
4450 | contexts. No such type is easily found in the C language, so you can |
4661 | such type is easily found in the C language, so you can provide your own |
4451 | provide your own type that you know is safe for your purposes. It is used |
4662 | type that you know is safe for your purposes. It is used both for signal |
4452 | both for signal handler "locking" as well as for signal and thread safety |
4663 | handler "locking" as well as for signal and thread safety in C<ev_async> |
4453 | in C<ev_async> watchers. |
4664 | watchers. |
4454 | |
4665 | |
4455 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4666 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4456 | (from F<signal.h>), which is usually good enough on most platforms, |
4667 | (from F<signal.h>), which is usually good enough on most platforms. |
4457 | although strictly speaking using a type that also implies a memory fence |
|
|
4458 | is required. |
|
|
4459 | |
4668 | |
4460 | =item EV_H (h) |
4669 | =item EV_H (h) |
4461 | |
4670 | |
4462 | The name of the F<ev.h> header file used to include it. The default if |
4671 | The name of the F<ev.h> header file used to include it. The default if |
4463 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
4672 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
… | |
… | |
4536 | #define EV_USE_POLL 1 |
4745 | #define EV_USE_POLL 1 |
4537 | #define EV_CHILD_ENABLE 1 |
4746 | #define EV_CHILD_ENABLE 1 |
4538 | #define EV_ASYNC_ENABLE 1 |
4747 | #define EV_ASYNC_ENABLE 1 |
4539 | |
4748 | |
4540 | The actual value is a bitset, it can be a combination of the following |
4749 | The actual value is a bitset, it can be a combination of the following |
4541 | values: |
4750 | values (by default, all of these are enabled): |
4542 | |
4751 | |
4543 | =over 4 |
4752 | =over 4 |
4544 | |
4753 | |
4545 | =item C<1> - faster/larger code |
4754 | =item C<1> - faster/larger code |
4546 | |
4755 | |
… | |
… | |
4550 | code size by roughly 30% on amd64). |
4759 | code size by roughly 30% on amd64). |
4551 | |
4760 | |
4552 | When optimising for size, use of compiler flags such as C<-Os> with |
4761 | When optimising for size, use of compiler flags such as C<-Os> with |
4553 | gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of |
4762 | gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of |
4554 | assertions. |
4763 | assertions. |
|
|
4764 | |
|
|
4765 | The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler |
|
|
4766 | (e.g. gcc with C<-Os>). |
4555 | |
4767 | |
4556 | =item C<2> - faster/larger data structures |
4768 | =item C<2> - faster/larger data structures |
4557 | |
4769 | |
4558 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
4770 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
4559 | hash table sizes and so on. This will usually further increase code size |
4771 | hash table sizes and so on. This will usually further increase code size |
4560 | and can additionally have an effect on the size of data structures at |
4772 | and can additionally have an effect on the size of data structures at |
4561 | runtime. |
4773 | runtime. |
4562 | |
4774 | |
|
|
4775 | The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler |
|
|
4776 | (e.g. gcc with C<-Os>). |
|
|
4777 | |
4563 | =item C<4> - full API configuration |
4778 | =item C<4> - full API configuration |
4564 | |
4779 | |
4565 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
4780 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
4566 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
4781 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
4567 | |
4782 | |
… | |
… | |
4597 | |
4812 | |
4598 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
4813 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
4599 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
4814 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
4600 | your program might be left out as well - a binary starting a timer and an |
4815 | your program might be left out as well - a binary starting a timer and an |
4601 | I/O watcher then might come out at only 5Kb. |
4816 | I/O watcher then might come out at only 5Kb. |
|
|
4817 | |
|
|
4818 | =item EV_API_STATIC |
|
|
4819 | |
|
|
4820 | If this symbol is defined (by default it is not), then all identifiers |
|
|
4821 | will have static linkage. This means that libev will not export any |
|
|
4822 | identifiers, and you cannot link against libev anymore. This can be useful |
|
|
4823 | when you embed libev, only want to use libev functions in a single file, |
|
|
4824 | and do not want its identifiers to be visible. |
|
|
4825 | |
|
|
4826 | To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that |
|
|
4827 | wants to use libev. |
|
|
4828 | |
|
|
4829 | This option only works when libev is compiled with a C compiler, as C++ |
|
|
4830 | doesn't support the required declaration syntax. |
4602 | |
4831 | |
4603 | =item EV_AVOID_STDIO |
4832 | =item EV_AVOID_STDIO |
4604 | |
4833 | |
4605 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
4834 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
4606 | functions (printf, scanf, perror etc.). This will increase the code size |
4835 | functions (printf, scanf, perror etc.). This will increase the code size |
… | |
… | |
4811 | default loop and triggering an C<ev_async> watcher from the default loop |
5040 | default loop and triggering an C<ev_async> watcher from the default loop |
4812 | watcher callback into the event loop interested in the signal. |
5041 | watcher callback into the event loop interested in the signal. |
4813 | |
5042 | |
4814 | =back |
5043 | =back |
4815 | |
5044 | |
4816 | See also L<THREAD LOCKING EXAMPLE>. |
5045 | See also L</THREAD LOCKING EXAMPLE>. |
4817 | |
5046 | |
4818 | =head3 COROUTINES |
5047 | =head3 COROUTINES |
4819 | |
5048 | |
4820 | Libev is very accommodating to coroutines ("cooperative threads"): |
5049 | Libev is very accommodating to coroutines ("cooperative threads"): |
4821 | libev fully supports nesting calls to its functions from different |
5050 | libev fully supports nesting calls to its functions from different |
… | |
… | |
5090 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
5319 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
5091 | assumes that the same (machine) code can be used to call any watcher |
5320 | assumes that the same (machine) code can be used to call any watcher |
5092 | callback: The watcher callbacks have different type signatures, but libev |
5321 | callback: The watcher callbacks have different type signatures, but libev |
5093 | calls them using an C<ev_watcher *> internally. |
5322 | calls them using an C<ev_watcher *> internally. |
5094 | |
5323 | |
|
|
5324 | =item null pointers and integer zero are represented by 0 bytes |
|
|
5325 | |
|
|
5326 | Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and |
|
|
5327 | relies on this setting pointers and integers to null. |
|
|
5328 | |
5095 | =item pointer accesses must be thread-atomic |
5329 | =item pointer accesses must be thread-atomic |
5096 | |
5330 | |
5097 | Accessing a pointer value must be atomic, it must both be readable and |
5331 | Accessing a pointer value must be atomic, it must both be readable and |
5098 | writable in one piece - this is the case on all current architectures. |
5332 | writable in one piece - this is the case on all current architectures. |
5099 | |
5333 | |
… | |
… | |
5112 | thread" or will block signals process-wide, both behaviours would |
5346 | thread" or will block signals process-wide, both behaviours would |
5113 | be compatible with libev. Interaction between C<sigprocmask> and |
5347 | be compatible with libev. Interaction between C<sigprocmask> and |
5114 | C<pthread_sigmask> could complicate things, however. |
5348 | C<pthread_sigmask> could complicate things, however. |
5115 | |
5349 | |
5116 | The most portable way to handle signals is to block signals in all threads |
5350 | The most portable way to handle signals is to block signals in all threads |
5117 | except the initial one, and run the default loop in the initial thread as |
5351 | except the initial one, and run the signal handling loop in the initial |
5118 | well. |
5352 | thread as well. |
5119 | |
5353 | |
5120 | =item C<long> must be large enough for common memory allocation sizes |
5354 | =item C<long> must be large enough for common memory allocation sizes |
5121 | |
5355 | |
5122 | To improve portability and simplify its API, libev uses C<long> internally |
5356 | To improve portability and simplify its API, libev uses C<long> internally |
5123 | instead of C<size_t> when allocating its data structures. On non-POSIX |
5357 | instead of C<size_t> when allocating its data structures. On non-POSIX |
… | |
… | |
5227 | =over 4 |
5461 | =over 4 |
5228 | |
5462 | |
5229 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5463 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5230 | |
5464 | |
5231 | The backward compatibility mechanism can be controlled by |
5465 | The backward compatibility mechanism can be controlled by |
5232 | C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> |
5466 | C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING> |
5233 | section. |
5467 | section. |
5234 | |
5468 | |
5235 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5469 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5236 | |
5470 | |
5237 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
5471 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
… | |
… | |
5280 | =over 4 |
5514 | =over 4 |
5281 | |
5515 | |
5282 | =item active |
5516 | =item active |
5283 | |
5517 | |
5284 | A watcher is active as long as it has been started and not yet stopped. |
5518 | A watcher is active as long as it has been started and not yet stopped. |
5285 | See L<WATCHER STATES> for details. |
5519 | See L</WATCHER STATES> for details. |
5286 | |
5520 | |
5287 | =item application |
5521 | =item application |
5288 | |
5522 | |
5289 | In this document, an application is whatever is using libev. |
5523 | In this document, an application is whatever is using libev. |
5290 | |
5524 | |
… | |
… | |
5326 | watchers and events. |
5560 | watchers and events. |
5327 | |
5561 | |
5328 | =item pending |
5562 | =item pending |
5329 | |
5563 | |
5330 | A watcher is pending as soon as the corresponding event has been |
5564 | A watcher is pending as soon as the corresponding event has been |
5331 | detected. See L<WATCHER STATES> for details. |
5565 | detected. See L</WATCHER STATES> for details. |
5332 | |
5566 | |
5333 | =item real time |
5567 | =item real time |
5334 | |
5568 | |
5335 | The physical time that is observed. It is apparently strictly monotonic :) |
5569 | The physical time that is observed. It is apparently strictly monotonic :) |
5336 | |
5570 | |