1 | .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) |
1 | .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sp \" Vertical space (when we can't use .PP) |
5 | .de Sp \" Vertical space (when we can't use .PP) |
6 | .if t .sp .5v |
6 | .if t .sp .5v |
… | |
… | |
131 | .\} |
131 | .\} |
132 | .rm #[ #] #H #V #F C |
132 | .rm #[ #] #H #V #F C |
133 | .\" ======================================================================== |
133 | .\" ======================================================================== |
134 | .\" |
134 | .\" |
135 | .IX Title "LIBEV 3" |
135 | .IX Title "LIBEV 3" |
136 | .TH LIBEV 3 "2013-12-27" "libev-4.15" "libev - high performance full featured event loop" |
136 | .TH LIBEV 3 "2017-11-14" "libev-4.24" "libev - high performance full featured event loop" |
137 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
137 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
138 | .\" way too many mistakes in technical documents. |
138 | .\" way too many mistakes in technical documents. |
139 | .if n .ad l |
139 | .if n .ad l |
140 | .nh |
140 | .nh |
141 | .SH "NAME" |
141 | .SH "NAME" |
… | |
… | |
536 | make libev check for a fork in each iteration by enabling this flag. |
536 | make libev check for a fork in each iteration by enabling this flag. |
537 | .Sp |
537 | .Sp |
538 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
538 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
539 | and thus this might slow down your event loop if you do a lot of loop |
539 | and thus this might slow down your event loop if you do a lot of loop |
540 | iterations and little real work, but is usually not noticeable (on my |
540 | iterations and little real work, but is usually not noticeable (on my |
541 | GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence |
541 | GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn |
542 | without a system call and thus \fIvery\fR fast, but my GNU/Linux system also has |
542 | sequence without a system call and thus \fIvery\fR fast, but my GNU/Linux |
543 | \&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). |
543 | system also has \f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). (Update: glibc |
|
|
544 | versions 2.25 apparently removed the \f(CW\*(C`getpid\*(C'\fR optimisation again). |
544 | .Sp |
545 | .Sp |
545 | The big advantage of this flag is that you can forget about fork (and |
546 | The big advantage of this flag is that you can forget about fork (and |
546 | forget about forgetting to tell libev about forking) when you use this |
547 | forget about forgetting to tell libev about forking, although you still |
547 | flag. |
548 | have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR) when you use this flag. |
548 | .Sp |
549 | .Sp |
549 | This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR |
550 | This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR |
550 | environment variable. |
551 | environment variable. |
551 | .ie n .IP """EVFLAG_NOINOTIFY""" 4 |
552 | .ie n .IP """EVFLAG_NOINOTIFY""" 4 |
552 | .el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4 |
553 | .el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4 |
… | |
… | |
810 | except in the rare occasion where you really need to free its resources. |
811 | except in the rare occasion where you really need to free its resources. |
811 | If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR |
812 | If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR |
812 | and \f(CW\*(C`ev_loop_destroy\*(C'\fR. |
813 | and \f(CW\*(C`ev_loop_destroy\*(C'\fR. |
813 | .IP "ev_loop_fork (loop)" 4 |
814 | .IP "ev_loop_fork (loop)" 4 |
814 | .IX Item "ev_loop_fork (loop)" |
815 | .IX Item "ev_loop_fork (loop)" |
815 | This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations to |
816 | This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations |
816 | reinitialise the kernel state for backends that have one. Despite the |
817 | to reinitialise the kernel state for backends that have one. Despite |
817 | name, you can call it anytime, but it makes most sense after forking, in |
818 | the name, you can call it anytime you are allowed to start or stop |
818 | the child process. You \fImust\fR call it (or use \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the |
819 | watchers (except inside an \f(CW\*(C`ev_prepare\*(C'\fR callback), but it makes most |
819 | child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR. |
820 | sense after forking, in the child process. You \fImust\fR call it (or use |
|
|
821 | \&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR. |
|
|
822 | .Sp |
|
|
823 | In addition, if you want to reuse a loop (via this function or |
|
|
824 | \&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR), you \fIalso\fR have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR. |
820 | .Sp |
825 | .Sp |
821 | Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after |
826 | Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after |
822 | a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is |
827 | a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is |
823 | because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things |
828 | because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things |
824 | during fork. |
829 | during fork. |
… | |
… | |
2161 | .PP |
2166 | .PP |
2162 | The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR |
2167 | The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR |
2163 | time. This is usually the right thing as this timestamp refers to the time |
2168 | time. This is usually the right thing as this timestamp refers to the time |
2164 | of the event triggering whatever timeout you are modifying/starting. If |
2169 | of the event triggering whatever timeout you are modifying/starting. If |
2165 | you suspect event processing to be delayed and you \fIneed\fR to base the |
2170 | you suspect event processing to be delayed and you \fIneed\fR to base the |
2166 | timeout on the current time, use something like this to adjust for this: |
2171 | timeout on the current time, use something like the following to adjust |
|
|
2172 | for it: |
2167 | .PP |
2173 | .PP |
2168 | .Vb 1 |
2174 | .Vb 1 |
2169 | \& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); |
2175 | \& ev_timer_set (&timer, after + (ev_time () \- ev_now ()), 0.); |
2170 | .Ve |
2176 | .Ve |
2171 | .PP |
2177 | .PP |
2172 | If the event loop is suspended for a long time, you can also force an |
2178 | If the event loop is suspended for a long time, you can also force an |
2173 | update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update |
2179 | update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update |
2174 | ()\*(C'\fR. |
2180 | ()\*(C'\fR, although that will push the event time of all outstanding events |
|
|
2181 | further into the future. |
2175 | .PP |
2182 | .PP |
2176 | \fIThe special problem of unsynchronised clocks\fR |
2183 | \fIThe special problem of unsynchronised clocks\fR |
2177 | .IX Subsection "The special problem of unsynchronised clocks" |
2184 | .IX Subsection "The special problem of unsynchronised clocks" |
2178 | .PP |
2185 | .PP |
2179 | Modern systems have a variety of clocks \- libev itself uses the normal |
2186 | Modern systems have a variety of clocks \- libev itself uses the normal |
… | |
… | |
2340 | Periodic watchers are also timers of a kind, but they are very versatile |
2347 | Periodic watchers are also timers of a kind, but they are very versatile |
2341 | (and unfortunately a bit complex). |
2348 | (and unfortunately a bit complex). |
2342 | .PP |
2349 | .PP |
2343 | Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or |
2350 | Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or |
2344 | relative time, the physical time that passes) but on wall clock time |
2351 | relative time, the physical time that passes) but on wall clock time |
2345 | (absolute time, the thing you can read on your calender or clock). The |
2352 | (absolute time, the thing you can read on your calendar or clock). The |
2346 | difference is that wall clock time can run faster or slower than real |
2353 | difference is that wall clock time can run faster or slower than real |
2347 | time, and time jumps are not uncommon (e.g. when you adjust your |
2354 | time, and time jumps are not uncommon (e.g. when you adjust your |
2348 | wrist-watch). |
2355 | wrist-watch). |
2349 | .PP |
2356 | .PP |
2350 | You can tell a periodic watcher to trigger after some specific point |
2357 | You can tell a periodic watcher to trigger after some specific point |
… | |
… | |
3048 | .IX Subsection "ev_prepare and ev_check - customise your event loop!" |
3055 | .IX Subsection "ev_prepare and ev_check - customise your event loop!" |
3049 | Prepare and check watchers are often (but not always) used in pairs: |
3056 | Prepare and check watchers are often (but not always) used in pairs: |
3050 | prepare watchers get invoked before the process blocks and check watchers |
3057 | prepare watchers get invoked before the process blocks and check watchers |
3051 | afterwards. |
3058 | afterwards. |
3052 | .PP |
3059 | .PP |
3053 | You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR or similar functions that enter |
3060 | You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR (or similar functions that enter the |
3054 | the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR |
3061 | current event loop) or \f(CW\*(C`ev_loop_fork\*(C'\fR from either \f(CW\*(C`ev_prepare\*(C'\fR or |
3055 | watchers. Other loops than the current one are fine, however. The |
3062 | \&\f(CW\*(C`ev_check\*(C'\fR watchers. Other loops than the current one are fine, |
3056 | rationale behind this is that you do not need to check for recursion in |
3063 | however. The rationale behind this is that you do not need to check |
3057 | those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, |
3064 | for recursion in those watchers, i.e. the sequence will always be |
3058 | \&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be |
3065 | \&\f(CW\*(C`ev_prepare\*(C'\fR, blocking, \f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each |
3059 | called in pairs bracketing the blocking call. |
3066 | kind they will always be called in pairs bracketing the blocking call. |
3060 | .PP |
3067 | .PP |
3061 | Their main purpose is to integrate other event mechanisms into libev and |
3068 | Their main purpose is to integrate other event mechanisms into libev and |
3062 | their use is somewhat advanced. They could be used, for example, to track |
3069 | their use is somewhat advanced. They could be used, for example, to track |
3063 | variable changes, implement your own watchers, integrate net-snmp or a |
3070 | variable changes, implement your own watchers, integrate net-snmp or a |
3064 | coroutine library and lots more. They are also occasionally useful if |
3071 | coroutine library and lots more. They are also occasionally useful if |
… | |
… | |
3358 | .PP |
3365 | .PP |
3359 | .Vb 3 |
3366 | .Vb 3 |
3360 | \& struct ev_loop *loop_hi = ev_default_init (0); |
3367 | \& struct ev_loop *loop_hi = ev_default_init (0); |
3361 | \& struct ev_loop *loop_lo = 0; |
3368 | \& struct ev_loop *loop_lo = 0; |
3362 | \& ev_embed embed; |
3369 | \& ev_embed embed; |
3363 | \& |
3370 | \& |
3364 | \& // see if there is a chance of getting one that works |
3371 | \& // see if there is a chance of getting one that works |
3365 | \& // (remember that a flags value of 0 means autodetection) |
3372 | \& // (remember that a flags value of 0 means autodetection) |
3366 | \& loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3373 | \& loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3367 | \& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3374 | \& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3368 | \& : 0; |
3375 | \& : 0; |
… | |
… | |
3384 | .PP |
3391 | .PP |
3385 | .Vb 3 |
3392 | .Vb 3 |
3386 | \& struct ev_loop *loop = ev_default_init (0); |
3393 | \& struct ev_loop *loop = ev_default_init (0); |
3387 | \& struct ev_loop *loop_socket = 0; |
3394 | \& struct ev_loop *loop_socket = 0; |
3388 | \& ev_embed embed; |
3395 | \& ev_embed embed; |
3389 | \& |
3396 | \& |
3390 | \& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3397 | \& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
3391 | \& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3398 | \& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
3392 | \& { |
3399 | \& { |
3393 | \& ev_embed_init (&embed, 0, loop_socket); |
3400 | \& ev_embed_init (&embed, 0, loop_socket); |
3394 | \& ev_embed_start (loop, &embed); |
3401 | \& ev_embed_start (loop, &embed); |
… | |
… | |
3411 | of course. |
3418 | of course. |
3412 | .PP |
3419 | .PP |
3413 | \fIThe special problem of life after fork \- how is it possible?\fR |
3420 | \fIThe special problem of life after fork \- how is it possible?\fR |
3414 | .IX Subsection "The special problem of life after fork - how is it possible?" |
3421 | .IX Subsection "The special problem of life after fork - how is it possible?" |
3415 | .PP |
3422 | .PP |
3416 | Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to set |
3423 | Most uses of \f(CW\*(C`fork ()\*(C'\fR consist of forking, then some simple calls to set |
3417 | up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This |
3424 | up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This |
3418 | sequence should be handled by libev without any problems. |
3425 | sequence should be handled by libev without any problems. |
3419 | .PP |
3426 | .PP |
3420 | This changes when the application actually wants to do event handling |
3427 | This changes when the application actually wants to do event handling |
3421 | in the child, or both parent in child, in effect \*(L"continuing\*(R" after the |
3428 | in the child, or both parent in child, in effect \*(L"continuing\*(R" after the |
… | |
… | |
4049 | files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files: |
4056 | files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files: |
4050 | .PP |
4057 | .PP |
4051 | .Vb 4 |
4058 | .Vb 4 |
4052 | \& // my_ev.h |
4059 | \& // my_ev.h |
4053 | \& #define EV_CB_DECLARE(type) struct my_coro *cb; |
4060 | \& #define EV_CB_DECLARE(type) struct my_coro *cb; |
4054 | \& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb); |
4061 | \& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb) |
4055 | \& #include "../libev/ev.h" |
4062 | \& #include "../libev/ev.h" |
4056 | \& |
4063 | \& |
4057 | \& // my_ev.c |
4064 | \& // my_ev.c |
4058 | \& #define EV_H "my_ev.h" |
4065 | \& #define EV_H "my_ev.h" |
4059 | \& #include "../libev/ev.c" |
4066 | \& #include "../libev/ev.c" |
… | |
… | |
4245 | \& void operator() (ev::io &w, int revents) |
4252 | \& void operator() (ev::io &w, int revents) |
4246 | \& { |
4253 | \& { |
4247 | \& ... |
4254 | \& ... |
4248 | \& } |
4255 | \& } |
4249 | \& } |
4256 | \& } |
4250 | \& |
4257 | \& |
4251 | \& myfunctor f; |
4258 | \& myfunctor f; |
4252 | \& |
4259 | \& |
4253 | \& ev::io w; |
4260 | \& ev::io w; |
4254 | \& w.set (&f); |
4261 | \& w.set (&f); |
4255 | .Ve |
4262 | .Ve |
… | |
… | |
4515 | \& ev_vars.h |
4522 | \& ev_vars.h |
4516 | \& ev_wrap.h |
4523 | \& ev_wrap.h |
4517 | \& |
4524 | \& |
4518 | \& ev_win32.c required on win32 platforms only |
4525 | \& ev_win32.c required on win32 platforms only |
4519 | \& |
4526 | \& |
4520 | \& ev_select.c only when select backend is enabled (which is enabled by default) |
4527 | \& ev_select.c only when select backend is enabled |
4521 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
4528 | \& ev_poll.c only when poll backend is enabled |
4522 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
4529 | \& ev_epoll.c only when the epoll backend is enabled |
4523 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
4530 | \& ev_kqueue.c only when the kqueue backend is enabled |
4524 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
4531 | \& ev_port.c only when the solaris port backend is enabled |
4525 | .Ve |
4532 | .Ve |
4526 | .PP |
4533 | .PP |
4527 | \&\fIev.c\fR includes the backend files directly when enabled, so you only need |
4534 | \&\fIev.c\fR includes the backend files directly when enabled, so you only need |
4528 | to compile this single file. |
4535 | to compile this single file. |
4529 | .PP |
4536 | .PP |
… | |
… | |
5406 | Libev assumes not only that all watcher pointers have the same internal |
5413 | Libev assumes not only that all watcher pointers have the same internal |
5407 | structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also |
5414 | structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also |
5408 | assumes that the same (machine) code can be used to call any watcher |
5415 | assumes that the same (machine) code can be used to call any watcher |
5409 | callback: The watcher callbacks have different type signatures, but libev |
5416 | callback: The watcher callbacks have different type signatures, but libev |
5410 | calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. |
5417 | calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. |
|
|
5418 | .IP "null pointers and integer zero are represented by 0 bytes" 4 |
|
|
5419 | .IX Item "null pointers and integer zero are represented by 0 bytes" |
|
|
5420 | Libev uses \f(CW\*(C`memset\*(C'\fR to initialise structs and arrays to \f(CW0\fR bytes, and |
|
|
5421 | relies on this setting pointers and integers to null. |
5411 | .IP "pointer accesses must be thread-atomic" 4 |
5422 | .IP "pointer accesses must be thread-atomic" 4 |
5412 | .IX Item "pointer accesses must be thread-atomic" |
5423 | .IX Item "pointer accesses must be thread-atomic" |
5413 | Accessing a pointer value must be atomic, it must both be readable and |
5424 | Accessing a pointer value must be atomic, it must both be readable and |
5414 | writable in one piece \- this is the case on all current architectures. |
5425 | writable in one piece \- this is the case on all current architectures. |
5415 | .ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 |
5426 | .ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 |