… | |
… | |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | #include <ev.h> |
7 | #include <ev.h> |
8 | |
8 | |
9 | =head1 EXAMPLE PROGRAM |
9 | =head2 EXAMPLE PROGRAM |
10 | |
10 | |
11 | #include <ev.h> |
11 | #include <ev.h> |
12 | |
12 | |
13 | ev_io stdin_watcher; |
13 | ev_io stdin_watcher; |
14 | ev_timer timeout_watcher; |
14 | ev_timer timeout_watcher; |
… | |
… | |
53 | The newest version of this document is also available as a html-formatted |
53 | The newest version of this document is also available as a html-formatted |
54 | web page you might find easier to navigate when reading it for the first |
54 | web page you might find easier to navigate when reading it for the first |
55 | time: L<http://cvs.schmorp.de/libev/ev.html>. |
55 | time: L<http://cvs.schmorp.de/libev/ev.html>. |
56 | |
56 | |
57 | Libev is an event loop: you register interest in certain events (such as a |
57 | Libev is an event loop: you register interest in certain events (such as a |
58 | file descriptor being readable or a timeout occuring), and it will manage |
58 | file descriptor being readable or a timeout occurring), and it will manage |
59 | these event sources and provide your program with events. |
59 | these event sources and provide your program with events. |
60 | |
60 | |
61 | To do this, it must take more or less complete control over your process |
61 | To do this, it must take more or less complete control over your process |
62 | (or thread) by executing the I<event loop> handler, and will then |
62 | (or thread) by executing the I<event loop> handler, and will then |
63 | communicate events via a callback mechanism. |
63 | communicate events via a callback mechanism. |
… | |
… | |
65 | You register interest in certain events by registering so-called I<event |
65 | You register interest in certain events by registering so-called I<event |
66 | watchers>, which are relatively small C structures you initialise with the |
66 | watchers>, which are relatively small C structures you initialise with the |
67 | details of the event, and then hand it over to libev by I<starting> the |
67 | details of the event, and then hand it over to libev by I<starting> the |
68 | watcher. |
68 | watcher. |
69 | |
69 | |
70 | =head1 FEATURES |
70 | =head2 FEATURES |
71 | |
71 | |
72 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
72 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
73 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
73 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
74 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
74 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
75 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
75 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
… | |
… | |
82 | |
82 | |
83 | It also is quite fast (see this |
83 | It also is quite fast (see this |
84 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
84 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
85 | for example). |
85 | for example). |
86 | |
86 | |
87 | =head1 CONVENTIONS |
87 | =head2 CONVENTIONS |
88 | |
88 | |
89 | Libev is very configurable. In this manual the default configuration will |
89 | Libev is very configurable. In this manual the default configuration will |
90 | be described, which supports multiple event loops. For more info about |
90 | be described, which supports multiple event loops. For more info about |
91 | various configuration options please have a look at B<EMBED> section in |
91 | various configuration options please have a look at B<EMBED> section in |
92 | this manual. If libev was configured without support for multiple event |
92 | this manual. If libev was configured without support for multiple event |
93 | loops, then all functions taking an initial argument of name C<loop> |
93 | loops, then all functions taking an initial argument of name C<loop> |
94 | (which is always of type C<struct ev_loop *>) will not have this argument. |
94 | (which is always of type C<struct ev_loop *>) will not have this argument. |
95 | |
95 | |
96 | =head1 TIME REPRESENTATION |
96 | =head2 TIME REPRESENTATION |
97 | |
97 | |
98 | Libev represents time as a single floating point number, representing the |
98 | Libev represents time as a single floating point number, representing the |
99 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
99 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
100 | the beginning of 1970, details are complicated, don't ask). This type is |
100 | the beginning of 1970, details are complicated, don't ask). This type is |
101 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
101 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
102 | to the C<double> type in C, and when you need to do any calculations on |
102 | to the C<double> type in C, and when you need to do any calculations on |
103 | it, you should treat it as such. |
103 | it, you should treat it as some floatingpoint value. Unlike the name |
|
|
104 | component C<stamp> might indicate, it is also used for time differences |
|
|
105 | throughout libev. |
104 | |
106 | |
105 | =head1 GLOBAL FUNCTIONS |
107 | =head1 GLOBAL FUNCTIONS |
106 | |
108 | |
107 | These functions can be called anytime, even before initialising the |
109 | These functions can be called anytime, even before initialising the |
108 | library in any way. |
110 | library in any way. |
… | |
… | |
112 | =item ev_tstamp ev_time () |
114 | =item ev_tstamp ev_time () |
113 | |
115 | |
114 | Returns the current time as libev would use it. Please note that the |
116 | Returns the current time as libev would use it. Please note that the |
115 | C<ev_now> function is usually faster and also often returns the timestamp |
117 | C<ev_now> function is usually faster and also often returns the timestamp |
116 | you actually want to know. |
118 | you actually want to know. |
|
|
119 | |
|
|
120 | =item ev_sleep (ev_tstamp interval) |
|
|
121 | |
|
|
122 | Sleep for the given interval: The current thread will be blocked until |
|
|
123 | either it is interrupted or the given time interval has passed. Basically |
|
|
124 | this is a subsecond-resolution C<sleep ()>. |
117 | |
125 | |
118 | =item int ev_version_major () |
126 | =item int ev_version_major () |
119 | |
127 | |
120 | =item int ev_version_minor () |
128 | =item int ev_version_minor () |
121 | |
129 | |
… | |
… | |
298 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
306 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
299 | |
307 | |
300 | This is your standard select(2) backend. Not I<completely> standard, as |
308 | This is your standard select(2) backend. Not I<completely> standard, as |
301 | libev tries to roll its own fd_set with no limits on the number of fds, |
309 | libev tries to roll its own fd_set with no limits on the number of fds, |
302 | but if that fails, expect a fairly low limit on the number of fds when |
310 | but if that fails, expect a fairly low limit on the number of fds when |
303 | using this backend. It doesn't scale too well (O(highest_fd)), but its usually |
311 | using this backend. It doesn't scale too well (O(highest_fd)), but its |
304 | the fastest backend for a low number of fds. |
312 | usually the fastest backend for a low number of (low-numbered :) fds. |
|
|
313 | |
|
|
314 | To get good performance out of this backend you need a high amount of |
|
|
315 | parallelity (most of the file descriptors should be busy). If you are |
|
|
316 | writing a server, you should C<accept ()> in a loop to accept as many |
|
|
317 | connections as possible during one iteration. You might also want to have |
|
|
318 | a look at C<ev_set_io_collect_interval ()> to increase the amount of |
|
|
319 | readyness notifications you get per iteration. |
305 | |
320 | |
306 | =item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) |
321 | =item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) |
307 | |
322 | |
308 | And this is your standard poll(2) backend. It's more complicated than |
323 | And this is your standard poll(2) backend. It's more complicated |
309 | select, but handles sparse fds better and has no artificial limit on the |
324 | than select, but handles sparse fds better and has no artificial |
310 | number of fds you can use (except it will slow down considerably with a |
325 | limit on the number of fds you can use (except it will slow down |
311 | lot of inactive fds). It scales similarly to select, i.e. O(total_fds). |
326 | considerably with a lot of inactive fds). It scales similarly to select, |
|
|
327 | i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for |
|
|
328 | performance tips. |
312 | |
329 | |
313 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
330 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
314 | |
331 | |
315 | For few fds, this backend is a bit little slower than poll and select, |
332 | For few fds, this backend is a bit little slower than poll and select, |
316 | but it scales phenomenally better. While poll and select usually scale like |
333 | but it scales phenomenally better. While poll and select usually scale |
317 | O(total_fds) where n is the total number of fds (or the highest fd), epoll scales |
334 | like O(total_fds) where n is the total number of fds (or the highest fd), |
318 | either O(1) or O(active_fds). |
335 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
|
|
336 | of shortcomings, such as silently dropping events in some hard-to-detect |
|
|
337 | cases and rewiring a syscall per fd change, no fork support and bad |
|
|
338 | support for dup. |
319 | |
339 | |
320 | While stopping and starting an I/O watcher in the same iteration will |
340 | While stopping, setting and starting an I/O watcher in the same iteration |
321 | result in some caching, there is still a syscall per such incident |
341 | will result in some caching, there is still a syscall per such incident |
322 | (because the fd could point to a different file description now), so its |
342 | (because the fd could point to a different file description now), so its |
323 | best to avoid that. Also, dup()ed file descriptors might not work very |
343 | best to avoid that. Also, C<dup ()>'ed file descriptors might not work |
324 | well if you register events for both fds. |
344 | very well if you register events for both fds. |
325 | |
345 | |
326 | Please note that epoll sometimes generates spurious notifications, so you |
346 | Please note that epoll sometimes generates spurious notifications, so you |
327 | need to use non-blocking I/O or other means to avoid blocking when no data |
347 | need to use non-blocking I/O or other means to avoid blocking when no data |
328 | (or space) is available. |
348 | (or space) is available. |
329 | |
349 | |
|
|
350 | Best performance from this backend is achieved by not unregistering all |
|
|
351 | watchers for a file descriptor until it has been closed, if possible, i.e. |
|
|
352 | keep at least one watcher active per fd at all times. |
|
|
353 | |
|
|
354 | While nominally embeddeble in other event loops, this feature is broken in |
|
|
355 | all kernel versions tested so far. |
|
|
356 | |
330 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
357 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
331 | |
358 | |
332 | Kqueue deserves special mention, as at the time of this writing, it |
359 | Kqueue deserves special mention, as at the time of this writing, it |
333 | was broken on all BSDs except NetBSD (usually it doesn't work with |
360 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
334 | anything but sockets and pipes, except on Darwin, where of course its |
361 | with anything but sockets and pipes, except on Darwin, where of course |
335 | completely useless). For this reason its not being "autodetected" |
362 | it's completely useless). For this reason it's not being "autodetected" |
336 | unless you explicitly specify it explicitly in the flags (i.e. using |
363 | unless you explicitly specify it explicitly in the flags (i.e. using |
337 | C<EVBACKEND_KQUEUE>). |
364 | C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) |
|
|
365 | system like NetBSD. |
|
|
366 | |
|
|
367 | You still can embed kqueue into a normal poll or select backend and use it |
|
|
368 | only for sockets (after having made sure that sockets work with kqueue on |
|
|
369 | the target platform). See C<ev_embed> watchers for more info. |
338 | |
370 | |
339 | It scales in the same way as the epoll backend, but the interface to the |
371 | It scales in the same way as the epoll backend, but the interface to the |
340 | kernel is more efficient (which says nothing about its actual speed, of |
372 | kernel is more efficient (which says nothing about its actual speed, of |
341 | course). While starting and stopping an I/O watcher does not cause an |
373 | course). While stopping, setting and starting an I/O watcher does never |
342 | extra syscall as with epoll, it still adds up to four event changes per |
374 | cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to |
343 | incident, so its best to avoid that. |
375 | two event changes per incident, support for C<fork ()> is very bad and it |
|
|
376 | drops fds silently in similarly hard-to-detect cases. |
|
|
377 | |
|
|
378 | This backend usually performs well under most conditions. |
|
|
379 | |
|
|
380 | While nominally embeddable in other event loops, this doesn't work |
|
|
381 | everywhere, so you might need to test for this. And since it is broken |
|
|
382 | almost everywhere, you should only use it when you have a lot of sockets |
|
|
383 | (for which it usually works), by embedding it into another event loop |
|
|
384 | (e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for |
|
|
385 | sockets. |
344 | |
386 | |
345 | =item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) |
387 | =item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) |
346 | |
388 | |
347 | This is not implemented yet (and might never be). |
389 | This is not implemented yet (and might never be, unless you send me an |
|
|
390 | implementation). According to reports, C</dev/poll> only supports sockets |
|
|
391 | and is not embeddable, which would limit the usefulness of this backend |
|
|
392 | immensely. |
348 | |
393 | |
349 | =item C<EVBACKEND_PORT> (value 32, Solaris 10) |
394 | =item C<EVBACKEND_PORT> (value 32, Solaris 10) |
350 | |
395 | |
351 | This uses the Solaris 10 port mechanism. As with everything on Solaris, |
396 | This uses the Solaris 10 event port mechanism. As with everything on Solaris, |
352 | it's really slow, but it still scales very well (O(active_fds)). |
397 | it's really slow, but it still scales very well (O(active_fds)). |
353 | |
398 | |
354 | Please note that solaris ports can result in a lot of spurious |
399 | Please note that solaris event ports can deliver a lot of spurious |
355 | notifications, so you need to use non-blocking I/O or other means to avoid |
400 | notifications, so you need to use non-blocking I/O or other means to avoid |
356 | blocking when no data (or space) is available. |
401 | blocking when no data (or space) is available. |
|
|
402 | |
|
|
403 | While this backend scales well, it requires one system call per active |
|
|
404 | file descriptor per loop iteration. For small and medium numbers of file |
|
|
405 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
|
|
406 | might perform better. |
357 | |
407 | |
358 | =item C<EVBACKEND_ALL> |
408 | =item C<EVBACKEND_ALL> |
359 | |
409 | |
360 | Try all backends (even potentially broken ones that wouldn't be tried |
410 | Try all backends (even potentially broken ones that wouldn't be tried |
361 | with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as |
411 | with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as |
362 | C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. |
412 | C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. |
|
|
413 | |
|
|
414 | It is definitely not recommended to use this flag. |
363 | |
415 | |
364 | =back |
416 | =back |
365 | |
417 | |
366 | If one or more of these are ored into the flags value, then only these |
418 | If one or more of these are ored into the flags value, then only these |
367 | backends will be tried (in the reverse order as given here). If none are |
419 | backends will be tried (in the reverse order as given here). If none are |
… | |
… | |
402 | Destroys the default loop again (frees all memory and kernel state |
454 | Destroys the default loop again (frees all memory and kernel state |
403 | etc.). None of the active event watchers will be stopped in the normal |
455 | etc.). None of the active event watchers will be stopped in the normal |
404 | sense, so e.g. C<ev_is_active> might still return true. It is your |
456 | sense, so e.g. C<ev_is_active> might still return true. It is your |
405 | responsibility to either stop all watchers cleanly yoursef I<before> |
457 | responsibility to either stop all watchers cleanly yoursef I<before> |
406 | calling this function, or cope with the fact afterwards (which is usually |
458 | calling this function, or cope with the fact afterwards (which is usually |
407 | the easiest thing, youc na just ignore the watchers and/or C<free ()> them |
459 | the easiest thing, you can just ignore the watchers and/or C<free ()> them |
408 | for example). |
460 | for example). |
|
|
461 | |
|
|
462 | Note that certain global state, such as signal state, will not be freed by |
|
|
463 | this function, and related watchers (such as signal and child watchers) |
|
|
464 | would need to be stopped manually. |
|
|
465 | |
|
|
466 | In general it is not advisable to call this function except in the |
|
|
467 | rare occasion where you really need to free e.g. the signal handling |
|
|
468 | pipe fds. If you need dynamically allocated loops it is better to use |
|
|
469 | C<ev_loop_new> and C<ev_loop_destroy>). |
409 | |
470 | |
410 | =item ev_loop_destroy (loop) |
471 | =item ev_loop_destroy (loop) |
411 | |
472 | |
412 | Like C<ev_default_destroy>, but destroys an event loop created by an |
473 | Like C<ev_default_destroy>, but destroys an event loop created by an |
413 | earlier call to C<ev_loop_new>. |
474 | earlier call to C<ev_loop_new>. |
… | |
… | |
458 | |
519 | |
459 | Returns the current "event loop time", which is the time the event loop |
520 | Returns the current "event loop time", which is the time the event loop |
460 | received events and started processing them. This timestamp does not |
521 | received events and started processing them. This timestamp does not |
461 | change as long as callbacks are being processed, and this is also the base |
522 | change as long as callbacks are being processed, and this is also the base |
462 | time used for relative timers. You can treat it as the timestamp of the |
523 | time used for relative timers. You can treat it as the timestamp of the |
463 | event occuring (or more correctly, libev finding out about it). |
524 | event occurring (or more correctly, libev finding out about it). |
464 | |
525 | |
465 | =item ev_loop (loop, int flags) |
526 | =item ev_loop (loop, int flags) |
466 | |
527 | |
467 | Finally, this is it, the event handler. This function usually is called |
528 | Finally, this is it, the event handler. This function usually is called |
468 | after you initialised all your watchers and you want to start handling |
529 | after you initialised all your watchers and you want to start handling |
… | |
… | |
552 | Example: For some weird reason, unregister the above signal handler again. |
613 | Example: For some weird reason, unregister the above signal handler again. |
553 | |
614 | |
554 | ev_ref (loop); |
615 | ev_ref (loop); |
555 | ev_signal_stop (loop, &exitsig); |
616 | ev_signal_stop (loop, &exitsig); |
556 | |
617 | |
|
|
618 | =item ev_set_io_collect_interval (loop, ev_tstamp interval) |
|
|
619 | |
|
|
620 | =item ev_set_timeout_collect_interval (loop, ev_tstamp interval) |
|
|
621 | |
|
|
622 | These advanced functions influence the time that libev will spend waiting |
|
|
623 | for events. Both are by default C<0>, meaning that libev will try to |
|
|
624 | invoke timer/periodic callbacks and I/O callbacks with minimum latency. |
|
|
625 | |
|
|
626 | Setting these to a higher value (the C<interval> I<must> be >= C<0>) |
|
|
627 | allows libev to delay invocation of I/O and timer/periodic callbacks to |
|
|
628 | increase efficiency of loop iterations. |
|
|
629 | |
|
|
630 | The background is that sometimes your program runs just fast enough to |
|
|
631 | handle one (or very few) event(s) per loop iteration. While this makes |
|
|
632 | the program responsive, it also wastes a lot of CPU time to poll for new |
|
|
633 | events, especially with backends like C<select ()> which have a high |
|
|
634 | overhead for the actual polling but can deliver many events at once. |
|
|
635 | |
|
|
636 | By setting a higher I<io collect interval> you allow libev to spend more |
|
|
637 | time collecting I/O events, so you can handle more events per iteration, |
|
|
638 | at the cost of increasing latency. Timeouts (both C<ev_periodic> and |
|
|
639 | C<ev_timer>) will be not affected. Setting this to a non-null value will |
|
|
640 | introduce an additional C<ev_sleep ()> call into most loop iterations. |
|
|
641 | |
|
|
642 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
|
|
643 | to spend more time collecting timeouts, at the expense of increased |
|
|
644 | latency (the watcher callback will be called later). C<ev_io> watchers |
|
|
645 | will not be affected. Setting this to a non-null value will not introduce |
|
|
646 | any overhead in libev. |
|
|
647 | |
|
|
648 | Many (busy) programs can usually benefit by setting the io collect |
|
|
649 | interval to a value near C<0.1> or so, which is often enough for |
|
|
650 | interactive servers (of course not for games), likewise for timeouts. It |
|
|
651 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
|
|
652 | as this approsaches the timing granularity of most systems. |
|
|
653 | |
557 | =back |
654 | =back |
558 | |
655 | |
559 | |
656 | |
560 | =head1 ANATOMY OF A WATCHER |
657 | =head1 ANATOMY OF A WATCHER |
561 | |
658 | |
… | |
… | |
886 | In general you can register as many read and/or write event watchers per |
983 | In general you can register as many read and/or write event watchers per |
887 | fd as you want (as long as you don't confuse yourself). Setting all file |
984 | fd as you want (as long as you don't confuse yourself). Setting all file |
888 | descriptors to non-blocking mode is also usually a good idea (but not |
985 | descriptors to non-blocking mode is also usually a good idea (but not |
889 | required if you know what you are doing). |
986 | required if you know what you are doing). |
890 | |
987 | |
891 | You have to be careful with dup'ed file descriptors, though. Some backends |
|
|
892 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
|
|
893 | descriptors correctly if you register interest in two or more fds pointing |
|
|
894 | to the same underlying file/socket/etc. description (that is, they share |
|
|
895 | the same underlying "file open"). |
|
|
896 | |
|
|
897 | If you must do this, then force the use of a known-to-be-good backend |
988 | If you must do this, then force the use of a known-to-be-good backend |
898 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
989 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
899 | C<EVBACKEND_POLL>). |
990 | C<EVBACKEND_POLL>). |
900 | |
991 | |
901 | Another thing you have to watch out for is that it is quite easy to |
992 | Another thing you have to watch out for is that it is quite easy to |
… | |
… | |
913 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1004 | such as poll (fortunately in our Xlib example, Xlib already does this on |
914 | its own, so its quite safe to use). |
1005 | its own, so its quite safe to use). |
915 | |
1006 | |
916 | =head3 The special problem of disappearing file descriptors |
1007 | =head3 The special problem of disappearing file descriptors |
917 | |
1008 | |
918 | Some backends (e.g kqueue, epoll) need to be told about closing a file |
1009 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
919 | descriptor (either by calling C<close> explicitly or by any other means, |
1010 | descriptor (either by calling C<close> explicitly or by any other means, |
920 | such as C<dup>). The reason is that you register interest in some file |
1011 | such as C<dup>). The reason is that you register interest in some file |
921 | descriptor, but when it goes away, the operating system will silently drop |
1012 | descriptor, but when it goes away, the operating system will silently drop |
922 | this interest. If another file descriptor with the same number then is |
1013 | this interest. If another file descriptor with the same number then is |
923 | registered with libev, there is no efficient way to see that this is, in |
1014 | registered with libev, there is no efficient way to see that this is, in |
… | |
… | |
932 | |
1023 | |
933 | This is how one would do it normally anyway, the important point is that |
1024 | This is how one would do it normally anyway, the important point is that |
934 | the libev application should not optimise around libev but should leave |
1025 | the libev application should not optimise around libev but should leave |
935 | optimisations to libev. |
1026 | optimisations to libev. |
936 | |
1027 | |
|
|
1028 | =head3 The special problem of dup'ed file descriptors |
|
|
1029 | |
|
|
1030 | Some backends (e.g. epoll), cannot register events for file descriptors, |
|
|
1031 | but only events for the underlying file descriptions. That means when you |
|
|
1032 | have C<dup ()>'ed file descriptors or weirder constellations, and register |
|
|
1033 | events for them, only one file descriptor might actually receive events. |
|
|
1034 | |
|
|
1035 | There is no workaround possible except not registering events |
|
|
1036 | for potentially C<dup ()>'ed file descriptors, or to resort to |
|
|
1037 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
|
|
1038 | |
|
|
1039 | =head3 The special problem of fork |
|
|
1040 | |
|
|
1041 | Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit |
|
|
1042 | useless behaviour. Libev fully supports fork, but needs to be told about |
|
|
1043 | it in the child. |
|
|
1044 | |
|
|
1045 | To support fork in your programs, you either have to call |
|
|
1046 | C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child, |
|
|
1047 | enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or |
|
|
1048 | C<EVBACKEND_POLL>. |
|
|
1049 | |
937 | |
1050 | |
938 | =head3 Watcher-Specific Functions |
1051 | =head3 Watcher-Specific Functions |
939 | |
1052 | |
940 | =over 4 |
1053 | =over 4 |
941 | |
1054 | |
… | |
… | |
954 | =item int events [read-only] |
1067 | =item int events [read-only] |
955 | |
1068 | |
956 | The events being watched. |
1069 | The events being watched. |
957 | |
1070 | |
958 | =back |
1071 | =back |
|
|
1072 | |
|
|
1073 | =head3 Examples |
959 | |
1074 | |
960 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
1075 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
961 | readable, but only once. Since it is likely line-buffered, you could |
1076 | readable, but only once. Since it is likely line-buffered, you could |
962 | attempt to read a whole line in the callback. |
1077 | attempt to read a whole line in the callback. |
963 | |
1078 | |
… | |
… | |
1061 | or C<ev_timer_again> is called and determines the next timeout (if any), |
1176 | or C<ev_timer_again> is called and determines the next timeout (if any), |
1062 | which is also when any modifications are taken into account. |
1177 | which is also when any modifications are taken into account. |
1063 | |
1178 | |
1064 | =back |
1179 | =back |
1065 | |
1180 | |
|
|
1181 | =head3 Examples |
|
|
1182 | |
1066 | Example: Create a timer that fires after 60 seconds. |
1183 | Example: Create a timer that fires after 60 seconds. |
1067 | |
1184 | |
1068 | static void |
1185 | static void |
1069 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1186 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1070 | { |
1187 | { |
… | |
… | |
1220 | |
1337 | |
1221 | The current reschedule callback, or C<0>, if this functionality is |
1338 | The current reschedule callback, or C<0>, if this functionality is |
1222 | switched off. Can be changed any time, but changes only take effect when |
1339 | switched off. Can be changed any time, but changes only take effect when |
1223 | the periodic timer fires or C<ev_periodic_again> is being called. |
1340 | the periodic timer fires or C<ev_periodic_again> is being called. |
1224 | |
1341 | |
|
|
1342 | =item ev_tstamp at [read-only] |
|
|
1343 | |
|
|
1344 | When active, contains the absolute time that the watcher is supposed to |
|
|
1345 | trigger next. |
|
|
1346 | |
1225 | =back |
1347 | =back |
|
|
1348 | |
|
|
1349 | =head3 Examples |
1226 | |
1350 | |
1227 | Example: Call a callback every hour, or, more precisely, whenever the |
1351 | Example: Call a callback every hour, or, more precisely, whenever the |
1228 | system clock is divisible by 3600. The callback invocation times have |
1352 | system clock is divisible by 3600. The callback invocation times have |
1229 | potentially a lot of jittering, but good long-term stability. |
1353 | potentially a lot of jittering, but good long-term stability. |
1230 | |
1354 | |
… | |
… | |
1322 | |
1446 | |
1323 | The process exit/trace status caused by C<rpid> (see your systems |
1447 | The process exit/trace status caused by C<rpid> (see your systems |
1324 | C<waitpid> and C<sys/wait.h> documentation for details). |
1448 | C<waitpid> and C<sys/wait.h> documentation for details). |
1325 | |
1449 | |
1326 | =back |
1450 | =back |
|
|
1451 | |
|
|
1452 | =head3 Examples |
1327 | |
1453 | |
1328 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
1454 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
1329 | |
1455 | |
1330 | static void |
1456 | static void |
1331 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1457 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
… | |
… | |
1372 | semantics of C<ev_stat> watchers, which means that libev sometimes needs |
1498 | semantics of C<ev_stat> watchers, which means that libev sometimes needs |
1373 | to fall back to regular polling again even with inotify, but changes are |
1499 | to fall back to regular polling again even with inotify, but changes are |
1374 | usually detected immediately, and if the file exists there will be no |
1500 | usually detected immediately, and if the file exists there will be no |
1375 | polling. |
1501 | polling. |
1376 | |
1502 | |
|
|
1503 | =head3 Inotify |
|
|
1504 | |
|
|
1505 | When C<inotify (7)> support has been compiled into libev (generally only |
|
|
1506 | available on Linux) and present at runtime, it will be used to speed up |
|
|
1507 | change detection where possible. The inotify descriptor will be created lazily |
|
|
1508 | when the first C<ev_stat> watcher is being started. |
|
|
1509 | |
|
|
1510 | Inotify presense does not change the semantics of C<ev_stat> watchers |
|
|
1511 | except that changes might be detected earlier, and in some cases, to avoid |
|
|
1512 | making regular C<stat> calls. Even in the presense of inotify support |
|
|
1513 | there are many cases where libev has to resort to regular C<stat> polling. |
|
|
1514 | |
|
|
1515 | (There is no support for kqueue, as apparently it cannot be used to |
|
|
1516 | implement this functionality, due to the requirement of having a file |
|
|
1517 | descriptor open on the object at all times). |
|
|
1518 | |
|
|
1519 | =head3 The special problem of stat time resolution |
|
|
1520 | |
|
|
1521 | The C<stat ()> syscall only supports full-second resolution portably, and |
|
|
1522 | even on systems where the resolution is higher, many filesystems still |
|
|
1523 | only support whole seconds. |
|
|
1524 | |
|
|
1525 | That means that, if the time is the only thing that changes, you might |
|
|
1526 | miss updates: on the first update, C<ev_stat> detects a change and calls |
|
|
1527 | your callback, which does something. When there is another update within |
|
|
1528 | the same second, C<ev_stat> will be unable to detect it. |
|
|
1529 | |
|
|
1530 | The solution to this is to delay acting on a change for a second (or till |
|
|
1531 | the next second boundary), using a roughly one-second delay C<ev_timer> |
|
|
1532 | (C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01> |
|
|
1533 | is added to work around small timing inconsistencies of some operating |
|
|
1534 | systems. |
|
|
1535 | |
1377 | =head3 Watcher-Specific Functions and Data Members |
1536 | =head3 Watcher-Specific Functions and Data Members |
1378 | |
1537 | |
1379 | =over 4 |
1538 | =over 4 |
1380 | |
1539 | |
1381 | =item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) |
1540 | =item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) |
… | |
… | |
1418 | =item const char *path [read-only] |
1577 | =item const char *path [read-only] |
1419 | |
1578 | |
1420 | The filesystem path that is being watched. |
1579 | The filesystem path that is being watched. |
1421 | |
1580 | |
1422 | =back |
1581 | =back |
|
|
1582 | |
|
|
1583 | =head3 Examples |
1423 | |
1584 | |
1424 | Example: Watch C</etc/passwd> for attribute changes. |
1585 | Example: Watch C</etc/passwd> for attribute changes. |
1425 | |
1586 | |
1426 | static void |
1587 | static void |
1427 | passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
1588 | passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
… | |
… | |
1440 | } |
1601 | } |
1441 | |
1602 | |
1442 | ... |
1603 | ... |
1443 | ev_stat passwd; |
1604 | ev_stat passwd; |
1444 | |
1605 | |
1445 | ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); |
1606 | ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.); |
1446 | ev_stat_start (loop, &passwd); |
1607 | ev_stat_start (loop, &passwd); |
|
|
1608 | |
|
|
1609 | Example: Like above, but additionally use a one-second delay so we do not |
|
|
1610 | miss updates (however, frequent updates will delay processing, too, so |
|
|
1611 | one might do the work both on C<ev_stat> callback invocation I<and> on |
|
|
1612 | C<ev_timer> callback invocation). |
|
|
1613 | |
|
|
1614 | static ev_stat passwd; |
|
|
1615 | static ev_timer timer; |
|
|
1616 | |
|
|
1617 | static void |
|
|
1618 | timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
1619 | { |
|
|
1620 | ev_timer_stop (EV_A_ w); |
|
|
1621 | |
|
|
1622 | /* now it's one second after the most recent passwd change */ |
|
|
1623 | } |
|
|
1624 | |
|
|
1625 | static void |
|
|
1626 | stat_cb (EV_P_ ev_stat *w, int revents) |
|
|
1627 | { |
|
|
1628 | /* reset the one-second timer */ |
|
|
1629 | ev_timer_again (EV_A_ &timer); |
|
|
1630 | } |
|
|
1631 | |
|
|
1632 | ... |
|
|
1633 | ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); |
|
|
1634 | ev_stat_start (loop, &passwd); |
|
|
1635 | ev_timer_init (&timer, timer_cb, 0., 1.01); |
1447 | |
1636 | |
1448 | |
1637 | |
1449 | =head2 C<ev_idle> - when you've got nothing better to do... |
1638 | =head2 C<ev_idle> - when you've got nothing better to do... |
1450 | |
1639 | |
1451 | Idle watchers trigger events when no other events of the same or higher |
1640 | Idle watchers trigger events when no other events of the same or higher |
… | |
… | |
1476 | Initialises and configures the idle watcher - it has no parameters of any |
1665 | Initialises and configures the idle watcher - it has no parameters of any |
1477 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
1666 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
1478 | believe me. |
1667 | believe me. |
1479 | |
1668 | |
1480 | =back |
1669 | =back |
|
|
1670 | |
|
|
1671 | =head3 Examples |
1481 | |
1672 | |
1482 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
1673 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
1483 | callback, free it. Also, use no error checking, as usual. |
1674 | callback, free it. Also, use no error checking, as usual. |
1484 | |
1675 | |
1485 | static void |
1676 | static void |
… | |
… | |
1537 | |
1728 | |
1538 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
1729 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
1539 | priority, to ensure that they are being run before any other watchers |
1730 | priority, to ensure that they are being run before any other watchers |
1540 | after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, |
1731 | after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, |
1541 | too) should not activate ("feed") events into libev. While libev fully |
1732 | too) should not activate ("feed") events into libev. While libev fully |
1542 | supports this, they will be called before other C<ev_check> watchers did |
1733 | supports this, they will be called before other C<ev_check> watchers |
1543 | their job. As C<ev_check> watchers are often used to embed other event |
1734 | did their job. As C<ev_check> watchers are often used to embed other |
1544 | loops those other event loops might be in an unusable state until their |
1735 | (non-libev) event loops those other event loops might be in an unusable |
1545 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
1736 | state until their C<ev_check> watcher ran (always remind yourself to |
1546 | others). |
1737 | coexist peacefully with others). |
1547 | |
1738 | |
1548 | =head3 Watcher-Specific Functions and Data Members |
1739 | =head3 Watcher-Specific Functions and Data Members |
1549 | |
1740 | |
1550 | =over 4 |
1741 | =over 4 |
1551 | |
1742 | |
… | |
… | |
1556 | Initialises and configures the prepare or check watcher - they have no |
1747 | Initialises and configures the prepare or check watcher - they have no |
1557 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1748 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1558 | macros, but using them is utterly, utterly and completely pointless. |
1749 | macros, but using them is utterly, utterly and completely pointless. |
1559 | |
1750 | |
1560 | =back |
1751 | =back |
|
|
1752 | |
|
|
1753 | =head3 Examples |
1561 | |
1754 | |
1562 | There are a number of principal ways to embed other event loops or modules |
1755 | There are a number of principal ways to embed other event loops or modules |
1563 | into libev. Here are some ideas on how to include libadns into libev |
1756 | into libev. Here are some ideas on how to include libadns into libev |
1564 | (there is a Perl module named C<EV::ADNS> that does this, which you could |
1757 | (there is a Perl module named C<EV::ADNS> that does this, which you could |
1565 | use for an actually working example. Another Perl module named C<EV::Glib> |
1758 | use for an actually working example. Another Perl module named C<EV::Glib> |
… | |
… | |
1734 | portable one. |
1927 | portable one. |
1735 | |
1928 | |
1736 | So when you want to use this feature you will always have to be prepared |
1929 | So when you want to use this feature you will always have to be prepared |
1737 | that you cannot get an embeddable loop. The recommended way to get around |
1930 | that you cannot get an embeddable loop. The recommended way to get around |
1738 | this is to have a separate variables for your embeddable loop, try to |
1931 | this is to have a separate variables for your embeddable loop, try to |
1739 | create it, and if that fails, use the normal loop for everything: |
1932 | create it, and if that fails, use the normal loop for everything. |
|
|
1933 | |
|
|
1934 | =head3 Watcher-Specific Functions and Data Members |
|
|
1935 | |
|
|
1936 | =over 4 |
|
|
1937 | |
|
|
1938 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
|
|
1939 | |
|
|
1940 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
|
|
1941 | |
|
|
1942 | Configures the watcher to embed the given loop, which must be |
|
|
1943 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
|
|
1944 | invoked automatically, otherwise it is the responsibility of the callback |
|
|
1945 | to invoke it (it will continue to be called until the sweep has been done, |
|
|
1946 | if you do not want thta, you need to temporarily stop the embed watcher). |
|
|
1947 | |
|
|
1948 | =item ev_embed_sweep (loop, ev_embed *) |
|
|
1949 | |
|
|
1950 | Make a single, non-blocking sweep over the embedded loop. This works |
|
|
1951 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
|
|
1952 | apropriate way for embedded loops. |
|
|
1953 | |
|
|
1954 | =item struct ev_loop *other [read-only] |
|
|
1955 | |
|
|
1956 | The embedded event loop. |
|
|
1957 | |
|
|
1958 | =back |
|
|
1959 | |
|
|
1960 | =head3 Examples |
|
|
1961 | |
|
|
1962 | Example: Try to get an embeddable event loop and embed it into the default |
|
|
1963 | event loop. If that is not possible, use the default loop. The default |
|
|
1964 | loop is stored in C<loop_hi>, while the mebeddable loop is stored in |
|
|
1965 | C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be |
|
|
1966 | used). |
1740 | |
1967 | |
1741 | struct ev_loop *loop_hi = ev_default_init (0); |
1968 | struct ev_loop *loop_hi = ev_default_init (0); |
1742 | struct ev_loop *loop_lo = 0; |
1969 | struct ev_loop *loop_lo = 0; |
1743 | struct ev_embed embed; |
1970 | struct ev_embed embed; |
1744 | |
1971 | |
… | |
… | |
1755 | ev_embed_start (loop_hi, &embed); |
1982 | ev_embed_start (loop_hi, &embed); |
1756 | } |
1983 | } |
1757 | else |
1984 | else |
1758 | loop_lo = loop_hi; |
1985 | loop_lo = loop_hi; |
1759 | |
1986 | |
1760 | =head3 Watcher-Specific Functions and Data Members |
1987 | Example: Check if kqueue is available but not recommended and create |
|
|
1988 | a kqueue backend for use with sockets (which usually work with any |
|
|
1989 | kqueue implementation). Store the kqueue/socket-only event loop in |
|
|
1990 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
1761 | |
1991 | |
1762 | =over 4 |
1992 | struct ev_loop *loop = ev_default_init (0); |
|
|
1993 | struct ev_loop *loop_socket = 0; |
|
|
1994 | struct ev_embed embed; |
|
|
1995 | |
|
|
1996 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
|
|
1997 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
|
|
1998 | { |
|
|
1999 | ev_embed_init (&embed, 0, loop_socket); |
|
|
2000 | ev_embed_start (loop, &embed); |
|
|
2001 | } |
1763 | |
2002 | |
1764 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
2003 | if (!loop_socket) |
|
|
2004 | loop_socket = loop; |
1765 | |
2005 | |
1766 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
2006 | // now use loop_socket for all sockets, and loop for everything else |
1767 | |
|
|
1768 | Configures the watcher to embed the given loop, which must be |
|
|
1769 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
|
|
1770 | invoked automatically, otherwise it is the responsibility of the callback |
|
|
1771 | to invoke it (it will continue to be called until the sweep has been done, |
|
|
1772 | if you do not want thta, you need to temporarily stop the embed watcher). |
|
|
1773 | |
|
|
1774 | =item ev_embed_sweep (loop, ev_embed *) |
|
|
1775 | |
|
|
1776 | Make a single, non-blocking sweep over the embedded loop. This works |
|
|
1777 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
|
|
1778 | apropriate way for embedded loops. |
|
|
1779 | |
|
|
1780 | =item struct ev_loop *loop [read-only] |
|
|
1781 | |
|
|
1782 | The embedded event loop. |
|
|
1783 | |
|
|
1784 | =back |
|
|
1785 | |
2007 | |
1786 | |
2008 | |
1787 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
2009 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
1788 | |
2010 | |
1789 | Fork watchers are called when a C<fork ()> was detected (usually because |
2011 | Fork watchers are called when a C<fork ()> was detected (usually because |
… | |
… | |
2124 | Libev can (and often is) directly embedded into host |
2346 | Libev can (and often is) directly embedded into host |
2125 | applications. Examples of applications that embed it include the Deliantra |
2347 | applications. Examples of applications that embed it include the Deliantra |
2126 | Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) |
2348 | Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) |
2127 | and rxvt-unicode. |
2349 | and rxvt-unicode. |
2128 | |
2350 | |
2129 | The goal is to enable you to just copy the neecssary files into your |
2351 | The goal is to enable you to just copy the necessary files into your |
2130 | source directory without having to change even a single line in them, so |
2352 | source directory without having to change even a single line in them, so |
2131 | you can easily upgrade by simply copying (or having a checked-out copy of |
2353 | you can easily upgrade by simply copying (or having a checked-out copy of |
2132 | libev somewhere in your source tree). |
2354 | libev somewhere in your source tree). |
2133 | |
2355 | |
2134 | =head2 FILESETS |
2356 | =head2 FILESETS |
… | |
… | |
2224 | |
2446 | |
2225 | If defined to be C<1>, libev will try to detect the availability of the |
2447 | If defined to be C<1>, libev will try to detect the availability of the |
2226 | monotonic clock option at both compiletime and runtime. Otherwise no use |
2448 | monotonic clock option at both compiletime and runtime. Otherwise no use |
2227 | of the monotonic clock option will be attempted. If you enable this, you |
2449 | of the monotonic clock option will be attempted. If you enable this, you |
2228 | usually have to link against librt or something similar. Enabling it when |
2450 | usually have to link against librt or something similar. Enabling it when |
2229 | the functionality isn't available is safe, though, althoguh you have |
2451 | the functionality isn't available is safe, though, although you have |
2230 | to make sure you link against any libraries where the C<clock_gettime> |
2452 | to make sure you link against any libraries where the C<clock_gettime> |
2231 | function is hiding in (often F<-lrt>). |
2453 | function is hiding in (often F<-lrt>). |
2232 | |
2454 | |
2233 | =item EV_USE_REALTIME |
2455 | =item EV_USE_REALTIME |
2234 | |
2456 | |
2235 | If defined to be C<1>, libev will try to detect the availability of the |
2457 | If defined to be C<1>, libev will try to detect the availability of the |
2236 | realtime clock option at compiletime (and assume its availability at |
2458 | realtime clock option at compiletime (and assume its availability at |
2237 | runtime if successful). Otherwise no use of the realtime clock option will |
2459 | runtime if successful). Otherwise no use of the realtime clock option will |
2238 | be attempted. This effectively replaces C<gettimeofday> by C<clock_get |
2460 | be attempted. This effectively replaces C<gettimeofday> by C<clock_get |
2239 | (CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries |
2461 | (CLOCK_REALTIME, ...)> and will not normally affect correctness. See the |
2240 | in the description of C<EV_USE_MONOTONIC>, though. |
2462 | note about libraries in the description of C<EV_USE_MONOTONIC>, though. |
|
|
2463 | |
|
|
2464 | =item EV_USE_NANOSLEEP |
|
|
2465 | |
|
|
2466 | If defined to be C<1>, libev will assume that C<nanosleep ()> is available |
|
|
2467 | and will use it for delays. Otherwise it will use C<select ()>. |
2241 | |
2468 | |
2242 | =item EV_USE_SELECT |
2469 | =item EV_USE_SELECT |
2243 | |
2470 | |
2244 | If undefined or defined to be C<1>, libev will compile in support for the |
2471 | If undefined or defined to be C<1>, libev will compile in support for the |
2245 | C<select>(2) backend. No attempt at autodetection will be done: if no |
2472 | C<select>(2) backend. No attempt at autodetection will be done: if no |
… | |
… | |
2309 | be detected at runtime. |
2536 | be detected at runtime. |
2310 | |
2537 | |
2311 | =item EV_H |
2538 | =item EV_H |
2312 | |
2539 | |
2313 | The name of the F<ev.h> header file used to include it. The default if |
2540 | The name of the F<ev.h> header file used to include it. The default if |
2314 | undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This |
2541 | undefined is C<"ev.h"> in F<event.h> and F<ev.c>. This can be used to |
2315 | can be used to virtually rename the F<ev.h> header file in case of conflicts. |
2542 | virtually rename the F<ev.h> header file in case of conflicts. |
2316 | |
2543 | |
2317 | =item EV_CONFIG_H |
2544 | =item EV_CONFIG_H |
2318 | |
2545 | |
2319 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
2546 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
2320 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
2547 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
2321 | C<EV_H>, above. |
2548 | C<EV_H>, above. |
2322 | |
2549 | |
2323 | =item EV_EVENT_H |
2550 | =item EV_EVENT_H |
2324 | |
2551 | |
2325 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
2552 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
2326 | of how the F<event.h> header can be found. |
2553 | of how the F<event.h> header can be found, the dfeault is C<"event.h">. |
2327 | |
2554 | |
2328 | =item EV_PROTOTYPES |
2555 | =item EV_PROTOTYPES |
2329 | |
2556 | |
2330 | If defined to be C<0>, then F<ev.h> will not define any function |
2557 | If defined to be C<0>, then F<ev.h> will not define any function |
2331 | prototypes, but still define all the structs and other symbols. This is |
2558 | prototypes, but still define all the structs and other symbols. This is |
… | |
… | |
2397 | than enough. If you need to manage thousands of children you might want to |
2624 | than enough. If you need to manage thousands of children you might want to |
2398 | increase this value (I<must> be a power of two). |
2625 | increase this value (I<must> be a power of two). |
2399 | |
2626 | |
2400 | =item EV_INOTIFY_HASHSIZE |
2627 | =item EV_INOTIFY_HASHSIZE |
2401 | |
2628 | |
2402 | C<ev_staz> watchers use a small hash table to distribute workload by |
2629 | C<ev_stat> watchers use a small hash table to distribute workload by |
2403 | inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), |
2630 | inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), |
2404 | usually more than enough. If you need to manage thousands of C<ev_stat> |
2631 | usually more than enough. If you need to manage thousands of C<ev_stat> |
2405 | watchers you might want to increase this value (I<must> be a power of |
2632 | watchers you might want to increase this value (I<must> be a power of |
2406 | two). |
2633 | two). |
2407 | |
2634 | |
… | |
… | |
2424 | |
2651 | |
2425 | =item ev_set_cb (ev, cb) |
2652 | =item ev_set_cb (ev, cb) |
2426 | |
2653 | |
2427 | Can be used to change the callback member declaration in each watcher, |
2654 | Can be used to change the callback member declaration in each watcher, |
2428 | and the way callbacks are invoked and set. Must expand to a struct member |
2655 | and the way callbacks are invoked and set. Must expand to a struct member |
2429 | definition and a statement, respectively. See the F<ev.v> header file for |
2656 | definition and a statement, respectively. See the F<ev.h> header file for |
2430 | their default definitions. One possible use for overriding these is to |
2657 | their default definitions. One possible use for overriding these is to |
2431 | avoid the C<struct ev_loop *> as first argument in all cases, or to use |
2658 | avoid the C<struct ev_loop *> as first argument in all cases, or to use |
2432 | method calls instead of plain function calls in C++. |
2659 | method calls instead of plain function calls in C++. |
|
|
2660 | |
|
|
2661 | =head2 EXPORTED API SYMBOLS |
|
|
2662 | |
|
|
2663 | If you need to re-export the API (e.g. via a dll) and you need a list of |
|
|
2664 | exported symbols, you can use the provided F<Symbol.*> files which list |
|
|
2665 | all public symbols, one per line: |
|
|
2666 | |
|
|
2667 | Symbols.ev for libev proper |
|
|
2668 | Symbols.event for the libevent emulation |
|
|
2669 | |
|
|
2670 | This can also be used to rename all public symbols to avoid clashes with |
|
|
2671 | multiple versions of libev linked together (which is obviously bad in |
|
|
2672 | itself, but sometimes it is inconvinient to avoid this). |
|
|
2673 | |
|
|
2674 | A sed command like this will create wrapper C<#define>'s that you need to |
|
|
2675 | include before including F<ev.h>: |
|
|
2676 | |
|
|
2677 | <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h |
|
|
2678 | |
|
|
2679 | This would create a file F<wrap.h> which essentially looks like this: |
|
|
2680 | |
|
|
2681 | #define ev_backend myprefix_ev_backend |
|
|
2682 | #define ev_check_start myprefix_ev_check_start |
|
|
2683 | #define ev_check_stop myprefix_ev_check_stop |
|
|
2684 | ... |
2433 | |
2685 | |
2434 | =head2 EXAMPLES |
2686 | =head2 EXAMPLES |
2435 | |
2687 | |
2436 | For a real-world example of a program the includes libev |
2688 | For a real-world example of a program the includes libev |
2437 | verbatim, you can have a look at the EV perl module |
2689 | verbatim, you can have a look at the EV perl module |
… | |
… | |
2478 | |
2730 | |
2479 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
2731 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
2480 | |
2732 | |
2481 | This means that, when you have a watcher that triggers in one hour and |
2733 | This means that, when you have a watcher that triggers in one hour and |
2482 | there are 100 watchers that would trigger before that then inserting will |
2734 | there are 100 watchers that would trigger before that then inserting will |
2483 | have to skip those 100 watchers. |
2735 | have to skip roughly seven (C<ld 100>) of these watchers. |
2484 | |
2736 | |
2485 | =item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) |
2737 | =item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers) |
2486 | |
2738 | |
2487 | That means that for changing a timer costs less than removing/adding them |
2739 | That means that changing a timer costs less than removing/adding them |
2488 | as only the relative motion in the event queue has to be paid for. |
2740 | as only the relative motion in the event queue has to be paid for. |
2489 | |
2741 | |
2490 | =item Starting io/check/prepare/idle/signal/child watchers: O(1) |
2742 | =item Starting io/check/prepare/idle/signal/child watchers: O(1) |
2491 | |
2743 | |
2492 | These just add the watcher into an array or at the head of a list. |
2744 | These just add the watcher into an array or at the head of a list. |
|
|
2745 | |
2493 | =item Stopping check/prepare/idle watchers: O(1) |
2746 | =item Stopping check/prepare/idle watchers: O(1) |
2494 | |
2747 | |
2495 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
2748 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
2496 | |
2749 | |
2497 | These watchers are stored in lists then need to be walked to find the |
2750 | These watchers are stored in lists then need to be walked to find the |
2498 | correct watcher to remove. The lists are usually short (you don't usually |
2751 | correct watcher to remove. The lists are usually short (you don't usually |
2499 | have many watchers waiting for the same fd or signal). |
2752 | have many watchers waiting for the same fd or signal). |
2500 | |
2753 | |
2501 | =item Finding the next timer per loop iteration: O(1) |
2754 | =item Finding the next timer in each loop iteration: O(1) |
|
|
2755 | |
|
|
2756 | By virtue of using a binary heap, the next timer is always found at the |
|
|
2757 | beginning of the storage array. |
2502 | |
2758 | |
2503 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
2759 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
2504 | |
2760 | |
2505 | A change means an I/O watcher gets started or stopped, which requires |
2761 | A change means an I/O watcher gets started or stopped, which requires |
2506 | libev to recalculate its status (and possibly tell the kernel). |
2762 | libev to recalculate its status (and possibly tell the kernel, depending |
|
|
2763 | on backend and wether C<ev_io_set> was used). |
2507 | |
2764 | |
2508 | =item Activating one watcher: O(1) |
2765 | =item Activating one watcher (putting it into the pending state): O(1) |
2509 | |
2766 | |
2510 | =item Priority handling: O(number_of_priorities) |
2767 | =item Priority handling: O(number_of_priorities) |
2511 | |
2768 | |
2512 | Priorities are implemented by allocating some space for each |
2769 | Priorities are implemented by allocating some space for each |
2513 | priority. When doing priority-based operations, libev usually has to |
2770 | priority. When doing priority-based operations, libev usually has to |
2514 | linearly search all the priorities. |
2771 | linearly search all the priorities, but starting/stopping and activating |
|
|
2772 | watchers becomes O(1) w.r.t. prioritiy handling. |
2515 | |
2773 | |
2516 | =back |
2774 | =back |
2517 | |
2775 | |
2518 | |
2776 | |
2519 | =head1 AUTHOR |
2777 | =head1 AUTHOR |