… | |
… | |
26 | puts ("stdin ready"); |
26 | puts ("stdin ready"); |
27 | // for one-shot events, one must manually stop the watcher |
27 | // for one-shot events, one must manually stop the watcher |
28 | // with its corresponding stop function. |
28 | // with its corresponding stop function. |
29 | ev_io_stop (EV_A_ w); |
29 | ev_io_stop (EV_A_ w); |
30 | |
30 | |
31 | // this causes all nested ev_loop's to stop iterating |
31 | // this causes all nested ev_run's to stop iterating |
32 | ev_unloop (EV_A_ EVUNLOOP_ALL); |
32 | ev_break (EV_A_ EVBREAK_ALL); |
33 | } |
33 | } |
34 | |
34 | |
35 | // another callback, this time for a time-out |
35 | // another callback, this time for a time-out |
36 | static void |
36 | static void |
37 | timeout_cb (EV_P_ ev_timer *w, int revents) |
37 | timeout_cb (EV_P_ ev_timer *w, int revents) |
38 | { |
38 | { |
39 | puts ("timeout"); |
39 | puts ("timeout"); |
40 | // this causes the innermost ev_loop to stop iterating |
40 | // this causes the innermost ev_run to stop iterating |
41 | ev_unloop (EV_A_ EVUNLOOP_ONE); |
41 | ev_break (EV_A_ EVBREAK_ONE); |
42 | } |
42 | } |
43 | |
43 | |
44 | int |
44 | int |
45 | main (void) |
45 | main (void) |
46 | { |
46 | { |
47 | // use the default event loop unless you have special needs |
47 | // use the default event loop unless you have special needs |
48 | struct ev_loop *loop = ev_default_loop (0); |
48 | struct ev_loop *loop = EV_DEFAULT; |
49 | |
49 | |
50 | // initialise an io watcher, then start it |
50 | // initialise an io watcher, then start it |
51 | // this one will watch for stdin to become readable |
51 | // this one will watch for stdin to become readable |
52 | ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
52 | ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
53 | ev_io_start (loop, &stdin_watcher); |
53 | ev_io_start (loop, &stdin_watcher); |
… | |
… | |
56 | // simple non-repeating 5.5 second timeout |
56 | // simple non-repeating 5.5 second timeout |
57 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
57 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
58 | ev_timer_start (loop, &timeout_watcher); |
58 | ev_timer_start (loop, &timeout_watcher); |
59 | |
59 | |
60 | // now wait for events to arrive |
60 | // now wait for events to arrive |
61 | ev_loop (loop, 0); |
61 | ev_run (loop, 0); |
62 | |
62 | |
63 | // unloop was called, so exit |
63 | // unloop was called, so exit |
64 | return 0; |
64 | return 0; |
65 | } |
65 | } |
66 | |
66 | |
… | |
… | |
75 | While this document tries to be as complete as possible in documenting |
75 | While this document tries to be as complete as possible in documenting |
76 | libev, its usage and the rationale behind its design, it is not a tutorial |
76 | libev, its usage and the rationale behind its design, it is not a tutorial |
77 | on event-based programming, nor will it introduce event-based programming |
77 | on event-based programming, nor will it introduce event-based programming |
78 | with libev. |
78 | with libev. |
79 | |
79 | |
80 | Familarity with event based programming techniques in general is assumed |
80 | Familiarity with event based programming techniques in general is assumed |
81 | throughout this document. |
81 | throughout this document. |
82 | |
82 | |
83 | =head1 ABOUT LIBEV |
83 | =head1 ABOUT LIBEV |
84 | |
84 | |
85 | Libev is an event loop: you register interest in certain events (such as a |
85 | Libev is an event loop: you register interest in certain events (such as a |
… | |
… | |
124 | this argument. |
124 | this argument. |
125 | |
125 | |
126 | =head2 TIME REPRESENTATION |
126 | =head2 TIME REPRESENTATION |
127 | |
127 | |
128 | Libev represents time as a single floating point number, representing |
128 | Libev represents time as a single floating point number, representing |
129 | the (fractional) number of seconds since the (POSIX) epoch (somewhere |
129 | the (fractional) number of seconds since the (POSIX) epoch (in practice |
130 | near the beginning of 1970, details are complicated, don't ask). This |
130 | somewhere near the beginning of 1970, details are complicated, don't |
131 | type is called C<ev_tstamp>, which is what you should use too. It usually |
131 | ask). This type is called C<ev_tstamp>, which is what you should use |
132 | aliases to the C<double> type in C. When you need to do any calculations |
132 | too. It usually aliases to the C<double> type in C. When you need to do |
133 | on it, you should treat it as some floating point value. Unlike the name |
133 | any calculations on it, you should treat it as some floating point value. |
|
|
134 | |
134 | component C<stamp> might indicate, it is also used for time differences |
135 | Unlike the name component C<stamp> might indicate, it is also used for |
135 | throughout libev. |
136 | time differences (e.g. delays) throughout libev. |
136 | |
137 | |
137 | =head1 ERROR HANDLING |
138 | =head1 ERROR HANDLING |
138 | |
139 | |
139 | Libev knows three classes of errors: operating system errors, usage errors |
140 | Libev knows three classes of errors: operating system errors, usage errors |
140 | and internal errors (bugs). |
141 | and internal errors (bugs). |
… | |
… | |
164 | |
165 | |
165 | =item ev_tstamp ev_time () |
166 | =item ev_tstamp ev_time () |
166 | |
167 | |
167 | Returns the current time as libev would use it. Please note that the |
168 | Returns the current time as libev would use it. Please note that the |
168 | C<ev_now> function is usually faster and also often returns the timestamp |
169 | C<ev_now> function is usually faster and also often returns the timestamp |
169 | you actually want to know. |
170 | you actually want to know. Also interesting is the combination of |
|
|
171 | C<ev_update_now> and C<ev_now>. |
170 | |
172 | |
171 | =item ev_sleep (ev_tstamp interval) |
173 | =item ev_sleep (ev_tstamp interval) |
172 | |
174 | |
173 | Sleep for the given interval: The current thread will be blocked until |
175 | Sleep for the given interval: The current thread will be blocked until |
174 | either it is interrupted or the given time interval has passed. Basically |
176 | either it is interrupted or the given time interval has passed. Basically |
… | |
… | |
191 | as this indicates an incompatible change. Minor versions are usually |
193 | as this indicates an incompatible change. Minor versions are usually |
192 | compatible to older versions, so a larger minor version alone is usually |
194 | compatible to older versions, so a larger minor version alone is usually |
193 | not a problem. |
195 | not a problem. |
194 | |
196 | |
195 | Example: Make sure we haven't accidentally been linked against the wrong |
197 | Example: Make sure we haven't accidentally been linked against the wrong |
196 | version. |
198 | version (note, however, that this will not detect other ABI mismatches, |
|
|
199 | such as LFS or reentrancy). |
197 | |
200 | |
198 | assert (("libev version mismatch", |
201 | assert (("libev version mismatch", |
199 | ev_version_major () == EV_VERSION_MAJOR |
202 | ev_version_major () == EV_VERSION_MAJOR |
200 | && ev_version_minor () >= EV_VERSION_MINOR)); |
203 | && ev_version_minor () >= EV_VERSION_MINOR)); |
201 | |
204 | |
… | |
… | |
212 | assert (("sorry, no epoll, no sex", |
215 | assert (("sorry, no epoll, no sex", |
213 | ev_supported_backends () & EVBACKEND_EPOLL)); |
216 | ev_supported_backends () & EVBACKEND_EPOLL)); |
214 | |
217 | |
215 | =item unsigned int ev_recommended_backends () |
218 | =item unsigned int ev_recommended_backends () |
216 | |
219 | |
217 | Return the set of all backends compiled into this binary of libev and also |
220 | Return the set of all backends compiled into this binary of libev and |
218 | recommended for this platform. This set is often smaller than the one |
221 | also recommended for this platform, meaning it will work for most file |
|
|
222 | descriptor types. This set is often smaller than the one returned by |
219 | returned by C<ev_supported_backends>, as for example kqueue is broken on |
223 | C<ev_supported_backends>, as for example kqueue is broken on most BSDs |
220 | most BSDs and will not be auto-detected unless you explicitly request it |
224 | and will not be auto-detected unless you explicitly request it (assuming |
221 | (assuming you know what you are doing). This is the set of backends that |
225 | you know what you are doing). This is the set of backends that libev will |
222 | libev will probe for if you specify no backends explicitly. |
226 | probe for if you specify no backends explicitly. |
223 | |
227 | |
224 | =item unsigned int ev_embeddable_backends () |
228 | =item unsigned int ev_embeddable_backends () |
225 | |
229 | |
226 | Returns the set of backends that are embeddable in other event loops. This |
230 | Returns the set of backends that are embeddable in other event loops. This |
227 | is the theoretical, all-platform, value. To find which backends |
231 | value is platform-specific but can include backends not available on the |
228 | might be supported on the current system, you would need to look at |
232 | current system. To find which embeddable backends might be supported on |
229 | C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for |
233 | the current system, you would need to look at C<ev_embeddable_backends () |
230 | recommended ones. |
234 | & ev_supported_backends ()>, likewise for recommended ones. |
231 | |
235 | |
232 | See the description of C<ev_embed> watchers for more info. |
236 | See the description of C<ev_embed> watchers for more info. |
233 | |
237 | |
234 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT] |
238 | =item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT] |
235 | |
239 | |
… | |
… | |
289 | ... |
293 | ... |
290 | ev_set_syserr_cb (fatal_error); |
294 | ev_set_syserr_cb (fatal_error); |
291 | |
295 | |
292 | =back |
296 | =back |
293 | |
297 | |
294 | =head1 FUNCTIONS CONTROLLING THE EVENT LOOP |
298 | =head1 FUNCTIONS CONTROLLING EVENT LOOPS |
295 | |
299 | |
296 | An event loop is described by a C<struct ev_loop *> (the C<struct> |
300 | An event loop is described by a C<struct ev_loop *> (the C<struct> is |
297 | is I<not> optional in this case, as there is also an C<ev_loop> |
301 | I<not> optional in this case unless libev 3 compatibility is disabled, as |
298 | I<function>). |
302 | libev 3 had an C<ev_loop> function colliding with the struct name). |
299 | |
303 | |
300 | The library knows two types of such loops, the I<default> loop, which |
304 | The library knows two types of such loops, the I<default> loop, which |
301 | supports signals and child events, and dynamically created loops which do |
305 | supports signals and child events, and dynamically created event loops |
302 | not. |
306 | which do not. |
303 | |
307 | |
304 | =over 4 |
308 | =over 4 |
305 | |
309 | |
306 | =item struct ev_loop *ev_default_loop (unsigned int flags) |
310 | =item struct ev_loop *ev_default_loop (unsigned int flags) |
307 | |
311 | |
308 | This will initialise the default event loop if it hasn't been initialised |
312 | This returns the "default" event loop object, which is what you should |
309 | yet and return it. If the default loop could not be initialised, returns |
313 | normally use when you just need "the event loop". Event loop objects and |
310 | false. If it already was initialised it simply returns it (and ignores the |
314 | the C<flags> parameter are described in more detail in the entry for |
311 | flags. If that is troubling you, check C<ev_backend ()> afterwards). |
315 | C<ev_loop_new>. |
|
|
316 | |
|
|
317 | If the default loop is already initialised then this function simply |
|
|
318 | returns it (and ignores the flags. If that is troubling you, check |
|
|
319 | C<ev_backend ()> afterwards). Otherwise it will create it with the given |
|
|
320 | flags, which should almost always be C<0>, unless the caller is also the |
|
|
321 | one calling C<ev_run> or otherwise qualifies as "the main program". |
312 | |
322 | |
313 | If you don't know what event loop to use, use the one returned from this |
323 | If you don't know what event loop to use, use the one returned from this |
314 | function. |
324 | function (or via the C<EV_DEFAULT> macro). |
315 | |
325 | |
316 | Note that this function is I<not> thread-safe, so if you want to use it |
326 | Note that this function is I<not> thread-safe, so if you want to use it |
317 | from multiple threads, you have to lock (note also that this is unlikely, |
327 | from multiple threads, you have to employ some kind of mutex (note also |
318 | as loops cannot be shared easily between threads anyway). |
328 | that this case is unlikely, as loops cannot be shared easily between |
|
|
329 | threads anyway). |
319 | |
330 | |
320 | The default loop is the only loop that can handle C<ev_signal> and |
331 | The default loop is the only loop that can handle C<ev_child> watchers, |
321 | C<ev_child> watchers, and to do this, it always registers a handler |
332 | and to do this, it always registers a handler for C<SIGCHLD>. If this is |
322 | for C<SIGCHLD>. If this is a problem for your application you can either |
333 | a problem for your application you can either create a dynamic loop with |
323 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
334 | C<ev_loop_new> which doesn't do that, or you can simply overwrite the |
324 | can simply overwrite the C<SIGCHLD> signal handler I<after> calling |
335 | C<SIGCHLD> signal handler I<after> calling C<ev_default_init>. |
325 | C<ev_default_init>. |
336 | |
|
|
337 | Example: This is the most typical usage. |
|
|
338 | |
|
|
339 | if (!ev_default_loop (0)) |
|
|
340 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
|
|
341 | |
|
|
342 | Example: Restrict libev to the select and poll backends, and do not allow |
|
|
343 | environment settings to be taken into account: |
|
|
344 | |
|
|
345 | ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); |
|
|
346 | |
|
|
347 | =item struct ev_loop *ev_loop_new (unsigned int flags) |
|
|
348 | |
|
|
349 | This will create and initialise a new event loop object. If the loop |
|
|
350 | could not be initialised, returns false. |
|
|
351 | |
|
|
352 | Note that this function I<is> thread-safe, and one common way to use |
|
|
353 | libev with threads is indeed to create one loop per thread, and using the |
|
|
354 | default loop in the "main" or "initial" thread. |
326 | |
355 | |
327 | The flags argument can be used to specify special behaviour or specific |
356 | The flags argument can be used to specify special behaviour or specific |
328 | backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). |
357 | backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). |
329 | |
358 | |
330 | The following flags are supported: |
359 | The following flags are supported: |
… | |
… | |
345 | useful to try out specific backends to test their performance, or to work |
374 | useful to try out specific backends to test their performance, or to work |
346 | around bugs. |
375 | around bugs. |
347 | |
376 | |
348 | =item C<EVFLAG_FORKCHECK> |
377 | =item C<EVFLAG_FORKCHECK> |
349 | |
378 | |
350 | Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after |
379 | Instead of calling C<ev_loop_fork> manually after a fork, you can also |
351 | a fork, you can also make libev check for a fork in each iteration by |
380 | make libev check for a fork in each iteration by enabling this flag. |
352 | enabling this flag. |
|
|
353 | |
381 | |
354 | This works by calling C<getpid ()> on every iteration of the loop, |
382 | This works by calling C<getpid ()> on every iteration of the loop, |
355 | and thus this might slow down your event loop if you do a lot of loop |
383 | and thus this might slow down your event loop if you do a lot of loop |
356 | iterations and little real work, but is usually not noticeable (on my |
384 | iterations and little real work, but is usually not noticeable (on my |
357 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence |
385 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence |
… | |
… | |
439 | of course I<doesn't>, and epoll just loves to report events for totally |
467 | of course I<doesn't>, and epoll just loves to report events for totally |
440 | I<different> file descriptors (even already closed ones, so one cannot |
468 | I<different> file descriptors (even already closed ones, so one cannot |
441 | even remove them from the set) than registered in the set (especially |
469 | even remove them from the set) than registered in the set (especially |
442 | on SMP systems). Libev tries to counter these spurious notifications by |
470 | on SMP systems). Libev tries to counter these spurious notifications by |
443 | employing an additional generation counter and comparing that against the |
471 | employing an additional generation counter and comparing that against the |
444 | events to filter out spurious ones, recreating the set when required. |
472 | events to filter out spurious ones, recreating the set when required. Last |
|
|
473 | not least, it also refuses to work with some file descriptors which work |
|
|
474 | perfectly fine with C<select> (files, many character devices...). |
445 | |
475 | |
446 | While stopping, setting and starting an I/O watcher in the same iteration |
476 | While stopping, setting and starting an I/O watcher in the same iteration |
447 | will result in some caching, there is still a system call per such |
477 | will result in some caching, there is still a system call per such |
448 | incident (because the same I<file descriptor> could point to a different |
478 | incident (because the same I<file descriptor> could point to a different |
449 | I<file description> now), so its best to avoid that. Also, C<dup ()>'ed |
479 | I<file description> now), so its best to avoid that. Also, C<dup ()>'ed |
… | |
… | |
547 | If one or more of the backend flags are or'ed into the flags value, |
577 | If one or more of the backend flags are or'ed into the flags value, |
548 | then only these backends will be tried (in the reverse order as listed |
578 | then only these backends will be tried (in the reverse order as listed |
549 | here). If none are specified, all backends in C<ev_recommended_backends |
579 | here). If none are specified, all backends in C<ev_recommended_backends |
550 | ()> will be tried. |
580 | ()> will be tried. |
551 | |
581 | |
552 | Example: This is the most typical usage. |
|
|
553 | |
|
|
554 | if (!ev_default_loop (0)) |
|
|
555 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
|
|
556 | |
|
|
557 | Example: Restrict libev to the select and poll backends, and do not allow |
|
|
558 | environment settings to be taken into account: |
|
|
559 | |
|
|
560 | ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); |
|
|
561 | |
|
|
562 | Example: Use whatever libev has to offer, but make sure that kqueue is |
|
|
563 | used if available (warning, breaks stuff, best use only with your own |
|
|
564 | private event loop and only if you know the OS supports your types of |
|
|
565 | fds): |
|
|
566 | |
|
|
567 | ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
|
|
568 | |
|
|
569 | =item struct ev_loop *ev_loop_new (unsigned int flags) |
|
|
570 | |
|
|
571 | Similar to C<ev_default_loop>, but always creates a new event loop that is |
|
|
572 | always distinct from the default loop. Unlike the default loop, it cannot |
|
|
573 | handle signal and child watchers, and attempts to do so will be greeted by |
|
|
574 | undefined behaviour (or a failed assertion if assertions are enabled). |
|
|
575 | |
|
|
576 | Note that this function I<is> thread-safe, and the recommended way to use |
|
|
577 | libev with threads is indeed to create one loop per thread, and using the |
|
|
578 | default loop in the "main" or "initial" thread. |
|
|
579 | |
|
|
580 | Example: Try to create a event loop that uses epoll and nothing else. |
582 | Example: Try to create a event loop that uses epoll and nothing else. |
581 | |
583 | |
582 | struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
584 | struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
583 | if (!epoller) |
585 | if (!epoller) |
584 | fatal ("no epoll found here, maybe it hides under your chair"); |
586 | fatal ("no epoll found here, maybe it hides under your chair"); |
585 | |
587 | |
|
|
588 | Example: Use whatever libev has to offer, but make sure that kqueue is |
|
|
589 | used if available. |
|
|
590 | |
|
|
591 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); |
|
|
592 | |
586 | =item ev_default_destroy () |
593 | =item ev_loop_destroy (loop) |
587 | |
594 | |
588 | Destroys the default loop again (frees all memory and kernel state |
595 | Destroys an event loop object (frees all memory and kernel state |
589 | etc.). None of the active event watchers will be stopped in the normal |
596 | etc.). None of the active event watchers will be stopped in the normal |
590 | sense, so e.g. C<ev_is_active> might still return true. It is your |
597 | sense, so e.g. C<ev_is_active> might still return true. It is your |
591 | responsibility to either stop all watchers cleanly yourself I<before> |
598 | responsibility to either stop all watchers cleanly yourself I<before> |
592 | calling this function, or cope with the fact afterwards (which is usually |
599 | calling this function, or cope with the fact afterwards (which is usually |
593 | the easiest thing, you can just ignore the watchers and/or C<free ()> them |
600 | the easiest thing, you can just ignore the watchers and/or C<free ()> them |
… | |
… | |
595 | |
602 | |
596 | Note that certain global state, such as signal state (and installed signal |
603 | Note that certain global state, such as signal state (and installed signal |
597 | handlers), will not be freed by this function, and related watchers (such |
604 | handlers), will not be freed by this function, and related watchers (such |
598 | as signal and child watchers) would need to be stopped manually. |
605 | as signal and child watchers) would need to be stopped manually. |
599 | |
606 | |
600 | In general it is not advisable to call this function except in the |
607 | This function is normally used on loop objects allocated by |
601 | rare occasion where you really need to free e.g. the signal handling |
608 | C<ev_loop_new>, but it can also be used on the default loop returned by |
|
|
609 | C<ev_default_loop>, in which case it is not thread-safe. |
|
|
610 | |
|
|
611 | Note that it is not advisable to call this function on the default loop |
|
|
612 | except in the rare occasion where you really need to free it's resources. |
602 | pipe fds. If you need dynamically allocated loops it is better to use |
613 | If you need dynamically allocated loops it is better to use C<ev_loop_new> |
603 | C<ev_loop_new> and C<ev_loop_destroy>. |
614 | and C<ev_loop_destroy>. |
604 | |
615 | |
605 | =item ev_loop_destroy (loop) |
616 | =item ev_loop_fork (loop) |
606 | |
617 | |
607 | Like C<ev_default_destroy>, but destroys an event loop created by an |
|
|
608 | earlier call to C<ev_loop_new>. |
|
|
609 | |
|
|
610 | =item ev_default_fork () |
|
|
611 | |
|
|
612 | This function sets a flag that causes subsequent C<ev_loop> iterations |
618 | This function sets a flag that causes subsequent C<ev_run> iterations to |
613 | to reinitialise the kernel state for backends that have one. Despite the |
619 | reinitialise the kernel state for backends that have one. Despite the |
614 | name, you can call it anytime, but it makes most sense after forking, in |
620 | name, you can call it anytime, but it makes most sense after forking, in |
615 | the child process (or both child and parent, but that again makes little |
621 | the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the |
616 | sense). You I<must> call it in the child before using any of the libev |
622 | child before resuming or calling C<ev_run>. |
617 | functions, and it will only take effect at the next C<ev_loop> iteration. |
623 | |
|
|
624 | Again, you I<have> to call it on I<any> loop that you want to re-use after |
|
|
625 | a fork, I<even if you do not plan to use the loop in the parent>. This is |
|
|
626 | because some kernel interfaces *cough* I<kqueue> *cough* do funny things |
|
|
627 | during fork. |
618 | |
628 | |
619 | On the other hand, you only need to call this function in the child |
629 | On the other hand, you only need to call this function in the child |
620 | process if and only if you want to use the event library in the child. If |
630 | process if and only if you want to use the event loop in the child. If |
621 | you just fork+exec, you don't have to call it at all. |
631 | you just fork+exec or create a new loop in the child, you don't have to |
|
|
632 | call it at all (in fact, C<epoll> is so badly broken that it makes a |
|
|
633 | difference, but libev will usually detect this case on its own and do a |
|
|
634 | costly reset of the backend). |
622 | |
635 | |
623 | The function itself is quite fast and it's usually not a problem to call |
636 | The function itself is quite fast and it's usually not a problem to call |
624 | it just in case after a fork. To make this easy, the function will fit in |
637 | it just in case after a fork. |
625 | quite nicely into a call to C<pthread_atfork>: |
|
|
626 | |
638 | |
|
|
639 | Example: Automate calling C<ev_loop_fork> on the default loop when |
|
|
640 | using pthreads. |
|
|
641 | |
|
|
642 | static void |
|
|
643 | post_fork_child (void) |
|
|
644 | { |
|
|
645 | ev_loop_fork (EV_DEFAULT); |
|
|
646 | } |
|
|
647 | |
|
|
648 | ... |
627 | pthread_atfork (0, 0, ev_default_fork); |
649 | pthread_atfork (0, 0, post_fork_child); |
628 | |
|
|
629 | =item ev_loop_fork (loop) |
|
|
630 | |
|
|
631 | Like C<ev_default_fork>, but acts on an event loop created by |
|
|
632 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
|
|
633 | after fork that you want to re-use in the child, and how you do this is |
|
|
634 | entirely your own problem. |
|
|
635 | |
650 | |
636 | =item int ev_is_default_loop (loop) |
651 | =item int ev_is_default_loop (loop) |
637 | |
652 | |
638 | Returns true when the given loop is, in fact, the default loop, and false |
653 | Returns true when the given loop is, in fact, the default loop, and false |
639 | otherwise. |
654 | otherwise. |
640 | |
655 | |
641 | =item unsigned int ev_loop_count (loop) |
656 | =item unsigned int ev_iteration (loop) |
642 | |
657 | |
643 | Returns the count of loop iterations for the loop, which is identical to |
658 | Returns the current iteration count for the event loop, which is identical |
644 | the number of times libev did poll for new events. It starts at C<0> and |
659 | to the number of times libev did poll for new events. It starts at C<0> |
645 | happily wraps around with enough iterations. |
660 | and happily wraps around with enough iterations. |
646 | |
661 | |
647 | This value can sometimes be useful as a generation counter of sorts (it |
662 | This value can sometimes be useful as a generation counter of sorts (it |
648 | "ticks" the number of loop iterations), as it roughly corresponds with |
663 | "ticks" the number of loop iterations), as it roughly corresponds with |
649 | C<ev_prepare> and C<ev_check> calls. |
664 | C<ev_prepare> and C<ev_check> calls - and is incremented between the |
|
|
665 | prepare and check phases. |
650 | |
666 | |
651 | =item unsigned int ev_loop_depth (loop) |
667 | =item unsigned int ev_depth (loop) |
652 | |
668 | |
653 | Returns the number of times C<ev_loop> was entered minus the number of |
669 | Returns the number of times C<ev_run> was entered minus the number of |
654 | times C<ev_loop> was exited, in other words, the recursion depth. |
670 | times C<ev_run> was exited, in other words, the recursion depth. |
655 | |
671 | |
656 | Outside C<ev_loop>, this number is zero. In a callback, this number is |
672 | Outside C<ev_run>, this number is zero. In a callback, this number is |
657 | C<1>, unless C<ev_loop> was invoked recursively (or from another thread), |
673 | C<1>, unless C<ev_run> was invoked recursively (or from another thread), |
658 | in which case it is higher. |
674 | in which case it is higher. |
659 | |
675 | |
660 | Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread |
676 | Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread |
661 | etc.), doesn't count as exit. |
677 | etc.), doesn't count as "exit" - consider this as a hint to avoid such |
|
|
678 | ungentleman-like behaviour unless it's really convenient. |
662 | |
679 | |
663 | =item unsigned int ev_backend (loop) |
680 | =item unsigned int ev_backend (loop) |
664 | |
681 | |
665 | Returns one of the C<EVBACKEND_*> flags indicating the event backend in |
682 | Returns one of the C<EVBACKEND_*> flags indicating the event backend in |
666 | use. |
683 | use. |
… | |
… | |
675 | |
692 | |
676 | =item ev_now_update (loop) |
693 | =item ev_now_update (loop) |
677 | |
694 | |
678 | Establishes the current time by querying the kernel, updating the time |
695 | Establishes the current time by querying the kernel, updating the time |
679 | returned by C<ev_now ()> in the progress. This is a costly operation and |
696 | returned by C<ev_now ()> in the progress. This is a costly operation and |
680 | is usually done automatically within C<ev_loop ()>. |
697 | is usually done automatically within C<ev_run ()>. |
681 | |
698 | |
682 | This function is rarely useful, but when some event callback runs for a |
699 | This function is rarely useful, but when some event callback runs for a |
683 | very long time without entering the event loop, updating libev's idea of |
700 | very long time without entering the event loop, updating libev's idea of |
684 | the current time is a good idea. |
701 | the current time is a good idea. |
685 | |
702 | |
… | |
… | |
687 | |
704 | |
688 | =item ev_suspend (loop) |
705 | =item ev_suspend (loop) |
689 | |
706 | |
690 | =item ev_resume (loop) |
707 | =item ev_resume (loop) |
691 | |
708 | |
692 | These two functions suspend and resume a loop, for use when the loop is |
709 | These two functions suspend and resume an event loop, for use when the |
693 | not used for a while and timeouts should not be processed. |
710 | loop is not used for a while and timeouts should not be processed. |
694 | |
711 | |
695 | A typical use case would be an interactive program such as a game: When |
712 | A typical use case would be an interactive program such as a game: When |
696 | the user presses C<^Z> to suspend the game and resumes it an hour later it |
713 | the user presses C<^Z> to suspend the game and resumes it an hour later it |
697 | would be best to handle timeouts as if no time had actually passed while |
714 | would be best to handle timeouts as if no time had actually passed while |
698 | the program was suspended. This can be achieved by calling C<ev_suspend> |
715 | the program was suspended. This can be achieved by calling C<ev_suspend> |
… | |
… | |
700 | C<ev_resume> directly afterwards to resume timer processing. |
717 | C<ev_resume> directly afterwards to resume timer processing. |
701 | |
718 | |
702 | Effectively, all C<ev_timer> watchers will be delayed by the time spend |
719 | Effectively, all C<ev_timer> watchers will be delayed by the time spend |
703 | between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers |
720 | between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers |
704 | will be rescheduled (that is, they will lose any events that would have |
721 | will be rescheduled (that is, they will lose any events that would have |
705 | occured while suspended). |
722 | occurred while suspended). |
706 | |
723 | |
707 | After calling C<ev_suspend> you B<must not> call I<any> function on the |
724 | After calling C<ev_suspend> you B<must not> call I<any> function on the |
708 | given loop other than C<ev_resume>, and you B<must not> call C<ev_resume> |
725 | given loop other than C<ev_resume>, and you B<must not> call C<ev_resume> |
709 | without a previous call to C<ev_suspend>. |
726 | without a previous call to C<ev_suspend>. |
710 | |
727 | |
711 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
728 | Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the |
712 | event loop time (see C<ev_now_update>). |
729 | event loop time (see C<ev_now_update>). |
713 | |
730 | |
714 | =item ev_loop (loop, int flags) |
731 | =item ev_run (loop, int flags) |
715 | |
732 | |
716 | Finally, this is it, the event handler. This function usually is called |
733 | Finally, this is it, the event handler. This function usually is called |
717 | after you have initialised all your watchers and you want to start |
734 | after you have initialised all your watchers and you want to start |
718 | handling events. |
735 | handling events. It will ask the operating system for any new events, call |
|
|
736 | the watcher callbacks, an then repeat the whole process indefinitely: This |
|
|
737 | is why event loops are called I<loops>. |
719 | |
738 | |
720 | If the flags argument is specified as C<0>, it will not return until |
739 | If the flags argument is specified as C<0>, it will keep handling events |
721 | either no event watchers are active anymore or C<ev_unloop> was called. |
740 | until either no event watchers are active anymore or C<ev_break> was |
|
|
741 | called. |
722 | |
742 | |
723 | Please note that an explicit C<ev_unloop> is usually better than |
743 | Please note that an explicit C<ev_break> is usually better than |
724 | relying on all watchers to be stopped when deciding when a program has |
744 | relying on all watchers to be stopped when deciding when a program has |
725 | finished (especially in interactive programs), but having a program |
745 | finished (especially in interactive programs), but having a program |
726 | that automatically loops as long as it has to and no longer by virtue |
746 | that automatically loops as long as it has to and no longer by virtue |
727 | of relying on its watchers stopping correctly, that is truly a thing of |
747 | of relying on its watchers stopping correctly, that is truly a thing of |
728 | beauty. |
748 | beauty. |
729 | |
749 | |
730 | A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle |
750 | A flags value of C<EVRUN_NOWAIT> will look for new events, will handle |
731 | those events and any already outstanding ones, but will not block your |
751 | those events and any already outstanding ones, but will not wait and |
732 | process in case there are no events and will return after one iteration of |
752 | block your process in case there are no events and will return after one |
733 | the loop. |
753 | iteration of the loop. This is sometimes useful to poll and handle new |
|
|
754 | events while doing lengthy calculations, to keep the program responsive. |
734 | |
755 | |
735 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
756 | A flags value of C<EVRUN_ONCE> will look for new events (waiting if |
736 | necessary) and will handle those and any already outstanding ones. It |
757 | necessary) and will handle those and any already outstanding ones. It |
737 | will block your process until at least one new event arrives (which could |
758 | will block your process until at least one new event arrives (which could |
738 | be an event internal to libev itself, so there is no guarantee that a |
759 | be an event internal to libev itself, so there is no guarantee that a |
739 | user-registered callback will be called), and will return after one |
760 | user-registered callback will be called), and will return after one |
740 | iteration of the loop. |
761 | iteration of the loop. |
741 | |
762 | |
742 | This is useful if you are waiting for some external event in conjunction |
763 | This is useful if you are waiting for some external event in conjunction |
743 | with something not expressible using other libev watchers (i.e. "roll your |
764 | with something not expressible using other libev watchers (i.e. "roll your |
744 | own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is |
765 | own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is |
745 | usually a better approach for this kind of thing. |
766 | usually a better approach for this kind of thing. |
746 | |
767 | |
747 | Here are the gory details of what C<ev_loop> does: |
768 | Here are the gory details of what C<ev_run> does: |
748 | |
769 | |
|
|
770 | - Increment loop depth. |
|
|
771 | - Reset the ev_break status. |
749 | - Before the first iteration, call any pending watchers. |
772 | - Before the first iteration, call any pending watchers. |
|
|
773 | LOOP: |
750 | * If EVFLAG_FORKCHECK was used, check for a fork. |
774 | - If EVFLAG_FORKCHECK was used, check for a fork. |
751 | - If a fork was detected (by any means), queue and call all fork watchers. |
775 | - If a fork was detected (by any means), queue and call all fork watchers. |
752 | - Queue and call all prepare watchers. |
776 | - Queue and call all prepare watchers. |
|
|
777 | - If ev_break was called, goto FINISH. |
753 | - If we have been forked, detach and recreate the kernel state |
778 | - If we have been forked, detach and recreate the kernel state |
754 | as to not disturb the other process. |
779 | as to not disturb the other process. |
755 | - Update the kernel state with all outstanding changes. |
780 | - Update the kernel state with all outstanding changes. |
756 | - Update the "event loop time" (ev_now ()). |
781 | - Update the "event loop time" (ev_now ()). |
757 | - Calculate for how long to sleep or block, if at all |
782 | - Calculate for how long to sleep or block, if at all |
758 | (active idle watchers, EVLOOP_NONBLOCK or not having |
783 | (active idle watchers, EVRUN_NOWAIT or not having |
759 | any active watchers at all will result in not sleeping). |
784 | any active watchers at all will result in not sleeping). |
760 | - Sleep if the I/O and timer collect interval say so. |
785 | - Sleep if the I/O and timer collect interval say so. |
|
|
786 | - Increment loop iteration counter. |
761 | - Block the process, waiting for any events. |
787 | - Block the process, waiting for any events. |
762 | - Queue all outstanding I/O (fd) events. |
788 | - Queue all outstanding I/O (fd) events. |
763 | - Update the "event loop time" (ev_now ()), and do time jump adjustments. |
789 | - Update the "event loop time" (ev_now ()), and do time jump adjustments. |
764 | - Queue all expired timers. |
790 | - Queue all expired timers. |
765 | - Queue all expired periodics. |
791 | - Queue all expired periodics. |
766 | - Unless any events are pending now, queue all idle watchers. |
792 | - Queue all idle watchers with priority higher than that of pending events. |
767 | - Queue all check watchers. |
793 | - Queue all check watchers. |
768 | - Call all queued watchers in reverse order (i.e. check watchers first). |
794 | - Call all queued watchers in reverse order (i.e. check watchers first). |
769 | Signals and child watchers are implemented as I/O watchers, and will |
795 | Signals and child watchers are implemented as I/O watchers, and will |
770 | be handled here by queueing them when their watcher gets executed. |
796 | be handled here by queueing them when their watcher gets executed. |
771 | - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
797 | - If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT |
772 | were used, or there are no active watchers, return, otherwise |
798 | were used, or there are no active watchers, goto FINISH, otherwise |
773 | continue with step *. |
799 | continue with step LOOP. |
|
|
800 | FINISH: |
|
|
801 | - Reset the ev_break status iff it was EVBREAK_ONE. |
|
|
802 | - Decrement the loop depth. |
|
|
803 | - Return. |
774 | |
804 | |
775 | Example: Queue some jobs and then loop until no events are outstanding |
805 | Example: Queue some jobs and then loop until no events are outstanding |
776 | anymore. |
806 | anymore. |
777 | |
807 | |
778 | ... queue jobs here, make sure they register event watchers as long |
808 | ... queue jobs here, make sure they register event watchers as long |
779 | ... as they still have work to do (even an idle watcher will do..) |
809 | ... as they still have work to do (even an idle watcher will do..) |
780 | ev_loop (my_loop, 0); |
810 | ev_run (my_loop, 0); |
781 | ... jobs done or somebody called unloop. yeah! |
811 | ... jobs done or somebody called unloop. yeah! |
782 | |
812 | |
783 | =item ev_unloop (loop, how) |
813 | =item ev_break (loop, how) |
784 | |
814 | |
785 | Can be used to make a call to C<ev_loop> return early (but only after it |
815 | Can be used to make a call to C<ev_run> return early (but only after it |
786 | has processed all outstanding events). The C<how> argument must be either |
816 | has processed all outstanding events). The C<how> argument must be either |
787 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
817 | C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or |
788 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
818 | C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return. |
789 | |
819 | |
790 | This "unloop state" will be cleared when entering C<ev_loop> again. |
820 | This "unloop state" will be cleared when entering C<ev_run> again. |
791 | |
821 | |
792 | It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls. |
822 | It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO## |
793 | |
823 | |
794 | =item ev_ref (loop) |
824 | =item ev_ref (loop) |
795 | |
825 | |
796 | =item ev_unref (loop) |
826 | =item ev_unref (loop) |
797 | |
827 | |
798 | Ref/unref can be used to add or remove a reference count on the event |
828 | Ref/unref can be used to add or remove a reference count on the event |
799 | loop: Every watcher keeps one reference, and as long as the reference |
829 | loop: Every watcher keeps one reference, and as long as the reference |
800 | count is nonzero, C<ev_loop> will not return on its own. |
830 | count is nonzero, C<ev_run> will not return on its own. |
801 | |
831 | |
802 | This is useful when you have a watcher that you never intend to |
832 | This is useful when you have a watcher that you never intend to |
803 | unregister, but that nevertheless should not keep C<ev_loop> from |
833 | unregister, but that nevertheless should not keep C<ev_run> from |
804 | returning. In such a case, call C<ev_unref> after starting, and C<ev_ref> |
834 | returning. In such a case, call C<ev_unref> after starting, and C<ev_ref> |
805 | before stopping it. |
835 | before stopping it. |
806 | |
836 | |
807 | As an example, libev itself uses this for its internal signal pipe: It |
837 | As an example, libev itself uses this for its internal signal pipe: It |
808 | is not visible to the libev user and should not keep C<ev_loop> from |
838 | is not visible to the libev user and should not keep C<ev_run> from |
809 | exiting if no event watchers registered by it are active. It is also an |
839 | exiting if no event watchers registered by it are active. It is also an |
810 | excellent way to do this for generic recurring timers or from within |
840 | excellent way to do this for generic recurring timers or from within |
811 | third-party libraries. Just remember to I<unref after start> and I<ref |
841 | third-party libraries. Just remember to I<unref after start> and I<ref |
812 | before stop> (but only if the watcher wasn't active before, or was active |
842 | before stop> (but only if the watcher wasn't active before, or was active |
813 | before, respectively. Note also that libev might stop watchers itself |
843 | before, respectively. Note also that libev might stop watchers itself |
814 | (e.g. non-repeating timers) in which case you have to C<ev_ref> |
844 | (e.g. non-repeating timers) in which case you have to C<ev_ref> |
815 | in the callback). |
845 | in the callback). |
816 | |
846 | |
817 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
847 | Example: Create a signal watcher, but keep it from keeping C<ev_run> |
818 | running when nothing else is active. |
848 | running when nothing else is active. |
819 | |
849 | |
820 | ev_signal exitsig; |
850 | ev_signal exitsig; |
821 | ev_signal_init (&exitsig, sig_cb, SIGINT); |
851 | ev_signal_init (&exitsig, sig_cb, SIGINT); |
822 | ev_signal_start (loop, &exitsig); |
852 | ev_signal_start (loop, &exitsig); |
… | |
… | |
867 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
897 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
868 | as this approaches the timing granularity of most systems. Note that if |
898 | as this approaches the timing granularity of most systems. Note that if |
869 | you do transactions with the outside world and you can't increase the |
899 | you do transactions with the outside world and you can't increase the |
870 | parallelity, then this setting will limit your transaction rate (if you |
900 | parallelity, then this setting will limit your transaction rate (if you |
871 | need to poll once per transaction and the I/O collect interval is 0.01, |
901 | need to poll once per transaction and the I/O collect interval is 0.01, |
872 | then you can't do more than 100 transations per second). |
902 | then you can't do more than 100 transactions per second). |
873 | |
903 | |
874 | Setting the I<timeout collect interval> can improve the opportunity for |
904 | Setting the I<timeout collect interval> can improve the opportunity for |
875 | saving power, as the program will "bundle" timer callback invocations that |
905 | saving power, as the program will "bundle" timer callback invocations that |
876 | are "near" in time together, by delaying some, thus reducing the number of |
906 | are "near" in time together, by delaying some, thus reducing the number of |
877 | times the process sleeps and wakes up again. Another useful technique to |
907 | times the process sleeps and wakes up again. Another useful technique to |
… | |
… | |
885 | ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01); |
915 | ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01); |
886 | |
916 | |
887 | =item ev_invoke_pending (loop) |
917 | =item ev_invoke_pending (loop) |
888 | |
918 | |
889 | This call will simply invoke all pending watchers while resetting their |
919 | This call will simply invoke all pending watchers while resetting their |
890 | pending state. Normally, C<ev_loop> does this automatically when required, |
920 | pending state. Normally, C<ev_run> does this automatically when required, |
891 | but when overriding the invoke callback this call comes handy. |
921 | but when overriding the invoke callback this call comes handy. This |
|
|
922 | function can be invoked from a watcher - this can be useful for example |
|
|
923 | when you want to do some lengthy calculation and want to pass further |
|
|
924 | event handling to another thread (you still have to make sure only one |
|
|
925 | thread executes within C<ev_invoke_pending> or C<ev_run> of course). |
892 | |
926 | |
893 | =item int ev_pending_count (loop) |
927 | =item int ev_pending_count (loop) |
894 | |
928 | |
895 | Returns the number of pending watchers - zero indicates that no watchers |
929 | Returns the number of pending watchers - zero indicates that no watchers |
896 | are pending. |
930 | are pending. |
897 | |
931 | |
898 | =item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P)) |
932 | =item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P)) |
899 | |
933 | |
900 | This overrides the invoke pending functionality of the loop: Instead of |
934 | This overrides the invoke pending functionality of the loop: Instead of |
901 | invoking all pending watchers when there are any, C<ev_loop> will call |
935 | invoking all pending watchers when there are any, C<ev_run> will call |
902 | this callback instead. This is useful, for example, when you want to |
936 | this callback instead. This is useful, for example, when you want to |
903 | invoke the actual watchers inside another context (another thread etc.). |
937 | invoke the actual watchers inside another context (another thread etc.). |
904 | |
938 | |
905 | If you want to reset the callback, use C<ev_invoke_pending> as new |
939 | If you want to reset the callback, use C<ev_invoke_pending> as new |
906 | callback. |
940 | callback. |
… | |
… | |
909 | |
943 | |
910 | Sometimes you want to share the same loop between multiple threads. This |
944 | Sometimes you want to share the same loop between multiple threads. This |
911 | can be done relatively simply by putting mutex_lock/unlock calls around |
945 | can be done relatively simply by putting mutex_lock/unlock calls around |
912 | each call to a libev function. |
946 | each call to a libev function. |
913 | |
947 | |
914 | However, C<ev_loop> can run an indefinite time, so it is not feasible to |
948 | However, C<ev_run> can run an indefinite time, so it is not feasible |
915 | wait for it to return. One way around this is to wake up the loop via |
949 | to wait for it to return. One way around this is to wake up the event |
916 | C<ev_unloop> and C<av_async_send>, another way is to set these I<release> |
950 | loop via C<ev_break> and C<av_async_send>, another way is to set these |
917 | and I<acquire> callbacks on the loop. |
951 | I<release> and I<acquire> callbacks on the loop. |
918 | |
952 | |
919 | When set, then C<release> will be called just before the thread is |
953 | When set, then C<release> will be called just before the thread is |
920 | suspended waiting for new events, and C<acquire> is called just |
954 | suspended waiting for new events, and C<acquire> is called just |
921 | afterwards. |
955 | afterwards. |
922 | |
956 | |
… | |
… | |
925 | |
959 | |
926 | While event loop modifications are allowed between invocations of |
960 | While event loop modifications are allowed between invocations of |
927 | C<release> and C<acquire> (that's their only purpose after all), no |
961 | C<release> and C<acquire> (that's their only purpose after all), no |
928 | modifications done will affect the event loop, i.e. adding watchers will |
962 | modifications done will affect the event loop, i.e. adding watchers will |
929 | have no effect on the set of file descriptors being watched, or the time |
963 | have no effect on the set of file descriptors being watched, or the time |
930 | waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it |
964 | waited. Use an C<ev_async> watcher to wake up C<ev_run> when you want it |
931 | to take note of any changes you made. |
965 | to take note of any changes you made. |
932 | |
966 | |
933 | In theory, threads executing C<ev_loop> will be async-cancel safe between |
967 | In theory, threads executing C<ev_run> will be async-cancel safe between |
934 | invocations of C<release> and C<acquire>. |
968 | invocations of C<release> and C<acquire>. |
935 | |
969 | |
936 | See also the locking example in the C<THREADS> section later in this |
970 | See also the locking example in the C<THREADS> section later in this |
937 | document. |
971 | document. |
938 | |
972 | |
… | |
… | |
947 | These two functions can be used to associate arbitrary data with a loop, |
981 | These two functions can be used to associate arbitrary data with a loop, |
948 | and are intended solely for the C<invoke_pending_cb>, C<release> and |
982 | and are intended solely for the C<invoke_pending_cb>, C<release> and |
949 | C<acquire> callbacks described above, but of course can be (ab-)used for |
983 | C<acquire> callbacks described above, but of course can be (ab-)used for |
950 | any other purpose as well. |
984 | any other purpose as well. |
951 | |
985 | |
952 | =item ev_loop_verify (loop) |
986 | =item ev_verify (loop) |
953 | |
987 | |
954 | This function only does something when C<EV_VERIFY> support has been |
988 | This function only does something when C<EV_VERIFY> support has been |
955 | compiled in, which is the default for non-minimal builds. It tries to go |
989 | compiled in, which is the default for non-minimal builds. It tries to go |
956 | through all internal structures and checks them for validity. If anything |
990 | through all internal structures and checks them for validity. If anything |
957 | is found to be inconsistent, it will print an error message to standard |
991 | is found to be inconsistent, it will print an error message to standard |
… | |
… | |
968 | |
1002 | |
969 | In the following description, uppercase C<TYPE> in names stands for the |
1003 | In the following description, uppercase C<TYPE> in names stands for the |
970 | watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer |
1004 | watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer |
971 | watchers and C<ev_io_start> for I/O watchers. |
1005 | watchers and C<ev_io_start> for I/O watchers. |
972 | |
1006 | |
973 | A watcher is a structure that you create and register to record your |
1007 | A watcher is an opaque structure that you allocate and register to record |
974 | interest in some event. For instance, if you want to wait for STDIN to |
1008 | your interest in some event. To make a concrete example, imagine you want |
975 | become readable, you would create an C<ev_io> watcher for that: |
1009 | to wait for STDIN to become readable, you would create an C<ev_io> watcher |
|
|
1010 | for that: |
976 | |
1011 | |
977 | static void my_cb (struct ev_loop *loop, ev_io *w, int revents) |
1012 | static void my_cb (struct ev_loop *loop, ev_io *w, int revents) |
978 | { |
1013 | { |
979 | ev_io_stop (w); |
1014 | ev_io_stop (w); |
980 | ev_unloop (loop, EVUNLOOP_ALL); |
1015 | ev_break (loop, EVBREAK_ALL); |
981 | } |
1016 | } |
982 | |
1017 | |
983 | struct ev_loop *loop = ev_default_loop (0); |
1018 | struct ev_loop *loop = ev_default_loop (0); |
984 | |
1019 | |
985 | ev_io stdin_watcher; |
1020 | ev_io stdin_watcher; |
986 | |
1021 | |
987 | ev_init (&stdin_watcher, my_cb); |
1022 | ev_init (&stdin_watcher, my_cb); |
988 | ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); |
1023 | ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); |
989 | ev_io_start (loop, &stdin_watcher); |
1024 | ev_io_start (loop, &stdin_watcher); |
990 | |
1025 | |
991 | ev_loop (loop, 0); |
1026 | ev_run (loop, 0); |
992 | |
1027 | |
993 | As you can see, you are responsible for allocating the memory for your |
1028 | As you can see, you are responsible for allocating the memory for your |
994 | watcher structures (and it is I<usually> a bad idea to do this on the |
1029 | watcher structures (and it is I<usually> a bad idea to do this on the |
995 | stack). |
1030 | stack). |
996 | |
1031 | |
997 | Each watcher has an associated watcher structure (called C<struct ev_TYPE> |
1032 | Each watcher has an associated watcher structure (called C<struct ev_TYPE> |
998 | or simply C<ev_TYPE>, as typedefs are provided for all watcher structs). |
1033 | or simply C<ev_TYPE>, as typedefs are provided for all watcher structs). |
999 | |
1034 | |
1000 | Each watcher structure must be initialised by a call to C<ev_init |
1035 | Each watcher structure must be initialised by a call to C<ev_init (watcher |
1001 | (watcher *, callback)>, which expects a callback to be provided. This |
1036 | *, callback)>, which expects a callback to be provided. This callback is |
1002 | callback gets invoked each time the event occurs (or, in the case of I/O |
1037 | invoked each time the event occurs (or, in the case of I/O watchers, each |
1003 | watchers, each time the event loop detects that the file descriptor given |
1038 | time the event loop detects that the file descriptor given is readable |
1004 | is readable and/or writable). |
1039 | and/or writable). |
1005 | |
1040 | |
1006 | Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >> |
1041 | Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >> |
1007 | macro to configure it, with arguments specific to the watcher type. There |
1042 | macro to configure it, with arguments specific to the watcher type. There |
1008 | is also a macro to combine initialisation and setting in one call: C<< |
1043 | is also a macro to combine initialisation and setting in one call: C<< |
1009 | ev_TYPE_init (watcher *, callback, ...) >>. |
1044 | ev_TYPE_init (watcher *, callback, ...) >>. |
… | |
… | |
1032 | =item C<EV_WRITE> |
1067 | =item C<EV_WRITE> |
1033 | |
1068 | |
1034 | The file descriptor in the C<ev_io> watcher has become readable and/or |
1069 | The file descriptor in the C<ev_io> watcher has become readable and/or |
1035 | writable. |
1070 | writable. |
1036 | |
1071 | |
1037 | =item C<EV_TIMEOUT> |
1072 | =item C<EV_TIMER> |
1038 | |
1073 | |
1039 | The C<ev_timer> watcher has timed out. |
1074 | The C<ev_timer> watcher has timed out. |
1040 | |
1075 | |
1041 | =item C<EV_PERIODIC> |
1076 | =item C<EV_PERIODIC> |
1042 | |
1077 | |
… | |
… | |
1060 | |
1095 | |
1061 | =item C<EV_PREPARE> |
1096 | =item C<EV_PREPARE> |
1062 | |
1097 | |
1063 | =item C<EV_CHECK> |
1098 | =item C<EV_CHECK> |
1064 | |
1099 | |
1065 | All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts |
1100 | All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts |
1066 | to gather new events, and all C<ev_check> watchers are invoked just after |
1101 | to gather new events, and all C<ev_check> watchers are invoked just after |
1067 | C<ev_loop> has gathered them, but before it invokes any callbacks for any |
1102 | C<ev_run> has gathered them, but before it invokes any callbacks for any |
1068 | received events. Callbacks of both watcher types can start and stop as |
1103 | received events. Callbacks of both watcher types can start and stop as |
1069 | many watchers as they want, and all of them will be taken into account |
1104 | many watchers as they want, and all of them will be taken into account |
1070 | (for example, a C<ev_prepare> watcher might start an idle watcher to keep |
1105 | (for example, a C<ev_prepare> watcher might start an idle watcher to keep |
1071 | C<ev_loop> from blocking). |
1106 | C<ev_run> from blocking). |
1072 | |
1107 | |
1073 | =item C<EV_EMBED> |
1108 | =item C<EV_EMBED> |
1074 | |
1109 | |
1075 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1110 | The embedded event loop specified in the C<ev_embed> watcher needs attention. |
1076 | |
1111 | |
1077 | =item C<EV_FORK> |
1112 | =item C<EV_FORK> |
1078 | |
1113 | |
1079 | The event loop has been resumed in the child process after fork (see |
1114 | The event loop has been resumed in the child process after fork (see |
1080 | C<ev_fork>). |
1115 | C<ev_fork>). |
|
|
1116 | |
|
|
1117 | =item C<EV_CLEANUP> |
|
|
1118 | |
|
|
1119 | The event loop is abotu to be destroyed (see C<ev_cleanup>). |
1081 | |
1120 | |
1082 | =item C<EV_ASYNC> |
1121 | =item C<EV_ASYNC> |
1083 | |
1122 | |
1084 | The given async watcher has been asynchronously notified (see C<ev_async>). |
1123 | The given async watcher has been asynchronously notified (see C<ev_async>). |
1085 | |
1124 | |
… | |
… | |
1104 | example it might indicate that a fd is readable or writable, and if your |
1143 | example it might indicate that a fd is readable or writable, and if your |
1105 | callbacks is well-written it can just attempt the operation and cope with |
1144 | callbacks is well-written it can just attempt the operation and cope with |
1106 | the error from read() or write(). This will not work in multi-threaded |
1145 | the error from read() or write(). This will not work in multi-threaded |
1107 | programs, though, as the fd could already be closed and reused for another |
1146 | programs, though, as the fd could already be closed and reused for another |
1108 | thing, so beware. |
1147 | thing, so beware. |
|
|
1148 | |
|
|
1149 | =back |
|
|
1150 | |
|
|
1151 | =head2 WATCHER STATES |
|
|
1152 | |
|
|
1153 | There are various watcher states mentioned throughout this manual - |
|
|
1154 | active, pending and so on. In this section these states and the rules to |
|
|
1155 | transition between them will be described in more detail - and while these |
|
|
1156 | rules might look complicated, they usually do "the right thing". |
|
|
1157 | |
|
|
1158 | =over 4 |
|
|
1159 | |
|
|
1160 | =item initialiased |
|
|
1161 | |
|
|
1162 | Before a watcher can be registered with the event looop it has to be |
|
|
1163 | initialised. This can be done with a call to C<ev_TYPE_init>, or calls to |
|
|
1164 | C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. |
|
|
1165 | |
|
|
1166 | In this state it is simply some block of memory that is suitable for use |
|
|
1167 | in an event loop. It can be moved around, freed, reused etc. at will. |
|
|
1168 | |
|
|
1169 | =item started/running/active |
|
|
1170 | |
|
|
1171 | Once a watcher has been started with a call to C<ev_TYPE_start> it becomes |
|
|
1172 | property of the event loop, and is actively waiting for events. While in |
|
|
1173 | this state it cannot be accessed (except in a few documented ways), moved, |
|
|
1174 | freed or anything else - the only legal thing is to keep a pointer to it, |
|
|
1175 | and call libev functions on it that are documented to work on active watchers. |
|
|
1176 | |
|
|
1177 | =item pending |
|
|
1178 | |
|
|
1179 | If a watcher is active and libev determines that an event it is interested |
|
|
1180 | in has occurred (such as a timer expiring), it will become pending. It will |
|
|
1181 | stay in this pending state until either it is stopped or its callback is |
|
|
1182 | about to be invoked, so it is not normally pending inside the watcher |
|
|
1183 | callback. |
|
|
1184 | |
|
|
1185 | The watcher might or might not be active while it is pending (for example, |
|
|
1186 | an expired non-repeating timer can be pending but no longer active). If it |
|
|
1187 | is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>), |
|
|
1188 | but it is still property of the event loop at this time, so cannot be |
|
|
1189 | moved, freed or reused. And if it is active the rules described in the |
|
|
1190 | previous item still apply. |
|
|
1191 | |
|
|
1192 | It is also possible to feed an event on a watcher that is not active (e.g. |
|
|
1193 | via C<ev_feed_event>), in which case it becomes pending without being |
|
|
1194 | active. |
|
|
1195 | |
|
|
1196 | =item stopped |
|
|
1197 | |
|
|
1198 | A watcher can be stopped implicitly by libev (in which case it might still |
|
|
1199 | be pending), or explicitly by calling its C<ev_TYPE_stop> function. The |
|
|
1200 | latter will clear any pending state the watcher might be in, regardless |
|
|
1201 | of whether it was active or not, so stopping a watcher explicitly before |
|
|
1202 | freeing it is often a good idea. |
|
|
1203 | |
|
|
1204 | While stopped (and not pending) the watcher is essentially in the |
|
|
1205 | initialised state, that is it can be reused, moved, modified in any way |
|
|
1206 | you wish. |
1109 | |
1207 | |
1110 | =back |
1208 | =back |
1111 | |
1209 | |
1112 | =head2 GENERIC WATCHER FUNCTIONS |
1210 | =head2 GENERIC WATCHER FUNCTIONS |
1113 | |
1211 | |
… | |
… | |
1375 | |
1473 | |
1376 | For example, to emulate how many other event libraries handle priorities, |
1474 | For example, to emulate how many other event libraries handle priorities, |
1377 | you can associate an C<ev_idle> watcher to each such watcher, and in |
1475 | you can associate an C<ev_idle> watcher to each such watcher, and in |
1378 | the normal watcher callback, you just start the idle watcher. The real |
1476 | the normal watcher callback, you just start the idle watcher. The real |
1379 | processing is done in the idle watcher callback. This causes libev to |
1477 | processing is done in the idle watcher callback. This causes libev to |
1380 | continously poll and process kernel event data for the watcher, but when |
1478 | continuously poll and process kernel event data for the watcher, but when |
1381 | the lock-out case is known to be rare (which in turn is rare :), this is |
1479 | the lock-out case is known to be rare (which in turn is rare :), this is |
1382 | workable. |
1480 | workable. |
1383 | |
1481 | |
1384 | Usually, however, the lock-out model implemented that way will perform |
1482 | Usually, however, the lock-out model implemented that way will perform |
1385 | miserably under the type of load it was designed to handle. In that case, |
1483 | miserably under the type of load it was designed to handle. In that case, |
… | |
… | |
1399 | { |
1497 | { |
1400 | // stop the I/O watcher, we received the event, but |
1498 | // stop the I/O watcher, we received the event, but |
1401 | // are not yet ready to handle it. |
1499 | // are not yet ready to handle it. |
1402 | ev_io_stop (EV_A_ w); |
1500 | ev_io_stop (EV_A_ w); |
1403 | |
1501 | |
1404 | // start the idle watcher to ahndle the actual event. |
1502 | // start the idle watcher to handle the actual event. |
1405 | // it will not be executed as long as other watchers |
1503 | // it will not be executed as long as other watchers |
1406 | // with the default priority are receiving events. |
1504 | // with the default priority are receiving events. |
1407 | ev_idle_start (EV_A_ &idle); |
1505 | ev_idle_start (EV_A_ &idle); |
1408 | } |
1506 | } |
1409 | |
1507 | |
… | |
… | |
1463 | |
1561 | |
1464 | If you cannot use non-blocking mode, then force the use of a |
1562 | If you cannot use non-blocking mode, then force the use of a |
1465 | known-to-be-good backend (at the time of this writing, this includes only |
1563 | known-to-be-good backend (at the time of this writing, this includes only |
1466 | C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file |
1564 | C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file |
1467 | descriptors for which non-blocking operation makes no sense (such as |
1565 | descriptors for which non-blocking operation makes no sense (such as |
1468 | files) - libev doesn't guarentee any specific behaviour in that case. |
1566 | files) - libev doesn't guarantee any specific behaviour in that case. |
1469 | |
1567 | |
1470 | Another thing you have to watch out for is that it is quite easy to |
1568 | Another thing you have to watch out for is that it is quite easy to |
1471 | receive "spurious" readiness notifications, that is your callback might |
1569 | receive "spurious" readiness notifications, that is your callback might |
1472 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
1570 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
1473 | because there is no data. Not only are some backends known to create a |
1571 | because there is no data. Not only are some backends known to create a |
… | |
… | |
1538 | |
1636 | |
1539 | So when you encounter spurious, unexplained daemon exits, make sure you |
1637 | So when you encounter spurious, unexplained daemon exits, make sure you |
1540 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
1638 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
1541 | somewhere, as that would have given you a big clue). |
1639 | somewhere, as that would have given you a big clue). |
1542 | |
1640 | |
|
|
1641 | =head3 The special problem of accept()ing when you can't |
|
|
1642 | |
|
|
1643 | Many implementations of the POSIX C<accept> function (for example, |
|
|
1644 | found in post-2004 Linux) have the peculiar behaviour of not removing a |
|
|
1645 | connection from the pending queue in all error cases. |
|
|
1646 | |
|
|
1647 | For example, larger servers often run out of file descriptors (because |
|
|
1648 | of resource limits), causing C<accept> to fail with C<ENFILE> but not |
|
|
1649 | rejecting the connection, leading to libev signalling readiness on |
|
|
1650 | the next iteration again (the connection still exists after all), and |
|
|
1651 | typically causing the program to loop at 100% CPU usage. |
|
|
1652 | |
|
|
1653 | Unfortunately, the set of errors that cause this issue differs between |
|
|
1654 | operating systems, there is usually little the app can do to remedy the |
|
|
1655 | situation, and no known thread-safe method of removing the connection to |
|
|
1656 | cope with overload is known (to me). |
|
|
1657 | |
|
|
1658 | One of the easiest ways to handle this situation is to just ignore it |
|
|
1659 | - when the program encounters an overload, it will just loop until the |
|
|
1660 | situation is over. While this is a form of busy waiting, no OS offers an |
|
|
1661 | event-based way to handle this situation, so it's the best one can do. |
|
|
1662 | |
|
|
1663 | A better way to handle the situation is to log any errors other than |
|
|
1664 | C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such |
|
|
1665 | messages, and continue as usual, which at least gives the user an idea of |
|
|
1666 | what could be wrong ("raise the ulimit!"). For extra points one could stop |
|
|
1667 | the C<ev_io> watcher on the listening fd "for a while", which reduces CPU |
|
|
1668 | usage. |
|
|
1669 | |
|
|
1670 | If your program is single-threaded, then you could also keep a dummy file |
|
|
1671 | descriptor for overload situations (e.g. by opening F</dev/null>), and |
|
|
1672 | when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>, |
|
|
1673 | close that fd, and create a new dummy fd. This will gracefully refuse |
|
|
1674 | clients under typical overload conditions. |
|
|
1675 | |
|
|
1676 | The last way to handle it is to simply log the error and C<exit>, as |
|
|
1677 | is often done with C<malloc> failures, but this results in an easy |
|
|
1678 | opportunity for a DoS attack. |
1543 | |
1679 | |
1544 | =head3 Watcher-Specific Functions |
1680 | =head3 Watcher-Specific Functions |
1545 | |
1681 | |
1546 | =over 4 |
1682 | =over 4 |
1547 | |
1683 | |
… | |
… | |
1579 | ... |
1715 | ... |
1580 | struct ev_loop *loop = ev_default_init (0); |
1716 | struct ev_loop *loop = ev_default_init (0); |
1581 | ev_io stdin_readable; |
1717 | ev_io stdin_readable; |
1582 | ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
1718 | ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
1583 | ev_io_start (loop, &stdin_readable); |
1719 | ev_io_start (loop, &stdin_readable); |
1584 | ev_loop (loop, 0); |
1720 | ev_run (loop, 0); |
1585 | |
1721 | |
1586 | |
1722 | |
1587 | =head2 C<ev_timer> - relative and optionally repeating timeouts |
1723 | =head2 C<ev_timer> - relative and optionally repeating timeouts |
1588 | |
1724 | |
1589 | Timer watchers are simple relative timers that generate an event after a |
1725 | Timer watchers are simple relative timers that generate an event after a |
… | |
… | |
1598 | The callback is guaranteed to be invoked only I<after> its timeout has |
1734 | The callback is guaranteed to be invoked only I<after> its timeout has |
1599 | passed (not I<at>, so on systems with very low-resolution clocks this |
1735 | passed (not I<at>, so on systems with very low-resolution clocks this |
1600 | might introduce a small delay). If multiple timers become ready during the |
1736 | might introduce a small delay). If multiple timers become ready during the |
1601 | same loop iteration then the ones with earlier time-out values are invoked |
1737 | same loop iteration then the ones with earlier time-out values are invoked |
1602 | before ones of the same priority with later time-out values (but this is |
1738 | before ones of the same priority with later time-out values (but this is |
1603 | no longer true when a callback calls C<ev_loop> recursively). |
1739 | no longer true when a callback calls C<ev_run> recursively). |
1604 | |
1740 | |
1605 | =head3 Be smart about timeouts |
1741 | =head3 Be smart about timeouts |
1606 | |
1742 | |
1607 | Many real-world problems involve some kind of timeout, usually for error |
1743 | Many real-world problems involve some kind of timeout, usually for error |
1608 | recovery. A typical example is an HTTP request - if the other side hangs, |
1744 | recovery. A typical example is an HTTP request - if the other side hangs, |
… | |
… | |
1694 | ev_tstamp timeout = last_activity + 60.; |
1830 | ev_tstamp timeout = last_activity + 60.; |
1695 | |
1831 | |
1696 | // if last_activity + 60. is older than now, we did time out |
1832 | // if last_activity + 60. is older than now, we did time out |
1697 | if (timeout < now) |
1833 | if (timeout < now) |
1698 | { |
1834 | { |
1699 | // timeout occured, take action |
1835 | // timeout occurred, take action |
1700 | } |
1836 | } |
1701 | else |
1837 | else |
1702 | { |
1838 | { |
1703 | // callback was invoked, but there was some activity, re-arm |
1839 | // callback was invoked, but there was some activity, re-arm |
1704 | // the watcher to fire in last_activity + 60, which is |
1840 | // the watcher to fire in last_activity + 60, which is |
… | |
… | |
1726 | to the current time (meaning we just have some activity :), then call the |
1862 | to the current time (meaning we just have some activity :), then call the |
1727 | callback, which will "do the right thing" and start the timer: |
1863 | callback, which will "do the right thing" and start the timer: |
1728 | |
1864 | |
1729 | ev_init (timer, callback); |
1865 | ev_init (timer, callback); |
1730 | last_activity = ev_now (loop); |
1866 | last_activity = ev_now (loop); |
1731 | callback (loop, timer, EV_TIMEOUT); |
1867 | callback (loop, timer, EV_TIMER); |
1732 | |
1868 | |
1733 | And when there is some activity, simply store the current time in |
1869 | And when there is some activity, simply store the current time in |
1734 | C<last_activity>, no libev calls at all: |
1870 | C<last_activity>, no libev calls at all: |
1735 | |
1871 | |
1736 | last_actiivty = ev_now (loop); |
1872 | last_activity = ev_now (loop); |
1737 | |
1873 | |
1738 | This technique is slightly more complex, but in most cases where the |
1874 | This technique is slightly more complex, but in most cases where the |
1739 | time-out is unlikely to be triggered, much more efficient. |
1875 | time-out is unlikely to be triggered, much more efficient. |
1740 | |
1876 | |
1741 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
1877 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
… | |
… | |
1779 | |
1915 | |
1780 | =head3 The special problem of time updates |
1916 | =head3 The special problem of time updates |
1781 | |
1917 | |
1782 | Establishing the current time is a costly operation (it usually takes at |
1918 | Establishing the current time is a costly operation (it usually takes at |
1783 | least two system calls): EV therefore updates its idea of the current |
1919 | least two system calls): EV therefore updates its idea of the current |
1784 | time only before and after C<ev_loop> collects new events, which causes a |
1920 | time only before and after C<ev_run> collects new events, which causes a |
1785 | growing difference between C<ev_now ()> and C<ev_time ()> when handling |
1921 | growing difference between C<ev_now ()> and C<ev_time ()> when handling |
1786 | lots of events in one iteration. |
1922 | lots of events in one iteration. |
1787 | |
1923 | |
1788 | The relative timeouts are calculated relative to the C<ev_now ()> |
1924 | The relative timeouts are calculated relative to the C<ev_now ()> |
1789 | time. This is usually the right thing as this timestamp refers to the time |
1925 | time. This is usually the right thing as this timestamp refers to the time |
… | |
… | |
1867 | Returns the remaining time until a timer fires. If the timer is active, |
2003 | Returns the remaining time until a timer fires. If the timer is active, |
1868 | then this time is relative to the current event loop time, otherwise it's |
2004 | then this time is relative to the current event loop time, otherwise it's |
1869 | the timeout value currently configured. |
2005 | the timeout value currently configured. |
1870 | |
2006 | |
1871 | That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns |
2007 | That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns |
1872 | C<5>. When the timer is started and one second passes, C<ev_timer_remain> |
2008 | C<5>. When the timer is started and one second passes, C<ev_timer_remaining> |
1873 | will return C<4>. When the timer expires and is restarted, it will return |
2009 | will return C<4>. When the timer expires and is restarted, it will return |
1874 | roughly C<7> (likely slightly less as callback invocation takes some time, |
2010 | roughly C<7> (likely slightly less as callback invocation takes some time, |
1875 | too), and so on. |
2011 | too), and so on. |
1876 | |
2012 | |
1877 | =item ev_tstamp repeat [read-write] |
2013 | =item ev_tstamp repeat [read-write] |
… | |
… | |
1906 | } |
2042 | } |
1907 | |
2043 | |
1908 | ev_timer mytimer; |
2044 | ev_timer mytimer; |
1909 | ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ |
2045 | ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ |
1910 | ev_timer_again (&mytimer); /* start timer */ |
2046 | ev_timer_again (&mytimer); /* start timer */ |
1911 | ev_loop (loop, 0); |
2047 | ev_run (loop, 0); |
1912 | |
2048 | |
1913 | // and in some piece of code that gets executed on any "activity": |
2049 | // and in some piece of code that gets executed on any "activity": |
1914 | // reset the timeout to start ticking again at 10 seconds |
2050 | // reset the timeout to start ticking again at 10 seconds |
1915 | ev_timer_again (&mytimer); |
2051 | ev_timer_again (&mytimer); |
1916 | |
2052 | |
… | |
… | |
1942 | |
2078 | |
1943 | As with timers, the callback is guaranteed to be invoked only when the |
2079 | As with timers, the callback is guaranteed to be invoked only when the |
1944 | point in time where it is supposed to trigger has passed. If multiple |
2080 | point in time where it is supposed to trigger has passed. If multiple |
1945 | timers become ready during the same loop iteration then the ones with |
2081 | timers become ready during the same loop iteration then the ones with |
1946 | earlier time-out values are invoked before ones with later time-out values |
2082 | earlier time-out values are invoked before ones with later time-out values |
1947 | (but this is no longer true when a callback calls C<ev_loop> recursively). |
2083 | (but this is no longer true when a callback calls C<ev_run> recursively). |
1948 | |
2084 | |
1949 | =head3 Watcher-Specific Functions and Data Members |
2085 | =head3 Watcher-Specific Functions and Data Members |
1950 | |
2086 | |
1951 | =over 4 |
2087 | =over 4 |
1952 | |
2088 | |
… | |
… | |
2080 | Example: Call a callback every hour, or, more precisely, whenever the |
2216 | Example: Call a callback every hour, or, more precisely, whenever the |
2081 | system time is divisible by 3600. The callback invocation times have |
2217 | system time is divisible by 3600. The callback invocation times have |
2082 | potentially a lot of jitter, but good long-term stability. |
2218 | potentially a lot of jitter, but good long-term stability. |
2083 | |
2219 | |
2084 | static void |
2220 | static void |
2085 | clock_cb (struct ev_loop *loop, ev_io *w, int revents) |
2221 | clock_cb (struct ev_loop *loop, ev_periodic *w, int revents) |
2086 | { |
2222 | { |
2087 | ... its now a full hour (UTC, or TAI or whatever your clock follows) |
2223 | ... its now a full hour (UTC, or TAI or whatever your clock follows) |
2088 | } |
2224 | } |
2089 | |
2225 | |
2090 | ev_periodic hourly_tick; |
2226 | ev_periodic hourly_tick; |
… | |
… | |
2190 | Example: Try to exit cleanly on SIGINT. |
2326 | Example: Try to exit cleanly on SIGINT. |
2191 | |
2327 | |
2192 | static void |
2328 | static void |
2193 | sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) |
2329 | sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) |
2194 | { |
2330 | { |
2195 | ev_unloop (loop, EVUNLOOP_ALL); |
2331 | ev_break (loop, EVBREAK_ALL); |
2196 | } |
2332 | } |
2197 | |
2333 | |
2198 | ev_signal signal_watcher; |
2334 | ev_signal signal_watcher; |
2199 | ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
2335 | ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
2200 | ev_signal_start (loop, &signal_watcher); |
2336 | ev_signal_start (loop, &signal_watcher); |
… | |
… | |
2586 | |
2722 | |
2587 | Prepare and check watchers are usually (but not always) used in pairs: |
2723 | Prepare and check watchers are usually (but not always) used in pairs: |
2588 | prepare watchers get invoked before the process blocks and check watchers |
2724 | prepare watchers get invoked before the process blocks and check watchers |
2589 | afterwards. |
2725 | afterwards. |
2590 | |
2726 | |
2591 | You I<must not> call C<ev_loop> or similar functions that enter |
2727 | You I<must not> call C<ev_run> or similar functions that enter |
2592 | the current event loop from either C<ev_prepare> or C<ev_check> |
2728 | the current event loop from either C<ev_prepare> or C<ev_check> |
2593 | watchers. Other loops than the current one are fine, however. The |
2729 | watchers. Other loops than the current one are fine, however. The |
2594 | rationale behind this is that you do not need to check for recursion in |
2730 | rationale behind this is that you do not need to check for recursion in |
2595 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
2731 | those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, |
2596 | C<ev_check> so if you have one watcher of each kind they will always be |
2732 | C<ev_check> so if you have one watcher of each kind they will always be |
… | |
… | |
2764 | |
2900 | |
2765 | if (timeout >= 0) |
2901 | if (timeout >= 0) |
2766 | // create/start timer |
2902 | // create/start timer |
2767 | |
2903 | |
2768 | // poll |
2904 | // poll |
2769 | ev_loop (EV_A_ 0); |
2905 | ev_run (EV_A_ 0); |
2770 | |
2906 | |
2771 | // stop timer again |
2907 | // stop timer again |
2772 | if (timeout >= 0) |
2908 | if (timeout >= 0) |
2773 | ev_timer_stop (EV_A_ &to); |
2909 | ev_timer_stop (EV_A_ &to); |
2774 | |
2910 | |
… | |
… | |
2852 | if you do not want that, you need to temporarily stop the embed watcher). |
2988 | if you do not want that, you need to temporarily stop the embed watcher). |
2853 | |
2989 | |
2854 | =item ev_embed_sweep (loop, ev_embed *) |
2990 | =item ev_embed_sweep (loop, ev_embed *) |
2855 | |
2991 | |
2856 | Make a single, non-blocking sweep over the embedded loop. This works |
2992 | Make a single, non-blocking sweep over the embedded loop. This works |
2857 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
2993 | similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most |
2858 | appropriate way for embedded loops. |
2994 | appropriate way for embedded loops. |
2859 | |
2995 | |
2860 | =item struct ev_loop *other [read-only] |
2996 | =item struct ev_loop *other [read-only] |
2861 | |
2997 | |
2862 | The embedded event loop. |
2998 | The embedded event loop. |
… | |
… | |
2922 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
3058 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
2923 | handlers will be invoked, too, of course. |
3059 | handlers will be invoked, too, of course. |
2924 | |
3060 | |
2925 | =head3 The special problem of life after fork - how is it possible? |
3061 | =head3 The special problem of life after fork - how is it possible? |
2926 | |
3062 | |
2927 | Most uses of C<fork()> consist of forking, then some simple calls to ste |
3063 | Most uses of C<fork()> consist of forking, then some simple calls to set |
2928 | up/change the process environment, followed by a call to C<exec()>. This |
3064 | up/change the process environment, followed by a call to C<exec()>. This |
2929 | sequence should be handled by libev without any problems. |
3065 | sequence should be handled by libev without any problems. |
2930 | |
3066 | |
2931 | This changes when the application actually wants to do event handling |
3067 | This changes when the application actually wants to do event handling |
2932 | in the child, or both parent in child, in effect "continuing" after the |
3068 | in the child, or both parent in child, in effect "continuing" after the |
… | |
… | |
2948 | disadvantage of having to use multiple event loops (which do not support |
3084 | disadvantage of having to use multiple event loops (which do not support |
2949 | signal watchers). |
3085 | signal watchers). |
2950 | |
3086 | |
2951 | When this is not possible, or you want to use the default loop for |
3087 | When this is not possible, or you want to use the default loop for |
2952 | other reasons, then in the process that wants to start "fresh", call |
3088 | other reasons, then in the process that wants to start "fresh", call |
2953 | C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying |
3089 | C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>. |
2954 | the default loop will "orphan" (not stop) all registered watchers, so you |
3090 | Destroying the default loop will "orphan" (not stop) all registered |
2955 | have to be careful not to execute code that modifies those watchers. Note |
3091 | watchers, so you have to be careful not to execute code that modifies |
2956 | also that in that case, you have to re-register any signal watchers. |
3092 | those watchers. Note also that in that case, you have to re-register any |
|
|
3093 | signal watchers. |
2957 | |
3094 | |
2958 | =head3 Watcher-Specific Functions and Data Members |
3095 | =head3 Watcher-Specific Functions and Data Members |
2959 | |
3096 | |
2960 | =over 4 |
3097 | =over 4 |
2961 | |
3098 | |
2962 | =item ev_fork_init (ev_signal *, callback) |
3099 | =item ev_fork_init (ev_fork *, callback) |
2963 | |
3100 | |
2964 | Initialises and configures the fork watcher - it has no parameters of any |
3101 | Initialises and configures the fork watcher - it has no parameters of any |
2965 | kind. There is a C<ev_fork_set> macro, but using it is utterly pointless, |
3102 | kind. There is a C<ev_fork_set> macro, but using it is utterly pointless, |
2966 | believe me. |
3103 | believe me. |
2967 | |
3104 | |
2968 | =back |
3105 | =back |
2969 | |
3106 | |
2970 | |
3107 | |
|
|
3108 | =head2 C<ev_cleanup> - even the best things end |
|
|
3109 | |
|
|
3110 | Cleanup watchers are called just before the event loop they are registered |
|
|
3111 | with is being destroyed. |
|
|
3112 | |
|
|
3113 | While there is no guarantee that the event loop gets destroyed, cleanup |
|
|
3114 | watchers provide a convenient method to install cleanup watchers for your |
|
|
3115 | program, worker threads and so on - you just to make sure to destroy the |
|
|
3116 | loop when you want them to be invoked. |
|
|
3117 | |
|
|
3118 | =head3 Watcher-Specific Functions and Data Members |
|
|
3119 | |
|
|
3120 | =over 4 |
|
|
3121 | |
|
|
3122 | =item ev_cleanup_init (ev_cleanup *, callback) |
|
|
3123 | |
|
|
3124 | Initialises and configures the cleanup watcher - it has no parameters of |
|
|
3125 | any kind. There is a C<ev_cleanup_set> macro, but using it is utterly |
|
|
3126 | pointless, believe me. |
|
|
3127 | |
|
|
3128 | =back |
|
|
3129 | |
|
|
3130 | Example: Register an atexit handler to destroy the default loop, so any |
|
|
3131 | cleanup functions are called. |
|
|
3132 | |
|
|
3133 | static void |
|
|
3134 | program_exits (void) |
|
|
3135 | { |
|
|
3136 | ev_loop_destroy (EV_DEFAULT_UC); |
|
|
3137 | } |
|
|
3138 | |
|
|
3139 | ... |
|
|
3140 | atexit (program_exits); |
|
|
3141 | |
|
|
3142 | |
2971 | =head2 C<ev_async> - how to wake up another event loop |
3143 | =head2 C<ev_async> - how to wake up an event loop |
2972 | |
3144 | |
2973 | In general, you cannot use an C<ev_loop> from multiple threads or other |
3145 | In general, you cannot use an C<ev_run> from multiple threads or other |
2974 | asynchronous sources such as signal handlers (as opposed to multiple event |
3146 | asynchronous sources such as signal handlers (as opposed to multiple event |
2975 | loops - those are of course safe to use in different threads). |
3147 | loops - those are of course safe to use in different threads). |
2976 | |
3148 | |
2977 | Sometimes, however, you need to wake up another event loop you do not |
3149 | Sometimes, however, you need to wake up an event loop you do not control, |
2978 | control, for example because it belongs to another thread. This is what |
3150 | for example because it belongs to another thread. This is what C<ev_async> |
2979 | C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you |
3151 | watchers do: as long as the C<ev_async> watcher is active, you can signal |
2980 | can signal it by calling C<ev_async_send>, which is thread- and signal |
3152 | it by calling C<ev_async_send>, which is thread- and signal safe. |
2981 | safe. |
|
|
2982 | |
3153 | |
2983 | This functionality is very similar to C<ev_signal> watchers, as signals, |
3154 | This functionality is very similar to C<ev_signal> watchers, as signals, |
2984 | too, are asynchronous in nature, and signals, too, will be compressed |
3155 | too, are asynchronous in nature, and signals, too, will be compressed |
2985 | (i.e. the number of callback invocations may be less than the number of |
3156 | (i.e. the number of callback invocations may be less than the number of |
2986 | C<ev_async_sent> calls). |
3157 | C<ev_async_sent> calls). |
… | |
… | |
3141 | |
3312 | |
3142 | If C<timeout> is less than 0, then no timeout watcher will be |
3313 | If C<timeout> is less than 0, then no timeout watcher will be |
3143 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
3314 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
3144 | repeat = 0) will be started. C<0> is a valid timeout. |
3315 | repeat = 0) will be started. C<0> is a valid timeout. |
3145 | |
3316 | |
3146 | The callback has the type C<void (*cb)(int revents, void *arg)> and gets |
3317 | The callback has the type C<void (*cb)(int revents, void *arg)> and is |
3147 | passed an C<revents> set like normal event callbacks (a combination of |
3318 | passed an C<revents> set like normal event callbacks (a combination of |
3148 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> |
3319 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg> |
3149 | value passed to C<ev_once>. Note that it is possible to receive I<both> |
3320 | value passed to C<ev_once>. Note that it is possible to receive I<both> |
3150 | a timeout and an io event at the same time - you probably should give io |
3321 | a timeout and an io event at the same time - you probably should give io |
3151 | events precedence. |
3322 | events precedence. |
3152 | |
3323 | |
3153 | Example: wait up to ten seconds for data to appear on STDIN_FILENO. |
3324 | Example: wait up to ten seconds for data to appear on STDIN_FILENO. |
3154 | |
3325 | |
3155 | static void stdin_ready (int revents, void *arg) |
3326 | static void stdin_ready (int revents, void *arg) |
3156 | { |
3327 | { |
3157 | if (revents & EV_READ) |
3328 | if (revents & EV_READ) |
3158 | /* stdin might have data for us, joy! */; |
3329 | /* stdin might have data for us, joy! */; |
3159 | else if (revents & EV_TIMEOUT) |
3330 | else if (revents & EV_TIMER) |
3160 | /* doh, nothing entered */; |
3331 | /* doh, nothing entered */; |
3161 | } |
3332 | } |
3162 | |
3333 | |
3163 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3334 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3164 | |
3335 | |
… | |
… | |
3298 | myclass obj; |
3469 | myclass obj; |
3299 | ev::io iow; |
3470 | ev::io iow; |
3300 | iow.set <myclass, &myclass::io_cb> (&obj); |
3471 | iow.set <myclass, &myclass::io_cb> (&obj); |
3301 | |
3472 | |
3302 | =item w->set (object *) |
3473 | =item w->set (object *) |
3303 | |
|
|
3304 | This is an B<experimental> feature that might go away in a future version. |
|
|
3305 | |
3474 | |
3306 | This is a variation of a method callback - leaving out the method to call |
3475 | This is a variation of a method callback - leaving out the method to call |
3307 | will default the method to C<operator ()>, which makes it possible to use |
3476 | will default the method to C<operator ()>, which makes it possible to use |
3308 | functor objects without having to manually specify the C<operator ()> all |
3477 | functor objects without having to manually specify the C<operator ()> all |
3309 | the time. Incidentally, you can then also leave out the template argument |
3478 | the time. Incidentally, you can then also leave out the template argument |
… | |
… | |
3349 | Associates a different C<struct ev_loop> with this watcher. You can only |
3518 | Associates a different C<struct ev_loop> with this watcher. You can only |
3350 | do this when the watcher is inactive (and not pending either). |
3519 | do this when the watcher is inactive (and not pending either). |
3351 | |
3520 | |
3352 | =item w->set ([arguments]) |
3521 | =item w->set ([arguments]) |
3353 | |
3522 | |
3354 | Basically the same as C<ev_TYPE_set>, with the same arguments. Must be |
3523 | Basically the same as C<ev_TYPE_set>, with the same arguments. Either this |
3355 | called at least once. Unlike the C counterpart, an active watcher gets |
3524 | method or a suitable start method must be called at least once. Unlike the |
3356 | automatically stopped and restarted when reconfiguring it with this |
3525 | C counterpart, an active watcher gets automatically stopped and restarted |
3357 | method. |
3526 | when reconfiguring it with this method. |
3358 | |
3527 | |
3359 | =item w->start () |
3528 | =item w->start () |
3360 | |
3529 | |
3361 | Starts the watcher. Note that there is no C<loop> argument, as the |
3530 | Starts the watcher. Note that there is no C<loop> argument, as the |
3362 | constructor already stores the event loop. |
3531 | constructor already stores the event loop. |
3363 | |
3532 | |
|
|
3533 | =item w->start ([arguments]) |
|
|
3534 | |
|
|
3535 | Instead of calling C<set> and C<start> methods separately, it is often |
|
|
3536 | convenient to wrap them in one call. Uses the same type of arguments as |
|
|
3537 | the configure C<set> method of the watcher. |
|
|
3538 | |
3364 | =item w->stop () |
3539 | =item w->stop () |
3365 | |
3540 | |
3366 | Stops the watcher if it is active. Again, no C<loop> argument. |
3541 | Stops the watcher if it is active. Again, no C<loop> argument. |
3367 | |
3542 | |
3368 | =item w->again () (C<ev::timer>, C<ev::periodic> only) |
3543 | =item w->again () (C<ev::timer>, C<ev::periodic> only) |
… | |
… | |
3380 | |
3555 | |
3381 | =back |
3556 | =back |
3382 | |
3557 | |
3383 | =back |
3558 | =back |
3384 | |
3559 | |
3385 | Example: Define a class with an IO and idle watcher, start one of them in |
3560 | Example: Define a class with two I/O and idle watchers, start the I/O |
3386 | the constructor. |
3561 | watchers in the constructor. |
3387 | |
3562 | |
3388 | class myclass |
3563 | class myclass |
3389 | { |
3564 | { |
3390 | ev::io io ; void io_cb (ev::io &w, int revents); |
3565 | ev::io io ; void io_cb (ev::io &w, int revents); |
|
|
3566 | ev::io2 io2 ; void io2_cb (ev::io &w, int revents); |
3391 | ev::idle idle; void idle_cb (ev::idle &w, int revents); |
3567 | ev::idle idle; void idle_cb (ev::idle &w, int revents); |
3392 | |
3568 | |
3393 | myclass (int fd) |
3569 | myclass (int fd) |
3394 | { |
3570 | { |
3395 | io .set <myclass, &myclass::io_cb > (this); |
3571 | io .set <myclass, &myclass::io_cb > (this); |
|
|
3572 | io2 .set <myclass, &myclass::io2_cb > (this); |
3396 | idle.set <myclass, &myclass::idle_cb> (this); |
3573 | idle.set <myclass, &myclass::idle_cb> (this); |
3397 | |
3574 | |
3398 | io.start (fd, ev::READ); |
3575 | io.set (fd, ev::WRITE); // configure the watcher |
|
|
3576 | io.start (); // start it whenever convenient |
|
|
3577 | |
|
|
3578 | io2.start (fd, ev::READ); // set + start in one call |
3399 | } |
3579 | } |
3400 | }; |
3580 | }; |
3401 | |
3581 | |
3402 | |
3582 | |
3403 | =head1 OTHER LANGUAGE BINDINGS |
3583 | =head1 OTHER LANGUAGE BINDINGS |
… | |
… | |
3451 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
3631 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
3452 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
3632 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
3453 | |
3633 | |
3454 | =item Lua |
3634 | =item Lua |
3455 | |
3635 | |
3456 | Brian Maher has written a partial interface to libev |
3636 | Brian Maher has written a partial interface to libev for lua (at the |
3457 | for lua (only C<ev_io> and C<ev_timer>), to be found at |
3637 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
3458 | L<http://github.com/brimworks/lua-ev>. |
3638 | L<http://github.com/brimworks/lua-ev>. |
3459 | |
3639 | |
3460 | =back |
3640 | =back |
3461 | |
3641 | |
3462 | |
3642 | |
… | |
… | |
3477 | loop argument"). The C<EV_A> form is used when this is the sole argument, |
3657 | loop argument"). The C<EV_A> form is used when this is the sole argument, |
3478 | C<EV_A_> is used when other arguments are following. Example: |
3658 | C<EV_A_> is used when other arguments are following. Example: |
3479 | |
3659 | |
3480 | ev_unref (EV_A); |
3660 | ev_unref (EV_A); |
3481 | ev_timer_add (EV_A_ watcher); |
3661 | ev_timer_add (EV_A_ watcher); |
3482 | ev_loop (EV_A_ 0); |
3662 | ev_run (EV_A_ 0); |
3483 | |
3663 | |
3484 | It assumes the variable C<loop> of type C<struct ev_loop *> is in scope, |
3664 | It assumes the variable C<loop> of type C<struct ev_loop *> is in scope, |
3485 | which is often provided by the following macro. |
3665 | which is often provided by the following macro. |
3486 | |
3666 | |
3487 | =item C<EV_P>, C<EV_P_> |
3667 | =item C<EV_P>, C<EV_P_> |
… | |
… | |
3527 | } |
3707 | } |
3528 | |
3708 | |
3529 | ev_check check; |
3709 | ev_check check; |
3530 | ev_check_init (&check, check_cb); |
3710 | ev_check_init (&check, check_cb); |
3531 | ev_check_start (EV_DEFAULT_ &check); |
3711 | ev_check_start (EV_DEFAULT_ &check); |
3532 | ev_loop (EV_DEFAULT_ 0); |
3712 | ev_run (EV_DEFAULT_ 0); |
3533 | |
3713 | |
3534 | =head1 EMBEDDING |
3714 | =head1 EMBEDDING |
3535 | |
3715 | |
3536 | Libev can (and often is) directly embedded into host |
3716 | Libev can (and often is) directly embedded into host |
3537 | applications. Examples of applications that embed it include the Deliantra |
3717 | applications. Examples of applications that embed it include the Deliantra |
… | |
… | |
3617 | libev.m4 |
3797 | libev.m4 |
3618 | |
3798 | |
3619 | =head2 PREPROCESSOR SYMBOLS/MACROS |
3799 | =head2 PREPROCESSOR SYMBOLS/MACROS |
3620 | |
3800 | |
3621 | Libev can be configured via a variety of preprocessor symbols you have to |
3801 | Libev can be configured via a variety of preprocessor symbols you have to |
3622 | define before including any of its files. The default in the absence of |
3802 | define before including (or compiling) any of its files. The default in |
3623 | autoconf is documented for every option. |
3803 | the absence of autoconf is documented for every option. |
|
|
3804 | |
|
|
3805 | Symbols marked with "(h)" do not change the ABI, and can have different |
|
|
3806 | values when compiling libev vs. including F<ev.h>, so it is permissible |
|
|
3807 | to redefine them before including F<ev.h> without breaking compatibility |
|
|
3808 | to a compiled library. All other symbols change the ABI, which means all |
|
|
3809 | users of libev and the libev code itself must be compiled with compatible |
|
|
3810 | settings. |
3624 | |
3811 | |
3625 | =over 4 |
3812 | =over 4 |
3626 | |
3813 | |
|
|
3814 | =item EV_COMPAT3 (h) |
|
|
3815 | |
|
|
3816 | Backwards compatibility is a major concern for libev. This is why this |
|
|
3817 | release of libev comes with wrappers for the functions and symbols that |
|
|
3818 | have been renamed between libev version 3 and 4. |
|
|
3819 | |
|
|
3820 | You can disable these wrappers (to test compatibility with future |
|
|
3821 | versions) by defining C<EV_COMPAT3> to C<0> when compiling your |
|
|
3822 | sources. This has the additional advantage that you can drop the C<struct> |
|
|
3823 | from C<struct ev_loop> declarations, as libev will provide an C<ev_loop> |
|
|
3824 | typedef in that case. |
|
|
3825 | |
|
|
3826 | In some future version, the default for C<EV_COMPAT3> will become C<0>, |
|
|
3827 | and in some even more future version the compatibility code will be |
|
|
3828 | removed completely. |
|
|
3829 | |
3627 | =item EV_STANDALONE |
3830 | =item EV_STANDALONE (h) |
3628 | |
3831 | |
3629 | Must always be C<1> if you do not use autoconf configuration, which |
3832 | Must always be C<1> if you do not use autoconf configuration, which |
3630 | keeps libev from including F<config.h>, and it also defines dummy |
3833 | keeps libev from including F<config.h>, and it also defines dummy |
3631 | implementations for some libevent functions (such as logging, which is not |
3834 | implementations for some libevent functions (such as logging, which is not |
3632 | supported). It will also not define any of the structs usually found in |
3835 | supported). It will also not define any of the structs usually found in |
… | |
… | |
3782 | as well as for signal and thread safety in C<ev_async> watchers. |
3985 | as well as for signal and thread safety in C<ev_async> watchers. |
3783 | |
3986 | |
3784 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
3987 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
3785 | (from F<signal.h>), which is usually good enough on most platforms. |
3988 | (from F<signal.h>), which is usually good enough on most platforms. |
3786 | |
3989 | |
3787 | =item EV_H |
3990 | =item EV_H (h) |
3788 | |
3991 | |
3789 | The name of the F<ev.h> header file used to include it. The default if |
3992 | The name of the F<ev.h> header file used to include it. The default if |
3790 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
3993 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
3791 | used to virtually rename the F<ev.h> header file in case of conflicts. |
3994 | used to virtually rename the F<ev.h> header file in case of conflicts. |
3792 | |
3995 | |
3793 | =item EV_CONFIG_H |
3996 | =item EV_CONFIG_H (h) |
3794 | |
3997 | |
3795 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
3998 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
3796 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
3999 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
3797 | C<EV_H>, above. |
4000 | C<EV_H>, above. |
3798 | |
4001 | |
3799 | =item EV_EVENT_H |
4002 | =item EV_EVENT_H (h) |
3800 | |
4003 | |
3801 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
4004 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
3802 | of how the F<event.h> header can be found, the default is C<"event.h">. |
4005 | of how the F<event.h> header can be found, the default is C<"event.h">. |
3803 | |
4006 | |
3804 | =item EV_PROTOTYPES |
4007 | =item EV_PROTOTYPES (h) |
3805 | |
4008 | |
3806 | If defined to be C<0>, then F<ev.h> will not define any function |
4009 | If defined to be C<0>, then F<ev.h> will not define any function |
3807 | prototypes, but still define all the structs and other symbols. This is |
4010 | prototypes, but still define all the structs and other symbols. This is |
3808 | occasionally useful if you want to provide your own wrapper functions |
4011 | occasionally useful if you want to provide your own wrapper functions |
3809 | around libev functions. |
4012 | around libev functions. |
… | |
… | |
3831 | fine. |
4034 | fine. |
3832 | |
4035 | |
3833 | If your embedding application does not need any priorities, defining these |
4036 | If your embedding application does not need any priorities, defining these |
3834 | both to C<0> will save some memory and CPU. |
4037 | both to C<0> will save some memory and CPU. |
3835 | |
4038 | |
3836 | =item EV_PERIODIC_ENABLE |
4039 | =item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, |
|
|
4040 | EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, |
|
|
4041 | EV_ASYNC_ENABLE, EV_CHILD_ENABLE. |
3837 | |
4042 | |
3838 | If undefined or defined to be C<1>, then periodic timers are supported. If |
4043 | If undefined or defined to be C<1> (and the platform supports it), then |
3839 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
4044 | the respective watcher type is supported. If defined to be C<0>, then it |
3840 | code. |
4045 | is not. Disabling watcher types mainly saves code size. |
3841 | |
4046 | |
3842 | =item EV_IDLE_ENABLE |
4047 | =item EV_FEATURES |
3843 | |
|
|
3844 | If undefined or defined to be C<1>, then idle watchers are supported. If |
|
|
3845 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
|
|
3846 | code. |
|
|
3847 | |
|
|
3848 | =item EV_EMBED_ENABLE |
|
|
3849 | |
|
|
3850 | If undefined or defined to be C<1>, then embed watchers are supported. If |
|
|
3851 | defined to be C<0>, then they are not. Embed watchers rely on most other |
|
|
3852 | watcher types, which therefore must not be disabled. |
|
|
3853 | |
|
|
3854 | =item EV_STAT_ENABLE |
|
|
3855 | |
|
|
3856 | If undefined or defined to be C<1>, then stat watchers are supported. If |
|
|
3857 | defined to be C<0>, then they are not. |
|
|
3858 | |
|
|
3859 | =item EV_FORK_ENABLE |
|
|
3860 | |
|
|
3861 | If undefined or defined to be C<1>, then fork watchers are supported. If |
|
|
3862 | defined to be C<0>, then they are not. |
|
|
3863 | |
|
|
3864 | =item EV_ASYNC_ENABLE |
|
|
3865 | |
|
|
3866 | If undefined or defined to be C<1>, then async watchers are supported. If |
|
|
3867 | defined to be C<0>, then they are not. |
|
|
3868 | |
|
|
3869 | =item EV_MINIMAL |
|
|
3870 | |
4048 | |
3871 | If you need to shave off some kilobytes of code at the expense of some |
4049 | If you need to shave off some kilobytes of code at the expense of some |
3872 | speed (but with the full API), define this symbol to C<1>. Currently this |
4050 | speed (but with the full API), you can define this symbol to request |
3873 | is used to override some inlining decisions, saves roughly 30% code size |
4051 | certain subsets of functionality. The default is to enable all features |
3874 | on amd64. It also selects a much smaller 2-heap for timer management over |
4052 | that can be enabled on the platform. |
3875 | the default 4-heap. |
|
|
3876 | |
4053 | |
3877 | You can save even more by disabling watcher types you do not need |
4054 | A typical way to use this symbol is to define it to C<0> (or to a bitset |
3878 | and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert> |
4055 | with some broad features you want) and then selectively re-enable |
3879 | (C<-DNDEBUG>) will usually reduce code size a lot. |
4056 | additional parts you want, for example if you want everything minimal, |
|
|
4057 | but multiple event loop support, async and child watchers and the poll |
|
|
4058 | backend, use this: |
3880 | |
4059 | |
3881 | Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to |
4060 | #define EV_FEATURES 0 |
3882 | provide a bare-bones event library. See C<ev.h> for details on what parts |
4061 | #define EV_MULTIPLICITY 1 |
3883 | of the API are still available, and do not complain if this subset changes |
4062 | #define EV_USE_POLL 1 |
3884 | over time. |
4063 | #define EV_CHILD_ENABLE 1 |
|
|
4064 | #define EV_ASYNC_ENABLE 1 |
|
|
4065 | |
|
|
4066 | The actual value is a bitset, it can be a combination of the following |
|
|
4067 | values: |
|
|
4068 | |
|
|
4069 | =over 4 |
|
|
4070 | |
|
|
4071 | =item C<1> - faster/larger code |
|
|
4072 | |
|
|
4073 | Use larger code to speed up some operations. |
|
|
4074 | |
|
|
4075 | Currently this is used to override some inlining decisions (enlarging the |
|
|
4076 | code size by roughly 30% on amd64). |
|
|
4077 | |
|
|
4078 | When optimising for size, use of compiler flags such as C<-Os> with |
|
|
4079 | gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of |
|
|
4080 | assertions. |
|
|
4081 | |
|
|
4082 | =item C<2> - faster/larger data structures |
|
|
4083 | |
|
|
4084 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
|
|
4085 | hash table sizes and so on. This will usually further increase code size |
|
|
4086 | and can additionally have an effect on the size of data structures at |
|
|
4087 | runtime. |
|
|
4088 | |
|
|
4089 | =item C<4> - full API configuration |
|
|
4090 | |
|
|
4091 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
|
|
4092 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
|
|
4093 | |
|
|
4094 | =item C<8> - full API |
|
|
4095 | |
|
|
4096 | This enables a lot of the "lesser used" API functions. See C<ev.h> for |
|
|
4097 | details on which parts of the API are still available without this |
|
|
4098 | feature, and do not complain if this subset changes over time. |
|
|
4099 | |
|
|
4100 | =item C<16> - enable all optional watcher types |
|
|
4101 | |
|
|
4102 | Enables all optional watcher types. If you want to selectively enable |
|
|
4103 | only some watcher types other than I/O and timers (e.g. prepare, |
|
|
4104 | embed, async, child...) you can enable them manually by defining |
|
|
4105 | C<EV_watchertype_ENABLE> to C<1> instead. |
|
|
4106 | |
|
|
4107 | =item C<32> - enable all backends |
|
|
4108 | |
|
|
4109 | This enables all backends - without this feature, you need to enable at |
|
|
4110 | least one backend manually (C<EV_USE_SELECT> is a good choice). |
|
|
4111 | |
|
|
4112 | =item C<64> - enable OS-specific "helper" APIs |
|
|
4113 | |
|
|
4114 | Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by |
|
|
4115 | default. |
|
|
4116 | |
|
|
4117 | =back |
|
|
4118 | |
|
|
4119 | Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0> |
|
|
4120 | reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb |
|
|
4121 | code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O |
|
|
4122 | watchers, timers and monotonic clock support. |
|
|
4123 | |
|
|
4124 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
|
|
4125 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
|
|
4126 | your program might be left out as well - a binary starting a timer and an |
|
|
4127 | I/O watcher then might come out at only 5Kb. |
|
|
4128 | |
|
|
4129 | =item EV_AVOID_STDIO |
|
|
4130 | |
|
|
4131 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
|
|
4132 | functions (printf, scanf, perror etc.). This will increase the code size |
|
|
4133 | somewhat, but if your program doesn't otherwise depend on stdio and your |
|
|
4134 | libc allows it, this avoids linking in the stdio library which is quite |
|
|
4135 | big. |
|
|
4136 | |
|
|
4137 | Note that error messages might become less precise when this option is |
|
|
4138 | enabled. |
3885 | |
4139 | |
3886 | =item EV_NSIG |
4140 | =item EV_NSIG |
3887 | |
4141 | |
3888 | The highest supported signal number, +1 (or, the number of |
4142 | The highest supported signal number, +1 (or, the number of |
3889 | signals): Normally, libev tries to deduce the maximum number of signals |
4143 | signals): Normally, libev tries to deduce the maximum number of signals |
3890 | automatically, but sometimes this fails, in which case it can be |
4144 | automatically, but sometimes this fails, in which case it can be |
3891 | specified. Also, using a lower number than detected (C<32> should be |
4145 | specified. Also, using a lower number than detected (C<32> should be |
3892 | good for about any system in existance) can save some memory, as libev |
4146 | good for about any system in existence) can save some memory, as libev |
3893 | statically allocates some 12-24 bytes per signal number. |
4147 | statically allocates some 12-24 bytes per signal number. |
3894 | |
4148 | |
3895 | =item EV_PID_HASHSIZE |
4149 | =item EV_PID_HASHSIZE |
3896 | |
4150 | |
3897 | C<ev_child> watchers use a small hash table to distribute workload by |
4151 | C<ev_child> watchers use a small hash table to distribute workload by |
3898 | pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more |
4152 | pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled), |
3899 | than enough. If you need to manage thousands of children you might want to |
4153 | usually more than enough. If you need to manage thousands of children you |
3900 | increase this value (I<must> be a power of two). |
4154 | might want to increase this value (I<must> be a power of two). |
3901 | |
4155 | |
3902 | =item EV_INOTIFY_HASHSIZE |
4156 | =item EV_INOTIFY_HASHSIZE |
3903 | |
4157 | |
3904 | C<ev_stat> watchers use a small hash table to distribute workload by |
4158 | C<ev_stat> watchers use a small hash table to distribute workload by |
3905 | inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), |
4159 | inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES> |
3906 | usually more than enough. If you need to manage thousands of C<ev_stat> |
4160 | disabled), usually more than enough. If you need to manage thousands of |
3907 | watchers you might want to increase this value (I<must> be a power of |
4161 | C<ev_stat> watchers you might want to increase this value (I<must> be a |
3908 | two). |
4162 | power of two). |
3909 | |
4163 | |
3910 | =item EV_USE_4HEAP |
4164 | =item EV_USE_4HEAP |
3911 | |
4165 | |
3912 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
4166 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3913 | timer and periodics heaps, libev uses a 4-heap when this symbol is defined |
4167 | timer and periodics heaps, libev uses a 4-heap when this symbol is defined |
3914 | to C<1>. The 4-heap uses more complicated (longer) code but has noticeably |
4168 | to C<1>. The 4-heap uses more complicated (longer) code but has noticeably |
3915 | faster performance with many (thousands) of watchers. |
4169 | faster performance with many (thousands) of watchers. |
3916 | |
4170 | |
3917 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
4171 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
3918 | (disabled). |
4172 | will be C<0>. |
3919 | |
4173 | |
3920 | =item EV_HEAP_CACHE_AT |
4174 | =item EV_HEAP_CACHE_AT |
3921 | |
4175 | |
3922 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
4176 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3923 | timer and periodics heaps, libev can cache the timestamp (I<at>) within |
4177 | timer and periodics heaps, libev can cache the timestamp (I<at>) within |
3924 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
4178 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
3925 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
4179 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
3926 | but avoids random read accesses on heap changes. This improves performance |
4180 | but avoids random read accesses on heap changes. This improves performance |
3927 | noticeably with many (hundreds) of watchers. |
4181 | noticeably with many (hundreds) of watchers. |
3928 | |
4182 | |
3929 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
4183 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
3930 | (disabled). |
4184 | will be C<0>. |
3931 | |
4185 | |
3932 | =item EV_VERIFY |
4186 | =item EV_VERIFY |
3933 | |
4187 | |
3934 | Controls how much internal verification (see C<ev_loop_verify ()>) will |
4188 | Controls how much internal verification (see C<ev_verify ()>) will |
3935 | be done: If set to C<0>, no internal verification code will be compiled |
4189 | be done: If set to C<0>, no internal verification code will be compiled |
3936 | in. If set to C<1>, then verification code will be compiled in, but not |
4190 | in. If set to C<1>, then verification code will be compiled in, but not |
3937 | called. If set to C<2>, then the internal verification code will be |
4191 | called. If set to C<2>, then the internal verification code will be |
3938 | called once per loop, which can slow down libev. If set to C<3>, then the |
4192 | called once per loop, which can slow down libev. If set to C<3>, then the |
3939 | verification code will be called very frequently, which will slow down |
4193 | verification code will be called very frequently, which will slow down |
3940 | libev considerably. |
4194 | libev considerably. |
3941 | |
4195 | |
3942 | The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be |
4196 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
3943 | C<0>. |
4197 | will be C<0>. |
3944 | |
4198 | |
3945 | =item EV_COMMON |
4199 | =item EV_COMMON |
3946 | |
4200 | |
3947 | By default, all watchers have a C<void *data> member. By redefining |
4201 | By default, all watchers have a C<void *data> member. By redefining |
3948 | this macro to a something else you can include more and other types of |
4202 | this macro to something else you can include more and other types of |
3949 | members. You have to define it each time you include one of the files, |
4203 | members. You have to define it each time you include one of the files, |
3950 | though, and it must be identical each time. |
4204 | though, and it must be identical each time. |
3951 | |
4205 | |
3952 | For example, the perl EV module uses something like this: |
4206 | For example, the perl EV module uses something like this: |
3953 | |
4207 | |
… | |
… | |
4006 | file. |
4260 | file. |
4007 | |
4261 | |
4008 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
4262 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
4009 | that everybody includes and which overrides some configure choices: |
4263 | that everybody includes and which overrides some configure choices: |
4010 | |
4264 | |
4011 | #define EV_MINIMAL 1 |
4265 | #define EV_FEATURES 8 |
4012 | #define EV_USE_POLL 0 |
4266 | #define EV_USE_SELECT 1 |
4013 | #define EV_MULTIPLICITY 0 |
|
|
4014 | #define EV_PERIODIC_ENABLE 0 |
4267 | #define EV_PREPARE_ENABLE 1 |
|
|
4268 | #define EV_IDLE_ENABLE 1 |
4015 | #define EV_STAT_ENABLE 0 |
4269 | #define EV_SIGNAL_ENABLE 1 |
4016 | #define EV_FORK_ENABLE 0 |
4270 | #define EV_CHILD_ENABLE 1 |
|
|
4271 | #define EV_USE_STDEXCEPT 0 |
4017 | #define EV_CONFIG_H <config.h> |
4272 | #define EV_CONFIG_H <config.h> |
4018 | #define EV_MINPRI 0 |
|
|
4019 | #define EV_MAXPRI 0 |
|
|
4020 | |
4273 | |
4021 | #include "ev++.h" |
4274 | #include "ev++.h" |
4022 | |
4275 | |
4023 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
4276 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
4024 | |
4277 | |
… | |
… | |
4155 | userdata *u = ev_userdata (EV_A); |
4408 | userdata *u = ev_userdata (EV_A); |
4156 | pthread_mutex_lock (&u->lock); |
4409 | pthread_mutex_lock (&u->lock); |
4157 | } |
4410 | } |
4158 | |
4411 | |
4159 | The event loop thread first acquires the mutex, and then jumps straight |
4412 | The event loop thread first acquires the mutex, and then jumps straight |
4160 | into C<ev_loop>: |
4413 | into C<ev_run>: |
4161 | |
4414 | |
4162 | void * |
4415 | void * |
4163 | l_run (void *thr_arg) |
4416 | l_run (void *thr_arg) |
4164 | { |
4417 | { |
4165 | struct ev_loop *loop = (struct ev_loop *)thr_arg; |
4418 | struct ev_loop *loop = (struct ev_loop *)thr_arg; |
4166 | |
4419 | |
4167 | l_acquire (EV_A); |
4420 | l_acquire (EV_A); |
4168 | pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0); |
4421 | pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0); |
4169 | ev_loop (EV_A_ 0); |
4422 | ev_run (EV_A_ 0); |
4170 | l_release (EV_A); |
4423 | l_release (EV_A); |
4171 | |
4424 | |
4172 | return 0; |
4425 | return 0; |
4173 | } |
4426 | } |
4174 | |
4427 | |
… | |
… | |
4226 | |
4479 | |
4227 | =head3 COROUTINES |
4480 | =head3 COROUTINES |
4228 | |
4481 | |
4229 | Libev is very accommodating to coroutines ("cooperative threads"): |
4482 | Libev is very accommodating to coroutines ("cooperative threads"): |
4230 | libev fully supports nesting calls to its functions from different |
4483 | libev fully supports nesting calls to its functions from different |
4231 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
4484 | coroutines (e.g. you can call C<ev_run> on the same loop from two |
4232 | different coroutines, and switch freely between both coroutines running |
4485 | different coroutines, and switch freely between both coroutines running |
4233 | the loop, as long as you don't confuse yourself). The only exception is |
4486 | the loop, as long as you don't confuse yourself). The only exception is |
4234 | that you must not do this from C<ev_periodic> reschedule callbacks. |
4487 | that you must not do this from C<ev_periodic> reschedule callbacks. |
4235 | |
4488 | |
4236 | Care has been taken to ensure that libev does not keep local state inside |
4489 | Care has been taken to ensure that libev does not keep local state inside |
4237 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
4490 | C<ev_run>, and other calls do not usually allow for coroutine switches as |
4238 | they do not call any callbacks. |
4491 | they do not call any callbacks. |
4239 | |
4492 | |
4240 | =head2 COMPILER WARNINGS |
4493 | =head2 COMPILER WARNINGS |
4241 | |
4494 | |
4242 | Depending on your compiler and compiler settings, you might get no or a |
4495 | Depending on your compiler and compiler settings, you might get no or a |
… | |
… | |
4253 | maintainable. |
4506 | maintainable. |
4254 | |
4507 | |
4255 | And of course, some compiler warnings are just plain stupid, or simply |
4508 | And of course, some compiler warnings are just plain stupid, or simply |
4256 | wrong (because they don't actually warn about the condition their message |
4509 | wrong (because they don't actually warn about the condition their message |
4257 | seems to warn about). For example, certain older gcc versions had some |
4510 | seems to warn about). For example, certain older gcc versions had some |
4258 | warnings that resulted an extreme number of false positives. These have |
4511 | warnings that resulted in an extreme number of false positives. These have |
4259 | been fixed, but some people still insist on making code warn-free with |
4512 | been fixed, but some people still insist on making code warn-free with |
4260 | such buggy versions. |
4513 | such buggy versions. |
4261 | |
4514 | |
4262 | While libev is written to generate as few warnings as possible, |
4515 | While libev is written to generate as few warnings as possible, |
4263 | "warn-free" code is not a goal, and it is recommended not to build libev |
4516 | "warn-free" code is not a goal, and it is recommended not to build libev |
… | |
… | |
4299 | I suggest using suppression lists. |
4552 | I suggest using suppression lists. |
4300 | |
4553 | |
4301 | |
4554 | |
4302 | =head1 PORTABILITY NOTES |
4555 | =head1 PORTABILITY NOTES |
4303 | |
4556 | |
|
|
4557 | =head2 GNU/LINUX 32 BIT LIMITATIONS |
|
|
4558 | |
|
|
4559 | GNU/Linux is the only common platform that supports 64 bit file/large file |
|
|
4560 | interfaces but I<disables> them by default. |
|
|
4561 | |
|
|
4562 | That means that libev compiled in the default environment doesn't support |
|
|
4563 | files larger than 2GiB or so, which mainly affects C<ev_stat> watchers. |
|
|
4564 | |
|
|
4565 | Unfortunately, many programs try to work around this GNU/Linux issue |
|
|
4566 | by enabling the large file API, which makes them incompatible with the |
|
|
4567 | standard libev compiled for their system. |
|
|
4568 | |
|
|
4569 | Likewise, libev cannot enable the large file API itself as this would |
|
|
4570 | suddenly make it incompatible to the default compile time environment, |
|
|
4571 | i.e. all programs not using special compile switches. |
|
|
4572 | |
|
|
4573 | =head2 OS/X AND DARWIN BUGS |
|
|
4574 | |
|
|
4575 | The whole thing is a bug if you ask me - basically any system interface |
|
|
4576 | you touch is broken, whether it is locales, poll, kqueue or even the |
|
|
4577 | OpenGL drivers. |
|
|
4578 | |
|
|
4579 | =head3 C<kqueue> is buggy |
|
|
4580 | |
|
|
4581 | The kqueue syscall is broken in all known versions - most versions support |
|
|
4582 | only sockets, many support pipes. |
|
|
4583 | |
|
|
4584 | Libev tries to work around this by not using C<kqueue> by default on this |
|
|
4585 | rotten platform, but of course you can still ask for it when creating a |
|
|
4586 | loop - embedding a socket-only kqueue loop into a select-based one is |
|
|
4587 | probably going to work well. |
|
|
4588 | |
|
|
4589 | =head3 C<poll> is buggy |
|
|
4590 | |
|
|
4591 | Instead of fixing C<kqueue>, Apple replaced their (working) C<poll> |
|
|
4592 | implementation by something calling C<kqueue> internally around the 10.5.6 |
|
|
4593 | release, so now C<kqueue> I<and> C<poll> are broken. |
|
|
4594 | |
|
|
4595 | Libev tries to work around this by not using C<poll> by default on |
|
|
4596 | this rotten platform, but of course you can still ask for it when creating |
|
|
4597 | a loop. |
|
|
4598 | |
|
|
4599 | =head3 C<select> is buggy |
|
|
4600 | |
|
|
4601 | All that's left is C<select>, and of course Apple found a way to fuck this |
|
|
4602 | one up as well: On OS/X, C<select> actively limits the number of file |
|
|
4603 | descriptors you can pass in to 1024 - your program suddenly crashes when |
|
|
4604 | you use more. |
|
|
4605 | |
|
|
4606 | There is an undocumented "workaround" for this - defining |
|
|
4607 | C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should> |
|
|
4608 | work on OS/X. |
|
|
4609 | |
|
|
4610 | =head2 SOLARIS PROBLEMS AND WORKAROUNDS |
|
|
4611 | |
|
|
4612 | =head3 C<errno> reentrancy |
|
|
4613 | |
|
|
4614 | The default compile environment on Solaris is unfortunately so |
|
|
4615 | thread-unsafe that you can't even use components/libraries compiled |
|
|
4616 | without C<-D_REENTRANT> in a threaded program, which, of course, isn't |
|
|
4617 | defined by default. A valid, if stupid, implementation choice. |
|
|
4618 | |
|
|
4619 | If you want to use libev in threaded environments you have to make sure |
|
|
4620 | it's compiled with C<_REENTRANT> defined. |
|
|
4621 | |
|
|
4622 | =head3 Event port backend |
|
|
4623 | |
|
|
4624 | The scalable event interface for Solaris is called "event |
|
|
4625 | ports". Unfortunately, this mechanism is very buggy in all major |
|
|
4626 | releases. If you run into high CPU usage, your program freezes or you get |
|
|
4627 | a large number of spurious wakeups, make sure you have all the relevant |
|
|
4628 | and latest kernel patches applied. No, I don't know which ones, but there |
|
|
4629 | are multiple ones to apply, and afterwards, event ports actually work |
|
|
4630 | great. |
|
|
4631 | |
|
|
4632 | If you can't get it to work, you can try running the program by setting |
|
|
4633 | the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and |
|
|
4634 | C<select> backends. |
|
|
4635 | |
|
|
4636 | =head2 AIX POLL BUG |
|
|
4637 | |
|
|
4638 | AIX unfortunately has a broken C<poll.h> header. Libev works around |
|
|
4639 | this by trying to avoid the poll backend altogether (i.e. it's not even |
|
|
4640 | compiled in), which normally isn't a big problem as C<select> works fine |
|
|
4641 | with large bitsets on AIX, and AIX is dead anyway. |
|
|
4642 | |
4304 | =head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS |
4643 | =head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS |
|
|
4644 | |
|
|
4645 | =head3 General issues |
4305 | |
4646 | |
4306 | Win32 doesn't support any of the standards (e.g. POSIX) that libev |
4647 | Win32 doesn't support any of the standards (e.g. POSIX) that libev |
4307 | requires, and its I/O model is fundamentally incompatible with the POSIX |
4648 | requires, and its I/O model is fundamentally incompatible with the POSIX |
4308 | model. Libev still offers limited functionality on this platform in |
4649 | model. Libev still offers limited functionality on this platform in |
4309 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
4650 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
4310 | descriptors. This only applies when using Win32 natively, not when using |
4651 | descriptors. This only applies when using Win32 natively, not when using |
4311 | e.g. cygwin. |
4652 | e.g. cygwin. Actually, it only applies to the microsofts own compilers, |
|
|
4653 | as every compielr comes with a slightly differently broken/incompatible |
|
|
4654 | environment. |
4312 | |
4655 | |
4313 | Lifting these limitations would basically require the full |
4656 | Lifting these limitations would basically require the full |
4314 | re-implementation of the I/O system. If you are into these kinds of |
4657 | re-implementation of the I/O system. If you are into this kind of thing, |
4315 | things, then note that glib does exactly that for you in a very portable |
4658 | then note that glib does exactly that for you in a very portable way (note |
4316 | way (note also that glib is the slowest event library known to man). |
4659 | also that glib is the slowest event library known to man). |
4317 | |
4660 | |
4318 | There is no supported compilation method available on windows except |
4661 | There is no supported compilation method available on windows except |
4319 | embedding it into other applications. |
4662 | embedding it into other applications. |
4320 | |
4663 | |
4321 | Sensible signal handling is officially unsupported by Microsoft - libev |
4664 | Sensible signal handling is officially unsupported by Microsoft - libev |
… | |
… | |
4349 | you do I<not> compile the F<ev.c> or any other embedded source files!): |
4692 | you do I<not> compile the F<ev.c> or any other embedded source files!): |
4350 | |
4693 | |
4351 | #include "evwrap.h" |
4694 | #include "evwrap.h" |
4352 | #include "ev.c" |
4695 | #include "ev.c" |
4353 | |
4696 | |
4354 | =over 4 |
|
|
4355 | |
|
|
4356 | =item The winsocket select function |
4697 | =head3 The winsocket C<select> function |
4357 | |
4698 | |
4358 | The winsocket C<select> function doesn't follow POSIX in that it |
4699 | The winsocket C<select> function doesn't follow POSIX in that it |
4359 | requires socket I<handles> and not socket I<file descriptors> (it is |
4700 | requires socket I<handles> and not socket I<file descriptors> (it is |
4360 | also extremely buggy). This makes select very inefficient, and also |
4701 | also extremely buggy). This makes select very inefficient, and also |
4361 | requires a mapping from file descriptors to socket handles (the Microsoft |
4702 | requires a mapping from file descriptors to socket handles (the Microsoft |
… | |
… | |
4370 | #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ |
4711 | #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ |
4371 | |
4712 | |
4372 | Note that winsockets handling of fd sets is O(n), so you can easily get a |
4713 | Note that winsockets handling of fd sets is O(n), so you can easily get a |
4373 | complexity in the O(n²) range when using win32. |
4714 | complexity in the O(n²) range when using win32. |
4374 | |
4715 | |
4375 | =item Limited number of file descriptors |
4716 | =head3 Limited number of file descriptors |
4376 | |
4717 | |
4377 | Windows has numerous arbitrary (and low) limits on things. |
4718 | Windows has numerous arbitrary (and low) limits on things. |
4378 | |
4719 | |
4379 | Early versions of winsocket's select only supported waiting for a maximum |
4720 | Early versions of winsocket's select only supported waiting for a maximum |
4380 | of C<64> handles (probably owning to the fact that all windows kernels |
4721 | of C<64> handles (probably owning to the fact that all windows kernels |
… | |
… | |
4395 | runtime libraries. This might get you to about C<512> or C<2048> sockets |
4736 | runtime libraries. This might get you to about C<512> or C<2048> sockets |
4396 | (depending on windows version and/or the phase of the moon). To get more, |
4737 | (depending on windows version and/or the phase of the moon). To get more, |
4397 | you need to wrap all I/O functions and provide your own fd management, but |
4738 | you need to wrap all I/O functions and provide your own fd management, but |
4398 | the cost of calling select (O(n²)) will likely make this unworkable. |
4739 | the cost of calling select (O(n²)) will likely make this unworkable. |
4399 | |
4740 | |
4400 | =back |
|
|
4401 | |
|
|
4402 | =head2 PORTABILITY REQUIREMENTS |
4741 | =head2 PORTABILITY REQUIREMENTS |
4403 | |
4742 | |
4404 | In addition to a working ISO-C implementation and of course the |
4743 | In addition to a working ISO-C implementation and of course the |
4405 | backend-specific APIs, libev relies on a few additional extensions: |
4744 | backend-specific APIs, libev relies on a few additional extensions: |
4406 | |
4745 | |
… | |
… | |
4444 | watchers. |
4783 | watchers. |
4445 | |
4784 | |
4446 | =item C<double> must hold a time value in seconds with enough accuracy |
4785 | =item C<double> must hold a time value in seconds with enough accuracy |
4447 | |
4786 | |
4448 | The type C<double> is used to represent timestamps. It is required to |
4787 | The type C<double> is used to represent timestamps. It is required to |
4449 | have at least 51 bits of mantissa (and 9 bits of exponent), which is good |
4788 | have at least 51 bits of mantissa (and 9 bits of exponent), which is |
4450 | enough for at least into the year 4000. This requirement is fulfilled by |
4789 | good enough for at least into the year 4000 with millisecond accuracy |
|
|
4790 | (the design goal for libev). This requirement is overfulfilled by |
4451 | implementations implementing IEEE 754, which is basically all existing |
4791 | implementations using IEEE 754, which is basically all existing ones. With |
4452 | ones. With IEEE 754 doubles, you get microsecond accuracy until at least |
4792 | IEEE 754 doubles, you get microsecond accuracy until at least 2200. |
4453 | 2200. |
|
|
4454 | |
4793 | |
4455 | =back |
4794 | =back |
4456 | |
4795 | |
4457 | If you know of other additional requirements drop me a note. |
4796 | If you know of other additional requirements drop me a note. |
4458 | |
4797 | |
… | |
… | |
4526 | involves iterating over all running async watchers or all signal numbers. |
4865 | involves iterating over all running async watchers or all signal numbers. |
4527 | |
4866 | |
4528 | =back |
4867 | =back |
4529 | |
4868 | |
4530 | |
4869 | |
|
|
4870 | =head1 PORTING FROM LIBEV 3.X TO 4.X |
|
|
4871 | |
|
|
4872 | The major version 4 introduced some minor incompatible changes to the API. |
|
|
4873 | |
|
|
4874 | At the moment, the C<ev.h> header file tries to implement superficial |
|
|
4875 | compatibility, so most programs should still compile. Those might be |
|
|
4876 | removed in later versions of libev, so better update early than late. |
|
|
4877 | |
|
|
4878 | =over 4 |
|
|
4879 | |
|
|
4880 | =item C<ev_default_destroy> and C<ev_default_fork> have been removed |
|
|
4881 | |
|
|
4882 | These calls can be replaced easily by their C<ev_loop_xxx> counterparts: |
|
|
4883 | |
|
|
4884 | ev_loop_destroy (EV_DEFAULT_UC); |
|
|
4885 | ev_loop_fork (EV_DEFAULT); |
|
|
4886 | |
|
|
4887 | =item function/symbol renames |
|
|
4888 | |
|
|
4889 | A number of functions and symbols have been renamed: |
|
|
4890 | |
|
|
4891 | ev_loop => ev_run |
|
|
4892 | EVLOOP_NONBLOCK => EVRUN_NOWAIT |
|
|
4893 | EVLOOP_ONESHOT => EVRUN_ONCE |
|
|
4894 | |
|
|
4895 | ev_unloop => ev_break |
|
|
4896 | EVUNLOOP_CANCEL => EVBREAK_CANCEL |
|
|
4897 | EVUNLOOP_ONE => EVBREAK_ONE |
|
|
4898 | EVUNLOOP_ALL => EVBREAK_ALL |
|
|
4899 | |
|
|
4900 | EV_TIMEOUT => EV_TIMER |
|
|
4901 | |
|
|
4902 | ev_loop_count => ev_iteration |
|
|
4903 | ev_loop_depth => ev_depth |
|
|
4904 | ev_loop_verify => ev_verify |
|
|
4905 | |
|
|
4906 | Most functions working on C<struct ev_loop> objects don't have an |
|
|
4907 | C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and |
|
|
4908 | associated constants have been renamed to not collide with the C<struct |
|
|
4909 | ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme |
|
|
4910 | as all other watcher types. Note that C<ev_loop_fork> is still called |
|
|
4911 | C<ev_loop_fork> because it would otherwise clash with the C<ev_fork> |
|
|
4912 | typedef. |
|
|
4913 | |
|
|
4914 | =item C<EV_COMPAT3> backwards compatibility mechanism |
|
|
4915 | |
|
|
4916 | The backward compatibility mechanism can be controlled by |
|
|
4917 | C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> |
|
|
4918 | section. |
|
|
4919 | |
|
|
4920 | =item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES> |
|
|
4921 | |
|
|
4922 | The preprocessor symbol C<EV_MINIMAL> has been replaced by a different |
|
|
4923 | mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile |
|
|
4924 | and work, but the library code will of course be larger. |
|
|
4925 | |
|
|
4926 | =back |
|
|
4927 | |
|
|
4928 | |
4531 | =head1 GLOSSARY |
4929 | =head1 GLOSSARY |
4532 | |
4930 | |
4533 | =over 4 |
4931 | =over 4 |
4534 | |
4932 | |
4535 | =item active |
4933 | =item active |
4536 | |
4934 | |
4537 | A watcher is active as long as it has been started (has been attached to |
4935 | A watcher is active as long as it has been started and not yet stopped. |
4538 | an event loop) but not yet stopped (disassociated from the event loop). |
4936 | See L<WATCHER STATES> for details. |
4539 | |
4937 | |
4540 | =item application |
4938 | =item application |
4541 | |
4939 | |
4542 | In this document, an application is whatever is using libev. |
4940 | In this document, an application is whatever is using libev. |
|
|
4941 | |
|
|
4942 | =item backend |
|
|
4943 | |
|
|
4944 | The part of the code dealing with the operating system interfaces. |
4543 | |
4945 | |
4544 | =item callback |
4946 | =item callback |
4545 | |
4947 | |
4546 | The address of a function that is called when some event has been |
4948 | The address of a function that is called when some event has been |
4547 | detected. Callbacks are being passed the event loop, the watcher that |
4949 | detected. Callbacks are being passed the event loop, the watcher that |
4548 | received the event, and the actual event bitset. |
4950 | received the event, and the actual event bitset. |
4549 | |
4951 | |
4550 | =item callback invocation |
4952 | =item callback/watcher invocation |
4551 | |
4953 | |
4552 | The act of calling the callback associated with a watcher. |
4954 | The act of calling the callback associated with a watcher. |
4553 | |
4955 | |
4554 | =item event |
4956 | =item event |
4555 | |
4957 | |
4556 | A change of state of some external event, such as data now being available |
4958 | A change of state of some external event, such as data now being available |
4557 | for reading on a file descriptor, time having passed or simply not having |
4959 | for reading on a file descriptor, time having passed or simply not having |
4558 | any other events happening anymore. |
4960 | any other events happening anymore. |
4559 | |
4961 | |
4560 | In libev, events are represented as single bits (such as C<EV_READ> or |
4962 | In libev, events are represented as single bits (such as C<EV_READ> or |
4561 | C<EV_TIMEOUT>). |
4963 | C<EV_TIMER>). |
4562 | |
4964 | |
4563 | =item event library |
4965 | =item event library |
4564 | |
4966 | |
4565 | A software package implementing an event model and loop. |
4967 | A software package implementing an event model and loop. |
4566 | |
4968 | |
… | |
… | |
4574 | The model used to describe how an event loop handles and processes |
4976 | The model used to describe how an event loop handles and processes |
4575 | watchers and events. |
4977 | watchers and events. |
4576 | |
4978 | |
4577 | =item pending |
4979 | =item pending |
4578 | |
4980 | |
4579 | A watcher is pending as soon as the corresponding event has been detected, |
4981 | A watcher is pending as soon as the corresponding event has been |
4580 | and stops being pending as soon as the watcher will be invoked or its |
4982 | detected. See L<WATCHER STATES> for details. |
4581 | pending status is explicitly cleared by the application. |
|
|
4582 | |
|
|
4583 | A watcher can be pending, but not active. Stopping a watcher also clears |
|
|
4584 | its pending status. |
|
|
4585 | |
4983 | |
4586 | =item real time |
4984 | =item real time |
4587 | |
4985 | |
4588 | The physical time that is observed. It is apparently strictly monotonic :) |
4986 | The physical time that is observed. It is apparently strictly monotonic :) |
4589 | |
4987 | |
… | |
… | |
4596 | =item watcher |
4994 | =item watcher |
4597 | |
4995 | |
4598 | A data structure that describes interest in certain events. Watchers need |
4996 | A data structure that describes interest in certain events. Watchers need |
4599 | to be started (attached to an event loop) before they can receive events. |
4997 | to be started (attached to an event loop) before they can receive events. |
4600 | |
4998 | |
4601 | =item watcher invocation |
|
|
4602 | |
|
|
4603 | The act of calling the callback associated with a watcher. |
|
|
4604 | |
|
|
4605 | =back |
4999 | =back |
4606 | |
5000 | |
4607 | =head1 AUTHOR |
5001 | =head1 AUTHOR |
4608 | |
5002 | |
4609 | Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. |
5003 | Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. |