|
|
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. |
… | |
… | |
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 | |
689 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
694 | 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 |
695 | 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 |
696 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
692 | during fork. |
697 | during fork. |
693 | |
698 | |
694 | On the other hand, you only need to call this function in the child |
699 | On the other hand, you only need to call this function in the child |
… | |
… | |
2389 | |
2394 | |
2390 | ev_periodic hourly_tick; |
2395 | ev_periodic hourly_tick; |
2391 | ev_periodic_init (&hourly_tick, clock_cb, |
2396 | ev_periodic_init (&hourly_tick, clock_cb, |
2392 | fmod (ev_now (loop), 3600.), 3600., 0); |
2397 | fmod (ev_now (loop), 3600.), 3600., 0); |
2393 | ev_periodic_start (loop, &hourly_tick); |
2398 | ev_periodic_start (loop, &hourly_tick); |
2394 | |
2399 | |
2395 | |
2400 | |
2396 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2401 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
2397 | |
2402 | |
2398 | Signal watchers will trigger an event when the process receives a specific |
2403 | 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 |
2404 | 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 |
2414 | 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 |
2415 | 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 |
2416 | 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. |
2417 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
2413 | |
2418 | |
2414 | When the first watcher gets started will libev actually register something |
2419 | 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 |
2420 | register something with the kernel. It thus coexists with your own signal |
2416 | you don't register any with libev for the same signal). |
2421 | handlers as long as you don't register any with libev for the same signal. |
2417 | |
2422 | |
2418 | If possible and supported, libev will install its handlers with |
2423 | If possible and supported, libev will install its handlers with |
2419 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2424 | 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 |
2425 | 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 |
2426 | interrupted by signals you can block all signals in an C<ev_check> watcher |
… | |
… | |
2903 | |
2908 | |
2904 | Prepare and check watchers are often (but not always) used in pairs: |
2909 | Prepare and check watchers are often (but not always) used in pairs: |
2905 | prepare watchers get invoked before the process blocks and check watchers |
2910 | prepare watchers get invoked before the process blocks and check watchers |
2906 | afterwards. |
2911 | afterwards. |
2907 | |
2912 | |
2908 | You I<must not> call C<ev_run> or similar functions that enter |
2913 | You I<must not> call C<ev_run> (or similar functions that enter the |
2909 | the current event loop from either C<ev_prepare> or C<ev_check> |
2914 | current event loop) or C<ev_loop_fork> from either C<ev_prepare> or |
2910 | watchers. Other loops than the current one are fine, however. The |
2915 | C<ev_check> watchers. Other loops than the current one are fine, |
2911 | rationale behind this is that you do not need to check for recursion in |
2916 | however. The rationale behind this is that you do not need to check |
2912 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
2917 | for recursion in those watchers, i.e. the sequence will always be |
2913 | C<ev_check> so if you have one watcher of each kind they will always be |
2918 | C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each |
2914 | called in pairs bracketing the blocking call. |
2919 | kind they will always be called in pairs bracketing the blocking call. |
2915 | |
2920 | |
2916 | Their main purpose is to integrate other event mechanisms into libev and |
2921 | Their main purpose is to integrate other event mechanisms into libev and |
2917 | their use is somewhat advanced. They could be used, for example, to track |
2922 | their use is somewhat advanced. They could be used, for example, to track |
2918 | variable changes, implement your own watchers, integrate net-snmp or a |
2923 | variable changes, implement your own watchers, integrate net-snmp or a |
2919 | coroutine library and lots more. They are also occasionally useful if |
2924 | coroutine library and lots more. They are also occasionally useful if |
… | |
… | |
3209 | used). |
3214 | used). |
3210 | |
3215 | |
3211 | struct ev_loop *loop_hi = ev_default_init (0); |
3216 | struct ev_loop *loop_hi = ev_default_init (0); |
3212 | struct ev_loop *loop_lo = 0; |
3217 | struct ev_loop *loop_lo = 0; |
3213 | ev_embed embed; |
3218 | ev_embed embed; |
3214 | |
3219 | |
3215 | // see if there is a chance of getting one that works |
3220 | // see if there is a chance of getting one that works |
3216 | // (remember that a flags value of 0 means autodetection) |
3221 | // (remember that a flags value of 0 means autodetection) |
3217 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3222 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3218 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3223 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3219 | : 0; |
3224 | : 0; |
… | |
… | |
3233 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3238 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
3234 | |
3239 | |
3235 | struct ev_loop *loop = ev_default_init (0); |
3240 | struct ev_loop *loop = ev_default_init (0); |
3236 | struct ev_loop *loop_socket = 0; |
3241 | struct ev_loop *loop_socket = 0; |
3237 | ev_embed embed; |
3242 | ev_embed embed; |
3238 | |
3243 | |
3239 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3244 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3240 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3245 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3241 | { |
3246 | { |
3242 | ev_embed_init (&embed, 0, loop_socket); |
3247 | ev_embed_init (&embed, 0, loop_socket); |
3243 | ev_embed_start (loop, &embed); |
3248 | ev_embed_start (loop, &embed); |
… | |
… | |
3259 | and calls it in the wrong process, the fork handlers will be invoked, too, |
3264 | and calls it in the wrong process, the fork handlers will be invoked, too, |
3260 | of course. |
3265 | of course. |
3261 | |
3266 | |
3262 | =head3 The special problem of life after fork - how is it possible? |
3267 | =head3 The special problem of life after fork - how is it possible? |
3263 | |
3268 | |
3264 | Most uses of C<fork()> consist of forking, then some simple calls to set |
3269 | 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 |
3270 | up/change the process environment, followed by a call to C<exec()>. This |
3266 | sequence should be handled by libev without any problems. |
3271 | sequence should be handled by libev without any problems. |
3267 | |
3272 | |
3268 | This changes when the application actually wants to do event handling |
3273 | 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 |
3274 | in the child, or both parent in child, in effect "continuing" after the |
… | |
… | |
3980 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
3985 | 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 |
3986 | 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. |
3987 | the callback model to a model using method callbacks on objects. |
3983 | |
3988 | |
3984 | To use it, |
3989 | To use it, |
3985 | |
3990 | |
3986 | #include <ev++.h> |
3991 | #include <ev++.h> |
3987 | |
3992 | |
3988 | This automatically includes F<ev.h> and puts all of its definitions (many |
3993 | 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 |
3994 | 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 |
3995 | put into the C<ev> namespace. It should support all the same embedding |
… | |
… | |
4093 | void operator() (ev::io &w, int revents) |
4098 | void operator() (ev::io &w, int revents) |
4094 | { |
4099 | { |
4095 | ... |
4100 | ... |
4096 | } |
4101 | } |
4097 | } |
4102 | } |
4098 | |
4103 | |
4099 | myfunctor f; |
4104 | myfunctor f; |
4100 | |
4105 | |
4101 | ev::io w; |
4106 | ev::io w; |
4102 | w.set (&f); |
4107 | w.set (&f); |
4103 | |
4108 | |
… | |
… | |
5427 | =over 4 |
5432 | =over 4 |
5428 | |
5433 | |
5429 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5434 | =item C<EV_COMPAT3> backwards compatibility mechanism |
5430 | |
5435 | |
5431 | The backward compatibility mechanism can be controlled by |
5436 | The backward compatibility mechanism can be controlled by |
5432 | C<EV_COMPAT3>. See L</PREPROCESSOR SYMBOLS/MACROS> in the L</EMBEDDING> |
5437 | C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING> |
5433 | section. |
5438 | section. |
5434 | |
5439 | |
5435 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5440 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
5436 | |
5441 | |
5437 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
5442 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |