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

Comparing libev/ev.pod (file contents):
Revision 1.44 by root, Sat Nov 24 16:57:30 2007 UTC vs.
Revision 1.61 by root, Thu Nov 29 12:21:05 2007 UTC

3libev - a high performance full-featured event loop written in C 3libev - a high performance full-featured event loop written in C
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 #include <ev.h> 7 #include <ev.h>
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 }
8 50
9=head1 DESCRIPTION 51=head1 DESCRIPTION
10 52
11Libev is an event loop: you register interest in certain events (such as a 53Libev 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 54file descriptor being readable or a timeout occuring), and it will manage
21details of the event, and then hand it over to libev by I<starting> the 63details of the event, and then hand it over to libev by I<starting> the
22watcher. 64watcher.
23 65
24=head1 FEATURES 66=head1 FEATURES
25 67
26Libev supports select, poll, the linux-specific epoll and the bsd-specific 68Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
27kqueue mechanisms for file descriptor events, relative timers, absolute 69BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
28timers with customised rescheduling, signal events, process status change 70for file descriptor events (C<ev_io>), the Linux C<inotify> interface
29events (related to SIGCHLD), and event watchers dealing with the event 71(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
30loop mechanism itself (idle, prepare and check watchers). It also is quite 72with customised rescheduling (C<ev_periodic>), synchronous signals
73(C<ev_signal>), process status change events (C<ev_child>), and event
74watchers dealing with the event loop mechanism itself (C<ev_idle>,
75C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as
76file watchers (C<ev_stat>) and even limited support for fork events
77(C<ev_fork>).
78
79It also is quite fast (see this
31fast (see this L<benchmark|http://libev.schmorp.de/bench.html> comparing 80L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
32it to libevent for example). 81for example).
33 82
34=head1 CONVENTIONS 83=head1 CONVENTIONS
35 84
36Libev is very configurable. In this manual the default configuration 85Libev is very configurable. In this manual the default configuration will
37will be described, which supports multiple event loops. For more info 86be described, which supports multiple event loops. For more info about
38about various configuration options please have a look at the file 87various configuration options please have a look at B<EMBED> section in
39F<README.embed> in the libev distribution. If libev was configured without 88this manual. If libev was configured without support for multiple event
40support for multiple event loops, then all functions taking an initial 89loops, 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 *>) 90(which is always of type C<struct ev_loop *>) will not have this argument.
42will not have this argument.
43 91
44=head1 TIME REPRESENTATION 92=head1 TIME REPRESENTATION
45 93
46Libev represents time as a single floating point number, representing the 94Libev represents time as a single floating point number, representing the
47(fractional) number of seconds since the (POSIX) epoch (somewhere near 95(fractional) number of seconds since the (POSIX) epoch (somewhere near
48the beginning of 1970, details are complicated, don't ask). This type is 96the 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 97called 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 98to the C<double> type in C, and when you need to do any calculations on
51it, you should treat it as such. 99it, you should treat it as such.
52 100
53
54=head1 GLOBAL FUNCTIONS 101=head1 GLOBAL FUNCTIONS
55 102
56These functions can be called anytime, even before initialising the 103These functions can be called anytime, even before initialising the
57library in any way. 104library in any way.
58 105
77Usually, it's a good idea to terminate if the major versions mismatch, 124Usually, it's a good idea to terminate if the major versions mismatch,
78as this indicates an incompatible change. Minor versions are usually 125as this indicates an incompatible change. Minor versions are usually
79compatible to older versions, so a larger minor version alone is usually 126compatible to older versions, so a larger minor version alone is usually
80not a problem. 127not a problem.
81 128
82Example: make sure we haven't accidentally been linked against the wrong 129Example: Make sure we haven't accidentally been linked against the wrong
83version: 130version.
84 131
85 assert (("libev version mismatch", 132 assert (("libev version mismatch",
86 ev_version_major () == EV_VERSION_MAJOR 133 ev_version_major () == EV_VERSION_MAJOR
87 && ev_version_minor () >= EV_VERSION_MINOR)); 134 && ev_version_minor () >= EV_VERSION_MINOR));
88 135
118 165
119See the description of C<ev_embed> watchers for more info. 166See the description of C<ev_embed> watchers for more info.
120 167
121=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 168=item ev_set_allocator (void *(*cb)(void *ptr, long size))
122 169
123Sets the allocation function to use (the prototype is similar to the 170Sets the allocation function to use (the prototype is similar - the
124realloc C function, the semantics are identical). It is used to allocate 171semantics is identical - to the realloc C function). It is used to
125and free memory (no surprises here). If it returns zero when memory 172allocate and free memory (no surprises here). If it returns zero when
126needs to be allocated, the library might abort or take some potentially 173memory needs to be allocated, the library might abort or take some
127destructive action. The default is your system realloc function. 174potentially destructive action. The default is your system realloc
175function.
128 176
129You could override this function in high-availability programs to, say, 177You could override this function in high-availability programs to, say,
130free some memory if it cannot allocate memory, to use a special allocator, 178free 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. 179or even to sleep a while and retry until some memory is available.
132 180
133Example: replace the libev allocator with one that waits a bit and then 181Example: Replace the libev allocator with one that waits a bit and then
134retries: better than mine). 182retries).
135 183
136 static void * 184 static void *
137 persistent_realloc (void *ptr, long size) 185 persistent_realloc (void *ptr, size_t size)
138 { 186 {
139 for (;;) 187 for (;;)
140 { 188 {
141 void *newptr = realloc (ptr, size); 189 void *newptr = realloc (ptr, size);
142 190
158callback is set, then libev will expect it to remedy the sitution, no 206callback is set, then libev will expect it to remedy the sitution, no
159matter what, when it returns. That is, libev will generally retry the 207matter what, when it returns. That is, libev will generally retry the
160requested operation, or, if the condition doesn't go away, do bad stuff 208requested operation, or, if the condition doesn't go away, do bad stuff
161(such as abort). 209(such as abort).
162 210
163Example: do the same thing as libev does internally: 211Example: This is basically the same thing that libev does internally, too.
164 212
165 static void 213 static void
166 fatal_error (const char *msg) 214 fatal_error (const char *msg)
167 { 215 {
168 perror (msg); 216 perror (msg);
314Similar to C<ev_default_loop>, but always creates a new event loop that is 362Similar 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 363always 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 364handle signal and child watchers, and attempts to do so will be greeted by
317undefined behaviour (or a failed assertion if assertions are enabled). 365undefined behaviour (or a failed assertion if assertions are enabled).
318 366
319Example: try to create a event loop that uses epoll and nothing else. 367Example: Try to create a event loop that uses epoll and nothing else.
320 368
321 struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 369 struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
322 if (!epoller) 370 if (!epoller)
323 fatal ("no epoll found here, maybe it hides under your chair"); 371 fatal ("no epoll found here, maybe it hides under your chair");
324 372
423 Signals and child watchers are implemented as I/O watchers, and will 471 Signals and child watchers are implemented as I/O watchers, and will
424 be handled here by queueing them when their watcher gets executed. 472 be handled here by queueing them when their watcher gets executed.
425 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 473 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
426 were used, return, otherwise continue with step *. 474 were used, return, otherwise continue with step *.
427 475
428Example: queue some jobs and then loop until no events are outsanding 476Example: Queue some jobs and then loop until no events are outsanding
429anymore. 477anymore.
430 478
431 ... queue jobs here, make sure they register event watchers as long 479 ... 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..) 480 ... as they still have work to do (even an idle watcher will do..)
433 ev_loop (my_loop, 0); 481 ev_loop (my_loop, 0);
453visible to the libev user and should not keep C<ev_loop> from exiting if 501visible 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 502no 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 503way 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>. 504libraries. Just remember to I<unref after start> and I<ref before stop>.
457 505
458Example: create a signal watcher, but keep it from keeping C<ev_loop> 506Example: Create a signal watcher, but keep it from keeping C<ev_loop>
459running when nothing else is active. 507running when nothing else is active.
460 508
461 struct dv_signal exitsig; 509 struct ev_signal exitsig;
462 ev_signal_init (&exitsig, sig_cb, SIGINT); 510 ev_signal_init (&exitsig, sig_cb, SIGINT);
463 ev_signal_start (myloop, &exitsig); 511 ev_signal_start (loop, &exitsig);
464 evf_unref (myloop); 512 evf_unref (loop);
465 513
466Example: for some weird reason, unregister the above signal handler again. 514Example: For some weird reason, unregister the above signal handler again.
467 515
468 ev_ref (myloop); 516 ev_ref (loop);
469 ev_signal_stop (myloop, &exitsig); 517 ev_signal_stop (loop, &exitsig);
470 518
471=back 519=back
472 520
473 521
474=head1 ANATOMY OF A WATCHER 522=head1 ANATOMY OF A WATCHER
544The signal specified in the C<ev_signal> watcher has been received by a thread. 592The signal specified in the C<ev_signal> watcher has been received by a thread.
545 593
546=item C<EV_CHILD> 594=item C<EV_CHILD>
547 595
548The pid specified in the C<ev_child> watcher has received a status change. 596The pid specified in the C<ev_child> watcher has received a status change.
597
598=item C<EV_STAT>
599
600The path specified in the C<ev_stat> watcher changed its attributes somehow.
549 601
550=item C<EV_IDLE> 602=item C<EV_IDLE>
551 603
552The C<ev_idle> watcher has determined that you have nothing better to do. 604The C<ev_idle> watcher has determined that you have nothing better to do.
553 605
561received events. Callbacks of both watcher types can start and stop as 613received events. Callbacks of both watcher types can start and stop as
562many watchers as they want, and all of them will be taken into account 614many watchers as they want, and all of them will be taken into account
563(for example, a C<ev_prepare> watcher might start an idle watcher to keep 615(for example, a C<ev_prepare> watcher might start an idle watcher to keep
564C<ev_loop> from blocking). 616C<ev_loop> from blocking).
565 617
618=item C<EV_EMBED>
619
620The embedded event loop specified in the C<ev_embed> watcher needs attention.
621
622=item C<EV_FORK>
623
624The event loop has been resumed in the child process after fork (see
625C<ev_fork>).
626
566=item C<EV_ERROR> 627=item C<EV_ERROR>
567 628
568An unspecified error has occured, the watcher has been stopped. This might 629An unspecified error has occured, the watcher has been stopped. This might
569happen because the watcher could not be properly started because libev 630happen because the watcher could not be properly started because libev
570ran out of memory, a file descriptor was found to be closed or any other 631ran out of memory, a file descriptor was found to be closed or any other
644events but its callback has not yet been invoked). As long as a watcher 705events but its callback has not yet been invoked). As long as a watcher
645is pending (but not active) you must not call an init function on it (but 706is pending (but not active) you must not call an init function on it (but
646C<ev_TYPE_set> is safe) and you must make sure the watcher is available to 707C<ev_TYPE_set> is safe) and you must make sure the watcher is available to
647libev (e.g. you cnanot C<free ()> it). 708libev (e.g. you cnanot C<free ()> it).
648 709
649=item callback = ev_cb (ev_TYPE *watcher) 710=item callback ev_cb (ev_TYPE *watcher)
650 711
651Returns the callback currently set on the watcher. 712Returns the callback currently set on the watcher.
652 713
653=item ev_cb_set (ev_TYPE *watcher, callback) 714=item ev_cb_set (ev_TYPE *watcher, callback)
654 715
682 { 743 {
683 struct my_io *w = (struct my_io *)w_; 744 struct my_io *w = (struct my_io *)w_;
684 ... 745 ...
685 } 746 }
686 747
687More interesting and less C-conformant ways of catsing your callback type 748More interesting and less C-conformant ways of casting your callback type
688have been omitted.... 749instead have been omitted.
750
751Another common scenario is having some data structure with multiple
752watchers:
753
754 struct my_biggy
755 {
756 int some_data;
757 ev_timer t1;
758 ev_timer t2;
759 }
760
761In this case getting the pointer to C<my_biggy> is a bit more complicated,
762you need to use C<offsetof>:
763
764 #include <stddef.h>
765
766 static void
767 t1_cb (EV_P_ struct ev_timer *w, int revents)
768 {
769 struct my_biggy big = (struct my_biggy *
770 (((char *)w) - offsetof (struct my_biggy, t1));
771 }
772
773 static void
774 t2_cb (EV_P_ struct ev_timer *w, int revents)
775 {
776 struct my_biggy big = (struct my_biggy *
777 (((char *)w) - offsetof (struct my_biggy, t2));
778 }
689 779
690 780
691=head1 WATCHER TYPES 781=head1 WATCHER TYPES
692 782
693This section describes each watcher in detail, but will not repeat 783This section describes each watcher in detail, but will not repeat
694information given in the last section. 784information given in the last section. Any initialisation/set macros,
785functions and members specific to the watcher type are explained.
786
787Members are additionally marked with either I<[read-only]>, meaning that,
788while the watcher is active, you can look at the member and expect some
789sensible content, but you must not modify it (you can modify it while the
790watcher is stopped to your hearts content), or I<[read-write]>, which
791means you can expect it to have some sensible content while the watcher
792is active, but you can also modify it. Modifying it may not do something
793sensible or take immediate effect (or do anything at all), but libev will
794not crash or malfunction in any way.
695 795
696 796
697=head2 C<ev_io> - is this file descriptor readable or writable? 797=head2 C<ev_io> - is this file descriptor readable or writable?
698 798
699I/O watchers check whether a file descriptor is readable or writable 799I/O watchers check whether a file descriptor is readable or writable
742 842
743Configures an C<ev_io> watcher. The C<fd> is the file descriptor to 843Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
744rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or 844rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or
745C<EV_READ | EV_WRITE> to receive the given events. 845C<EV_READ | EV_WRITE> to receive the given events.
746 846
847=item int fd [read-only]
848
849The file descriptor being watched.
850
851=item int events [read-only]
852
853The events being watched.
854
747=back 855=back
748 856
749Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well 857Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
750readable, but only once. Since it is likely line-buffered, you could 858readable, but only once. Since it is likely line-buffered, you could
751attempt to read a whole line in the callback: 859attempt to read a whole line in the callback.
752 860
753 static void 861 static void
754 stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 862 stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
755 { 863 {
756 ev_io_stop (loop, w); 864 ev_io_stop (loop, w);
808=item ev_timer_again (loop) 916=item ev_timer_again (loop)
809 917
810This will act as if the timer timed out and restart it again if it is 918This will act as if the timer timed out and restart it again if it is
811repeating. The exact semantics are: 919repeating. The exact semantics are:
812 920
921If the timer is pending, its pending status is cleared.
922
813If the timer is started but nonrepeating, stop it. 923If the timer is started but nonrepeating, stop it (as if it timed out).
814 924
815If the timer is repeating, either start it if necessary (with the repeat 925If the timer is repeating, either start it if necessary (with the
816value), or reset the running timer to the repeat value. 926C<repeat> value), or reset the running timer to the C<repeat> value.
817 927
818This sounds a bit complicated, but here is a useful and typical 928This sounds a bit complicated, but here is a useful and typical
819example: Imagine you have a tcp connection and you want a so-called idle 929example: Imagine you have a tcp connection and you want a so-called idle
820timeout, that is, you want to be called when there have been, say, 60 930timeout, that is, you want to be called when there have been, say, 60
821seconds of inactivity on the socket. The easiest way to do this is to 931seconds of inactivity on the socket. The easiest way to do this is to
822configure an C<ev_timer> with after=repeat=60 and calling ev_timer_again each 932configure an C<ev_timer> with a C<repeat> value of C<60> and then call
823time you successfully read or write some data. If you go into an idle 933C<ev_timer_again> each time you successfully read or write some data. If
824state where you do not expect data to travel on the socket, you can stop 934you go into an idle state where you do not expect data to travel on the
825the timer, and again will automatically restart it if need be. 935socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
936automatically restart it if need be.
937
938That means you can ignore the C<after> value and C<ev_timer_start>
939altogether and only ever use the C<repeat> value and C<ev_timer_again>:
940
941 ev_timer_init (timer, callback, 0., 5.);
942 ev_timer_again (loop, timer);
943 ...
944 timer->again = 17.;
945 ev_timer_again (loop, timer);
946 ...
947 timer->again = 10.;
948 ev_timer_again (loop, timer);
949
950This is more slightly efficient then stopping/starting the timer each time
951you want to modify its timeout value.
952
953=item ev_tstamp repeat [read-write]
954
955The current C<repeat> value. Will be used each time the watcher times out
956or C<ev_timer_again> is called and determines the next timeout (if any),
957which is also when any modifications are taken into account.
826 958
827=back 959=back
828 960
829Example: create a timer that fires after 60 seconds. 961Example: Create a timer that fires after 60 seconds.
830 962
831 static void 963 static void
832 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 964 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
833 { 965 {
834 .. one minute over, w is actually stopped right here 966 .. one minute over, w is actually stopped right here
836 968
837 struct ev_timer mytimer; 969 struct ev_timer mytimer;
838 ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 970 ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
839 ev_timer_start (loop, &mytimer); 971 ev_timer_start (loop, &mytimer);
840 972
841Example: create a timeout timer that times out after 10 seconds of 973Example: Create a timeout timer that times out after 10 seconds of
842inactivity. 974inactivity.
843 975
844 static void 976 static void
845 timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 977 timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
846 { 978 {
957Simply stops and restarts the periodic watcher again. This is only useful 1089Simply stops and restarts the periodic watcher again. This is only useful
958when you changed some parameters or the reschedule callback would return 1090when you changed some parameters or the reschedule callback would return
959a different time than the last time it was called (e.g. in a crond like 1091a different time than the last time it was called (e.g. in a crond like
960program when the crontabs have changed). 1092program when the crontabs have changed).
961 1093
1094=item ev_tstamp interval [read-write]
1095
1096The current interval value. Can be modified any time, but changes only
1097take effect when the periodic timer fires or C<ev_periodic_again> is being
1098called.
1099
1100=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]
1101
1102The current reschedule callback, or C<0>, if this functionality is
1103switched off. Can be changed any time, but changes only take effect when
1104the periodic timer fires or C<ev_periodic_again> is being called.
1105
962=back 1106=back
963 1107
964Example: call a callback every hour, or, more precisely, whenever the 1108Example: Call a callback every hour, or, more precisely, whenever the
965system clock is divisible by 3600. The callback invocation times have 1109system clock is divisible by 3600. The callback invocation times have
966potentially a lot of jittering, but good long-term stability. 1110potentially a lot of jittering, but good long-term stability.
967 1111
968 static void 1112 static void
969 clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1113 clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
973 1117
974 struct ev_periodic hourly_tick; 1118 struct ev_periodic hourly_tick;
975 ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 1119 ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
976 ev_periodic_start (loop, &hourly_tick); 1120 ev_periodic_start (loop, &hourly_tick);
977 1121
978Example: the same as above, but use a reschedule callback to do it: 1122Example: The same as above, but use a reschedule callback to do it:
979 1123
980 #include <math.h> 1124 #include <math.h>
981 1125
982 static ev_tstamp 1126 static ev_tstamp
983 my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 1127 my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
985 return fmod (now, 3600.) + 3600.; 1129 return fmod (now, 3600.) + 3600.;
986 } 1130 }
987 1131
988 ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1132 ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
989 1133
990Example: call a callback every hour, starting now: 1134Example: Call a callback every hour, starting now:
991 1135
992 struct ev_periodic hourly_tick; 1136 struct ev_periodic hourly_tick;
993 ev_periodic_init (&hourly_tick, clock_cb, 1137 ev_periodic_init (&hourly_tick, clock_cb,
994 fmod (ev_now (loop), 3600.), 3600., 0); 1138 fmod (ev_now (loop), 3600.), 3600., 0);
995 ev_periodic_start (loop, &hourly_tick); 1139 ev_periodic_start (loop, &hourly_tick);
1016=item ev_signal_set (ev_signal *, int signum) 1160=item ev_signal_set (ev_signal *, int signum)
1017 1161
1018Configures the watcher to trigger on the given signal number (usually one 1162Configures the watcher to trigger on the given signal number (usually one
1019of the C<SIGxxx> constants). 1163of the C<SIGxxx> constants).
1020 1164
1165=item int signum [read-only]
1166
1167The signal the watcher watches out for.
1168
1021=back 1169=back
1022 1170
1023 1171
1024=head2 C<ev_child> - watch out for process status changes 1172=head2 C<ev_child> - watch out for process status changes
1025 1173
1037at the C<rstatus> member of the C<ev_child> watcher structure to see 1185at the C<rstatus> member of the C<ev_child> watcher structure to see
1038the status word (use the macros from C<sys/wait.h> and see your systems 1186the status word (use the macros from C<sys/wait.h> and see your systems
1039C<waitpid> documentation). The C<rpid> member contains the pid of the 1187C<waitpid> documentation). The C<rpid> member contains the pid of the
1040process causing the status change. 1188process causing the status change.
1041 1189
1190=item int pid [read-only]
1191
1192The process id this watcher watches out for, or C<0>, meaning any process id.
1193
1194=item int rpid [read-write]
1195
1196The process id that detected a status change.
1197
1198=item int rstatus [read-write]
1199
1200The process exit/trace status caused by C<rpid> (see your systems
1201C<waitpid> and C<sys/wait.h> documentation for details).
1202
1042=back 1203=back
1043 1204
1044Example: try to exit cleanly on SIGINT and SIGTERM. 1205Example: Try to exit cleanly on SIGINT and SIGTERM.
1045 1206
1046 static void 1207 static void
1047 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1208 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1048 { 1209 {
1049 ev_unloop (loop, EVUNLOOP_ALL); 1210 ev_unloop (loop, EVUNLOOP_ALL);
1050 } 1211 }
1051 1212
1052 struct ev_signal signal_watcher; 1213 struct ev_signal signal_watcher;
1053 ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 1214 ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1054 ev_signal_start (loop, &sigint_cb); 1215 ev_signal_start (loop, &sigint_cb);
1216
1217
1218=head2 C<ev_stat> - did the file attributes just change?
1219
1220This watches a filesystem path for attribute changes. That is, it calls
1221C<stat> regularly (or when the OS says it changed) and sees if it changed
1222compared to the last time, invoking the callback if it did.
1223
1224The path does not need to exist: changing from "path exists" to "path does
1225not exist" is a status change like any other. The condition "path does
1226not exist" is signified by the C<st_nlink> field being zero (which is
1227otherwise always forced to be at least one) and all the other fields of
1228the stat buffer having unspecified contents.
1229
1230The path I<should> be absolute and I<must not> end in a slash. If it is
1231relative and your working directory changes, the behaviour is undefined.
1232
1233Since there is no standard to do this, the portable implementation simply
1234calls C<stat (2)> regularly on the path to see if it changed somehow. You
1235can specify a recommended polling interval for this case. If you specify
1236a polling interval of C<0> (highly recommended!) then a I<suitable,
1237unspecified default> value will be used (which you can expect to be around
1238five seconds, although this might change dynamically). Libev will also
1239impose a minimum interval which is currently around C<0.1>, but thats
1240usually overkill.
1241
1242This watcher type is not meant for massive numbers of stat watchers,
1243as even with OS-supported change notifications, this can be
1244resource-intensive.
1245
1246At the time of this writing, only the Linux inotify interface is
1247implemented (implementing kqueue support is left as an exercise for the
1248reader). Inotify will be used to give hints only and should not change the
1249semantics of C<ev_stat> watchers, which means that libev sometimes needs
1250to fall back to regular polling again even with inotify, but changes are
1251usually detected immediately, and if the file exists there will be no
1252polling.
1253
1254=over 4
1255
1256=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
1257
1258=item ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)
1259
1260Configures the watcher to wait for status changes of the given
1261C<path>. The C<interval> is a hint on how quickly a change is expected to
1262be detected and should normally be specified as C<0> to let libev choose
1263a suitable value. The memory pointed to by C<path> must point to the same
1264path for as long as the watcher is active.
1265
1266The callback will be receive C<EV_STAT> when a change was detected,
1267relative to the attributes at the time the watcher was started (or the
1268last change was detected).
1269
1270=item ev_stat_stat (ev_stat *)
1271
1272Updates the stat buffer immediately with new values. If you change the
1273watched path in your callback, you could call this fucntion to avoid
1274detecting this change (while introducing a race condition). Can also be
1275useful simply to find out the new values.
1276
1277=item ev_statdata attr [read-only]
1278
1279The most-recently detected attributes of the file. Although the type is of
1280C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
1281suitable for your system. If the C<st_nlink> member is C<0>, then there
1282was some error while C<stat>ing the file.
1283
1284=item ev_statdata prev [read-only]
1285
1286The previous attributes of the file. The callback gets invoked whenever
1287C<prev> != C<attr>.
1288
1289=item ev_tstamp interval [read-only]
1290
1291The specified interval.
1292
1293=item const char *path [read-only]
1294
1295The filesystem path that is being watched.
1296
1297=back
1298
1299Example: Watch C</etc/passwd> for attribute changes.
1300
1301 static void
1302 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1303 {
1304 /* /etc/passwd changed in some way */
1305 if (w->attr.st_nlink)
1306 {
1307 printf ("passwd current size %ld\n", (long)w->attr.st_size);
1308 printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
1309 printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
1310 }
1311 else
1312 /* you shalt not abuse printf for puts */
1313 puts ("wow, /etc/passwd is not there, expect problems. "
1314 "if this is windows, they already arrived\n");
1315 }
1316
1317 ...
1318 ev_stat passwd;
1319
1320 ev_stat_init (&passwd, passwd_cb, "/etc/passwd");
1321 ev_stat_start (loop, &passwd);
1055 1322
1056 1323
1057=head2 C<ev_idle> - when you've got nothing better to do... 1324=head2 C<ev_idle> - when you've got nothing better to do...
1058 1325
1059Idle watchers trigger events when there are no other events are pending 1326Idle watchers trigger events when there are no other events are pending
1080kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 1347kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1081believe me. 1348believe me.
1082 1349
1083=back 1350=back
1084 1351
1085Example: dynamically allocate an C<ev_idle>, start it, and in the 1352Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1086callback, free it. Alos, use no error checking, as usual. 1353callback, free it. Also, use no error checking, as usual.
1087 1354
1088 static void 1355 static void
1089 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1356 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1090 { 1357 {
1091 free (w); 1358 free (w);
1102 1369
1103Prepare and check watchers are usually (but not always) used in tandem: 1370Prepare and check watchers are usually (but not always) used in tandem:
1104prepare watchers get invoked before the process blocks and check watchers 1371prepare watchers get invoked before the process blocks and check watchers
1105afterwards. 1372afterwards.
1106 1373
1374You I<must not> call C<ev_loop> or similar functions that enter
1375the current event loop from either C<ev_prepare> or C<ev_check>
1376watchers. Other loops than the current one are fine, however. The
1377rationale behind this is that you do not need to check for recursion in
1378those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
1379C<ev_check> so if you have one watcher of each kind they will always be
1380called in pairs bracketing the blocking call.
1381
1107Their main purpose is to integrate other event mechanisms into libev and 1382Their main purpose is to integrate other event mechanisms into libev and
1108their use is somewhat advanced. This could be used, for example, to track 1383their use is somewhat advanced. This could be used, for example, to track
1109variable changes, implement your own watchers, integrate net-snmp or a 1384variable changes, implement your own watchers, integrate net-snmp or a
1110coroutine library and lots more. 1385coroutine library and lots more. They are also occasionally useful if
1386you cache some data and want to flush it before blocking (for example,
1387in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
1388watcher).
1111 1389
1112This is done by examining in each prepare call which file descriptors need 1390This is done by examining in each prepare call which file descriptors need
1113to be watched by the other library, registering C<ev_io> watchers for 1391to be watched by the other library, registering C<ev_io> watchers for
1114them and starting an C<ev_timer> watcher for any timeouts (many libraries 1392them and starting an C<ev_timer> watcher for any timeouts (many libraries
1115provide just this functionality). Then, in the check watcher you check for 1393provide just this functionality). Then, in the check watcher you check for
1137parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1415parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1138macros, but using them is utterly, utterly and completely pointless. 1416macros, but using them is utterly, utterly and completely pointless.
1139 1417
1140=back 1418=back
1141 1419
1142Example: *TODO*. 1420Example: To include a library such as adns, you would add IO watchers
1421and a timeout watcher in a prepare handler, as required by libadns, and
1422in a check watcher, destroy them and call into libadns. What follows is
1423pseudo-code only of course:
1424
1425 static ev_io iow [nfd];
1426 static ev_timer tw;
1427
1428 static void
1429 io_cb (ev_loop *loop, ev_io *w, int revents)
1430 {
1431 // set the relevant poll flags
1432 // could also call adns_processreadable etc. here
1433 struct pollfd *fd = (struct pollfd *)w->data;
1434 if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1435 if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1436 }
1437
1438 // create io watchers for each fd and a timer before blocking
1439 static void
1440 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1441 {
1442 int timeout = 3600000;truct pollfd fds [nfd];
1443 // actual code will need to loop here and realloc etc.
1444 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1445
1446 /* the callback is illegal, but won't be called as we stop during check */
1447 ev_timer_init (&tw, 0, timeout * 1e-3);
1448 ev_timer_start (loop, &tw);
1449
1450 // create on ev_io per pollfd
1451 for (int i = 0; i < nfd; ++i)
1452 {
1453 ev_io_init (iow + i, io_cb, fds [i].fd,
1454 ((fds [i].events & POLLIN ? EV_READ : 0)
1455 | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1456
1457 fds [i].revents = 0;
1458 iow [i].data = fds + i;
1459 ev_io_start (loop, iow + i);
1460 }
1461 }
1462
1463 // stop all watchers after blocking
1464 static void
1465 adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1466 {
1467 ev_timer_stop (loop, &tw);
1468
1469 for (int i = 0; i < nfd; ++i)
1470 ev_io_stop (loop, iow + i);
1471
1472 adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1473 }
1143 1474
1144 1475
1145=head2 C<ev_embed> - when one backend isn't enough... 1476=head2 C<ev_embed> - when one backend isn't enough...
1146 1477
1147This is a rather advanced watcher type that lets you embed one event loop 1478This is a rather advanced watcher type that lets you embed one event loop
1228 1559
1229Make a single, non-blocking sweep over the embedded loop. This works 1560Make a single, non-blocking sweep over the embedded loop. This works
1230similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most 1561similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1231apropriate way for embedded loops. 1562apropriate way for embedded loops.
1232 1563
1564=item struct ev_loop *loop [read-only]
1565
1566The embedded event loop.
1567
1568=back
1569
1570
1571=head2 C<ev_fork> - the audacity to resume the event loop after a fork
1572
1573Fork watchers are called when a C<fork ()> was detected (usually because
1574whoever is a good citizen cared to tell libev about it by calling
1575C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the
1576event loop blocks next and before C<ev_check> watchers are being called,
1577and only in the child after the fork. If whoever good citizen calling
1578C<ev_default_fork> cheats and calls it in the wrong process, the fork
1579handlers will be invoked, too, of course.
1580
1581=over 4
1582
1583=item ev_fork_init (ev_signal *, callback)
1584
1585Initialises and configures the fork watcher - it has no parameters of any
1586kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
1587believe me.
1588
1233=back 1589=back
1234 1590
1235 1591
1236=head1 OTHER FUNCTIONS 1592=head1 OTHER FUNCTIONS
1237 1593
1399 1755
1400=item w->sweep () C<ev::embed> only 1756=item w->sweep () C<ev::embed> only
1401 1757
1402Invokes C<ev_embed_sweep>. 1758Invokes C<ev_embed_sweep>.
1403 1759
1760=item w->update () C<ev::stat> only
1761
1762Invokes C<ev_stat_stat>.
1763
1404=back 1764=back
1405 1765
1406=back 1766=back
1407 1767
1408Example: Define a class with an IO and idle watcher, start one of them in 1768Example: Define a class with an IO and idle watcher, start one of them in
1420 : io (this, &myclass::io_cb), 1780 : io (this, &myclass::io_cb),
1421 idle (this, &myclass::idle_cb) 1781 idle (this, &myclass::idle_cb)
1422 { 1782 {
1423 io.start (fd, ev::READ); 1783 io.start (fd, ev::READ);
1424 } 1784 }
1785
1786
1787=head1 MACRO MAGIC
1788
1789Libev can be compiled with a variety of options, the most fundemantal is
1790C<EV_MULTIPLICITY>. This option determines wether (most) functions and
1791callbacks have an initial C<struct ev_loop *> argument.
1792
1793To make it easier to write programs that cope with either variant, the
1794following macros are defined:
1795
1796=over 4
1797
1798=item C<EV_A>, C<EV_A_>
1799
1800This provides the loop I<argument> for functions, if one is required ("ev
1801loop argument"). The C<EV_A> form is used when this is the sole argument,
1802C<EV_A_> is used when other arguments are following. Example:
1803
1804 ev_unref (EV_A);
1805 ev_timer_add (EV_A_ watcher);
1806 ev_loop (EV_A_ 0);
1807
1808It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
1809which is often provided by the following macro.
1810
1811=item C<EV_P>, C<EV_P_>
1812
1813This provides the loop I<parameter> for functions, if one is required ("ev
1814loop parameter"). The C<EV_P> form is used when this is the sole parameter,
1815C<EV_P_> is used when other parameters are following. Example:
1816
1817 // this is how ev_unref is being declared
1818 static void ev_unref (EV_P);
1819
1820 // this is how you can declare your typical callback
1821 static void cb (EV_P_ ev_timer *w, int revents)
1822
1823It declares a parameter C<loop> of type C<struct ev_loop *>, quite
1824suitable for use with C<EV_A>.
1825
1826=item C<EV_DEFAULT>, C<EV_DEFAULT_>
1827
1828Similar to the other two macros, this gives you the value of the default
1829loop, if multiple loops are supported ("ev loop default").
1830
1831=back
1832
1833Example: Declare and initialise a check watcher, working regardless of
1834wether multiple loops are supported or not.
1835
1836 static void
1837 check_cb (EV_P_ ev_timer *w, int revents)
1838 {
1839 ev_check_stop (EV_A_ w);
1840 }
1841
1842 ev_check check;
1843 ev_check_init (&check, check_cb);
1844 ev_check_start (EV_DEFAULT_ &check);
1845 ev_loop (EV_DEFAULT_ 0);
1846
1425 1847
1426=head1 EMBEDDING 1848=head1 EMBEDDING
1427 1849
1428Libev can (and often is) directly embedded into host 1850Libev can (and often is) directly embedded into host
1429applications. Examples of applications that embed it include the Deliantra 1851applications. Examples of applications that embed it include the Deliantra
1604 2026
1605=item EV_USE_DEVPOLL 2027=item EV_USE_DEVPOLL
1606 2028
1607reserved for future expansion, works like the USE symbols above. 2029reserved for future expansion, works like the USE symbols above.
1608 2030
2031=item EV_USE_INOTIFY
2032
2033If defined to be C<1>, libev will compile in support for the Linux inotify
2034interface to speed up C<ev_stat> watchers. Its actual availability will
2035be detected at runtime.
2036
1609=item EV_H 2037=item EV_H
1610 2038
1611The name of the F<ev.h> header file used to include it. The default if 2039The name of the F<ev.h> header file used to include it. The default if
1612undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This 2040undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This
1613can be used to virtually rename the F<ev.h> header file in case of conflicts. 2041can be used to virtually rename the F<ev.h> header file in case of conflicts.
1636will have the C<struct ev_loop *> as first argument, and you can create 2064will have the C<struct ev_loop *> as first argument, and you can create
1637additional independent event loops. Otherwise there will be no support 2065additional independent event loops. Otherwise there will be no support
1638for multiple event loops and there is no first event loop pointer 2066for multiple event loops and there is no first event loop pointer
1639argument. Instead, all functions act on the single default loop. 2067argument. Instead, all functions act on the single default loop.
1640 2068
1641=item EV_PERIODICS 2069=item EV_PERIODIC_ENABLE
1642 2070
1643If undefined or defined to be C<1>, then periodic timers are supported, 2071If undefined or defined to be C<1>, then periodic timers are supported. If
1644otherwise not. This saves a few kb of code. 2072defined to be C<0>, then they are not. Disabling them saves a few kB of
2073code.
2074
2075=item EV_EMBED_ENABLE
2076
2077If undefined or defined to be C<1>, then embed watchers are supported. If
2078defined to be C<0>, then they are not.
2079
2080=item EV_STAT_ENABLE
2081
2082If undefined or defined to be C<1>, then stat watchers are supported. If
2083defined to be C<0>, then they are not.
2084
2085=item EV_FORK_ENABLE
2086
2087If undefined or defined to be C<1>, then fork watchers are supported. If
2088defined to be C<0>, then they are not.
2089
2090=item EV_MINIMAL
2091
2092If you need to shave off some kilobytes of code at the expense of some
2093speed, define this symbol to C<1>. Currently only used for gcc to override
2094some inlining decisions, saves roughly 30% codesize of amd64.
2095
2096=item EV_PID_HASHSIZE
2097
2098C<ev_child> watchers use a small hash table to distribute workload by
2099pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
2100than enough. If you need to manage thousands of children you might want to
2101increase this value (I<must> be a power of two).
2102
2103=item EV_INOTIFY_HASHSIZE
2104
2105C<ev_staz> watchers use a small hash table to distribute workload by
2106inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2107usually more than enough. If you need to manage thousands of C<ev_stat>
2108watchers you might want to increase this value (I<must> be a power of
2109two).
1645 2110
1646=item EV_COMMON 2111=item EV_COMMON
1647 2112
1648By default, all watchers have a C<void *data> member. By redefining 2113By default, all watchers have a C<void *data> member. By redefining
1649this macro to a something else you can include more and other types of 2114this macro to a something else you can include more and other types of
1692And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: 2157And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
1693 2158
1694 #include "ev_cpp.h" 2159 #include "ev_cpp.h"
1695 #include "ev.c" 2160 #include "ev.c"
1696 2161
2162
2163=head1 COMPLEXITIES
2164
2165In this section the complexities of (many of) the algorithms used inside
2166libev will be explained. For complexity discussions about backends see the
2167documentation for C<ev_default_init>.
2168
2169=over 4
2170
2171=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2172
2173=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
2174
2175=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2176
2177=item Stopping check/prepare/idle watchers: O(1)
2178
2179=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2180
2181=item Finding the next timer per loop iteration: O(1)
2182
2183=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2184
2185=item Activating one watcher: O(1)
2186
2187=back
2188
2189
1697=head1 AUTHOR 2190=head1 AUTHOR
1698 2191
1699Marc Lehmann <libev@schmorp.de>. 2192Marc Lehmann <libev@schmorp.de>.
1700 2193

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines