|
|
1 | =encoding utf-8 |
|
|
2 | |
1 | =head1 NAME |
3 | =head1 NAME |
2 | |
4 | |
3 | libev - a high performance full-featured event loop written in C |
5 | libev - a high performance full-featured event loop written in C |
4 | |
6 | |
5 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
… | |
… | |
82 | |
84 | |
83 | =head1 WHAT TO READ WHEN IN A HURRY |
85 | =head1 WHAT TO READ WHEN IN A HURRY |
84 | |
86 | |
85 | This manual tries to be very detailed, but unfortunately, this also makes |
87 | This manual tries to be very detailed, but unfortunately, this also makes |
86 | it very long. If you just want to know the basics of libev, I suggest |
88 | it very long. If you just want to know the basics of libev, I suggest |
87 | reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and |
89 | reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and |
88 | look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and |
90 | look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and |
89 | C<ev_timer> sections in L<WATCHER TYPES>. |
91 | C<ev_timer> sections in L</WATCHER TYPES>. |
90 | |
92 | |
91 | =head1 ABOUT LIBEV |
93 | =head1 ABOUT LIBEV |
92 | |
94 | |
93 | Libev is an event loop: you register interest in certain events (such as a |
95 | Libev is an event loop: you register interest in certain events (such as a |
94 | file descriptor being readable or a timeout occurring), and it will manage |
96 | file descriptor being readable or a timeout occurring), and it will manage |
… | |
… | |
174 | =item ev_tstamp ev_time () |
176 | =item ev_tstamp ev_time () |
175 | |
177 | |
176 | Returns the current time as libev would use it. Please note that the |
178 | Returns the current time as libev would use it. Please note that the |
177 | C<ev_now> function is usually faster and also often returns the timestamp |
179 | C<ev_now> function is usually faster and also often returns the timestamp |
178 | you actually want to know. Also interesting is the combination of |
180 | you actually want to know. Also interesting is the combination of |
179 | C<ev_update_now> and C<ev_now>. |
181 | C<ev_now_update> and C<ev_now>. |
180 | |
182 | |
181 | =item ev_sleep (ev_tstamp interval) |
183 | =item ev_sleep (ev_tstamp interval) |
182 | |
184 | |
183 | Sleep for the given interval: The current thread will be blocked |
185 | Sleep for the given interval: The current thread will be blocked |
184 | until either it is interrupted or the given time interval has |
186 | until either it is interrupted or the given time interval has |
… | |
… | |
247 | the current system, you would need to look at C<ev_embeddable_backends () |
249 | the current system, you would need to look at C<ev_embeddable_backends () |
248 | & ev_supported_backends ()>, likewise for recommended ones. |
250 | & ev_supported_backends ()>, likewise for recommended ones. |
249 | |
251 | |
250 | See the description of C<ev_embed> watchers for more info. |
252 | See the description of C<ev_embed> watchers for more info. |
251 | |
253 | |
252 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) |
254 | =item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ()) |
253 | |
255 | |
254 | Sets the allocation function to use (the prototype is similar - the |
256 | Sets the allocation function to use (the prototype is similar - the |
255 | semantics are identical to the C<realloc> C89/SuS/POSIX function). It is |
257 | semantics are identical to the C<realloc> C89/SuS/POSIX function). It is |
256 | used to allocate and free memory (no surprises here). If it returns zero |
258 | used to allocate and free memory (no surprises here). If it returns zero |
257 | when memory needs to be allocated (C<size != 0>), the library might abort |
259 | when memory needs to be allocated (C<size != 0>), the library might abort |
… | |
… | |
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. |
… | |
… | |
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 sequence |
413 | without a system call and thus I<very> fast, but my GNU/Linux system also has |
417 | without a system call and thus I<very> fast, but my GNU/Linux system also has |
414 | C<pthread_atfork> which is even faster). |
418 | C<pthread_atfork> which is even faster). |
415 | |
419 | |
416 | The big advantage of this flag is that you can forget about fork (and |
420 | 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 |
421 | forget about forgetting to tell libev about forking, although you still |
418 | flag. |
422 | have to ignore C<SIGPIPE>) when you use this flag. |
419 | |
423 | |
420 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
424 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
421 | environment variable. |
425 | environment variable. |
422 | |
426 | |
423 | =item C<EVFLAG_NOINOTIFY> |
427 | =item C<EVFLAG_NOINOTIFY> |
… | |
… | |
567 | |
571 | |
568 | It scales in the same way as the epoll backend, but the interface to the |
572 | 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 |
573 | 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 |
574 | 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 |
575 | 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 |
576 | 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 |
577 | might have to leak fd's on fork, but it's more sane than epoll) and it |
574 | cases |
578 | drops fds silently in similarly hard-to-detect cases. |
575 | |
579 | |
576 | This backend usually performs well under most conditions. |
580 | This backend usually performs well under most conditions. |
577 | |
581 | |
578 | While nominally embeddable in other event loops, this doesn't work |
582 | 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 |
583 | 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> |
682 | If you need dynamically allocated loops it is better to use C<ev_loop_new> |
679 | and C<ev_loop_destroy>. |
683 | and C<ev_loop_destroy>. |
680 | |
684 | |
681 | =item ev_loop_fork (loop) |
685 | =item ev_loop_fork (loop) |
682 | |
686 | |
683 | This function sets a flag that causes subsequent C<ev_run> iterations to |
687 | This function sets a flag that causes subsequent C<ev_run> iterations |
684 | reinitialise the kernel state for backends that have one. Despite the |
688 | 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 |
689 | 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 |
690 | watchers (except inside an C<ev_prepare> callback), but it makes most |
|
|
691 | sense after forking, in the child process. You I<must> call it (or use |
687 | child before resuming or calling C<ev_run>. |
692 | C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>. |
688 | |
693 | |
|
|
694 | In addition, if you want to reuse a loop (via this function or |
|
|
695 | C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>. |
|
|
696 | |
689 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
697 | 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 |
698 | 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 |
699 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
692 | during fork. |
700 | during fork. |
693 | |
701 | |
694 | On the other hand, you only need to call this function in the child |
702 | On the other hand, you only need to call this function in the child |
… | |
… | |
764 | |
772 | |
765 | This function is rarely useful, but when some event callback runs for a |
773 | 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 |
774 | very long time without entering the event loop, updating libev's idea of |
767 | the current time is a good idea. |
775 | the current time is a good idea. |
768 | |
776 | |
769 | See also L<The special problem of time updates> in the C<ev_timer> section. |
777 | See also L</The special problem of time updates> in the C<ev_timer> section. |
770 | |
778 | |
771 | =item ev_suspend (loop) |
779 | =item ev_suspend (loop) |
772 | |
780 | |
773 | =item ev_resume (loop) |
781 | =item ev_resume (loop) |
774 | |
782 | |
… | |
… | |
792 | without a previous call to C<ev_suspend>. |
800 | without a previous call to C<ev_suspend>. |
793 | |
801 | |
794 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
802 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
795 | event loop time (see C<ev_now_update>). |
803 | event loop time (see C<ev_now_update>). |
796 | |
804 | |
797 | =item ev_run (loop, int flags) |
805 | =item bool ev_run (loop, int flags) |
798 | |
806 | |
799 | Finally, this is it, the event handler. This function usually is called |
807 | 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 |
808 | 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 |
809 | 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 |
810 | the watcher callbacks, and then repeat the whole process indefinitely: This |
803 | is why event loops are called I<loops>. |
811 | is why event loops are called I<loops>. |
804 | |
812 | |
805 | If the flags argument is specified as C<0>, it will keep handling events |
813 | 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 |
814 | until either no event watchers are active anymore or C<ev_break> was |
807 | called. |
815 | called. |
|
|
816 | |
|
|
817 | The return value is false if there are no more active watchers (which |
|
|
818 | usually means "all jobs done" or "deadlock"), and true in all other cases |
|
|
819 | (which usually means " you should call C<ev_run> again"). |
808 | |
820 | |
809 | Please note that an explicit C<ev_break> is usually better than |
821 | 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 |
822 | relying on all watchers to be stopped when deciding when a program has |
811 | finished (especially in interactive programs), but having a program |
823 | finished (especially in interactive programs), but having a program |
812 | that automatically loops as long as it has to and no longer by virtue |
824 | 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 |
825 | of relying on its watchers stopping correctly, that is truly a thing of |
814 | beauty. |
826 | beauty. |
815 | |
827 | |
816 | This function is also I<mostly> exception-safe - you can break out of |
828 | 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++ |
829 | 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 |
830 | exception and so on. This does not decrement the C<ev_depth> value, nor |
819 | will it clear any outstanding C<EVBREAK_ONE> breaks. |
831 | will it clear any outstanding C<EVBREAK_ONE> breaks. |
820 | |
832 | |
821 | A flags value of C<EVRUN_NOWAIT> will look for new events, will handle |
833 | 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 |
834 | those events and any already outstanding ones, but will not wait and |
… | |
… | |
1012 | invoke the actual watchers inside another context (another thread etc.). |
1024 | invoke the actual watchers inside another context (another thread etc.). |
1013 | |
1025 | |
1014 | If you want to reset the callback, use C<ev_invoke_pending> as new |
1026 | If you want to reset the callback, use C<ev_invoke_pending> as new |
1015 | callback. |
1027 | callback. |
1016 | |
1028 | |
1017 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) |
1029 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ()) |
1018 | |
1030 | |
1019 | Sometimes you want to share the same loop between multiple threads. This |
1031 | 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 |
1032 | can be done relatively simply by putting mutex_lock/unlock calls around |
1021 | each call to a libev function. |
1033 | each call to a libev function. |
1022 | |
1034 | |
1023 | However, C<ev_run> can run an indefinite time, so it is not feasible |
1035 | However, C<ev_run> can run an indefinite time, so it is not feasible |
1024 | to wait for it to return. One way around this is to wake up the event |
1036 | to wait for it to return. One way around this is to wake up the event |
1025 | loop via C<ev_break> and C<av_async_send>, another way is to set these |
1037 | loop via C<ev_break> and C<ev_async_send>, another way is to set these |
1026 | I<release> and I<acquire> callbacks on the loop. |
1038 | I<release> and I<acquire> callbacks on the loop. |
1027 | |
1039 | |
1028 | When set, then C<release> will be called just before the thread is |
1040 | When set, then C<release> will be called just before the thread is |
1029 | suspended waiting for new events, and C<acquire> is called just |
1041 | suspended waiting for new events, and C<acquire> is called just |
1030 | afterwards. |
1042 | afterwards. |
… | |
… | |
1170 | |
1182 | |
1171 | =item C<EV_PREPARE> |
1183 | =item C<EV_PREPARE> |
1172 | |
1184 | |
1173 | =item C<EV_CHECK> |
1185 | =item C<EV_CHECK> |
1174 | |
1186 | |
1175 | All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts |
1187 | 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 |
1188 | 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 |
1189 | just after C<ev_run> has gathered them, but before it queues any callbacks |
|
|
1190 | for any received events. That means C<ev_prepare> watchers are the last |
|
|
1191 | watchers invoked before the event loop sleeps or polls for new events, and |
|
|
1192 | C<ev_check> watchers will be invoked before any other watchers of the same |
|
|
1193 | or lower priority within an event loop iteration. |
|
|
1194 | |
1178 | received events. Callbacks of both watcher types can start and stop as |
1195 | 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 |
1196 | 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 |
1197 | C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from |
1181 | C<ev_run> from blocking). |
1198 | blocking). |
1182 | |
1199 | |
1183 | =item C<EV_EMBED> |
1200 | =item C<EV_EMBED> |
1184 | |
1201 | |
1185 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1202 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1186 | |
1203 | |
… | |
… | |
1309 | |
1326 | |
1310 | =item callback ev_cb (ev_TYPE *watcher) |
1327 | =item callback ev_cb (ev_TYPE *watcher) |
1311 | |
1328 | |
1312 | Returns the callback currently set on the watcher. |
1329 | Returns the callback currently set on the watcher. |
1313 | |
1330 | |
1314 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1331 | =item ev_set_cb (ev_TYPE *watcher, callback) |
1315 | |
1332 | |
1316 | Change the callback. You can change the callback at virtually any time |
1333 | Change the callback. You can change the callback at virtually any time |
1317 | (modulo threads). |
1334 | (modulo threads). |
1318 | |
1335 | |
1319 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
1336 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
… | |
… | |
1337 | or might not have been clamped to the valid range. |
1354 | or might not have been clamped to the valid range. |
1338 | |
1355 | |
1339 | The default priority used by watchers when no priority has been set is |
1356 | 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 :). |
1357 | always C<0>, which is supposed to not be too high and not be too low :). |
1341 | |
1358 | |
1342 | See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1359 | See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1343 | priorities. |
1360 | priorities. |
1344 | |
1361 | |
1345 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1362 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1346 | |
1363 | |
1347 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
1364 | 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 |
1389 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
1373 | functions that do not need a watcher. |
1390 | functions that do not need a watcher. |
1374 | |
1391 | |
1375 | =back |
1392 | =back |
1376 | |
1393 | |
1377 | See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR |
1394 | See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR |
1378 | OWN COMPOSITE WATCHERS> idioms. |
1395 | OWN COMPOSITE WATCHERS> idioms. |
1379 | |
1396 | |
1380 | =head2 WATCHER STATES |
1397 | =head2 WATCHER STATES |
1381 | |
1398 | |
1382 | There are various watcher states mentioned throughout this manual - |
1399 | There are various watcher states mentioned throughout this manual - |
… | |
… | |
1384 | transition between them will be described in more detail - and while these |
1401 | transition between them will be described in more detail - and while these |
1385 | rules might look complicated, they usually do "the right thing". |
1402 | rules might look complicated, they usually do "the right thing". |
1386 | |
1403 | |
1387 | =over 4 |
1404 | =over 4 |
1388 | |
1405 | |
1389 | =item initialiased |
1406 | =item initialised |
1390 | |
1407 | |
1391 | Before a watcher can be registered with the event loop it has to be |
1408 | 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 |
1409 | 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. |
1410 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1394 | |
1411 | |
… | |
… | |
1771 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1788 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1772 | monotonic clock option helps a lot here). |
1789 | monotonic clock option helps a lot here). |
1773 | |
1790 | |
1774 | The callback is guaranteed to be invoked only I<after> its timeout has |
1791 | The callback is guaranteed to be invoked only I<after> its timeout has |
1775 | passed (not I<at>, so on systems with very low-resolution clocks this |
1792 | passed (not I<at>, so on systems with very low-resolution clocks this |
1776 | might introduce a small delay). If multiple timers become ready during the |
1793 | might introduce a small delay, see "the special problem of being too |
|
|
1794 | early", below). If multiple timers become ready during the same loop |
1777 | same loop iteration then the ones with earlier time-out values are invoked |
1795 | iteration then the ones with earlier time-out values are invoked before |
1778 | before ones of the same priority with later time-out values (but this is |
1796 | ones of the same priority with later time-out values (but this is no |
1779 | no longer true when a callback calls C<ev_run> recursively). |
1797 | longer true when a callback calls C<ev_run> recursively). |
1780 | |
1798 | |
1781 | =head3 Be smart about timeouts |
1799 | =head3 Be smart about timeouts |
1782 | |
1800 | |
1783 | Many real-world problems involve some kind of timeout, usually for error |
1801 | Many real-world problems involve some kind of timeout, usually for error |
1784 | recovery. A typical example is an HTTP request - if the other side hangs, |
1802 | recovery. A typical example is an HTTP request - if the other side hangs, |
… | |
… | |
1859 | |
1877 | |
1860 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
1878 | In this case, it would be more efficient to leave the C<ev_timer> alone, |
1861 | but remember the time of last activity, and check for a real timeout only |
1879 | but remember the time of last activity, and check for a real timeout only |
1862 | within the callback: |
1880 | within the callback: |
1863 | |
1881 | |
|
|
1882 | ev_tstamp timeout = 60.; |
1864 | ev_tstamp last_activity; // time of last activity |
1883 | ev_tstamp last_activity; // time of last activity |
|
|
1884 | ev_timer timer; |
1865 | |
1885 | |
1866 | static void |
1886 | static void |
1867 | callback (EV_P_ ev_timer *w, int revents) |
1887 | callback (EV_P_ ev_timer *w, int revents) |
1868 | { |
1888 | { |
1869 | ev_tstamp now = ev_now (EV_A); |
1889 | // calculate when the timeout would happen |
1870 | ev_tstamp timeout = last_activity + 60.; |
1890 | ev_tstamp after = last_activity - ev_now (EV_A) + timeout; |
1871 | |
1891 | |
1872 | // if last_activity + 60. is older than now, we did time out |
1892 | // if negative, it means we the timeout already occurred |
1873 | if (timeout < now) |
1893 | if (after < 0.) |
1874 | { |
1894 | { |
1875 | // timeout occurred, take action |
1895 | // timeout occurred, take action |
1876 | } |
1896 | } |
1877 | else |
1897 | else |
1878 | { |
1898 | { |
1879 | // callback was invoked, but there was some activity, re-arm |
1899 | // callback was invoked, but there was some recent |
1880 | // the watcher to fire in last_activity + 60, which is |
1900 | // activity. simply restart the timer to time out |
1881 | // guaranteed to be in the future, so "again" is positive: |
1901 | // after "after" seconds, which is the earliest time |
1882 | w->repeat = timeout - now; |
1902 | // the timeout can occur. |
|
|
1903 | ev_timer_set (w, after, 0.); |
1883 | ev_timer_again (EV_A_ w); |
1904 | ev_timer_start (EV_A_ w); |
1884 | } |
1905 | } |
1885 | } |
1906 | } |
1886 | |
1907 | |
1887 | To summarise the callback: first calculate the real timeout (defined |
1908 | To summarise the callback: first calculate in how many seconds the |
1888 | as "60 seconds after the last activity"), then check if that time has |
1909 | timeout will occur (by calculating the absolute time when it would occur, |
1889 | been reached, which means something I<did>, in fact, time out. Otherwise |
1910 | C<last_activity + timeout>, and subtracting the current time, C<ev_now |
1890 | the callback was invoked too early (C<timeout> is in the future), so |
1911 | (EV_A)> from that). |
1891 | re-schedule the timer to fire at that future time, to see if maybe we have |
|
|
1892 | a timeout then. |
|
|
1893 | |
1912 | |
1894 | Note how C<ev_timer_again> is used, taking advantage of the |
1913 | If this value is negative, then we are already past the timeout, i.e. we |
1895 | C<ev_timer_again> optimisation when the timer is already running. |
1914 | timed out, and need to do whatever is needed in this case. |
|
|
1915 | |
|
|
1916 | Otherwise, we now the earliest time at which the timeout would trigger, |
|
|
1917 | and simply start the timer with this timeout value. |
|
|
1918 | |
|
|
1919 | In other words, each time the callback is invoked it will check whether |
|
|
1920 | the timeout occurred. If not, it will simply reschedule itself to check |
|
|
1921 | again at the earliest time it could time out. Rinse. Repeat. |
1896 | |
1922 | |
1897 | This scheme causes more callback invocations (about one every 60 seconds |
1923 | This scheme causes more callback invocations (about one every 60 seconds |
1898 | minus half the average time between activity), but virtually no calls to |
1924 | minus half the average time between activity), but virtually no calls to |
1899 | libev to change the timeout. |
1925 | libev to change the timeout. |
1900 | |
1926 | |
1901 | To start the timer, simply initialise the watcher and set C<last_activity> |
1927 | To start the machinery, simply initialise the watcher and set |
1902 | to the current time (meaning we just have some activity :), then call the |
1928 | C<last_activity> to the current time (meaning there was some activity just |
1903 | callback, which will "do the right thing" and start the timer: |
1929 | now), then call the callback, which will "do the right thing" and start |
|
|
1930 | the timer: |
1904 | |
1931 | |
|
|
1932 | last_activity = ev_now (EV_A); |
1905 | ev_init (timer, callback); |
1933 | ev_init (&timer, callback); |
1906 | last_activity = ev_now (loop); |
1934 | callback (EV_A_ &timer, 0); |
1907 | callback (loop, timer, EV_TIMER); |
|
|
1908 | |
1935 | |
1909 | And when there is some activity, simply store the current time in |
1936 | When there is some activity, simply store the current time in |
1910 | C<last_activity>, no libev calls at all: |
1937 | C<last_activity>, no libev calls at all: |
1911 | |
1938 | |
|
|
1939 | if (activity detected) |
1912 | last_activity = ev_now (loop); |
1940 | last_activity = ev_now (EV_A); |
|
|
1941 | |
|
|
1942 | When your timeout value changes, then the timeout can be changed by simply |
|
|
1943 | providing a new value, stopping the timer and calling the callback, which |
|
|
1944 | will again do the right thing (for example, time out immediately :). |
|
|
1945 | |
|
|
1946 | timeout = new_value; |
|
|
1947 | ev_timer_stop (EV_A_ &timer); |
|
|
1948 | callback (EV_A_ &timer, 0); |
1913 | |
1949 | |
1914 | This technique is slightly more complex, but in most cases where the |
1950 | This technique is slightly more complex, but in most cases where the |
1915 | time-out is unlikely to be triggered, much more efficient. |
1951 | time-out is unlikely to be triggered, much more efficient. |
1916 | |
|
|
1917 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
|
|
1918 | callback :) - just change the timeout and invoke the callback, which will |
|
|
1919 | fix things for you. |
|
|
1920 | |
1952 | |
1921 | =item 4. Wee, just use a double-linked list for your timeouts. |
1953 | =item 4. Wee, just use a double-linked list for your timeouts. |
1922 | |
1954 | |
1923 | If there is not one request, but many thousands (millions...), all |
1955 | If there is not one request, but many thousands (millions...), all |
1924 | employing some kind of timeout with the same timeout value, then one can |
1956 | employing some kind of timeout with the same timeout value, then one can |
… | |
… | |
1951 | Method #1 is almost always a bad idea, and buys you nothing. Method #4 is |
1983 | Method #1 is almost always a bad idea, and buys you nothing. Method #4 is |
1952 | rather complicated, but extremely efficient, something that really pays |
1984 | rather complicated, but extremely efficient, something that really pays |
1953 | off after the first million or so of active timers, i.e. it's usually |
1985 | off after the first million or so of active timers, i.e. it's usually |
1954 | overkill :) |
1986 | overkill :) |
1955 | |
1987 | |
|
|
1988 | =head3 The special problem of being too early |
|
|
1989 | |
|
|
1990 | If you ask a timer to call your callback after three seconds, then |
|
|
1991 | you expect it to be invoked after three seconds - but of course, this |
|
|
1992 | cannot be guaranteed to infinite precision. Less obviously, it cannot be |
|
|
1993 | guaranteed to any precision by libev - imagine somebody suspending the |
|
|
1994 | process with a STOP signal for a few hours for example. |
|
|
1995 | |
|
|
1996 | So, libev tries to invoke your callback as soon as possible I<after> the |
|
|
1997 | delay has occurred, but cannot guarantee this. |
|
|
1998 | |
|
|
1999 | A less obvious failure mode is calling your callback too early: many event |
|
|
2000 | loops compare timestamps with a "elapsed delay >= requested delay", but |
|
|
2001 | this can cause your callback to be invoked much earlier than you would |
|
|
2002 | expect. |
|
|
2003 | |
|
|
2004 | To see why, imagine a system with a clock that only offers full second |
|
|
2005 | resolution (think windows if you can't come up with a broken enough OS |
|
|
2006 | yourself). If you schedule a one-second timer at the time 500.9, then the |
|
|
2007 | event loop will schedule your timeout to elapse at a system time of 500 |
|
|
2008 | (500.9 truncated to the resolution) + 1, or 501. |
|
|
2009 | |
|
|
2010 | If an event library looks at the timeout 0.1s later, it will see "501 >= |
|
|
2011 | 501" and invoke the callback 0.1s after it was started, even though a |
|
|
2012 | one-second delay was requested - this is being "too early", despite best |
|
|
2013 | intentions. |
|
|
2014 | |
|
|
2015 | This is the reason why libev will never invoke the callback if the elapsed |
|
|
2016 | delay equals the requested delay, but only when the elapsed delay is |
|
|
2017 | larger than the requested delay. In the example above, libev would only invoke |
|
|
2018 | the callback at system time 502, or 1.1s after the timer was started. |
|
|
2019 | |
|
|
2020 | So, while libev cannot guarantee that your callback will be invoked |
|
|
2021 | exactly when requested, it I<can> and I<does> guarantee that the requested |
|
|
2022 | delay has actually elapsed, or in other words, it always errs on the "too |
|
|
2023 | late" side of things. |
|
|
2024 | |
1956 | =head3 The special problem of time updates |
2025 | =head3 The special problem of time updates |
1957 | |
2026 | |
1958 | Establishing the current time is a costly operation (it usually takes at |
2027 | Establishing the current time is a costly operation (it usually takes |
1959 | least two system calls): EV therefore updates its idea of the current |
2028 | at least one system call): EV therefore updates its idea of the current |
1960 | time only before and after C<ev_run> collects new events, which causes a |
2029 | time only before and after C<ev_run> collects new events, which causes a |
1961 | growing difference between C<ev_now ()> and C<ev_time ()> when handling |
2030 | growing difference between C<ev_now ()> and C<ev_time ()> when handling |
1962 | lots of events in one iteration. |
2031 | lots of events in one iteration. |
1963 | |
2032 | |
1964 | The relative timeouts are calculated relative to the C<ev_now ()> |
2033 | The relative timeouts are calculated relative to the C<ev_now ()> |
1965 | time. This is usually the right thing as this timestamp refers to the time |
2034 | time. This is usually the right thing as this timestamp refers to the time |
1966 | of the event triggering whatever timeout you are modifying/starting. If |
2035 | of the event triggering whatever timeout you are modifying/starting. If |
1967 | you suspect event processing to be delayed and you I<need> to base the |
2036 | you suspect event processing to be delayed and you I<need> to base the |
1968 | timeout on the current time, use something like this to adjust for this: |
2037 | timeout on the current time, use something like the following to adjust |
|
|
2038 | for it: |
1969 | |
2039 | |
1970 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
2040 | ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.); |
1971 | |
2041 | |
1972 | If the event loop is suspended for a long time, you can also force an |
2042 | If the event loop is suspended for a long time, you can also force an |
1973 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
2043 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1974 | ()>. |
2044 | ()>, although that will push the event time of all outstanding events |
|
|
2045 | further into the future. |
|
|
2046 | |
|
|
2047 | =head3 The special problem of unsynchronised clocks |
|
|
2048 | |
|
|
2049 | Modern systems have a variety of clocks - libev itself uses the normal |
|
|
2050 | "wall clock" clock and, if available, the monotonic clock (to avoid time |
|
|
2051 | jumps). |
|
|
2052 | |
|
|
2053 | Neither of these clocks is synchronised with each other or any other clock |
|
|
2054 | on the system, so C<ev_time ()> might return a considerably different time |
|
|
2055 | than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example, |
|
|
2056 | a call to C<gettimeofday> might return a second count that is one higher |
|
|
2057 | than a directly following call to C<time>. |
|
|
2058 | |
|
|
2059 | The moral of this is to only compare libev-related timestamps with |
|
|
2060 | C<ev_time ()> and C<ev_now ()>, at least if you want better precision than |
|
|
2061 | a second or so. |
|
|
2062 | |
|
|
2063 | One more problem arises due to this lack of synchronisation: if libev uses |
|
|
2064 | the system monotonic clock and you compare timestamps from C<ev_time> |
|
|
2065 | or C<ev_now> from when you started your timer and when your callback is |
|
|
2066 | invoked, you will find that sometimes the callback is a bit "early". |
|
|
2067 | |
|
|
2068 | This is because C<ev_timer>s work in real time, not wall clock time, so |
|
|
2069 | libev makes sure your callback is not invoked before the delay happened, |
|
|
2070 | I<measured according to the real time>, not the system clock. |
|
|
2071 | |
|
|
2072 | If your timeouts are based on a physical timescale (e.g. "time out this |
|
|
2073 | connection after 100 seconds") then this shouldn't bother you as it is |
|
|
2074 | exactly the right behaviour. |
|
|
2075 | |
|
|
2076 | If you want to compare wall clock/system timestamps to your timers, then |
|
|
2077 | you need to use C<ev_periodic>s, as these are based on the wall clock |
|
|
2078 | time, where your comparisons will always generate correct results. |
1975 | |
2079 | |
1976 | =head3 The special problems of suspended animation |
2080 | =head3 The special problems of suspended animation |
1977 | |
2081 | |
1978 | When you leave the server world it is quite customary to hit machines that |
2082 | When you leave the server world it is quite customary to hit machines that |
1979 | can suspend/hibernate - what happens to the clocks during such a suspend? |
2083 | can suspend/hibernate - what happens to the clocks during such a suspend? |
… | |
… | |
2023 | keep up with the timer (because it takes longer than those 10 seconds to |
2127 | keep up with the timer (because it takes longer than those 10 seconds to |
2024 | do stuff) the timer will not fire more than once per event loop iteration. |
2128 | do stuff) the timer will not fire more than once per event loop iteration. |
2025 | |
2129 | |
2026 | =item ev_timer_again (loop, ev_timer *) |
2130 | =item ev_timer_again (loop, ev_timer *) |
2027 | |
2131 | |
2028 | This will act as if the timer timed out and restarts it again if it is |
2132 | This will act as if the timer timed out, and restarts it again if it is |
2029 | repeating. The exact semantics are: |
2133 | repeating. It basically works like calling C<ev_timer_stop>, updating the |
|
|
2134 | timeout to the C<repeat> value and calling C<ev_timer_start>. |
2030 | |
2135 | |
|
|
2136 | The exact semantics are as in the following rules, all of which will be |
|
|
2137 | applied to the watcher: |
|
|
2138 | |
|
|
2139 | =over 4 |
|
|
2140 | |
2031 | If the timer is pending, its pending status is cleared. |
2141 | =item If the timer is pending, the pending status is always cleared. |
2032 | |
2142 | |
2033 | If the timer is started but non-repeating, stop it (as if it timed out). |
2143 | =item If the timer is started but non-repeating, stop it (as if it timed |
|
|
2144 | out, without invoking it). |
2034 | |
2145 | |
2035 | If the timer is repeating, either start it if necessary (with the |
2146 | =item If the timer is repeating, make the C<repeat> value the new timeout |
2036 | C<repeat> value), or reset the running timer to the C<repeat> value. |
2147 | and start the timer, if necessary. |
2037 | |
2148 | |
|
|
2149 | =back |
|
|
2150 | |
2038 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
2151 | This sounds a bit complicated, see L</Be smart about timeouts>, above, for a |
2039 | usage example. |
2152 | usage example. |
2040 | |
2153 | |
2041 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2154 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
2042 | |
2155 | |
2043 | Returns the remaining time until a timer fires. If the timer is active, |
2156 | Returns the remaining time until a timer fires. If the timer is active, |
… | |
… | |
2096 | Periodic watchers are also timers of a kind, but they are very versatile |
2209 | Periodic watchers are also timers of a kind, but they are very versatile |
2097 | (and unfortunately a bit complex). |
2210 | (and unfortunately a bit complex). |
2098 | |
2211 | |
2099 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2212 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2100 | relative time, the physical time that passes) but on wall clock time |
2213 | relative time, the physical time that passes) but on wall clock time |
2101 | (absolute time, the thing you can read on your calender or clock). The |
2214 | (absolute time, the thing you can read on your calendar or clock). The |
2102 | difference is that wall clock time can run faster or slower than real |
2215 | difference is that wall clock time can run faster or slower than real |
2103 | time, and time jumps are not uncommon (e.g. when you adjust your |
2216 | time, and time jumps are not uncommon (e.g. when you adjust your |
2104 | wrist-watch). |
2217 | wrist-watch). |
2105 | |
2218 | |
2106 | You can tell a periodic watcher to trigger after some specific point |
2219 | You can tell a periodic watcher to trigger after some specific point |
… | |
… | |
2286 | |
2399 | |
2287 | ev_periodic hourly_tick; |
2400 | ev_periodic hourly_tick; |
2288 | ev_periodic_init (&hourly_tick, clock_cb, |
2401 | ev_periodic_init (&hourly_tick, clock_cb, |
2289 | fmod (ev_now (loop), 3600.), 3600., 0); |
2402 | fmod (ev_now (loop), 3600.), 3600., 0); |
2290 | ev_periodic_start (loop, &hourly_tick); |
2403 | ev_periodic_start (loop, &hourly_tick); |
2291 | |
2404 | |
2292 | |
2405 | |
2293 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2406 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2294 | |
2407 | |
2295 | Signal watchers will trigger an event when the process receives a specific |
2408 | Signal watchers will trigger an event when the process receives a specific |
2296 | signal one or more times. Even though signals are very asynchronous, libev |
2409 | signal one or more times. Even though signals are very asynchronous, libev |
… | |
… | |
2306 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
2419 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
2307 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
2420 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
2308 | C<SIGINT> in both the default loop and another loop at the same time. At |
2421 | C<SIGINT> in both the default loop and another loop at the same time. At |
2309 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2422 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2310 | |
2423 | |
2311 | When the first watcher gets started will libev actually register something |
2424 | Only after the first watcher for a signal is started will libev actually |
2312 | with the kernel (thus it coexists with your own signal handlers as long as |
2425 | register something with the kernel. It thus coexists with your own signal |
2313 | you don't register any with libev for the same signal). |
2426 | handlers as long as you don't register any with libev for the same signal. |
2314 | |
2427 | |
2315 | If possible and supported, libev will install its handlers with |
2428 | If possible and supported, libev will install its handlers with |
2316 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2429 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2317 | not be unduly interrupted. If you have a problem with system calls getting |
2430 | not be unduly interrupted. If you have a problem with system calls getting |
2318 | interrupted by signals you can block all signals in an C<ev_check> watcher |
2431 | interrupted by signals you can block all signals in an C<ev_check> watcher |
… | |
… | |
2503 | |
2616 | |
2504 | =head2 C<ev_stat> - did the file attributes just change? |
2617 | =head2 C<ev_stat> - did the file attributes just change? |
2505 | |
2618 | |
2506 | This watches a file system path for attribute changes. That is, it calls |
2619 | This watches a file system path for attribute changes. That is, it calls |
2507 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2620 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2508 | and sees if it changed compared to the last time, invoking the callback if |
2621 | and sees if it changed compared to the last time, invoking the callback |
2509 | it did. |
2622 | if it did. Starting the watcher C<stat>'s the file, so only changes that |
|
|
2623 | happen after the watcher has been started will be reported. |
2510 | |
2624 | |
2511 | The path does not need to exist: changing from "path exists" to "path does |
2625 | The path does not need to exist: changing from "path exists" to "path does |
2512 | not exist" is a status change like any other. The condition "path does not |
2626 | not exist" is a status change like any other. The condition "path does not |
2513 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2627 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2514 | C<st_nlink> field being zero (which is otherwise always forced to be at |
2628 | C<st_nlink> field being zero (which is otherwise always forced to be at |
… | |
… | |
2744 | Apart from keeping your process non-blocking (which is a useful |
2858 | Apart from keeping your process non-blocking (which is a useful |
2745 | effect on its own sometimes), idle watchers are a good place to do |
2859 | effect on its own sometimes), idle watchers are a good place to do |
2746 | "pseudo-background processing", or delay processing stuff to after the |
2860 | "pseudo-background processing", or delay processing stuff to after the |
2747 | event loop has handled all outstanding events. |
2861 | event loop has handled all outstanding events. |
2748 | |
2862 | |
|
|
2863 | =head3 Abusing an C<ev_idle> watcher for its side-effect |
|
|
2864 | |
|
|
2865 | As long as there is at least one active idle watcher, libev will never |
|
|
2866 | sleep unnecessarily. Or in other words, it will loop as fast as possible. |
|
|
2867 | For this to work, the idle watcher doesn't need to be invoked at all - the |
|
|
2868 | lowest priority will do. |
|
|
2869 | |
|
|
2870 | This mode of operation can be useful together with an C<ev_check> watcher, |
|
|
2871 | to do something on each event loop iteration - for example to balance load |
|
|
2872 | between different connections. |
|
|
2873 | |
|
|
2874 | See L</Abusing an ev_check watcher for its side-effect> for a longer |
|
|
2875 | example. |
|
|
2876 | |
2749 | =head3 Watcher-Specific Functions and Data Members |
2877 | =head3 Watcher-Specific Functions and Data Members |
2750 | |
2878 | |
2751 | =over 4 |
2879 | =over 4 |
2752 | |
2880 | |
2753 | =item ev_idle_init (ev_idle *, callback) |
2881 | =item ev_idle_init (ev_idle *, callback) |
… | |
… | |
2764 | callback, free it. Also, use no error checking, as usual. |
2892 | callback, free it. Also, use no error checking, as usual. |
2765 | |
2893 | |
2766 | static void |
2894 | static void |
2767 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2895 | idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
2768 | { |
2896 | { |
|
|
2897 | // stop the watcher |
|
|
2898 | ev_idle_stop (loop, w); |
|
|
2899 | |
|
|
2900 | // now we can free it |
2769 | free (w); |
2901 | free (w); |
|
|
2902 | |
2770 | // now do something you wanted to do when the program has |
2903 | // now do something you wanted to do when the program has |
2771 | // no longer anything immediate to do. |
2904 | // no longer anything immediate to do. |
2772 | } |
2905 | } |
2773 | |
2906 | |
2774 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
2907 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
… | |
… | |
2776 | ev_idle_start (loop, idle_watcher); |
2909 | ev_idle_start (loop, idle_watcher); |
2777 | |
2910 | |
2778 | |
2911 | |
2779 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2912 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2780 | |
2913 | |
2781 | Prepare and check watchers are usually (but not always) used in pairs: |
2914 | Prepare and check watchers are often (but not always) used in pairs: |
2782 | prepare watchers get invoked before the process blocks and check watchers |
2915 | prepare watchers get invoked before the process blocks and check watchers |
2783 | afterwards. |
2916 | afterwards. |
2784 | |
2917 | |
2785 | You I<must not> call C<ev_run> or similar functions that enter |
2918 | You I<must not> call C<ev_run> (or similar functions that enter the |
2786 | the current event loop from either C<ev_prepare> or C<ev_check> |
2919 | current event loop) or C<ev_loop_fork> from either C<ev_prepare> or |
2787 | watchers. Other loops than the current one are fine, however. The |
2920 | C<ev_check> watchers. Other loops than the current one are fine, |
2788 | rationale behind this is that you do not need to check for recursion in |
2921 | however. The rationale behind this is that you do not need to check |
2789 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
2922 | for recursion in those watchers, i.e. the sequence will always be |
2790 | C<ev_check> so if you have one watcher of each kind they will always be |
2923 | C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each |
2791 | called in pairs bracketing the blocking call. |
2924 | kind they will always be called in pairs bracketing the blocking call. |
2792 | |
2925 | |
2793 | Their main purpose is to integrate other event mechanisms into libev and |
2926 | Their main purpose is to integrate other event mechanisms into libev and |
2794 | their use is somewhat advanced. They could be used, for example, to track |
2927 | their use is somewhat advanced. They could be used, for example, to track |
2795 | variable changes, implement your own watchers, integrate net-snmp or a |
2928 | variable changes, implement your own watchers, integrate net-snmp or a |
2796 | coroutine library and lots more. They are also occasionally useful if |
2929 | coroutine library and lots more. They are also occasionally useful if |
… | |
… | |
2814 | with priority higher than or equal to the event loop and one coroutine |
2947 | with priority higher than or equal to the event loop and one coroutine |
2815 | of lower priority, but only once, using idle watchers to keep the event |
2948 | of lower priority, but only once, using idle watchers to keep the event |
2816 | loop from blocking if lower-priority coroutines are active, thus mapping |
2949 | loop from blocking if lower-priority coroutines are active, thus mapping |
2817 | low-priority coroutines to idle/background tasks). |
2950 | low-priority coroutines to idle/background tasks). |
2818 | |
2951 | |
2819 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
2952 | When used for this purpose, it is recommended to give C<ev_check> watchers |
2820 | priority, to ensure that they are being run before any other watchers |
2953 | highest (C<EV_MAXPRI>) priority, to ensure that they are being run before |
2821 | after the poll (this doesn't matter for C<ev_prepare> watchers). |
2954 | any other watchers after the poll (this doesn't matter for C<ev_prepare> |
|
|
2955 | watchers). |
2822 | |
2956 | |
2823 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
2957 | Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not |
2824 | activate ("feed") events into libev. While libev fully supports this, they |
2958 | activate ("feed") events into libev. While libev fully supports this, they |
2825 | might get executed before other C<ev_check> watchers did their job. As |
2959 | might get executed before other C<ev_check> watchers did their job. As |
2826 | C<ev_check> watchers are often used to embed other (non-libev) event |
2960 | C<ev_check> watchers are often used to embed other (non-libev) event |
2827 | loops those other event loops might be in an unusable state until their |
2961 | loops those other event loops might be in an unusable state until their |
2828 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
2962 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
2829 | others). |
2963 | others). |
|
|
2964 | |
|
|
2965 | =head3 Abusing an C<ev_check> watcher for its side-effect |
|
|
2966 | |
|
|
2967 | C<ev_check> (and less often also C<ev_prepare>) watchers can also be |
|
|
2968 | useful because they are called once per event loop iteration. For |
|
|
2969 | example, if you want to handle a large number of connections fairly, you |
|
|
2970 | normally only do a bit of work for each active connection, and if there |
|
|
2971 | is more work to do, you wait for the next event loop iteration, so other |
|
|
2972 | connections have a chance of making progress. |
|
|
2973 | |
|
|
2974 | Using an C<ev_check> watcher is almost enough: it will be called on the |
|
|
2975 | next event loop iteration. However, that isn't as soon as possible - |
|
|
2976 | without external events, your C<ev_check> watcher will not be invoked. |
|
|
2977 | |
|
|
2978 | This is where C<ev_idle> watchers come in handy - all you need is a |
|
|
2979 | single global idle watcher that is active as long as you have one active |
|
|
2980 | C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop |
|
|
2981 | will not sleep, and the C<ev_check> watcher makes sure a callback gets |
|
|
2982 | invoked. Neither watcher alone can do that. |
2830 | |
2983 | |
2831 | =head3 Watcher-Specific Functions and Data Members |
2984 | =head3 Watcher-Specific Functions and Data Members |
2832 | |
2985 | |
2833 | =over 4 |
2986 | =over 4 |
2834 | |
2987 | |
… | |
… | |
3035 | |
3188 | |
3036 | =over 4 |
3189 | =over 4 |
3037 | |
3190 | |
3038 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3191 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3039 | |
3192 | |
3040 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
3193 | =item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop) |
3041 | |
3194 | |
3042 | Configures the watcher to embed the given loop, which must be |
3195 | Configures the watcher to embed the given loop, which must be |
3043 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3196 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3044 | invoked automatically, otherwise it is the responsibility of the callback |
3197 | invoked automatically, otherwise it is the responsibility of the callback |
3045 | to invoke it (it will continue to be called until the sweep has been done, |
3198 | to invoke it (it will continue to be called until the sweep has been done, |
… | |
… | |
3066 | used). |
3219 | used). |
3067 | |
3220 | |
3068 | struct ev_loop *loop_hi = ev_default_init (0); |
3221 | struct ev_loop *loop_hi = ev_default_init (0); |
3069 | struct ev_loop *loop_lo = 0; |
3222 | struct ev_loop *loop_lo = 0; |
3070 | ev_embed embed; |
3223 | ev_embed embed; |
3071 | |
3224 | |
3072 | // see if there is a chance of getting one that works |
3225 | // see if there is a chance of getting one that works |
3073 | // (remember that a flags value of 0 means autodetection) |
3226 | // (remember that a flags value of 0 means autodetection) |
3074 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3227 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3075 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3228 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3076 | : 0; |
3229 | : 0; |
… | |
… | |
3090 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3243 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3091 | |
3244 | |
3092 | struct ev_loop *loop = ev_default_init (0); |
3245 | struct ev_loop *loop = ev_default_init (0); |
3093 | struct ev_loop *loop_socket = 0; |
3246 | struct ev_loop *loop_socket = 0; |
3094 | ev_embed embed; |
3247 | ev_embed embed; |
3095 | |
3248 | |
3096 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3249 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3097 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3250 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3098 | { |
3251 | { |
3099 | ev_embed_init (&embed, 0, loop_socket); |
3252 | ev_embed_init (&embed, 0, loop_socket); |
3100 | ev_embed_start (loop, &embed); |
3253 | ev_embed_start (loop, &embed); |
… | |
… | |
3108 | |
3261 | |
3109 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3262 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3110 | |
3263 | |
3111 | Fork watchers are called when a C<fork ()> was detected (usually because |
3264 | Fork watchers are called when a C<fork ()> was detected (usually because |
3112 | whoever is a good citizen cared to tell libev about it by calling |
3265 | whoever is a good citizen cared to tell libev about it by calling |
3113 | C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the |
3266 | C<ev_loop_fork>). The invocation is done before the event loop blocks next |
3114 | event loop blocks next and before C<ev_check> watchers are being called, |
3267 | and before C<ev_check> watchers are being called, and only in the child |
3115 | and only in the child after the fork. If whoever good citizen calling |
3268 | after the fork. If whoever good citizen calling C<ev_default_fork> cheats |
3116 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
3269 | and calls it in the wrong process, the fork handlers will be invoked, too, |
3117 | handlers will be invoked, too, of course. |
3270 | of course. |
3118 | |
3271 | |
3119 | =head3 The special problem of life after fork - how is it possible? |
3272 | =head3 The special problem of life after fork - how is it possible? |
3120 | |
3273 | |
3121 | Most uses of C<fork()> consist of forking, then some simple calls to set |
3274 | Most uses of C<fork ()> consist of forking, then some simple calls to set |
3122 | up/change the process environment, followed by a call to C<exec()>. This |
3275 | up/change the process environment, followed by a call to C<exec()>. This |
3123 | sequence should be handled by libev without any problems. |
3276 | sequence should be handled by libev without any problems. |
3124 | |
3277 | |
3125 | This changes when the application actually wants to do event handling |
3278 | This changes when the application actually wants to do event handling |
3126 | in the child, or both parent in child, in effect "continuing" after the |
3279 | in the child, or both parent in child, in effect "continuing" after the |
… | |
… | |
3215 | it by calling C<ev_async_send>, which is thread- and signal safe. |
3368 | it by calling C<ev_async_send>, which is thread- and signal safe. |
3216 | |
3369 | |
3217 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3370 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3218 | too, are asynchronous in nature, and signals, too, will be compressed |
3371 | too, are asynchronous in nature, and signals, too, will be compressed |
3219 | (i.e. the number of callback invocations may be less than the number of |
3372 | (i.e. the number of callback invocations may be less than the number of |
3220 | C<ev_async_sent> calls). In fact, you could use signal watchers as a kind |
3373 | C<ev_async_send> calls). In fact, you could use signal watchers as a kind |
3221 | of "global async watchers" by using a watcher on an otherwise unused |
3374 | of "global async watchers" by using a watcher on an otherwise unused |
3222 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3375 | signal, and C<ev_feed_signal> to signal this watcher from another thread, |
3223 | even without knowing which loop owns the signal. |
3376 | even without knowing which loop owns the signal. |
3224 | |
3377 | |
3225 | =head3 Queueing |
3378 | =head3 Queueing |
… | |
… | |
3402 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3555 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3403 | |
3556 | |
3404 | =item ev_feed_fd_event (loop, int fd, int revents) |
3557 | =item ev_feed_fd_event (loop, int fd, int revents) |
3405 | |
3558 | |
3406 | Feed an event on the given fd, as if a file descriptor backend detected |
3559 | Feed an event on the given fd, as if a file descriptor backend detected |
3407 | the given events it. |
3560 | the given events. |
3408 | |
3561 | |
3409 | =item ev_feed_signal_event (loop, int signum) |
3562 | =item ev_feed_signal_event (loop, int signum) |
3410 | |
3563 | |
3411 | Feed an event as if the given signal occurred. See also C<ev_feed_signal>, |
3564 | Feed an event as if the given signal occurred. See also C<ev_feed_signal>, |
3412 | which is async-safe. |
3565 | which is async-safe. |
… | |
… | |
3486 | { |
3639 | { |
3487 | struct my_biggy big = (struct my_biggy *) |
3640 | struct my_biggy big = (struct my_biggy *) |
3488 | (((char *)w) - offsetof (struct my_biggy, t2)); |
3641 | (((char *)w) - offsetof (struct my_biggy, t2)); |
3489 | } |
3642 | } |
3490 | |
3643 | |
|
|
3644 | =head2 AVOIDING FINISHING BEFORE RETURNING |
|
|
3645 | |
|
|
3646 | Often you have structures like this in event-based programs: |
|
|
3647 | |
|
|
3648 | callback () |
|
|
3649 | { |
|
|
3650 | free (request); |
|
|
3651 | } |
|
|
3652 | |
|
|
3653 | request = start_new_request (..., callback); |
|
|
3654 | |
|
|
3655 | The intent is to start some "lengthy" operation. The C<request> could be |
|
|
3656 | used to cancel the operation, or do other things with it. |
|
|
3657 | |
|
|
3658 | It's not uncommon to have code paths in C<start_new_request> that |
|
|
3659 | immediately invoke the callback, for example, to report errors. Or you add |
|
|
3660 | some caching layer that finds that it can skip the lengthy aspects of the |
|
|
3661 | operation and simply invoke the callback with the result. |
|
|
3662 | |
|
|
3663 | The problem here is that this will happen I<before> C<start_new_request> |
|
|
3664 | has returned, so C<request> is not set. |
|
|
3665 | |
|
|
3666 | Even if you pass the request by some safer means to the callback, you |
|
|
3667 | might want to do something to the request after starting it, such as |
|
|
3668 | canceling it, which probably isn't working so well when the callback has |
|
|
3669 | already been invoked. |
|
|
3670 | |
|
|
3671 | A common way around all these issues is to make sure that |
|
|
3672 | C<start_new_request> I<always> returns before the callback is invoked. If |
|
|
3673 | C<start_new_request> immediately knows the result, it can artificially |
|
|
3674 | delay invoking the callback by using a C<prepare> or C<idle> watcher for |
|
|
3675 | example, or more sneakily, by reusing an existing (stopped) watcher and |
|
|
3676 | pushing it into the pending queue: |
|
|
3677 | |
|
|
3678 | ev_set_cb (watcher, callback); |
|
|
3679 | ev_feed_event (EV_A_ watcher, 0); |
|
|
3680 | |
|
|
3681 | This way, C<start_new_request> can safely return before the callback is |
|
|
3682 | invoked, while not delaying callback invocation too much. |
|
|
3683 | |
3491 | =head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS |
3684 | =head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS |
3492 | |
3685 | |
3493 | Often (especially in GUI toolkits) there are places where you have |
3686 | Often (especially in GUI toolkits) there are places where you have |
3494 | I<modal> interaction, which is most easily implemented by recursively |
3687 | I<modal> interaction, which is most easily implemented by recursively |
3495 | invoking C<ev_run>. |
3688 | invoking C<ev_run>. |
3496 | |
3689 | |
3497 | This brings the problem of exiting - a callback might want to finish the |
3690 | This brings the problem of exiting - a callback might want to finish the |
3498 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3691 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3499 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3692 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3500 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3693 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3501 | other combination: In these cases, C<ev_break> will not work alone. |
3694 | other combination: In these cases, a simple C<ev_break> will not work. |
3502 | |
3695 | |
3503 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3696 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3504 | invocation, and use a loop around C<ev_run> until the condition is |
3697 | invocation, and use a loop around C<ev_run> until the condition is |
3505 | triggered, using C<EVRUN_ONCE>: |
3698 | triggered, using C<EVRUN_ONCE>: |
3506 | |
3699 | |
… | |
… | |
3508 | int exit_main_loop = 0; |
3701 | int exit_main_loop = 0; |
3509 | |
3702 | |
3510 | while (!exit_main_loop) |
3703 | while (!exit_main_loop) |
3511 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3704 | ev_run (EV_DEFAULT_ EVRUN_ONCE); |
3512 | |
3705 | |
3513 | // in a model watcher |
3706 | // in a modal watcher |
3514 | int exit_nested_loop = 0; |
3707 | int exit_nested_loop = 0; |
3515 | |
3708 | |
3516 | while (!exit_nested_loop) |
3709 | while (!exit_nested_loop) |
3517 | ev_run (EV_A_ EVRUN_ONCE); |
3710 | ev_run (EV_A_ EVRUN_ONCE); |
3518 | |
3711 | |
… | |
… | |
3692 | called): |
3885 | called): |
3693 | |
3886 | |
3694 | void |
3887 | void |
3695 | wait_for_event (ev_watcher *w) |
3888 | wait_for_event (ev_watcher *w) |
3696 | { |
3889 | { |
3697 | ev_cb_set (w) = current_coro; |
3890 | ev_set_cb (w, current_coro); |
3698 | switch_to (libev_coro); |
3891 | switch_to (libev_coro); |
3699 | } |
3892 | } |
3700 | |
3893 | |
3701 | That basically suspends the coroutine inside C<wait_for_event> and |
3894 | That basically suspends the coroutine inside C<wait_for_event> and |
3702 | continues the libev coroutine, which, when appropriate, switches back to |
3895 | continues the libev coroutine, which, when appropriate, switches back to |
3703 | this or any other coroutine. I am sure if you sue this your own :) |
3896 | this or any other coroutine. |
3704 | |
3897 | |
3705 | You can do similar tricks if you have, say, threads with an event queue - |
3898 | You can do similar tricks if you have, say, threads with an event queue - |
3706 | instead of storing a coroutine, you store the queue object and instead of |
3899 | instead of storing a coroutine, you store the queue object and instead of |
3707 | switching to a coroutine, you push the watcher onto the queue and notify |
3900 | switching to a coroutine, you push the watcher onto the queue and notify |
3708 | any waiters. |
3901 | any waiters. |
3709 | |
3902 | |
3710 | To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two |
3903 | To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two |
3711 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3904 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3712 | |
3905 | |
3713 | // my_ev.h |
3906 | // my_ev.h |
3714 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3907 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3715 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); |
3908 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb) |
3716 | #include "../libev/ev.h" |
3909 | #include "../libev/ev.h" |
3717 | |
3910 | |
3718 | // my_ev.c |
3911 | // my_ev.c |
3719 | #define EV_H "my_ev.h" |
3912 | #define EV_H "my_ev.h" |
3720 | #include "../libev/ev.c" |
3913 | #include "../libev/ev.c" |
… | |
… | |
3759 | |
3952 | |
3760 | =back |
3953 | =back |
3761 | |
3954 | |
3762 | =head1 C++ SUPPORT |
3955 | =head1 C++ SUPPORT |
3763 | |
3956 | |
|
|
3957 | =head2 C API |
|
|
3958 | |
|
|
3959 | The normal C API should work fine when used from C++: both ev.h and the |
|
|
3960 | libev sources can be compiled as C++. Therefore, code that uses the C API |
|
|
3961 | will work fine. |
|
|
3962 | |
|
|
3963 | Proper exception specifications might have to be added to callbacks passed |
|
|
3964 | to libev: exceptions may be thrown only from watcher callbacks, all |
|
|
3965 | other callbacks (allocator, syserr, loop acquire/release and periodic |
|
|
3966 | reschedule callbacks) must not throw exceptions, and might need a C<throw |
|
|
3967 | ()> specification. If you have code that needs to be compiled as both C |
|
|
3968 | and C++ you can use the C<EV_THROW> macro for this: |
|
|
3969 | |
|
|
3970 | static void |
|
|
3971 | fatal_error (const char *msg) EV_THROW |
|
|
3972 | { |
|
|
3973 | perror (msg); |
|
|
3974 | abort (); |
|
|
3975 | } |
|
|
3976 | |
|
|
3977 | ... |
|
|
3978 | ev_set_syserr_cb (fatal_error); |
|
|
3979 | |
|
|
3980 | The only API functions that can currently throw exceptions are C<ev_run>, |
|
|
3981 | C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter |
|
|
3982 | because it runs cleanup watchers). |
|
|
3983 | |
|
|
3984 | Throwing exceptions in watcher callbacks is only supported if libev itself |
|
|
3985 | is compiled with a C++ compiler or your C and C++ environments allow |
|
|
3986 | throwing exceptions through C libraries (most do). |
|
|
3987 | |
|
|
3988 | =head2 C++ API |
|
|
3989 | |
3764 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
3990 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
3765 | you to use some convenience methods to start/stop watchers and also change |
3991 | you to use some convenience methods to start/stop watchers and also change |
3766 | the callback model to a model using method callbacks on objects. |
3992 | the callback model to a model using method callbacks on objects. |
3767 | |
3993 | |
3768 | To use it, |
3994 | To use it, |
3769 | |
3995 | |
3770 | #include <ev++.h> |
3996 | #include <ev++.h> |
3771 | |
3997 | |
3772 | This automatically includes F<ev.h> and puts all of its definitions (many |
3998 | This automatically includes F<ev.h> and puts all of its definitions (many |
3773 | of them macros) into the global namespace. All C++ specific things are |
3999 | of them macros) into the global namespace. All C++ specific things are |
3774 | put into the C<ev> namespace. It should support all the same embedding |
4000 | put into the C<ev> namespace. It should support all the same embedding |
… | |
… | |
3783 | with C<operator ()> can be used as callbacks. Other types should be easy |
4009 | with C<operator ()> can be used as callbacks. Other types should be easy |
3784 | to add as long as they only need one additional pointer for context. If |
4010 | to add as long as they only need one additional pointer for context. If |
3785 | you need support for other types of functors please contact the author |
4011 | you need support for other types of functors please contact the author |
3786 | (preferably after implementing it). |
4012 | (preferably after implementing it). |
3787 | |
4013 | |
|
|
4014 | For all this to work, your C++ compiler either has to use the same calling |
|
|
4015 | conventions as your C compiler (for static member functions), or you have |
|
|
4016 | to embed libev and compile libev itself as C++. |
|
|
4017 | |
3788 | Here is a list of things available in the C<ev> namespace: |
4018 | Here is a list of things available in the C<ev> namespace: |
3789 | |
4019 | |
3790 | =over 4 |
4020 | =over 4 |
3791 | |
4021 | |
3792 | =item C<ev::READ>, C<ev::WRITE> etc. |
4022 | =item C<ev::READ>, C<ev::WRITE> etc. |
… | |
… | |
3801 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
4031 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
3802 | |
4032 | |
3803 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
4033 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
3804 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
4034 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
3805 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
4035 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
3806 | defines by many implementations. |
4036 | defined by many implementations. |
3807 | |
4037 | |
3808 | All of those classes have these methods: |
4038 | All of those classes have these methods: |
3809 | |
4039 | |
3810 | =over 4 |
4040 | =over 4 |
3811 | |
4041 | |
… | |
… | |
3873 | void operator() (ev::io &w, int revents) |
4103 | void operator() (ev::io &w, int revents) |
3874 | { |
4104 | { |
3875 | ... |
4105 | ... |
3876 | } |
4106 | } |
3877 | } |
4107 | } |
3878 | |
4108 | |
3879 | myfunctor f; |
4109 | myfunctor f; |
3880 | |
4110 | |
3881 | ev::io w; |
4111 | ev::io w; |
3882 | w.set (&f); |
4112 | w.set (&f); |
3883 | |
4113 | |
… | |
… | |
3901 | Associates a different C<struct ev_loop> with this watcher. You can only |
4131 | Associates a different C<struct ev_loop> with this watcher. You can only |
3902 | do this when the watcher is inactive (and not pending either). |
4132 | do this when the watcher is inactive (and not pending either). |
3903 | |
4133 | |
3904 | =item w->set ([arguments]) |
4134 | =item w->set ([arguments]) |
3905 | |
4135 | |
3906 | Basically the same as C<ev_TYPE_set>, with the same arguments. Either this |
4136 | Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>), |
3907 | method or a suitable start method must be called at least once. Unlike the |
4137 | with the same arguments. Either this method or a suitable start method |
3908 | C counterpart, an active watcher gets automatically stopped and restarted |
4138 | must be called at least once. Unlike the C counterpart, an active watcher |
3909 | when reconfiguring it with this method. |
4139 | gets automatically stopped and restarted when reconfiguring it with this |
|
|
4140 | method. |
|
|
4141 | |
|
|
4142 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
|
|
4143 | clashing with the C<set (loop)> method. |
3910 | |
4144 | |
3911 | =item w->start () |
4145 | =item w->start () |
3912 | |
4146 | |
3913 | Starts the watcher. Note that there is no C<loop> argument, as the |
4147 | Starts the watcher. Note that there is no C<loop> argument, as the |
3914 | constructor already stores the event loop. |
4148 | constructor already stores the event loop. |
… | |
… | |
3944 | watchers in the constructor. |
4178 | watchers in the constructor. |
3945 | |
4179 | |
3946 | class myclass |
4180 | class myclass |
3947 | { |
4181 | { |
3948 | ev::io io ; void io_cb (ev::io &w, int revents); |
4182 | ev::io io ; void io_cb (ev::io &w, int revents); |
3949 | ev::io2 io2 ; void io2_cb (ev::io &w, int revents); |
4183 | ev::io io2 ; void io2_cb (ev::io &w, int revents); |
3950 | ev::idle idle; void idle_cb (ev::idle &w, int revents); |
4184 | ev::idle idle; void idle_cb (ev::idle &w, int revents); |
3951 | |
4185 | |
3952 | myclass (int fd) |
4186 | myclass (int fd) |
3953 | { |
4187 | { |
3954 | io .set <myclass, &myclass::io_cb > (this); |
4188 | io .set <myclass, &myclass::io_cb > (this); |
… | |
… | |
4005 | L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. |
4239 | L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. |
4006 | |
4240 | |
4007 | =item D |
4241 | =item D |
4008 | |
4242 | |
4009 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
4243 | Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to |
4010 | be found at L<http://proj.llucax.com.ar/wiki/evd>. |
4244 | be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>. |
4011 | |
4245 | |
4012 | =item Ocaml |
4246 | =item Ocaml |
4013 | |
4247 | |
4014 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
4248 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
4015 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
4249 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
… | |
… | |
4018 | |
4252 | |
4019 | Brian Maher has written a partial interface to libev for lua (at the |
4253 | Brian Maher has written a partial interface to libev for lua (at the |
4020 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4254 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4021 | L<http://github.com/brimworks/lua-ev>. |
4255 | L<http://github.com/brimworks/lua-ev>. |
4022 | |
4256 | |
|
|
4257 | =item Javascript |
|
|
4258 | |
|
|
4259 | Node.js (L<http://nodejs.org>) uses libev as the underlying event library. |
|
|
4260 | |
|
|
4261 | =item Others |
|
|
4262 | |
|
|
4263 | There are others, and I stopped counting. |
|
|
4264 | |
4023 | =back |
4265 | =back |
4024 | |
4266 | |
4025 | |
4267 | |
4026 | =head1 MACRO MAGIC |
4268 | =head1 MACRO MAGIC |
4027 | |
4269 | |
… | |
… | |
4063 | suitable for use with C<EV_A>. |
4305 | suitable for use with C<EV_A>. |
4064 | |
4306 | |
4065 | =item C<EV_DEFAULT>, C<EV_DEFAULT_> |
4307 | =item C<EV_DEFAULT>, C<EV_DEFAULT_> |
4066 | |
4308 | |
4067 | Similar to the other two macros, this gives you the value of the default |
4309 | Similar to the other two macros, this gives you the value of the default |
4068 | loop, if multiple loops are supported ("ev loop default"). |
4310 | loop, if multiple loops are supported ("ev loop default"). The default loop |
|
|
4311 | will be initialised if it isn't already initialised. |
|
|
4312 | |
|
|
4313 | For non-multiplicity builds, these macros do nothing, so you always have |
|
|
4314 | to initialise the loop somewhere. |
4069 | |
4315 | |
4070 | =item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> |
4316 | =item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_> |
4071 | |
4317 | |
4072 | Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the |
4318 | Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the |
4073 | default loop has been initialised (C<UC> == unchecked). Their behaviour |
4319 | default loop has been initialised (C<UC> == unchecked). Their behaviour |
… | |
… | |
4321 | |
4567 | |
4322 | If programs implement their own fd to handle mapping on win32, then this |
4568 | If programs implement their own fd to handle mapping on win32, then this |
4323 | macro can be used to override the C<close> function, useful to unregister |
4569 | macro can be used to override the C<close> function, useful to unregister |
4324 | file descriptors again. Note that the replacement function has to close |
4570 | file descriptors again. Note that the replacement function has to close |
4325 | the underlying OS handle. |
4571 | the underlying OS handle. |
|
|
4572 | |
|
|
4573 | =item EV_USE_WSASOCKET |
|
|
4574 | |
|
|
4575 | If defined to be C<1>, libev will use C<WSASocket> to create its internal |
|
|
4576 | communication socket, which works better in some environments. Otherwise, |
|
|
4577 | the normal C<socket> function will be used, which works better in other |
|
|
4578 | environments. |
4326 | |
4579 | |
4327 | =item EV_USE_POLL |
4580 | =item EV_USE_POLL |
4328 | |
4581 | |
4329 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4582 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4330 | backend. Otherwise it will be enabled on non-win32 platforms. It |
4583 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
4366 | If defined to be C<1>, libev will compile in support for the Linux inotify |
4619 | If defined to be C<1>, libev will compile in support for the Linux inotify |
4367 | interface to speed up C<ev_stat> watchers. Its actual availability will |
4620 | interface to speed up C<ev_stat> watchers. Its actual availability will |
4368 | be detected at runtime. If undefined, it will be enabled if the headers |
4621 | be detected at runtime. If undefined, it will be enabled if the headers |
4369 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4622 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4370 | |
4623 | |
|
|
4624 | =item EV_NO_SMP |
|
|
4625 | |
|
|
4626 | If defined to be C<1>, libev will assume that memory is always coherent |
|
|
4627 | between threads, that is, threads can be used, but threads never run on |
|
|
4628 | different cpus (or different cpu cores). This reduces dependencies |
|
|
4629 | and makes libev faster. |
|
|
4630 | |
|
|
4631 | =item EV_NO_THREADS |
|
|
4632 | |
|
|
4633 | If defined to be C<1>, libev will assume that it will never be called from |
|
|
4634 | different threads (that includes signal handlers), which is a stronger |
|
|
4635 | assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes |
|
|
4636 | libev faster. |
|
|
4637 | |
4371 | =item EV_ATOMIC_T |
4638 | =item EV_ATOMIC_T |
4372 | |
4639 | |
4373 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4640 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4374 | access is atomic and serialised with respect to other threads or signal |
4641 | access is atomic with respect to other threads or signal contexts. No |
4375 | contexts. No such type is easily found in the C language, so you can |
4642 | such type is easily found in the C language, so you can provide your own |
4376 | provide your own type that you know is safe for your purposes. It is used |
4643 | type that you know is safe for your purposes. It is used both for signal |
4377 | both for signal handler "locking" as well as for signal and thread safety |
4644 | handler "locking" as well as for signal and thread safety in C<ev_async> |
4378 | in C<ev_async> watchers. |
4645 | watchers. |
4379 | |
4646 | |
4380 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4647 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4381 | (from F<signal.h>), which is usually good enough on most platforms. |
4648 | (from F<signal.h>), which is usually good enough on most platforms. |
4382 | |
4649 | |
4383 | =item EV_H (h) |
4650 | =item EV_H (h) |
… | |
… | |
4410 | will have the C<struct ev_loop *> as first argument, and you can create |
4677 | will have the C<struct ev_loop *> as first argument, and you can create |
4411 | additional independent event loops. Otherwise there will be no support |
4678 | additional independent event loops. Otherwise there will be no support |
4412 | for multiple event loops and there is no first event loop pointer |
4679 | for multiple event loops and there is no first event loop pointer |
4413 | argument. Instead, all functions act on the single default loop. |
4680 | argument. Instead, all functions act on the single default loop. |
4414 | |
4681 | |
|
|
4682 | Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a |
|
|
4683 | default loop when multiplicity is switched off - you always have to |
|
|
4684 | initialise the loop manually in this case. |
|
|
4685 | |
4415 | =item EV_MINPRI |
4686 | =item EV_MINPRI |
4416 | |
4687 | |
4417 | =item EV_MAXPRI |
4688 | =item EV_MAXPRI |
4418 | |
4689 | |
4419 | The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to |
4690 | The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to |
… | |
… | |
4455 | #define EV_USE_POLL 1 |
4726 | #define EV_USE_POLL 1 |
4456 | #define EV_CHILD_ENABLE 1 |
4727 | #define EV_CHILD_ENABLE 1 |
4457 | #define EV_ASYNC_ENABLE 1 |
4728 | #define EV_ASYNC_ENABLE 1 |
4458 | |
4729 | |
4459 | The actual value is a bitset, it can be a combination of the following |
4730 | The actual value is a bitset, it can be a combination of the following |
4460 | values: |
4731 | values (by default, all of these are enabled): |
4461 | |
4732 | |
4462 | =over 4 |
4733 | =over 4 |
4463 | |
4734 | |
4464 | =item C<1> - faster/larger code |
4735 | =item C<1> - faster/larger code |
4465 | |
4736 | |
… | |
… | |
4469 | code size by roughly 30% on amd64). |
4740 | code size by roughly 30% on amd64). |
4470 | |
4741 | |
4471 | When optimising for size, use of compiler flags such as C<-Os> with |
4742 | When optimising for size, use of compiler flags such as C<-Os> with |
4472 | gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of |
4743 | gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of |
4473 | assertions. |
4744 | assertions. |
|
|
4745 | |
|
|
4746 | The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler |
|
|
4747 | (e.g. gcc with C<-Os>). |
4474 | |
4748 | |
4475 | =item C<2> - faster/larger data structures |
4749 | =item C<2> - faster/larger data structures |
4476 | |
4750 | |
4477 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
4751 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
4478 | hash table sizes and so on. This will usually further increase code size |
4752 | hash table sizes and so on. This will usually further increase code size |
4479 | and can additionally have an effect on the size of data structures at |
4753 | and can additionally have an effect on the size of data structures at |
4480 | runtime. |
4754 | runtime. |
4481 | |
4755 | |
|
|
4756 | The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler |
|
|
4757 | (e.g. gcc with C<-Os>). |
|
|
4758 | |
4482 | =item C<4> - full API configuration |
4759 | =item C<4> - full API configuration |
4483 | |
4760 | |
4484 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
4761 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
4485 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
4762 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
4486 | |
4763 | |
… | |
… | |
4516 | |
4793 | |
4517 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
4794 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
4518 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
4795 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
4519 | your program might be left out as well - a binary starting a timer and an |
4796 | your program might be left out as well - a binary starting a timer and an |
4520 | I/O watcher then might come out at only 5Kb. |
4797 | I/O watcher then might come out at only 5Kb. |
|
|
4798 | |
|
|
4799 | =item EV_API_STATIC |
|
|
4800 | |
|
|
4801 | If this symbol is defined (by default it is not), then all identifiers |
|
|
4802 | will have static linkage. This means that libev will not export any |
|
|
4803 | identifiers, and you cannot link against libev anymore. This can be useful |
|
|
4804 | when you embed libev, only want to use libev functions in a single file, |
|
|
4805 | and do not want its identifiers to be visible. |
|
|
4806 | |
|
|
4807 | To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that |
|
|
4808 | wants to use libev. |
|
|
4809 | |
|
|
4810 | This option only works when libev is compiled with a C compiler, as C++ |
|
|
4811 | doesn't support the required declaration syntax. |
4521 | |
4812 | |
4522 | =item EV_AVOID_STDIO |
4813 | =item EV_AVOID_STDIO |
4523 | |
4814 | |
4524 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
4815 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
4525 | functions (printf, scanf, perror etc.). This will increase the code size |
4816 | functions (printf, scanf, perror etc.). This will increase the code size |
… | |
… | |
4730 | default loop and triggering an C<ev_async> watcher from the default loop |
5021 | default loop and triggering an C<ev_async> watcher from the default loop |
4731 | watcher callback into the event loop interested in the signal. |
5022 | watcher callback into the event loop interested in the signal. |
4732 | |
5023 | |
4733 | =back |
5024 | =back |
4734 | |
5025 | |
4735 | See also L<THREAD LOCKING EXAMPLE>. |
5026 | See also L</THREAD LOCKING EXAMPLE>. |
4736 | |
5027 | |
4737 | =head3 COROUTINES |
5028 | =head3 COROUTINES |
4738 | |
5029 | |
4739 | Libev is very accommodating to coroutines ("cooperative threads"): |
5030 | Libev is very accommodating to coroutines ("cooperative threads"): |
4740 | libev fully supports nesting calls to its functions from different |
5031 | libev fully supports nesting calls to its functions from different |
… | |
… | |
5031 | thread" or will block signals process-wide, both behaviours would |
5322 | thread" or will block signals process-wide, both behaviours would |
5032 | be compatible with libev. Interaction between C<sigprocmask> and |
5323 | be compatible with libev. Interaction between C<sigprocmask> and |
5033 | C<pthread_sigmask> could complicate things, however. |
5324 | C<pthread_sigmask> could complicate things, however. |
5034 | |
5325 | |
5035 | The most portable way to handle signals is to block signals in all threads |
5326 | The most portable way to handle signals is to block signals in all threads |
5036 | except the initial one, and run the default loop in the initial thread as |
5327 | except the initial one, and run the signal handling loop in the initial |
5037 | well. |
5328 | thread as well. |
5038 | |
5329 | |
5039 | =item C<long> must be large enough for common memory allocation sizes |
5330 | =item C<long> must be large enough for common memory allocation sizes |
5040 | |
5331 | |
5041 | To improve portability and simplify its API, libev uses C<long> internally |
5332 | To improve portability and simplify its API, libev uses C<long> internally |
5042 | instead of C<size_t> when allocating its data structures. On non-POSIX |
5333 | instead of C<size_t> when allocating its data structures. On non-POSIX |
… | |
… | |
5051 | good enough for at least into the year 4000 with millisecond accuracy |
5342 | good enough for at least into the year 4000 with millisecond accuracy |
5052 | (the design goal for libev). This requirement is overfulfilled by |
5343 | (the design goal for libev). This requirement is overfulfilled by |
5053 | implementations using IEEE 754, which is basically all existing ones. |
5344 | implementations using IEEE 754, which is basically all existing ones. |
5054 | |
5345 | |
5055 | With IEEE 754 doubles, you get microsecond accuracy until at least the |
5346 | With IEEE 754 doubles, you get microsecond accuracy until at least the |
5056 | year 2255 (and millisecond accuray till the year 287396 - by then, libev |
5347 | year 2255 (and millisecond accuracy till the year 287396 - by then, libev |
5057 | is either obsolete or somebody patched it to use C<long double> or |
5348 | is either obsolete or somebody patched it to use C<long double> or |
5058 | something like that, just kidding). |
5349 | something like that, just kidding). |
5059 | |
5350 | |
5060 | =back |
5351 | =back |
5061 | |
5352 | |
… | |
… | |
5146 | =over 4 |
5437 | =over 4 |
5147 | |
5438 | |
5148 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5439 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5149 | |
5440 | |
5150 | The backward compatibility mechanism can be controlled by |
5441 | The backward compatibility mechanism can be controlled by |
5151 | C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> |
5442 | C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING> |
5152 | section. |
5443 | section. |
5153 | |
5444 | |
5154 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5445 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5155 | |
5446 | |
5156 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
5447 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
… | |
… | |
5199 | =over 4 |
5490 | =over 4 |
5200 | |
5491 | |
5201 | =item active |
5492 | =item active |
5202 | |
5493 | |
5203 | A watcher is active as long as it has been started and not yet stopped. |
5494 | A watcher is active as long as it has been started and not yet stopped. |
5204 | See L<WATCHER STATES> for details. |
5495 | See L</WATCHER STATES> for details. |
5205 | |
5496 | |
5206 | =item application |
5497 | =item application |
5207 | |
5498 | |
5208 | In this document, an application is whatever is using libev. |
5499 | In this document, an application is whatever is using libev. |
5209 | |
5500 | |
… | |
… | |
5245 | watchers and events. |
5536 | watchers and events. |
5246 | |
5537 | |
5247 | =item pending |
5538 | =item pending |
5248 | |
5539 | |
5249 | A watcher is pending as soon as the corresponding event has been |
5540 | A watcher is pending as soon as the corresponding event has been |
5250 | detected. See L<WATCHER STATES> for details. |
5541 | detected. See L</WATCHER STATES> for details. |
5251 | |
5542 | |
5252 | =item real time |
5543 | =item real time |
5253 | |
5544 | |
5254 | The physical time that is observed. It is apparently strictly monotonic :) |
5545 | The physical time that is observed. It is apparently strictly monotonic :) |
5255 | |
5546 | |