ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.pod
(Generate patch)

Comparing libev/ev.pod (file contents):
Revision 1.48 by root, Tue Nov 27 08:11:52 2007 UTC vs.
Revision 1.78 by root, Sun Dec 9 19:42:57 2007 UTC

4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 #include <ev.h> 7 #include <ev.h>
8 8
9=head1 EXAMPLE PROGRAM
10
11 #include <ev.h>
12
13 ev_io stdin_watcher;
14 ev_timer timeout_watcher;
15
16 /* called when data readable on stdin */
17 static void
18 stdin_cb (EV_P_ struct ev_io *w, int revents)
19 {
20 /* puts ("stdin ready"); */
21 ev_io_stop (EV_A_ w); /* just a syntax example */
22 ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */
23 }
24
25 static void
26 timeout_cb (EV_P_ struct ev_timer *w, int revents)
27 {
28 /* puts ("timeout"); */
29 ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */
30 }
31
32 int
33 main (void)
34 {
35 struct ev_loop *loop = ev_default_loop (0);
36
37 /* initialise an io watcher, then start it */
38 ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
39 ev_io_start (loop, &stdin_watcher);
40
41 /* simple non-repeating 5.5 second timeout */
42 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
43 ev_timer_start (loop, &timeout_watcher);
44
45 /* loop till timeout or data ready */
46 ev_loop (loop, 0);
47
48 return 0;
49 }
50
9=head1 DESCRIPTION 51=head1 DESCRIPTION
52
53The newest version of this document is also available as a html-formatted
54web page you might find easier to navigate when reading it for the first
55time: L<http://cvs.schmorp.de/libev/ev.html>.
10 56
11Libev is an event loop: you register interest in certain events (such as a 57Libev is an event loop: you register interest in certain events (such as a
12file descriptor being readable or a timeout occuring), and it will manage 58file descriptor being readable or a timeout occuring), and it will manage
13these event sources and provide your program with events. 59these event sources and provide your program with events.
14 60
21details of the event, and then hand it over to libev by I<starting> the 67details of the event, and then hand it over to libev by I<starting> the
22watcher. 68watcher.
23 69
24=head1 FEATURES 70=head1 FEATURES
25 71
26Libev supports select, poll, the linux-specific epoll and the bsd-specific 72Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
27kqueue mechanisms for file descriptor events, relative timers, absolute 73BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
28timers with customised rescheduling, signal events, process status change 74for file descriptor events (C<ev_io>), the Linux C<inotify> interface
29events (related to SIGCHLD), and event watchers dealing with the event 75(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
30loop mechanism itself (idle, prepare and check watchers). It also is quite 76with customised rescheduling (C<ev_periodic>), synchronous signals
77(C<ev_signal>), process status change events (C<ev_child>), and event
78watchers dealing with the event loop mechanism itself (C<ev_idle>,
79C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as
80file watchers (C<ev_stat>) and even limited support for fork events
81(C<ev_fork>).
82
83It also is quite fast (see this
31fast (see this L<benchmark|http://libev.schmorp.de/bench.html> comparing 84L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
32it to libevent for example). 85for example).
33 86
34=head1 CONVENTIONS 87=head1 CONVENTIONS
35 88
36Libev is very configurable. In this manual the default configuration 89Libev is very configurable. In this manual the default configuration will
37will be described, which supports multiple event loops. For more info 90be described, which supports multiple event loops. For more info about
38about various configuration options please have a look at the file 91various configuration options please have a look at B<EMBED> section in
39F<README.embed> in the libev distribution. If libev was configured without 92this manual. If libev was configured without support for multiple event
40support for multiple event loops, then all functions taking an initial 93loops, then all functions taking an initial argument of name C<loop>
41argument of name C<loop> (which is always of type C<struct ev_loop *>) 94(which is always of type C<struct ev_loop *>) will not have this argument.
42will not have this argument.
43 95
44=head1 TIME REPRESENTATION 96=head1 TIME REPRESENTATION
45 97
46Libev represents time as a single floating point number, representing the 98Libev represents time as a single floating point number, representing the
47(fractional) number of seconds since the (POSIX) epoch (somewhere near 99(fractional) number of seconds since the (POSIX) epoch (somewhere near
48the beginning of 1970, details are complicated, don't ask). This type is 100the beginning of 1970, details are complicated, don't ask). This type is
49called C<ev_tstamp>, which is what you should use too. It usually aliases 101called C<ev_tstamp>, which is what you should use too. It usually aliases
50to the C<double> type in C, and when you need to do any calculations on 102to the C<double> type in C, and when you need to do any calculations on
51it, you should treat it as such. 103it, you should treat it as such.
52 104
53
54=head1 GLOBAL FUNCTIONS 105=head1 GLOBAL FUNCTIONS
55 106
56These functions can be called anytime, even before initialising the 107These functions can be called anytime, even before initialising the
57library in any way. 108library in any way.
58 109
77Usually, it's a good idea to terminate if the major versions mismatch, 128Usually, it's a good idea to terminate if the major versions mismatch,
78as this indicates an incompatible change. Minor versions are usually 129as this indicates an incompatible change. Minor versions are usually
79compatible to older versions, so a larger minor version alone is usually 130compatible to older versions, so a larger minor version alone is usually
80not a problem. 131not a problem.
81 132
82Example: make sure we haven't accidentally been linked against the wrong 133Example: Make sure we haven't accidentally been linked against the wrong
83version: 134version.
84 135
85 assert (("libev version mismatch", 136 assert (("libev version mismatch",
86 ev_version_major () == EV_VERSION_MAJOR 137 ev_version_major () == EV_VERSION_MAJOR
87 && ev_version_minor () >= EV_VERSION_MINOR)); 138 && ev_version_minor () >= EV_VERSION_MINOR));
88 139
118 169
119See the description of C<ev_embed> watchers for more info. 170See the description of C<ev_embed> watchers for more info.
120 171
121=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 172=item ev_set_allocator (void *(*cb)(void *ptr, long size))
122 173
123Sets the allocation function to use (the prototype is similar to the 174Sets the allocation function to use (the prototype is similar - the
124realloc C function, the semantics are identical). It is used to allocate 175semantics is identical - to the realloc C function). It is used to
125and free memory (no surprises here). If it returns zero when memory 176allocate and free memory (no surprises here). If it returns zero when
126needs to be allocated, the library might abort or take some potentially 177memory needs to be allocated, the library might abort or take some
127destructive action. The default is your system realloc function. 178potentially destructive action. The default is your system realloc
179function.
128 180
129You could override this function in high-availability programs to, say, 181You could override this function in high-availability programs to, say,
130free some memory if it cannot allocate memory, to use a special allocator, 182free some memory if it cannot allocate memory, to use a special allocator,
131or even to sleep a while and retry until some memory is available. 183or even to sleep a while and retry until some memory is available.
132 184
133Example: replace the libev allocator with one that waits a bit and then 185Example: Replace the libev allocator with one that waits a bit and then
134retries: better than mine). 186retries).
135 187
136 static void * 188 static void *
137 persistent_realloc (void *ptr, long size) 189 persistent_realloc (void *ptr, size_t size)
138 { 190 {
139 for (;;) 191 for (;;)
140 { 192 {
141 void *newptr = realloc (ptr, size); 193 void *newptr = realloc (ptr, size);
142 194
158callback is set, then libev will expect it to remedy the sitution, no 210callback is set, then libev will expect it to remedy the sitution, no
159matter what, when it returns. That is, libev will generally retry the 211matter what, when it returns. That is, libev will generally retry the
160requested operation, or, if the condition doesn't go away, do bad stuff 212requested operation, or, if the condition doesn't go away, do bad stuff
161(such as abort). 213(such as abort).
162 214
163Example: do the same thing as libev does internally: 215Example: This is basically the same thing that libev does internally, too.
164 216
165 static void 217 static void
166 fatal_error (const char *msg) 218 fatal_error (const char *msg)
167 { 219 {
168 perror (msg); 220 perror (msg);
218C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 270C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
219override the flags completely if it is found in the environment. This is 271override the flags completely if it is found in the environment. This is
220useful to try out specific backends to test their performance, or to work 272useful to try out specific backends to test their performance, or to work
221around bugs. 273around bugs.
222 274
275=item C<EVFLAG_FORKCHECK>
276
277Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after
278a fork, you can also make libev check for a fork in each iteration by
279enabling this flag.
280
281This works by calling C<getpid ()> on every iteration of the loop,
282and thus this might slow down your event loop if you do a lot of loop
283iterations and little real work, but is usually not noticeable (on my
284Linux system for example, C<getpid> is actually a simple 5-insn sequence
285without a syscall and thus I<very> fast, but my Linux system also has
286C<pthread_atfork> which is even faster).
287
288The big advantage of this flag is that you can forget about fork (and
289forget about forgetting to tell libev about forking) when you use this
290flag.
291
292This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>
293environment variable.
294
223=item C<EVBACKEND_SELECT> (value 1, portable select backend) 295=item C<EVBACKEND_SELECT> (value 1, portable select backend)
224 296
225This is your standard select(2) backend. Not I<completely> standard, as 297This is your standard select(2) backend. Not I<completely> standard, as
226libev tries to roll its own fd_set with no limits on the number of fds, 298libev tries to roll its own fd_set with no limits on the number of fds,
227but if that fails, expect a fairly low limit on the number of fds when 299but if that fails, expect a fairly low limit on the number of fds when
314Similar to C<ev_default_loop>, but always creates a new event loop that is 386Similar to C<ev_default_loop>, but always creates a new event loop that is
315always distinct from the default loop. Unlike the default loop, it cannot 387always distinct from the default loop. Unlike the default loop, it cannot
316handle signal and child watchers, and attempts to do so will be greeted by 388handle signal and child watchers, and attempts to do so will be greeted by
317undefined behaviour (or a failed assertion if assertions are enabled). 389undefined behaviour (or a failed assertion if assertions are enabled).
318 390
319Example: try to create a event loop that uses epoll and nothing else. 391Example: Try to create a event loop that uses epoll and nothing else.
320 392
321 struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 393 struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
322 if (!epoller) 394 if (!epoller)
323 fatal ("no epoll found here, maybe it hides under your chair"); 395 fatal ("no epoll found here, maybe it hides under your chair");
324 396
362 434
363Like C<ev_default_fork>, but acts on an event loop created by 435Like C<ev_default_fork>, but acts on an event loop created by
364C<ev_loop_new>. Yes, you have to call this on every allocated event loop 436C<ev_loop_new>. Yes, you have to call this on every allocated event loop
365after fork, and how you do this is entirely your own problem. 437after fork, and how you do this is entirely your own problem.
366 438
439=item unsigned int ev_loop_count (loop)
440
441Returns the count of loop iterations for the loop, which is identical to
442the number of times libev did poll for new events. It starts at C<0> and
443happily wraps around with enough iterations.
444
445This value can sometimes be useful as a generation counter of sorts (it
446"ticks" the number of loop iterations), as it roughly corresponds with
447C<ev_prepare> and C<ev_check> calls.
448
367=item unsigned int ev_backend (loop) 449=item unsigned int ev_backend (loop)
368 450
369Returns one of the C<EVBACKEND_*> flags indicating the event backend in 451Returns one of the C<EVBACKEND_*> flags indicating the event backend in
370use. 452use.
371 453
404libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is 486libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
405usually a better approach for this kind of thing. 487usually a better approach for this kind of thing.
406 488
407Here are the gory details of what C<ev_loop> does: 489Here are the gory details of what C<ev_loop> does:
408 490
491 - Before the first iteration, call any pending watchers.
409 * If there are no active watchers (reference count is zero), return. 492 * If there are no active watchers (reference count is zero), return.
410 - Queue prepare watchers and then call all outstanding watchers. 493 - Queue all prepare watchers and then call all outstanding watchers.
411 - If we have been forked, recreate the kernel state. 494 - If we have been forked, recreate the kernel state.
412 - Update the kernel state with all outstanding changes. 495 - Update the kernel state with all outstanding changes.
413 - Update the "event loop time". 496 - Update the "event loop time".
414 - Calculate for how long to block. 497 - Calculate for how long to block.
415 - Block the process, waiting for any events. 498 - Block the process, waiting for any events.
423 Signals and child watchers are implemented as I/O watchers, and will 506 Signals and child watchers are implemented as I/O watchers, and will
424 be handled here by queueing them when their watcher gets executed. 507 be handled here by queueing them when their watcher gets executed.
425 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 508 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
426 were used, return, otherwise continue with step *. 509 were used, return, otherwise continue with step *.
427 510
428Example: queue some jobs and then loop until no events are outsanding 511Example: Queue some jobs and then loop until no events are outsanding
429anymore. 512anymore.
430 513
431 ... queue jobs here, make sure they register event watchers as long 514 ... queue jobs here, make sure they register event watchers as long
432 ... as they still have work to do (even an idle watcher will do..) 515 ... as they still have work to do (even an idle watcher will do..)
433 ev_loop (my_loop, 0); 516 ev_loop (my_loop, 0);
453visible to the libev user and should not keep C<ev_loop> from exiting if 536visible to the libev user and should not keep C<ev_loop> from exiting if
454no event watchers registered by it are active. It is also an excellent 537no event watchers registered by it are active. It is also an excellent
455way to do this for generic recurring timers or from within third-party 538way to do this for generic recurring timers or from within third-party
456libraries. Just remember to I<unref after start> and I<ref before stop>. 539libraries. Just remember to I<unref after start> and I<ref before stop>.
457 540
458Example: create a signal watcher, but keep it from keeping C<ev_loop> 541Example: Create a signal watcher, but keep it from keeping C<ev_loop>
459running when nothing else is active. 542running when nothing else is active.
460 543
461 struct dv_signal exitsig; 544 struct ev_signal exitsig;
462 ev_signal_init (&exitsig, sig_cb, SIGINT); 545 ev_signal_init (&exitsig, sig_cb, SIGINT);
463 ev_signal_start (myloop, &exitsig); 546 ev_signal_start (loop, &exitsig);
464 evf_unref (myloop); 547 evf_unref (loop);
465 548
466Example: for some weird reason, unregister the above signal handler again. 549Example: For some weird reason, unregister the above signal handler again.
467 550
468 ev_ref (myloop); 551 ev_ref (loop);
469 ev_signal_stop (myloop, &exitsig); 552 ev_signal_stop (loop, &exitsig);
470 553
471=back 554=back
472 555
473 556
474=head1 ANATOMY OF A WATCHER 557=head1 ANATOMY OF A WATCHER
565received events. Callbacks of both watcher types can start and stop as 648received events. Callbacks of both watcher types can start and stop as
566many watchers as they want, and all of them will be taken into account 649many watchers as they want, and all of them will be taken into account
567(for example, a C<ev_prepare> watcher might start an idle watcher to keep 650(for example, a C<ev_prepare> watcher might start an idle watcher to keep
568C<ev_loop> from blocking). 651C<ev_loop> from blocking).
569 652
653=item C<EV_EMBED>
654
655The embedded event loop specified in the C<ev_embed> watcher needs attention.
656
657=item C<EV_FORK>
658
659The event loop has been resumed in the child process after fork (see
660C<ev_fork>).
661
570=item C<EV_ERROR> 662=item C<EV_ERROR>
571 663
572An unspecified error has occured, the watcher has been stopped. This might 664An unspecified error has occured, the watcher has been stopped. This might
573happen because the watcher could not be properly started because libev 665happen because the watcher could not be properly started because libev
574ran out of memory, a file descriptor was found to be closed or any other 666ran out of memory, a file descriptor was found to be closed or any other
645=item bool ev_is_pending (ev_TYPE *watcher) 737=item bool ev_is_pending (ev_TYPE *watcher)
646 738
647Returns a true value iff the watcher is pending, (i.e. it has outstanding 739Returns a true value iff the watcher is pending, (i.e. it has outstanding
648events but its callback has not yet been invoked). As long as a watcher 740events but its callback has not yet been invoked). As long as a watcher
649is pending (but not active) you must not call an init function on it (but 741is pending (but not active) you must not call an init function on it (but
650C<ev_TYPE_set> is safe) and you must make sure the watcher is available to 742C<ev_TYPE_set> is safe), you must not change its priority, and you must
651libev (e.g. you cnanot C<free ()> it). 743make sure the watcher is available to libev (e.g. you cannot C<free ()>
744it).
652 745
653=item callback = ev_cb (ev_TYPE *watcher) 746=item callback ev_cb (ev_TYPE *watcher)
654 747
655Returns the callback currently set on the watcher. 748Returns the callback currently set on the watcher.
656 749
657=item ev_cb_set (ev_TYPE *watcher, callback) 750=item ev_cb_set (ev_TYPE *watcher, callback)
658 751
659Change the callback. You can change the callback at virtually any time 752Change the callback. You can change the callback at virtually any time
660(modulo threads). 753(modulo threads).
754
755=item ev_set_priority (ev_TYPE *watcher, priority)
756
757=item int ev_priority (ev_TYPE *watcher)
758
759Set and query the priority of the watcher. The priority is a small
760integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
761(default: C<-2>). Pending watchers with higher priority will be invoked
762before watchers with lower priority, but priority will not keep watchers
763from being executed (except for C<ev_idle> watchers).
764
765This means that priorities are I<only> used for ordering callback
766invocation after new events have been received. This is useful, for
767example, to reduce latency after idling, or more often, to bind two
768watchers on the same event and make sure one is called first.
769
770If you need to suppress invocation when higher priority events are pending
771you need to look at C<ev_idle> watchers, which provide this functionality.
772
773You I<must not> change the priority of a watcher as long as it is active or
774pending.
775
776The default priority used by watchers when no priority has been set is
777always C<0>, which is supposed to not be too high and not be too low :).
778
779Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
780fine, as long as you do not mind that the priority value you query might
781or might not have been adjusted to be within valid range.
782
783=item ev_invoke (loop, ev_TYPE *watcher, int revents)
784
785Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
786C<loop> nor C<revents> need to be valid as long as the watcher callback
787can deal with that fact.
788
789=item int ev_clear_pending (loop, ev_TYPE *watcher)
790
791If the watcher is pending, this function returns clears its pending status
792and returns its C<revents> bitset (as if its callback was invoked). If the
793watcher isn't pending it does nothing and returns C<0>.
661 794
662=back 795=back
663 796
664 797
665=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER 798=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
686 { 819 {
687 struct my_io *w = (struct my_io *)w_; 820 struct my_io *w = (struct my_io *)w_;
688 ... 821 ...
689 } 822 }
690 823
691More interesting and less C-conformant ways of catsing your callback type 824More interesting and less C-conformant ways of casting your callback type
692have been omitted.... 825instead have been omitted.
826
827Another common scenario is having some data structure with multiple
828watchers:
829
830 struct my_biggy
831 {
832 int some_data;
833 ev_timer t1;
834 ev_timer t2;
835 }
836
837In this case getting the pointer to C<my_biggy> is a bit more complicated,
838you need to use C<offsetof>:
839
840 #include <stddef.h>
841
842 static void
843 t1_cb (EV_P_ struct ev_timer *w, int revents)
844 {
845 struct my_biggy big = (struct my_biggy *
846 (((char *)w) - offsetof (struct my_biggy, t1));
847 }
848
849 static void
850 t2_cb (EV_P_ struct ev_timer *w, int revents)
851 {
852 struct my_biggy big = (struct my_biggy *
853 (((char *)w) - offsetof (struct my_biggy, t2));
854 }
693 855
694 856
695=head1 WATCHER TYPES 857=head1 WATCHER TYPES
696 858
697This section describes each watcher in detail, but will not repeat 859This section describes each watcher in detail, but will not repeat
742it is best to always use non-blocking I/O: An extra C<read>(2) returning 904it is best to always use non-blocking I/O: An extra C<read>(2) returning
743C<EAGAIN> is far preferable to a program hanging until some data arrives. 905C<EAGAIN> is far preferable to a program hanging until some data arrives.
744 906
745If you cannot run the fd in non-blocking mode (for example you should not 907If you cannot run the fd in non-blocking mode (for example you should not
746play around with an Xlib connection), then you have to seperately re-test 908play around with an Xlib connection), then you have to seperately re-test
747wether a file descriptor is really ready with a known-to-be good interface 909whether a file descriptor is really ready with a known-to-be good interface
748such as poll (fortunately in our Xlib example, Xlib already does this on 910such as poll (fortunately in our Xlib example, Xlib already does this on
749its own, so its quite safe to use). 911its own, so its quite safe to use).
750 912
751=over 4 913=over 4
752 914
766 928
767The events being watched. 929The events being watched.
768 930
769=back 931=back
770 932
771Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well 933Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
772readable, but only once. Since it is likely line-buffered, you could 934readable, but only once. Since it is likely line-buffered, you could
773attempt to read a whole line in the callback: 935attempt to read a whole line in the callback.
774 936
775 static void 937 static void
776 stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 938 stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
777 { 939 {
778 ev_io_stop (loop, w); 940 ev_io_stop (loop, w);
830=item ev_timer_again (loop) 992=item ev_timer_again (loop)
831 993
832This will act as if the timer timed out and restart it again if it is 994This will act as if the timer timed out and restart it again if it is
833repeating. The exact semantics are: 995repeating. The exact semantics are:
834 996
997If the timer is pending, its pending status is cleared.
998
835If the timer is started but nonrepeating, stop it. 999If the timer is started but nonrepeating, stop it (as if it timed out).
836 1000
837If the timer is repeating, either start it if necessary (with the repeat 1001If the timer is repeating, either start it if necessary (with the
838value), or reset the running timer to the repeat value. 1002C<repeat> value), or reset the running timer to the C<repeat> value.
839 1003
840This sounds a bit complicated, but here is a useful and typical 1004This sounds a bit complicated, but here is a useful and typical
841example: Imagine you have a tcp connection and you want a so-called 1005example: Imagine you have a tcp connection and you want a so-called idle
842idle timeout, that is, you want to be called when there have been, 1006timeout, that is, you want to be called when there have been, say, 60
843say, 60 seconds of inactivity on the socket. The easiest way to do 1007seconds of inactivity on the socket. The easiest way to do this is to
844this is to configure an C<ev_timer> with C<after>=C<repeat>=C<60> and calling 1008configure an C<ev_timer> with a C<repeat> value of C<60> and then call
845C<ev_timer_again> each time you successfully read or write some data. If 1009C<ev_timer_again> each time you successfully read or write some data. If
846you go into an idle state where you do not expect data to travel on the 1010you go into an idle state where you do not expect data to travel on the
847socket, you can stop the timer, and again will automatically restart it if 1011socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
848need be. 1012automatically restart it if need be.
849 1013
850You can also ignore the C<after> value and C<ev_timer_start> altogether 1014That means you can ignore the C<after> value and C<ev_timer_start>
851and only ever use the C<repeat> value: 1015altogether and only ever use the C<repeat> value and C<ev_timer_again>:
852 1016
853 ev_timer_init (timer, callback, 0., 5.); 1017 ev_timer_init (timer, callback, 0., 5.);
854 ev_timer_again (loop, timer); 1018 ev_timer_again (loop, timer);
855 ... 1019 ...
856 timer->again = 17.; 1020 timer->again = 17.;
857 ev_timer_again (loop, timer); 1021 ev_timer_again (loop, timer);
858 ... 1022 ...
859 timer->again = 10.; 1023 timer->again = 10.;
860 ev_timer_again (loop, timer); 1024 ev_timer_again (loop, timer);
861 1025
862This is more efficient then stopping/starting the timer eahc time you want 1026This is more slightly efficient then stopping/starting the timer each time
863to modify its timeout value. 1027you want to modify its timeout value.
864 1028
865=item ev_tstamp repeat [read-write] 1029=item ev_tstamp repeat [read-write]
866 1030
867The current C<repeat> value. Will be used each time the watcher times out 1031The current C<repeat> value. Will be used each time the watcher times out
868or C<ev_timer_again> is called and determines the next timeout (if any), 1032or C<ev_timer_again> is called and determines the next timeout (if any),
869which is also when any modifications are taken into account. 1033which is also when any modifications are taken into account.
870 1034
871=back 1035=back
872 1036
873Example: create a timer that fires after 60 seconds. 1037Example: Create a timer that fires after 60 seconds.
874 1038
875 static void 1039 static void
876 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1040 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
877 { 1041 {
878 .. one minute over, w is actually stopped right here 1042 .. one minute over, w is actually stopped right here
880 1044
881 struct ev_timer mytimer; 1045 struct ev_timer mytimer;
882 ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 1046 ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
883 ev_timer_start (loop, &mytimer); 1047 ev_timer_start (loop, &mytimer);
884 1048
885Example: create a timeout timer that times out after 10 seconds of 1049Example: Create a timeout timer that times out after 10 seconds of
886inactivity. 1050inactivity.
887 1051
888 static void 1052 static void
889 timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1053 timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
890 { 1054 {
910but on wallclock time (absolute time). You can tell a periodic watcher 1074but on wallclock time (absolute time). You can tell a periodic watcher
911to trigger "at" some specific point in time. For example, if you tell a 1075to trigger "at" some specific point in time. For example, if you tell a
912periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now () 1076periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
913+ 10.>) and then reset your system clock to the last year, then it will 1077+ 10.>) and then reset your system clock to the last year, then it will
914take a year to trigger the event (unlike an C<ev_timer>, which would trigger 1078take a year to trigger the event (unlike an C<ev_timer>, which would trigger
915roughly 10 seconds later and of course not if you reset your system time 1079roughly 10 seconds later).
916again).
917 1080
918They can also be used to implement vastly more complex timers, such as 1081They can also be used to implement vastly more complex timers, such as
919triggering an event on eahc midnight, local time. 1082triggering an event on each midnight, local time or other, complicated,
1083rules.
920 1084
921As with timers, the callback is guarenteed to be invoked only when the 1085As with timers, the callback is guarenteed to be invoked only when the
922time (C<at>) has been passed, but if multiple periodic timers become ready 1086time (C<at>) has been passed, but if multiple periodic timers become ready
923during the same loop iteration then order of execution is undefined. 1087during the same loop iteration then order of execution is undefined.
924 1088
931Lots of arguments, lets sort it out... There are basically three modes of 1095Lots of arguments, lets sort it out... There are basically three modes of
932operation, and we will explain them from simplest to complex: 1096operation, and we will explain them from simplest to complex:
933 1097
934=over 4 1098=over 4
935 1099
936=item * absolute timer (interval = reschedule_cb = 0) 1100=item * absolute timer (at = time, interval = reschedule_cb = 0)
937 1101
938In this configuration the watcher triggers an event at the wallclock time 1102In this configuration the watcher triggers an event at the wallclock time
939C<at> and doesn't repeat. It will not adjust when a time jump occurs, 1103C<at> and doesn't repeat. It will not adjust when a time jump occurs,
940that is, if it is to be run at January 1st 2011 then it will run when the 1104that is, if it is to be run at January 1st 2011 then it will run when the
941system time reaches or surpasses this time. 1105system time reaches or surpasses this time.
942 1106
943=item * non-repeating interval timer (interval > 0, reschedule_cb = 0) 1107=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
944 1108
945In this mode the watcher will always be scheduled to time out at the next 1109In this mode the watcher will always be scheduled to time out at the next
946C<at + N * interval> time (for some integer N) and then repeat, regardless 1110C<at + N * interval> time (for some integer N, which can also be negative)
947of any time jumps. 1111and then repeat, regardless of any time jumps.
948 1112
949This can be used to create timers that do not drift with respect to system 1113This can be used to create timers that do not drift with respect to system
950time: 1114time:
951 1115
952 ev_periodic_set (&periodic, 0., 3600., 0); 1116 ev_periodic_set (&periodic, 0., 3600., 0);
958 1122
959Another way to think about it (for the mathematically inclined) is that 1123Another way to think about it (for the mathematically inclined) is that
960C<ev_periodic> will try to run the callback in this mode at the next possible 1124C<ev_periodic> will try to run the callback in this mode at the next possible
961time where C<time = at (mod interval)>, regardless of any time jumps. 1125time where C<time = at (mod interval)>, regardless of any time jumps.
962 1126
1127For numerical stability it is preferable that the C<at> value is near
1128C<ev_now ()> (the current time), but there is no range requirement for
1129this value.
1130
963=item * manual reschedule mode (reschedule_cb = callback) 1131=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
964 1132
965In this mode the values for C<interval> and C<at> are both being 1133In this mode the values for C<interval> and C<at> are both being
966ignored. Instead, each time the periodic watcher gets scheduled, the 1134ignored. Instead, each time the periodic watcher gets scheduled, the
967reschedule callback will be called with the watcher as first, and the 1135reschedule callback will be called with the watcher as first, and the
968current time as second argument. 1136current time as second argument.
969 1137
970NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, 1138NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
971ever, or make any event loop modifications>. If you need to stop it, 1139ever, or make any event loop modifications>. If you need to stop it,
972return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by 1140return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
973starting a prepare watcher). 1141starting an C<ev_prepare> watcher, which is legal).
974 1142
975Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 1143Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
976ev_tstamp now)>, e.g.: 1144ev_tstamp now)>, e.g.:
977 1145
978 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 1146 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
1001Simply stops and restarts the periodic watcher again. This is only useful 1169Simply stops and restarts the periodic watcher again. This is only useful
1002when you changed some parameters or the reschedule callback would return 1170when you changed some parameters or the reschedule callback would return
1003a different time than the last time it was called (e.g. in a crond like 1171a different time than the last time it was called (e.g. in a crond like
1004program when the crontabs have changed). 1172program when the crontabs have changed).
1005 1173
1174=item ev_tstamp offset [read-write]
1175
1176When repeating, this contains the offset value, otherwise this is the
1177absolute point in time (the C<at> value passed to C<ev_periodic_set>).
1178
1179Can be modified any time, but changes only take effect when the periodic
1180timer fires or C<ev_periodic_again> is being called.
1181
1006=item ev_tstamp interval [read-write] 1182=item ev_tstamp interval [read-write]
1007 1183
1008The current interval value. Can be modified any time, but changes only 1184The current interval value. Can be modified any time, but changes only
1009take effect when the periodic timer fires or C<ev_periodic_again> is being 1185take effect when the periodic timer fires or C<ev_periodic_again> is being
1010called. 1186called.
1015switched off. Can be changed any time, but changes only take effect when 1191switched off. Can be changed any time, but changes only take effect when
1016the periodic timer fires or C<ev_periodic_again> is being called. 1192the periodic timer fires or C<ev_periodic_again> is being called.
1017 1193
1018=back 1194=back
1019 1195
1020Example: call a callback every hour, or, more precisely, whenever the 1196Example: Call a callback every hour, or, more precisely, whenever the
1021system clock is divisible by 3600. The callback invocation times have 1197system clock is divisible by 3600. The callback invocation times have
1022potentially a lot of jittering, but good long-term stability. 1198potentially a lot of jittering, but good long-term stability.
1023 1199
1024 static void 1200 static void
1025 clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1201 clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1029 1205
1030 struct ev_periodic hourly_tick; 1206 struct ev_periodic hourly_tick;
1031 ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 1207 ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1032 ev_periodic_start (loop, &hourly_tick); 1208 ev_periodic_start (loop, &hourly_tick);
1033 1209
1034Example: the same as above, but use a reschedule callback to do it: 1210Example: The same as above, but use a reschedule callback to do it:
1035 1211
1036 #include <math.h> 1212 #include <math.h>
1037 1213
1038 static ev_tstamp 1214 static ev_tstamp
1039 my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 1215 my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
1041 return fmod (now, 3600.) + 3600.; 1217 return fmod (now, 3600.) + 3600.;
1042 } 1218 }
1043 1219
1044 ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1220 ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1045 1221
1046Example: call a callback every hour, starting now: 1222Example: Call a callback every hour, starting now:
1047 1223
1048 struct ev_periodic hourly_tick; 1224 struct ev_periodic hourly_tick;
1049 ev_periodic_init (&hourly_tick, clock_cb, 1225 ev_periodic_init (&hourly_tick, clock_cb,
1050 fmod (ev_now (loop), 3600.), 3600., 0); 1226 fmod (ev_now (loop), 3600.), 3600., 0);
1051 ev_periodic_start (loop, &hourly_tick); 1227 ev_periodic_start (loop, &hourly_tick);
1112The process exit/trace status caused by C<rpid> (see your systems 1288The process exit/trace status caused by C<rpid> (see your systems
1113C<waitpid> and C<sys/wait.h> documentation for details). 1289C<waitpid> and C<sys/wait.h> documentation for details).
1114 1290
1115=back 1291=back
1116 1292
1117Example: try to exit cleanly on SIGINT and SIGTERM. 1293Example: Try to exit cleanly on SIGINT and SIGTERM.
1118 1294
1119 static void 1295 static void
1120 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1296 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1121 { 1297 {
1122 ev_unloop (loop, EVUNLOOP_ALL); 1298 ev_unloop (loop, EVUNLOOP_ALL);
1137not exist" is a status change like any other. The condition "path does 1313not exist" is a status change like any other. The condition "path does
1138not exist" is signified by the C<st_nlink> field being zero (which is 1314not exist" is signified by the C<st_nlink> field being zero (which is
1139otherwise always forced to be at least one) and all the other fields of 1315otherwise always forced to be at least one) and all the other fields of
1140the stat buffer having unspecified contents. 1316the stat buffer having unspecified contents.
1141 1317
1318The path I<should> be absolute and I<must not> end in a slash. If it is
1319relative and your working directory changes, the behaviour is undefined.
1320
1142Since there is no standard to do this, the portable implementation simply 1321Since there is no standard to do this, the portable implementation simply
1143calls C<stat (2)> regulalry on the path to see if it changed somehow. You 1322calls C<stat (2)> regularly on the path to see if it changed somehow. You
1144can specify a recommended polling interval for this case. If you specify 1323can specify a recommended polling interval for this case. If you specify
1145a polling interval of C<0> (highly recommended!) then a I<suitable, 1324a polling interval of C<0> (highly recommended!) then a I<suitable,
1146unspecified default> value will be used (which you can expect to be around 1325unspecified default> value will be used (which you can expect to be around
1147five seconds, although this might change dynamically). Libev will also 1326five seconds, although this might change dynamically). Libev will also
1148impose a minimum interval which is currently around C<0.1>, but thats 1327impose a minimum interval which is currently around C<0.1>, but thats
1150 1329
1151This watcher type is not meant for massive numbers of stat watchers, 1330This watcher type is not meant for massive numbers of stat watchers,
1152as even with OS-supported change notifications, this can be 1331as even with OS-supported change notifications, this can be
1153resource-intensive. 1332resource-intensive.
1154 1333
1155At the time of this writing, no specific OS backends are implemented, but 1334At the time of this writing, only the Linux inotify interface is
1156if demand increases, at least a kqueue and inotify backend will be added. 1335implemented (implementing kqueue support is left as an exercise for the
1336reader). Inotify will be used to give hints only and should not change the
1337semantics of C<ev_stat> watchers, which means that libev sometimes needs
1338to fall back to regular polling again even with inotify, but changes are
1339usually detected immediately, and if the file exists there will be no
1340polling.
1157 1341
1158=over 4 1342=over 4
1159 1343
1160=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) 1344=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
1161 1345
1225 ev_stat_start (loop, &passwd); 1409 ev_stat_start (loop, &passwd);
1226 1410
1227 1411
1228=head2 C<ev_idle> - when you've got nothing better to do... 1412=head2 C<ev_idle> - when you've got nothing better to do...
1229 1413
1230Idle watchers trigger events when there are no other events are pending 1414Idle watchers trigger events when no other events of the same or higher
1231(prepare, check and other idle watchers do not count). That is, as long 1415priority are pending (prepare, check and other idle watchers do not
1232as your process is busy handling sockets or timeouts (or even signals, 1416count).
1233imagine) it will not be triggered. But when your process is idle all idle 1417
1234watchers are being called again and again, once per event loop iteration - 1418That is, as long as your process is busy handling sockets or timeouts
1419(or even signals, imagine) of the same or higher priority it will not be
1420triggered. But when your process is idle (or only lower-priority watchers
1421are pending), the idle watchers are being called once per event loop
1235until stopped, that is, or your process receives more events and becomes 1422iteration - until stopped, that is, or your process receives more events
1236busy. 1423and becomes busy again with higher priority stuff.
1237 1424
1238The most noteworthy effect is that as long as any idle watchers are 1425The most noteworthy effect is that as long as any idle watchers are
1239active, the process will not block when waiting for new events. 1426active, the process will not block when waiting for new events.
1240 1427
1241Apart from keeping your process non-blocking (which is a useful 1428Apart from keeping your process non-blocking (which is a useful
1251kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 1438kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1252believe me. 1439believe me.
1253 1440
1254=back 1441=back
1255 1442
1256Example: dynamically allocate an C<ev_idle>, start it, and in the 1443Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1257callback, free it. Alos, use no error checking, as usual. 1444callback, free it. Also, use no error checking, as usual.
1258 1445
1259 static void 1446 static void
1260 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1447 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1261 { 1448 {
1262 free (w); 1449 free (w);
1307with priority higher than or equal to the event loop and one coroutine 1494with priority higher than or equal to the event loop and one coroutine
1308of lower priority, but only once, using idle watchers to keep the event 1495of lower priority, but only once, using idle watchers to keep the event
1309loop from blocking if lower-priority coroutines are active, thus mapping 1496loop from blocking if lower-priority coroutines are active, thus mapping
1310low-priority coroutines to idle/background tasks). 1497low-priority coroutines to idle/background tasks).
1311 1498
1499It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1500priority, to ensure that they are being run before any other watchers
1501after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1502too) should not activate ("feed") events into libev. While libev fully
1503supports this, they will be called before other C<ev_check> watchers did
1504their job. As C<ev_check> watchers are often used to embed other event
1505loops those other event loops might be in an unusable state until their
1506C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1507others).
1508
1312=over 4 1509=over 4
1313 1510
1314=item ev_prepare_init (ev_prepare *, callback) 1511=item ev_prepare_init (ev_prepare *, callback)
1315 1512
1316=item ev_check_init (ev_check *, callback) 1513=item ev_check_init (ev_check *, callback)
1319parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1516parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1320macros, but using them is utterly, utterly and completely pointless. 1517macros, but using them is utterly, utterly and completely pointless.
1321 1518
1322=back 1519=back
1323 1520
1324Example: To include a library such as adns, you would add IO watchers 1521There are a number of principal ways to embed other event loops or modules
1325and a timeout watcher in a prepare handler, as required by libadns, and 1522into libev. Here are some ideas on how to include libadns into libev
1523(there is a Perl module named C<EV::ADNS> that does this, which you could
1524use for an actually working example. Another Perl module named C<EV::Glib>
1525embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
1526into the Glib event loop).
1527
1528Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1326in a check watcher, destroy them and call into libadns. What follows is 1529and in a check watcher, destroy them and call into libadns. What follows
1327pseudo-code only of course: 1530is pseudo-code only of course. This requires you to either use a low
1531priority for the check watcher or use C<ev_clear_pending> explicitly, as
1532the callbacks for the IO/timeout watchers might not have been called yet.
1328 1533
1329 static ev_io iow [nfd]; 1534 static ev_io iow [nfd];
1330 static ev_timer tw; 1535 static ev_timer tw;
1331 1536
1332 static void 1537 static void
1333 io_cb (ev_loop *loop, ev_io *w, int revents) 1538 io_cb (ev_loop *loop, ev_io *w, int revents)
1334 { 1539 {
1335 // set the relevant poll flags
1336 // could also call adns_processreadable etc. here
1337 struct pollfd *fd = (struct pollfd *)w->data;
1338 if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1339 if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1340 } 1540 }
1341 1541
1342 // create io watchers for each fd and a timer before blocking 1542 // create io watchers for each fd and a timer before blocking
1343 static void 1543 static void
1344 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 1544 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1345 { 1545 {
1346 int timeout = 3600000;truct pollfd fds [nfd]; 1546 int timeout = 3600000;
1547 struct pollfd fds [nfd];
1347 // actual code will need to loop here and realloc etc. 1548 // actual code will need to loop here and realloc etc.
1348 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 1549 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1349 1550
1350 /* the callback is illegal, but won't be called as we stop during check */ 1551 /* the callback is illegal, but won't be called as we stop during check */
1351 ev_timer_init (&tw, 0, timeout * 1e-3); 1552 ev_timer_init (&tw, 0, timeout * 1e-3);
1352 ev_timer_start (loop, &tw); 1553 ev_timer_start (loop, &tw);
1353 1554
1354 // create on ev_io per pollfd 1555 // create one ev_io per pollfd
1355 for (int i = 0; i < nfd; ++i) 1556 for (int i = 0; i < nfd; ++i)
1356 { 1557 {
1357 ev_io_init (iow + i, io_cb, fds [i].fd, 1558 ev_io_init (iow + i, io_cb, fds [i].fd,
1358 ((fds [i].events & POLLIN ? EV_READ : 0) 1559 ((fds [i].events & POLLIN ? EV_READ : 0)
1359 | (fds [i].events & POLLOUT ? EV_WRITE : 0))); 1560 | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1360 1561
1361 fds [i].revents = 0; 1562 fds [i].revents = 0;
1362 iow [i].data = fds + i;
1363 ev_io_start (loop, iow + i); 1563 ev_io_start (loop, iow + i);
1364 } 1564 }
1365 } 1565 }
1366 1566
1367 // stop all watchers after blocking 1567 // stop all watchers after blocking
1369 adns_check_cb (ev_loop *loop, ev_check *w, int revents) 1569 adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1370 { 1570 {
1371 ev_timer_stop (loop, &tw); 1571 ev_timer_stop (loop, &tw);
1372 1572
1373 for (int i = 0; i < nfd; ++i) 1573 for (int i = 0; i < nfd; ++i)
1574 {
1575 // set the relevant poll flags
1576 // could also call adns_processreadable etc. here
1577 struct pollfd *fd = fds + i;
1578 int revents = ev_clear_pending (iow + i);
1579 if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1580 if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1581
1582 // now stop the watcher
1374 ev_io_stop (loop, iow + i); 1583 ev_io_stop (loop, iow + i);
1584 }
1375 1585
1376 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); 1586 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1587 }
1588
1589Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1590in the prepare watcher and would dispose of the check watcher.
1591
1592Method 3: If the module to be embedded supports explicit event
1593notification (adns does), you can also make use of the actual watcher
1594callbacks, and only destroy/create the watchers in the prepare watcher.
1595
1596 static void
1597 timer_cb (EV_P_ ev_timer *w, int revents)
1598 {
1599 adns_state ads = (adns_state)w->data;
1600 update_now (EV_A);
1601
1602 adns_processtimeouts (ads, &tv_now);
1603 }
1604
1605 static void
1606 io_cb (EV_P_ ev_io *w, int revents)
1607 {
1608 adns_state ads = (adns_state)w->data;
1609 update_now (EV_A);
1610
1611 if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1612 if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1613 }
1614
1615 // do not ever call adns_afterpoll
1616
1617Method 4: Do not use a prepare or check watcher because the module you
1618want to embed is too inflexible to support it. Instead, youc na override
1619their poll function. The drawback with this solution is that the main
1620loop is now no longer controllable by EV. The C<Glib::EV> module does
1621this.
1622
1623 static gint
1624 event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1625 {
1626 int got_events = 0;
1627
1628 for (n = 0; n < nfds; ++n)
1629 // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1630
1631 if (timeout >= 0)
1632 // create/start timer
1633
1634 // poll
1635 ev_loop (EV_A_ 0);
1636
1637 // stop timer again
1638 if (timeout >= 0)
1639 ev_timer_stop (EV_A_ &to);
1640
1641 // stop io watchers again - their callbacks should have set
1642 for (n = 0; n < nfds; ++n)
1643 ev_io_stop (EV_A_ iow [n]);
1644
1645 return got_events;
1377 } 1646 }
1378 1647
1379 1648
1380=head2 C<ev_embed> - when one backend isn't enough... 1649=head2 C<ev_embed> - when one backend isn't enough...
1381 1650
1470The embedded event loop. 1739The embedded event loop.
1471 1740
1472=back 1741=back
1473 1742
1474 1743
1744=head2 C<ev_fork> - the audacity to resume the event loop after a fork
1745
1746Fork watchers are called when a C<fork ()> was detected (usually because
1747whoever is a good citizen cared to tell libev about it by calling
1748C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the
1749event loop blocks next and before C<ev_check> watchers are being called,
1750and only in the child after the fork. If whoever good citizen calling
1751C<ev_default_fork> cheats and calls it in the wrong process, the fork
1752handlers will be invoked, too, of course.
1753
1754=over 4
1755
1756=item ev_fork_init (ev_signal *, callback)
1757
1758Initialises and configures the fork watcher - it has no parameters of any
1759kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
1760believe me.
1761
1762=back
1763
1764
1475=head1 OTHER FUNCTIONS 1765=head1 OTHER FUNCTIONS
1476 1766
1477There are some other functions of possible interest. Described. Here. Now. 1767There are some other functions of possible interest. Described. Here. Now.
1478 1768
1479=over 4 1769=over 4
1564 1854
1565To use it, 1855To use it,
1566 1856
1567 #include <ev++.h> 1857 #include <ev++.h>
1568 1858
1569(it is not installed by default). This automatically includes F<ev.h> 1859This automatically includes F<ev.h> and puts all of its definitions (many
1570and puts all of its definitions (many of them macros) into the global 1860of them macros) into the global namespace. All C++ specific things are
1571namespace. All C++ specific things are put into the C<ev> namespace. 1861put into the C<ev> namespace. It should support all the same embedding
1862options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1572 1863
1573It should support all the same embedding options as F<ev.h>, most notably 1864Care has been taken to keep the overhead low. The only data member the C++
1574C<EV_MULTIPLICITY>. 1865classes add (compared to plain C-style watchers) is the event loop pointer
1866that the watcher is associated with (or no additional members at all if
1867you disable C<EV_MULTIPLICITY> when embedding libev).
1868
1869Currently, functions, and static and non-static member functions can be
1870used as callbacks. Other types should be easy to add as long as they only
1871need one additional pointer for context. If you need support for other
1872types of functors please contact the author (preferably after implementing
1873it).
1575 1874
1576Here is a list of things available in the C<ev> namespace: 1875Here is a list of things available in the C<ev> namespace:
1577 1876
1578=over 4 1877=over 4
1579 1878
1595 1894
1596All of those classes have these methods: 1895All of those classes have these methods:
1597 1896
1598=over 4 1897=over 4
1599 1898
1600=item ev::TYPE::TYPE (object *, object::method *) 1899=item ev::TYPE::TYPE ()
1601 1900
1602=item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *) 1901=item ev::TYPE::TYPE (struct ev_loop *)
1603 1902
1604=item ev::TYPE::~TYPE 1903=item ev::TYPE::~TYPE
1605 1904
1606The constructor takes a pointer to an object and a method pointer to 1905The constructor (optionally) takes an event loop to associate the watcher
1607the event handler callback to call in this class. The constructor calls 1906with. If it is omitted, it will use C<EV_DEFAULT>.
1608C<ev_init> for you, which means you have to call the C<set> method 1907
1609before starting it. If you do not specify a loop then the constructor 1908The constructor calls C<ev_init> for you, which means you have to call the
1610automatically associates the default loop with this watcher. 1909C<set> method before starting it.
1910
1911It will not set a callback, however: You have to call the templated C<set>
1912method to set a callback before you can start the watcher.
1913
1914(The reason why you have to use a method is a limitation in C++ which does
1915not allow explicit template arguments for constructors).
1611 1916
1612The destructor automatically stops the watcher if it is active. 1917The destructor automatically stops the watcher if it is active.
1918
1919=item w->set<class, &class::method> (object *)
1920
1921This method sets the callback method to call. The method has to have a
1922signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
1923first argument and the C<revents> as second. The object must be given as
1924parameter and is stored in the C<data> member of the watcher.
1925
1926This method synthesizes efficient thunking code to call your method from
1927the C callback that libev requires. If your compiler can inline your
1928callback (i.e. it is visible to it at the place of the C<set> call and
1929your compiler is good :), then the method will be fully inlined into the
1930thunking function, making it as fast as a direct C callback.
1931
1932Example: simple class declaration and watcher initialisation
1933
1934 struct myclass
1935 {
1936 void io_cb (ev::io &w, int revents) { }
1937 }
1938
1939 myclass obj;
1940 ev::io iow;
1941 iow.set <myclass, &myclass::io_cb> (&obj);
1942
1943=item w->set<function> (void *data = 0)
1944
1945Also sets a callback, but uses a static method or plain function as
1946callback. The optional C<data> argument will be stored in the watcher's
1947C<data> member and is free for you to use.
1948
1949The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
1950
1951See the method-C<set> above for more details.
1952
1953Example:
1954
1955 static void io_cb (ev::io &w, int revents) { }
1956 iow.set <io_cb> ();
1613 1957
1614=item w->set (struct ev_loop *) 1958=item w->set (struct ev_loop *)
1615 1959
1616Associates a different C<struct ev_loop> with this watcher. You can only 1960Associates a different C<struct ev_loop> with this watcher. You can only
1617do this when the watcher is inactive (and not pending either). 1961do this when the watcher is inactive (and not pending either).
1618 1962
1619=item w->set ([args]) 1963=item w->set ([args])
1620 1964
1621Basically the same as C<ev_TYPE_set>, with the same args. Must be 1965Basically the same as C<ev_TYPE_set>, with the same args. Must be
1622called at least once. Unlike the C counterpart, an active watcher gets 1966called at least once. Unlike the C counterpart, an active watcher gets
1623automatically stopped and restarted. 1967automatically stopped and restarted when reconfiguring it with this
1968method.
1624 1969
1625=item w->start () 1970=item w->start ()
1626 1971
1627Starts the watcher. Note that there is no C<loop> argument as the 1972Starts the watcher. Note that there is no C<loop> argument, as the
1628constructor already takes the loop. 1973constructor already stores the event loop.
1629 1974
1630=item w->stop () 1975=item w->stop ()
1631 1976
1632Stops the watcher if it is active. Again, no C<loop> argument. 1977Stops the watcher if it is active. Again, no C<loop> argument.
1633 1978
1638 1983
1639=item w->sweep () C<ev::embed> only 1984=item w->sweep () C<ev::embed> only
1640 1985
1641Invokes C<ev_embed_sweep>. 1986Invokes C<ev_embed_sweep>.
1642 1987
1988=item w->update () C<ev::stat> only
1989
1990Invokes C<ev_stat_stat>.
1991
1643=back 1992=back
1644 1993
1645=back 1994=back
1646 1995
1647Example: Define a class with an IO and idle watcher, start one of them in 1996Example: Define a class with an IO and idle watcher, start one of them in
1654 2003
1655 myclass (); 2004 myclass ();
1656 } 2005 }
1657 2006
1658 myclass::myclass (int fd) 2007 myclass::myclass (int fd)
1659 : io (this, &myclass::io_cb),
1660 idle (this, &myclass::idle_cb)
1661 { 2008 {
2009 io .set <myclass, &myclass::io_cb > (this);
2010 idle.set <myclass, &myclass::idle_cb> (this);
2011
1662 io.start (fd, ev::READ); 2012 io.start (fd, ev::READ);
1663 } 2013 }
2014
2015
2016=head1 MACRO MAGIC
2017
2018Libev can be compiled with a variety of options, the most fundemantal is
2019C<EV_MULTIPLICITY>. This option determines whether (most) functions and
2020callbacks have an initial C<struct ev_loop *> argument.
2021
2022To make it easier to write programs that cope with either variant, the
2023following macros are defined:
2024
2025=over 4
2026
2027=item C<EV_A>, C<EV_A_>
2028
2029This provides the loop I<argument> for functions, if one is required ("ev
2030loop argument"). The C<EV_A> form is used when this is the sole argument,
2031C<EV_A_> is used when other arguments are following. Example:
2032
2033 ev_unref (EV_A);
2034 ev_timer_add (EV_A_ watcher);
2035 ev_loop (EV_A_ 0);
2036
2037It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
2038which is often provided by the following macro.
2039
2040=item C<EV_P>, C<EV_P_>
2041
2042This provides the loop I<parameter> for functions, if one is required ("ev
2043loop parameter"). The C<EV_P> form is used when this is the sole parameter,
2044C<EV_P_> is used when other parameters are following. Example:
2045
2046 // this is how ev_unref is being declared
2047 static void ev_unref (EV_P);
2048
2049 // this is how you can declare your typical callback
2050 static void cb (EV_P_ ev_timer *w, int revents)
2051
2052It declares a parameter C<loop> of type C<struct ev_loop *>, quite
2053suitable for use with C<EV_A>.
2054
2055=item C<EV_DEFAULT>, C<EV_DEFAULT_>
2056
2057Similar to the other two macros, this gives you the value of the default
2058loop, if multiple loops are supported ("ev loop default").
2059
2060=back
2061
2062Example: Declare and initialise a check watcher, utilising the above
2063macros so it will work regardless of whether multiple loops are supported
2064or not.
2065
2066 static void
2067 check_cb (EV_P_ ev_timer *w, int revents)
2068 {
2069 ev_check_stop (EV_A_ w);
2070 }
2071
2072 ev_check check;
2073 ev_check_init (&check, check_cb);
2074 ev_check_start (EV_DEFAULT_ &check);
2075 ev_loop (EV_DEFAULT_ 0);
1664 2076
1665=head1 EMBEDDING 2077=head1 EMBEDDING
1666 2078
1667Libev can (and often is) directly embedded into host 2079Libev can (and often is) directly embedded into host
1668applications. Examples of applications that embed it include the Deliantra 2080applications. Examples of applications that embed it include the Deliantra
1708 ev_vars.h 2120 ev_vars.h
1709 ev_wrap.h 2121 ev_wrap.h
1710 2122
1711 ev_win32.c required on win32 platforms only 2123 ev_win32.c required on win32 platforms only
1712 2124
1713 ev_select.c only when select backend is enabled (which is by default) 2125 ev_select.c only when select backend is enabled (which is enabled by default)
1714 ev_poll.c only when poll backend is enabled (disabled by default) 2126 ev_poll.c only when poll backend is enabled (disabled by default)
1715 ev_epoll.c only when the epoll backend is enabled (disabled by default) 2127 ev_epoll.c only when the epoll backend is enabled (disabled by default)
1716 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 2128 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1717 ev_port.c only when the solaris port backend is enabled (disabled by default) 2129 ev_port.c only when the solaris port backend is enabled (disabled by default)
1718 2130
1843 2255
1844=item EV_USE_DEVPOLL 2256=item EV_USE_DEVPOLL
1845 2257
1846reserved for future expansion, works like the USE symbols above. 2258reserved for future expansion, works like the USE symbols above.
1847 2259
2260=item EV_USE_INOTIFY
2261
2262If defined to be C<1>, libev will compile in support for the Linux inotify
2263interface to speed up C<ev_stat> watchers. Its actual availability will
2264be detected at runtime.
2265
1848=item EV_H 2266=item EV_H
1849 2267
1850The name of the F<ev.h> header file used to include it. The default if 2268The name of the F<ev.h> header file used to include it. The default if
1851undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This 2269undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This
1852can be used to virtually rename the F<ev.h> header file in case of conflicts. 2270can be used to virtually rename the F<ev.h> header file in case of conflicts.
1875will have the C<struct ev_loop *> as first argument, and you can create 2293will have the C<struct ev_loop *> as first argument, and you can create
1876additional independent event loops. Otherwise there will be no support 2294additional independent event loops. Otherwise there will be no support
1877for multiple event loops and there is no first event loop pointer 2295for multiple event loops and there is no first event loop pointer
1878argument. Instead, all functions act on the single default loop. 2296argument. Instead, all functions act on the single default loop.
1879 2297
2298=item EV_MINPRI
2299
2300=item EV_MAXPRI
2301
2302The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
2303C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
2304provide for more priorities by overriding those symbols (usually defined
2305to be C<-2> and C<2>, respectively).
2306
2307When doing priority-based operations, libev usually has to linearly search
2308all the priorities, so having many of them (hundreds) uses a lot of space
2309and time, so using the defaults of five priorities (-2 .. +2) is usually
2310fine.
2311
2312If your embedding app does not need any priorities, defining these both to
2313C<0> will save some memory and cpu.
2314
1880=item EV_PERIODIC_ENABLE 2315=item EV_PERIODIC_ENABLE
1881 2316
1882If undefined or defined to be C<1>, then periodic timers are supported. If 2317If undefined or defined to be C<1>, then periodic timers are supported. If
1883defined to be C<0>, then they are not. Disabling them saves a few kB of 2318defined to be C<0>, then they are not. Disabling them saves a few kB of
1884code. 2319code.
1885 2320
2321=item EV_IDLE_ENABLE
2322
2323If undefined or defined to be C<1>, then idle watchers are supported. If
2324defined to be C<0>, then they are not. Disabling them saves a few kB of
2325code.
2326
1886=item EV_EMBED_ENABLE 2327=item EV_EMBED_ENABLE
1887 2328
1888If undefined or defined to be C<1>, then embed watchers are supported. If 2329If undefined or defined to be C<1>, then embed watchers are supported. If
1889defined to be C<0>, then they are not. 2330defined to be C<0>, then they are not.
1890 2331
1891=item EV_STAT_ENABLE 2332=item EV_STAT_ENABLE
1892 2333
1893If undefined or defined to be C<1>, then stat watchers are supported. If 2334If undefined or defined to be C<1>, then stat watchers are supported. If
2335defined to be C<0>, then they are not.
2336
2337=item EV_FORK_ENABLE
2338
2339If undefined or defined to be C<1>, then fork watchers are supported. If
1894defined to be C<0>, then they are not. 2340defined to be C<0>, then they are not.
1895 2341
1896=item EV_MINIMAL 2342=item EV_MINIMAL
1897 2343
1898If you need to shave off some kilobytes of code at the expense of some 2344If you need to shave off some kilobytes of code at the expense of some
1899speed, define this symbol to C<1>. Currently only used for gcc to override 2345speed, define this symbol to C<1>. Currently only used for gcc to override
1900some inlining decisions, saves roughly 30% codesize of amd64. 2346some inlining decisions, saves roughly 30% codesize of amd64.
2347
2348=item EV_PID_HASHSIZE
2349
2350C<ev_child> watchers use a small hash table to distribute workload by
2351pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
2352than enough. If you need to manage thousands of children you might want to
2353increase this value (I<must> be a power of two).
2354
2355=item EV_INOTIFY_HASHSIZE
2356
2357C<ev_staz> watchers use a small hash table to distribute workload by
2358inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2359usually more than enough. If you need to manage thousands of C<ev_stat>
2360watchers you might want to increase this value (I<must> be a power of
2361two).
1901 2362
1902=item EV_COMMON 2363=item EV_COMMON
1903 2364
1904By default, all watchers have a C<void *data> member. By redefining 2365By default, all watchers have a C<void *data> member. By redefining
1905this macro to a something else you can include more and other types of 2366this macro to a something else you can include more and other types of
1934interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file 2395interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
1935will be compiled. It is pretty complex because it provides its own header 2396will be compiled. It is pretty complex because it provides its own header
1936file. 2397file.
1937 2398
1938The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file 2399The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
1939that everybody includes and which overrides some autoconf choices: 2400that everybody includes and which overrides some configure choices:
1940 2401
2402 #define EV_MINIMAL 1
1941 #define EV_USE_POLL 0 2403 #define EV_USE_POLL 0
1942 #define EV_MULTIPLICITY 0 2404 #define EV_MULTIPLICITY 0
1943 #define EV_PERIODICS 0 2405 #define EV_PERIODIC_ENABLE 0
2406 #define EV_STAT_ENABLE 0
2407 #define EV_FORK_ENABLE 0
1944 #define EV_CONFIG_H <config.h> 2408 #define EV_CONFIG_H <config.h>
2409 #define EV_MINPRI 0
2410 #define EV_MAXPRI 0
1945 2411
1946 #include "ev++.h" 2412 #include "ev++.h"
1947 2413
1948And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: 2414And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
1949 2415
1955 2421
1956In this section the complexities of (many of) the algorithms used inside 2422In this section the complexities of (many of) the algorithms used inside
1957libev will be explained. For complexity discussions about backends see the 2423libev will be explained. For complexity discussions about backends see the
1958documentation for C<ev_default_init>. 2424documentation for C<ev_default_init>.
1959 2425
2426All of the following are about amortised time: If an array needs to be
2427extended, libev needs to realloc and move the whole array, but this
2428happens asymptotically never with higher number of elements, so O(1) might
2429mean it might do a lengthy realloc operation in rare cases, but on average
2430it is much faster and asymptotically approaches constant time.
2431
1960=over 4 2432=over 4
1961 2433
1962=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) 2434=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
1963 2435
2436This means that, when you have a watcher that triggers in one hour and
2437there are 100 watchers that would trigger before that then inserting will
2438have to skip those 100 watchers.
2439
1964=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) 2440=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
1965 2441
2442That means that for changing a timer costs less than removing/adding them
2443as only the relative motion in the event queue has to be paid for.
2444
1966=item Starting io/check/prepare/idle/signal/child watchers: O(1) 2445=item Starting io/check/prepare/idle/signal/child watchers: O(1)
1967 2446
2447These just add the watcher into an array or at the head of a list.
1968=item Stopping check/prepare/idle watchers: O(1) 2448=item Stopping check/prepare/idle watchers: O(1)
1969 2449
1970=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16)) 2450=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2451
2452These watchers are stored in lists then need to be walked to find the
2453correct watcher to remove. The lists are usually short (you don't usually
2454have many watchers waiting for the same fd or signal).
1971 2455
1972=item Finding the next timer per loop iteration: O(1) 2456=item Finding the next timer per loop iteration: O(1)
1973 2457
1974=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) 2458=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
1975 2459
2460A change means an I/O watcher gets started or stopped, which requires
2461libev to recalculate its status (and possibly tell the kernel).
2462
1976=item Activating one watcher: O(1) 2463=item Activating one watcher: O(1)
1977 2464
2465=item Priority handling: O(number_of_priorities)
2466
2467Priorities are implemented by allocating some space for each
2468priority. When doing priority-based operations, libev usually has to
2469linearly search all the priorities.
2470
1978=back 2471=back
1979 2472
1980 2473
1981=head1 AUTHOR 2474=head1 AUTHOR
1982 2475

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines