|
|
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 |
… | |
… | |
396 | |
398 | |
397 | If this flag bit is or'ed into the flag value (or the program runs setuid |
399 | If this flag bit is or'ed into the flag value (or the program runs setuid |
398 | or setgid) then libev will I<not> look at the environment variable |
400 | or setgid) then libev will I<not> look at the environment variable |
399 | C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will |
401 | C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will |
400 | override the flags completely if it is found in the environment. This is |
402 | override the flags completely if it is found in the environment. This is |
401 | useful to try out specific backends to test their performance, or to work |
403 | useful to try out specific backends to test their performance, to work |
402 | around bugs. |
404 | around bugs, or to make libev threadsafe (accessing environment variables |
|
|
405 | cannot be done in a threadsafe way, but usually it works if no other |
|
|
406 | thread modifies them). |
403 | |
407 | |
404 | =item C<EVFLAG_FORKCHECK> |
408 | =item C<EVFLAG_FORKCHECK> |
405 | |
409 | |
406 | Instead of calling C<ev_loop_fork> manually after a fork, you can also |
410 | Instead of calling C<ev_loop_fork> manually after a fork, you can also |
407 | make libev check for a fork in each iteration by enabling this flag. |
411 | make libev check for a fork in each iteration by enabling this flag. |
408 | |
412 | |
409 | This works by calling C<getpid ()> on every iteration of the loop, |
413 | This works by calling C<getpid ()> on every iteration of the loop, |
410 | and thus this might slow down your event loop if you do a lot of loop |
414 | and thus this might slow down your event loop if you do a lot of loop |
411 | iterations and little real work, but is usually not noticeable (on my |
415 | iterations and little real work, but is usually not noticeable (on my |
412 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence |
416 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn |
413 | without a system call and thus I<very> fast, but my GNU/Linux system also has |
417 | sequence without a system call and thus I<very> fast, but my GNU/Linux |
414 | C<pthread_atfork> which is even faster). |
418 | system also has C<pthread_atfork> which is even faster). (Update: glibc |
|
|
419 | versions 2.25 apparently removed the C<getpid> optimisation again). |
415 | |
420 | |
416 | The big advantage of this flag is that you can forget about fork (and |
421 | The big advantage of this flag is that you can forget about fork (and |
417 | forget about forgetting to tell libev about forking) when you use this |
422 | forget about forgetting to tell libev about forking, although you still |
418 | flag. |
423 | have to ignore C<SIGPIPE>) when you use this flag. |
419 | |
424 | |
420 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
425 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
421 | environment variable. |
426 | environment variable. |
422 | |
427 | |
423 | =item C<EVFLAG_NOINOTIFY> |
428 | =item C<EVFLAG_NOINOTIFY> |
… | |
… | |
569 | kernel is more efficient (which says nothing about its actual speed, of |
574 | kernel is more efficient (which says nothing about its actual speed, of |
570 | course). While stopping, setting and starting an I/O watcher does never |
575 | course). While stopping, setting and starting an I/O watcher does never |
571 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
576 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
572 | two event changes per incident. Support for C<fork ()> is very bad (you |
577 | two event changes per incident. Support for C<fork ()> is very bad (you |
573 | might have to leak fd's on fork, but it's more sane than epoll) and it |
578 | might have to leak fd's on fork, but it's more sane than epoll) and it |
574 | drops fds silently in similarly hard-to-detect cases |
579 | drops fds silently in similarly hard-to-detect cases. |
575 | |
580 | |
576 | This backend usually performs well under most conditions. |
581 | This backend usually performs well under most conditions. |
577 | |
582 | |
578 | While nominally embeddable in other event loops, this doesn't work |
583 | While nominally embeddable in other event loops, this doesn't work |
579 | everywhere, so you might need to test for this. And since it is broken |
584 | everywhere, so you might need to test for this. And since it is broken |
… | |
… | |
678 | If you need dynamically allocated loops it is better to use C<ev_loop_new> |
683 | If you need dynamically allocated loops it is better to use C<ev_loop_new> |
679 | and C<ev_loop_destroy>. |
684 | and C<ev_loop_destroy>. |
680 | |
685 | |
681 | =item ev_loop_fork (loop) |
686 | =item ev_loop_fork (loop) |
682 | |
687 | |
683 | This function sets a flag that causes subsequent C<ev_run> iterations to |
688 | This function sets a flag that causes subsequent C<ev_run> iterations |
684 | reinitialise the kernel state for backends that have one. Despite the |
689 | to reinitialise the kernel state for backends that have one. Despite |
685 | name, you can call it anytime, but it makes most sense after forking, in |
690 | the name, you can call it anytime you are allowed to start or stop |
686 | the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the |
691 | watchers (except inside an C<ev_prepare> callback), but it makes most |
|
|
692 | sense after forking, in the child process. You I<must> call it (or use |
687 | child before resuming or calling C<ev_run>. |
693 | C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>. |
688 | |
694 | |
|
|
695 | In addition, if you want to reuse a loop (via this function or |
|
|
696 | C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>. |
|
|
697 | |
689 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
698 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
690 | a fork, I<even if you do not plan to use the loop in the parent>. This is |
699 | a fork, I<even if you do not plan to use the loop in the parent>. This is |
691 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
700 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
692 | during fork. |
701 | during fork. |
693 | |
702 | |
694 | On the other hand, you only need to call this function in the child |
703 | On the other hand, you only need to call this function in the child |
… | |
… | |
1393 | transition between them will be described in more detail - and while these |
1402 | transition between them will be described in more detail - and while these |
1394 | rules might look complicated, they usually do "the right thing". |
1403 | rules might look complicated, they usually do "the right thing". |
1395 | |
1404 | |
1396 | =over 4 |
1405 | =over 4 |
1397 | |
1406 | |
1398 | =item initialiased |
1407 | =item initialised |
1399 | |
1408 | |
1400 | Before a watcher can be registered with the event loop it has to be |
1409 | Before a watcher can be registered with the event loop it has to be |
1401 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
1410 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
1402 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1411 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
1403 | |
1412 | |
… | |
… | |
2024 | |
2033 | |
2025 | The relative timeouts are calculated relative to the C<ev_now ()> |
2034 | The relative timeouts are calculated relative to the C<ev_now ()> |
2026 | time. This is usually the right thing as this timestamp refers to the time |
2035 | time. This is usually the right thing as this timestamp refers to the time |
2027 | of the event triggering whatever timeout you are modifying/starting. If |
2036 | of the event triggering whatever timeout you are modifying/starting. If |
2028 | you suspect event processing to be delayed and you I<need> to base the |
2037 | you suspect event processing to be delayed and you I<need> to base the |
2029 | timeout on the current time, use something like this to adjust for this: |
2038 | timeout on the current time, use something like the following to adjust |
|
|
2039 | for it: |
2030 | |
2040 | |
2031 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
2041 | ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.); |
2032 | |
2042 | |
2033 | If the event loop is suspended for a long time, you can also force an |
2043 | If the event loop is suspended for a long time, you can also force an |
2034 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
2044 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
2035 | ()>. |
2045 | ()>, although that will push the event time of all outstanding events |
|
|
2046 | further into the future. |
2036 | |
2047 | |
2037 | =head3 The special problem of unsynchronised clocks |
2048 | =head3 The special problem of unsynchronised clocks |
2038 | |
2049 | |
2039 | Modern systems have a variety of clocks - libev itself uses the normal |
2050 | Modern systems have a variety of clocks - libev itself uses the normal |
2040 | "wall clock" clock and, if available, the monotonic clock (to avoid time |
2051 | "wall clock" clock and, if available, the monotonic clock (to avoid time |
… | |
… | |
2199 | Periodic watchers are also timers of a kind, but they are very versatile |
2210 | Periodic watchers are also timers of a kind, but they are very versatile |
2200 | (and unfortunately a bit complex). |
2211 | (and unfortunately a bit complex). |
2201 | |
2212 | |
2202 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2213 | Unlike C<ev_timer>, periodic watchers are not based on real time (or |
2203 | relative time, the physical time that passes) but on wall clock time |
2214 | relative time, the physical time that passes) but on wall clock time |
2204 | (absolute time, the thing you can read on your calender or clock). The |
2215 | (absolute time, the thing you can read on your calendar or clock). The |
2205 | difference is that wall clock time can run faster or slower than real |
2216 | difference is that wall clock time can run faster or slower than real |
2206 | time, and time jumps are not uncommon (e.g. when you adjust your |
2217 | time, and time jumps are not uncommon (e.g. when you adjust your |
2207 | wrist-watch). |
2218 | wrist-watch). |
2208 | |
2219 | |
2209 | You can tell a periodic watcher to trigger after some specific point |
2220 | You can tell a periodic watcher to trigger after some specific point |
… | |
… | |
2389 | |
2400 | |
2390 | ev_periodic hourly_tick; |
2401 | ev_periodic hourly_tick; |
2391 | ev_periodic_init (&hourly_tick, clock_cb, |
2402 | ev_periodic_init (&hourly_tick, clock_cb, |
2392 | fmod (ev_now (loop), 3600.), 3600., 0); |
2403 | fmod (ev_now (loop), 3600.), 3600., 0); |
2393 | ev_periodic_start (loop, &hourly_tick); |
2404 | ev_periodic_start (loop, &hourly_tick); |
2394 | |
2405 | |
2395 | |
2406 | |
2396 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2407 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2397 | |
2408 | |
2398 | Signal watchers will trigger an event when the process receives a specific |
2409 | Signal watchers will trigger an event when the process receives a specific |
2399 | signal one or more times. Even though signals are very asynchronous, libev |
2410 | signal one or more times. Even though signals are very asynchronous, libev |
… | |
… | |
2409 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
2420 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
2410 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
2421 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
2411 | C<SIGINT> in both the default loop and another loop at the same time. At |
2422 | C<SIGINT> in both the default loop and another loop at the same time. At |
2412 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2423 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2413 | |
2424 | |
2414 | When the first watcher gets started will libev actually register something |
2425 | Only after the first watcher for a signal is started will libev actually |
2415 | with the kernel (thus it coexists with your own signal handlers as long as |
2426 | register something with the kernel. It thus coexists with your own signal |
2416 | you don't register any with libev for the same signal). |
2427 | handlers as long as you don't register any with libev for the same signal. |
2417 | |
2428 | |
2418 | If possible and supported, libev will install its handlers with |
2429 | If possible and supported, libev will install its handlers with |
2419 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2430 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2420 | not be unduly interrupted. If you have a problem with system calls getting |
2431 | not be unduly interrupted. If you have a problem with system calls getting |
2421 | interrupted by signals you can block all signals in an C<ev_check> watcher |
2432 | interrupted by signals you can block all signals in an C<ev_check> watcher |
… | |
… | |
2606 | |
2617 | |
2607 | =head2 C<ev_stat> - did the file attributes just change? |
2618 | =head2 C<ev_stat> - did the file attributes just change? |
2608 | |
2619 | |
2609 | This watches a file system path for attribute changes. That is, it calls |
2620 | This watches a file system path for attribute changes. That is, it calls |
2610 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2621 | C<stat> on that path in regular intervals (or when the OS says it changed) |
2611 | and sees if it changed compared to the last time, invoking the callback if |
2622 | and sees if it changed compared to the last time, invoking the callback |
2612 | it did. |
2623 | if it did. Starting the watcher C<stat>'s the file, so only changes that |
|
|
2624 | happen after the watcher has been started will be reported. |
2613 | |
2625 | |
2614 | The path does not need to exist: changing from "path exists" to "path does |
2626 | The path does not need to exist: changing from "path exists" to "path does |
2615 | not exist" is a status change like any other. The condition "path does not |
2627 | not exist" is a status change like any other. The condition "path does not |
2616 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2628 | exist" (or more correctly "path cannot be stat'ed") is signified by the |
2617 | C<st_nlink> field being zero (which is otherwise always forced to be at |
2629 | C<st_nlink> field being zero (which is otherwise always forced to be at |
… | |
… | |
2858 | |
2870 | |
2859 | This mode of operation can be useful together with an C<ev_check> watcher, |
2871 | This mode of operation can be useful together with an C<ev_check> watcher, |
2860 | to do something on each event loop iteration - for example to balance load |
2872 | to do something on each event loop iteration - for example to balance load |
2861 | between different connections. |
2873 | between different connections. |
2862 | |
2874 | |
2863 | See L</Abusing an C<ev_check> watcher for its side-effect> for a longer |
2875 | See L</Abusing an ev_check watcher for its side-effect> for a longer |
2864 | example. |
2876 | example. |
2865 | |
2877 | |
2866 | =head3 Watcher-Specific Functions and Data Members |
2878 | =head3 Watcher-Specific Functions and Data Members |
2867 | |
2879 | |
2868 | =over 4 |
2880 | =over 4 |
… | |
… | |
2902 | |
2914 | |
2903 | Prepare and check watchers are often (but not always) used in pairs: |
2915 | Prepare and check watchers are often (but not always) used in pairs: |
2904 | prepare watchers get invoked before the process blocks and check watchers |
2916 | prepare watchers get invoked before the process blocks and check watchers |
2905 | afterwards. |
2917 | afterwards. |
2906 | |
2918 | |
2907 | You I<must not> call C<ev_run> or similar functions that enter |
2919 | You I<must not> call C<ev_run> (or similar functions that enter the |
2908 | the current event loop from either C<ev_prepare> or C<ev_check> |
2920 | current event loop) or C<ev_loop_fork> from either C<ev_prepare> or |
2909 | watchers. Other loops than the current one are fine, however. The |
2921 | C<ev_check> watchers. Other loops than the current one are fine, |
2910 | rationale behind this is that you do not need to check for recursion in |
2922 | however. The rationale behind this is that you do not need to check |
2911 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
2923 | for recursion in those watchers, i.e. the sequence will always be |
2912 | C<ev_check> so if you have one watcher of each kind they will always be |
2924 | C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each |
2913 | called in pairs bracketing the blocking call. |
2925 | kind they will always be called in pairs bracketing the blocking call. |
2914 | |
2926 | |
2915 | Their main purpose is to integrate other event mechanisms into libev and |
2927 | Their main purpose is to integrate other event mechanisms into libev and |
2916 | their use is somewhat advanced. They could be used, for example, to track |
2928 | their use is somewhat advanced. They could be used, for example, to track |
2917 | variable changes, implement your own watchers, integrate net-snmp or a |
2929 | variable changes, implement your own watchers, integrate net-snmp or a |
2918 | coroutine library and lots more. They are also occasionally useful if |
2930 | coroutine library and lots more. They are also occasionally useful if |
… | |
… | |
2962 | |
2974 | |
2963 | Using an C<ev_check> watcher is almost enough: it will be called on the |
2975 | Using an C<ev_check> watcher is almost enough: it will be called on the |
2964 | next event loop iteration. However, that isn't as soon as possible - |
2976 | next event loop iteration. However, that isn't as soon as possible - |
2965 | without external events, your C<ev_check> watcher will not be invoked. |
2977 | without external events, your C<ev_check> watcher will not be invoked. |
2966 | |
2978 | |
2967 | |
|
|
2968 | This is where C<ev_idle> watchers come in handy - all you need is a |
2979 | This is where C<ev_idle> watchers come in handy - all you need is a |
2969 | single global idle watcher that is active as long as you have one active |
2980 | single global idle watcher that is active as long as you have one active |
2970 | C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop |
2981 | C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop |
2971 | will not sleep, and the C<ev_check> watcher makes sure a callback gets |
2982 | will not sleep, and the C<ev_check> watcher makes sure a callback gets |
2972 | invoked. Neither watcher alone can do that. |
2983 | invoked. Neither watcher alone can do that. |
… | |
… | |
3178 | |
3189 | |
3179 | =over 4 |
3190 | =over 4 |
3180 | |
3191 | |
3181 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3192 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
3182 | |
3193 | |
3183 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
3194 | =item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop) |
3184 | |
3195 | |
3185 | Configures the watcher to embed the given loop, which must be |
3196 | Configures the watcher to embed the given loop, which must be |
3186 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3197 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
3187 | invoked automatically, otherwise it is the responsibility of the callback |
3198 | invoked automatically, otherwise it is the responsibility of the callback |
3188 | to invoke it (it will continue to be called until the sweep has been done, |
3199 | to invoke it (it will continue to be called until the sweep has been done, |
… | |
… | |
3209 | used). |
3220 | used). |
3210 | |
3221 | |
3211 | struct ev_loop *loop_hi = ev_default_init (0); |
3222 | struct ev_loop *loop_hi = ev_default_init (0); |
3212 | struct ev_loop *loop_lo = 0; |
3223 | struct ev_loop *loop_lo = 0; |
3213 | ev_embed embed; |
3224 | ev_embed embed; |
3214 | |
3225 | |
3215 | // see if there is a chance of getting one that works |
3226 | // see if there is a chance of getting one that works |
3216 | // (remember that a flags value of 0 means autodetection) |
3227 | // (remember that a flags value of 0 means autodetection) |
3217 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3228 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3218 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3229 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3219 | : 0; |
3230 | : 0; |
… | |
… | |
3233 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3244 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3234 | |
3245 | |
3235 | struct ev_loop *loop = ev_default_init (0); |
3246 | struct ev_loop *loop = ev_default_init (0); |
3236 | struct ev_loop *loop_socket = 0; |
3247 | struct ev_loop *loop_socket = 0; |
3237 | ev_embed embed; |
3248 | ev_embed embed; |
3238 | |
3249 | |
3239 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3250 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3240 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3251 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3241 | { |
3252 | { |
3242 | ev_embed_init (&embed, 0, loop_socket); |
3253 | ev_embed_init (&embed, 0, loop_socket); |
3243 | ev_embed_start (loop, &embed); |
3254 | ev_embed_start (loop, &embed); |
… | |
… | |
3251 | |
3262 | |
3252 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3263 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
3253 | |
3264 | |
3254 | Fork watchers are called when a C<fork ()> was detected (usually because |
3265 | Fork watchers are called when a C<fork ()> was detected (usually because |
3255 | whoever is a good citizen cared to tell libev about it by calling |
3266 | whoever is a good citizen cared to tell libev about it by calling |
3256 | C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the |
3267 | C<ev_loop_fork>). The invocation is done before the event loop blocks next |
3257 | event loop blocks next and before C<ev_check> watchers are being called, |
3268 | and before C<ev_check> watchers are being called, and only in the child |
3258 | and only in the child after the fork. If whoever good citizen calling |
3269 | after the fork. If whoever good citizen calling C<ev_default_fork> cheats |
3259 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
3270 | and calls it in the wrong process, the fork handlers will be invoked, too, |
3260 | handlers will be invoked, too, of course. |
3271 | of course. |
3261 | |
3272 | |
3262 | =head3 The special problem of life after fork - how is it possible? |
3273 | =head3 The special problem of life after fork - how is it possible? |
3263 | |
3274 | |
3264 | Most uses of C<fork()> consist of forking, then some simple calls to set |
3275 | Most uses of C<fork ()> consist of forking, then some simple calls to set |
3265 | up/change the process environment, followed by a call to C<exec()>. This |
3276 | up/change the process environment, followed by a call to C<exec()>. This |
3266 | sequence should be handled by libev without any problems. |
3277 | sequence should be handled by libev without any problems. |
3267 | |
3278 | |
3268 | This changes when the application actually wants to do event handling |
3279 | This changes when the application actually wants to do event handling |
3269 | in the child, or both parent in child, in effect "continuing" after the |
3280 | in the child, or both parent in child, in effect "continuing" after the |
… | |
… | |
3659 | already been invoked. |
3670 | already been invoked. |
3660 | |
3671 | |
3661 | A common way around all these issues is to make sure that |
3672 | A common way around all these issues is to make sure that |
3662 | C<start_new_request> I<always> returns before the callback is invoked. If |
3673 | C<start_new_request> I<always> returns before the callback is invoked. If |
3663 | C<start_new_request> immediately knows the result, it can artificially |
3674 | C<start_new_request> immediately knows the result, it can artificially |
3664 | delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher |
3675 | delay invoking the callback by using a C<prepare> or C<idle> watcher for |
3665 | for example, or more sneakily, by reusing an existing (stopped) watcher |
3676 | example, or more sneakily, by reusing an existing (stopped) watcher and |
3666 | and pushing it into the pending queue: |
3677 | pushing it into the pending queue: |
3667 | |
3678 | |
3668 | ev_set_cb (watcher, callback); |
3679 | ev_set_cb (watcher, callback); |
3669 | ev_feed_event (EV_A_ watcher, 0); |
3680 | ev_feed_event (EV_A_ watcher, 0); |
3670 | |
3681 | |
3671 | This way, C<start_new_request> can safely return before the callback is |
3682 | This way, C<start_new_request> can safely return before the callback is |
… | |
… | |
3679 | |
3690 | |
3680 | This brings the problem of exiting - a callback might want to finish the |
3691 | This brings the problem of exiting - a callback might want to finish the |
3681 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3692 | main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but |
3682 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3693 | a modal "Are you sure?" dialog is still waiting), or just the nested one |
3683 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3694 | and not the main one (e.g. user clocked "Ok" in a modal dialog), or some |
3684 | other combination: In these cases, C<ev_break> will not work alone. |
3695 | other combination: In these cases, a simple C<ev_break> will not work. |
3685 | |
3696 | |
3686 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3697 | The solution is to maintain "break this loop" variable for each C<ev_run> |
3687 | invocation, and use a loop around C<ev_run> until the condition is |
3698 | invocation, and use a loop around C<ev_run> until the condition is |
3688 | triggered, using C<EVRUN_ONCE>: |
3699 | triggered, using C<EVRUN_ONCE>: |
3689 | |
3700 | |
… | |
… | |
3893 | To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two |
3904 | To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two |
3894 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3905 | files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: |
3895 | |
3906 | |
3896 | // my_ev.h |
3907 | // my_ev.h |
3897 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3908 | #define EV_CB_DECLARE(type) struct my_coro *cb; |
3898 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); |
3909 | #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb) |
3899 | #include "../libev/ev.h" |
3910 | #include "../libev/ev.h" |
3900 | |
3911 | |
3901 | // my_ev.c |
3912 | // my_ev.c |
3902 | #define EV_H "my_ev.h" |
3913 | #define EV_H "my_ev.h" |
3903 | #include "../libev/ev.c" |
3914 | #include "../libev/ev.c" |
… | |
… | |
3950 | libev sources can be compiled as C++. Therefore, code that uses the C API |
3961 | libev sources can be compiled as C++. Therefore, code that uses the C API |
3951 | will work fine. |
3962 | will work fine. |
3952 | |
3963 | |
3953 | Proper exception specifications might have to be added to callbacks passed |
3964 | Proper exception specifications might have to be added to callbacks passed |
3954 | to libev: exceptions may be thrown only from watcher callbacks, all |
3965 | to libev: exceptions may be thrown only from watcher callbacks, all |
3955 | other callbacks (allocator, syserr, loop acquire/release and periodioc |
3966 | other callbacks (allocator, syserr, loop acquire/release and periodic |
3956 | reschedule callbacks) must not throw exceptions, and might need a C<throw |
3967 | reschedule callbacks) must not throw exceptions, and might need a C<throw |
3957 | ()> specification. If you have code that needs to be compiled as both C |
3968 | ()> specification. If you have code that needs to be compiled as both C |
3958 | and C++ you can use the C<EV_THROW> macro for this: |
3969 | and C++ you can use the C<EV_THROW> macro for this: |
3959 | |
3970 | |
3960 | static void |
3971 | static void |
… | |
… | |
3980 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
3991 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
3981 | you to use some convenience methods to start/stop watchers and also change |
3992 | you to use some convenience methods to start/stop watchers and also change |
3982 | the callback model to a model using method callbacks on objects. |
3993 | the callback model to a model using method callbacks on objects. |
3983 | |
3994 | |
3984 | To use it, |
3995 | To use it, |
3985 | |
3996 | |
3986 | #include <ev++.h> |
3997 | #include <ev++.h> |
3987 | |
3998 | |
3988 | This automatically includes F<ev.h> and puts all of its definitions (many |
3999 | This automatically includes F<ev.h> and puts all of its definitions (many |
3989 | of them macros) into the global namespace. All C++ specific things are |
4000 | of them macros) into the global namespace. All C++ specific things are |
3990 | put into the C<ev> namespace. It should support all the same embedding |
4001 | put into the C<ev> namespace. It should support all the same embedding |
… | |
… | |
4093 | void operator() (ev::io &w, int revents) |
4104 | void operator() (ev::io &w, int revents) |
4094 | { |
4105 | { |
4095 | ... |
4106 | ... |
4096 | } |
4107 | } |
4097 | } |
4108 | } |
4098 | |
4109 | |
4099 | myfunctor f; |
4110 | myfunctor f; |
4100 | |
4111 | |
4101 | ev::io w; |
4112 | ev::io w; |
4102 | w.set (&f); |
4113 | w.set (&f); |
4103 | |
4114 | |
… | |
… | |
4121 | Associates a different C<struct ev_loop> with this watcher. You can only |
4132 | Associates a different C<struct ev_loop> with this watcher. You can only |
4122 | do this when the watcher is inactive (and not pending either). |
4133 | do this when the watcher is inactive (and not pending either). |
4123 | |
4134 | |
4124 | =item w->set ([arguments]) |
4135 | =item w->set ([arguments]) |
4125 | |
4136 | |
4126 | Basically the same as C<ev_TYPE_set>, with the same arguments. Either this |
4137 | Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>), |
4127 | method or a suitable start method must be called at least once. Unlike the |
4138 | with the same arguments. Either this method or a suitable start method |
4128 | C counterpart, an active watcher gets automatically stopped and restarted |
4139 | must be called at least once. Unlike the C counterpart, an active watcher |
4129 | when reconfiguring it with this method. |
4140 | gets automatically stopped and restarted when reconfiguring it with this |
|
|
4141 | method. |
|
|
4142 | |
|
|
4143 | For C<ev::embed> watchers this method is called C<set_embed>, to avoid |
|
|
4144 | clashing with the C<set (loop)> method. |
4130 | |
4145 | |
4131 | =item w->start () |
4146 | =item w->start () |
4132 | |
4147 | |
4133 | Starts the watcher. Note that there is no C<loop> argument, as the |
4148 | Starts the watcher. Note that there is no C<loop> argument, as the |
4134 | constructor already stores the event loop. |
4149 | constructor already stores the event loop. |
… | |
… | |
4238 | |
4253 | |
4239 | Brian Maher has written a partial interface to libev for lua (at the |
4254 | Brian Maher has written a partial interface to libev for lua (at the |
4240 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4255 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
4241 | L<http://github.com/brimworks/lua-ev>. |
4256 | L<http://github.com/brimworks/lua-ev>. |
4242 | |
4257 | |
|
|
4258 | =item Javascript |
|
|
4259 | |
|
|
4260 | Node.js (L<http://nodejs.org>) uses libev as the underlying event library. |
|
|
4261 | |
|
|
4262 | =item Others |
|
|
4263 | |
|
|
4264 | There are others, and I stopped counting. |
|
|
4265 | |
4243 | =back |
4266 | =back |
4244 | |
4267 | |
4245 | |
4268 | |
4246 | =head1 MACRO MAGIC |
4269 | =head1 MACRO MAGIC |
4247 | |
4270 | |
… | |
… | |
4364 | ev_vars.h |
4387 | ev_vars.h |
4365 | ev_wrap.h |
4388 | ev_wrap.h |
4366 | |
4389 | |
4367 | ev_win32.c required on win32 platforms only |
4390 | ev_win32.c required on win32 platforms only |
4368 | |
4391 | |
4369 | ev_select.c only when select backend is enabled (which is enabled by default) |
4392 | ev_select.c only when select backend is enabled |
4370 | ev_poll.c only when poll backend is enabled (disabled by default) |
4393 | ev_poll.c only when poll backend is enabled |
4371 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
4394 | ev_epoll.c only when the epoll backend is enabled |
4372 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
4395 | ev_kqueue.c only when the kqueue backend is enabled |
4373 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
4396 | ev_port.c only when the solaris port backend is enabled |
4374 | |
4397 | |
4375 | F<ev.c> includes the backend files directly when enabled, so you only need |
4398 | F<ev.c> includes the backend files directly when enabled, so you only need |
4376 | to compile this single file. |
4399 | to compile this single file. |
4377 | |
4400 | |
4378 | =head3 LIBEVENT COMPATIBILITY API |
4401 | =head3 LIBEVENT COMPATIBILITY API |
… | |
… | |
4545 | |
4568 | |
4546 | If programs implement their own fd to handle mapping on win32, then this |
4569 | If programs implement their own fd to handle mapping on win32, then this |
4547 | macro can be used to override the C<close> function, useful to unregister |
4570 | macro can be used to override the C<close> function, useful to unregister |
4548 | file descriptors again. Note that the replacement function has to close |
4571 | file descriptors again. Note that the replacement function has to close |
4549 | the underlying OS handle. |
4572 | the underlying OS handle. |
|
|
4573 | |
|
|
4574 | =item EV_USE_WSASOCKET |
|
|
4575 | |
|
|
4576 | If defined to be C<1>, libev will use C<WSASocket> to create its internal |
|
|
4577 | communication socket, which works better in some environments. Otherwise, |
|
|
4578 | the normal C<socket> function will be used, which works better in other |
|
|
4579 | environments. |
4550 | |
4580 | |
4551 | =item EV_USE_POLL |
4581 | =item EV_USE_POLL |
4552 | |
4582 | |
4553 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4583 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
4554 | backend. Otherwise it will be enabled on non-win32 platforms. It |
4584 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
4599 | different cpus (or different cpu cores). This reduces dependencies |
4629 | different cpus (or different cpu cores). This reduces dependencies |
4600 | and makes libev faster. |
4630 | and makes libev faster. |
4601 | |
4631 | |
4602 | =item EV_NO_THREADS |
4632 | =item EV_NO_THREADS |
4603 | |
4633 | |
4604 | If defined to be C<1>, libev will assume that it will never be called |
4634 | If defined to be C<1>, libev will assume that it will never be called from |
4605 | from different threads, which is a stronger assumption than C<EV_NO_SMP>, |
4635 | different threads (that includes signal handlers), which is a stronger |
4606 | above. This reduces dependencies and makes libev faster. |
4636 | assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes |
|
|
4637 | libev faster. |
4607 | |
4638 | |
4608 | =item EV_ATOMIC_T |
4639 | =item EV_ATOMIC_T |
4609 | |
4640 | |
4610 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4641 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
4611 | access is atomic and serialised with respect to other threads or signal |
4642 | access is atomic with respect to other threads or signal contexts. No |
4612 | contexts. No such type is easily found in the C language, so you can |
4643 | such type is easily found in the C language, so you can provide your own |
4613 | provide your own type that you know is safe for your purposes. It is used |
4644 | type that you know is safe for your purposes. It is used both for signal |
4614 | both for signal handler "locking" as well as for signal and thread safety |
4645 | handler "locking" as well as for signal and thread safety in C<ev_async> |
4615 | in C<ev_async> watchers. |
4646 | watchers. |
4616 | |
4647 | |
4617 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4648 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
4618 | (from F<signal.h>), which is usually good enough on most platforms, |
4649 | (from F<signal.h>), which is usually good enough on most platforms. |
4619 | although strictly speaking using a type that also implies a memory fence |
|
|
4620 | is required. |
|
|
4621 | |
4650 | |
4622 | =item EV_H (h) |
4651 | =item EV_H (h) |
4623 | |
4652 | |
4624 | The name of the F<ev.h> header file used to include it. The default if |
4653 | The name of the F<ev.h> header file used to include it. The default if |
4625 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
4654 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
… | |
… | |
5272 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
5301 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
5273 | assumes that the same (machine) code can be used to call any watcher |
5302 | assumes that the same (machine) code can be used to call any watcher |
5274 | callback: The watcher callbacks have different type signatures, but libev |
5303 | callback: The watcher callbacks have different type signatures, but libev |
5275 | calls them using an C<ev_watcher *> internally. |
5304 | calls them using an C<ev_watcher *> internally. |
5276 | |
5305 | |
|
|
5306 | =item null pointers and integer zero are represented by 0 bytes |
|
|
5307 | |
|
|
5308 | Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and |
|
|
5309 | relies on this setting pointers and integers to null. |
|
|
5310 | |
5277 | =item pointer accesses must be thread-atomic |
5311 | =item pointer accesses must be thread-atomic |
5278 | |
5312 | |
5279 | Accessing a pointer value must be atomic, it must both be readable and |
5313 | Accessing a pointer value must be atomic, it must both be readable and |
5280 | writable in one piece - this is the case on all current architectures. |
5314 | writable in one piece - this is the case on all current architectures. |
5281 | |
5315 | |
… | |
… | |
5294 | thread" or will block signals process-wide, both behaviours would |
5328 | thread" or will block signals process-wide, both behaviours would |
5295 | be compatible with libev. Interaction between C<sigprocmask> and |
5329 | be compatible with libev. Interaction between C<sigprocmask> and |
5296 | C<pthread_sigmask> could complicate things, however. |
5330 | C<pthread_sigmask> could complicate things, however. |
5297 | |
5331 | |
5298 | The most portable way to handle signals is to block signals in all threads |
5332 | The most portable way to handle signals is to block signals in all threads |
5299 | except the initial one, and run the default loop in the initial thread as |
5333 | except the initial one, and run the signal handling loop in the initial |
5300 | well. |
5334 | thread as well. |
5301 | |
5335 | |
5302 | =item C<long> must be large enough for common memory allocation sizes |
5336 | =item C<long> must be large enough for common memory allocation sizes |
5303 | |
5337 | |
5304 | To improve portability and simplify its API, libev uses C<long> internally |
5338 | To improve portability and simplify its API, libev uses C<long> internally |
5305 | instead of C<size_t> when allocating its data structures. On non-POSIX |
5339 | instead of C<size_t> when allocating its data structures. On non-POSIX |
… | |
… | |
5409 | =over 4 |
5443 | =over 4 |
5410 | |
5444 | |
5411 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5445 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5412 | |
5446 | |
5413 | The backward compatibility mechanism can be controlled by |
5447 | The backward compatibility mechanism can be controlled by |
5414 | C<EV_COMPAT3>. See L</PREPROCESSOR SYMBOLS/MACROS> in the L</EMBEDDING> |
5448 | C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING> |
5415 | section. |
5449 | section. |
5416 | |
5450 | |
5417 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5451 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5418 | |
5452 | |
5419 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
5453 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |