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

Comparing libev/ev.pod (file contents):
Revision 1.132 by root, Wed Feb 20 17:45:29 2008 UTC vs.
Revision 1.159 by root, Thu May 22 02:44:57 2008 UTC

6 6
7 #include <ev.h> 7 #include <ev.h>
8 8
9=head2 EXAMPLE PROGRAM 9=head2 EXAMPLE PROGRAM
10 10
11 // a single header file is required
11 #include <ev.h> 12 #include <ev.h>
12 13
14 // every watcher type has its own typedef'd struct
15 // with the name ev_<type>
13 ev_io stdin_watcher; 16 ev_io stdin_watcher;
14 ev_timer timeout_watcher; 17 ev_timer timeout_watcher;
15 18
19 // all watcher callbacks have a similar signature
16 /* called when data readable on stdin */ 20 // this callback is called when data is readable on stdin
17 static void 21 static void
18 stdin_cb (EV_P_ struct ev_io *w, int revents) 22 stdin_cb (EV_P_ struct ev_io *w, int revents)
19 { 23 {
20 /* puts ("stdin ready"); */ 24 puts ("stdin ready");
21 ev_io_stop (EV_A_ w); /* just a syntax example */ 25 // for one-shot events, one must manually stop the watcher
22 ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */ 26 // with its corresponding stop function.
27 ev_io_stop (EV_A_ w);
28
29 // this causes all nested ev_loop's to stop iterating
30 ev_unloop (EV_A_ EVUNLOOP_ALL);
23 } 31 }
24 32
33 // another callback, this time for a time-out
25 static void 34 static void
26 timeout_cb (EV_P_ struct ev_timer *w, int revents) 35 timeout_cb (EV_P_ struct ev_timer *w, int revents)
27 { 36 {
28 /* puts ("timeout"); */ 37 puts ("timeout");
29 ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */ 38 // this causes the innermost ev_loop to stop iterating
39 ev_unloop (EV_A_ EVUNLOOP_ONE);
30 } 40 }
31 41
32 int 42 int
33 main (void) 43 main (void)
34 { 44 {
45 // use the default event loop unless you have special needs
35 struct ev_loop *loop = ev_default_loop (0); 46 struct ev_loop *loop = ev_default_loop (0);
36 47
37 /* initialise an io watcher, then start it */ 48 // initialise an io watcher, then start it
49 // this one will watch for stdin to become readable
38 ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); 50 ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
39 ev_io_start (loop, &stdin_watcher); 51 ev_io_start (loop, &stdin_watcher);
40 52
53 // initialise a timer watcher, then start it
41 /* simple non-repeating 5.5 second timeout */ 54 // simple non-repeating 5.5 second timeout
42 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); 55 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
43 ev_timer_start (loop, &timeout_watcher); 56 ev_timer_start (loop, &timeout_watcher);
44 57
45 /* loop till timeout or data ready */ 58 // now wait for events to arrive
46 ev_loop (loop, 0); 59 ev_loop (loop, 0);
47 60
61 // unloop was called, so exit
48 return 0; 62 return 0;
49 } 63 }
50 64
51=head1 DESCRIPTION 65=head1 DESCRIPTION
52 66
53The newest version of this document is also available as a html-formatted 67The newest version of this document is also available as an html-formatted
54web page you might find easier to navigate when reading it for the first 68web page you might find easier to navigate when reading it for the first
55time: L<http://cvs.schmorp.de/libev/ev.html>. 69time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
56 70
57Libev is an event loop: you register interest in certain events (such as a 71Libev is an event loop: you register interest in certain events (such as a
58file descriptor being readable or a timeout occurring), and it will manage 72file descriptor being readable or a timeout occurring), and it will manage
59these event sources and provide your program with events. 73these event sources and provide your program with events.
60 74
84L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent 98L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
85for example). 99for example).
86 100
87=head2 CONVENTIONS 101=head2 CONVENTIONS
88 102
89Libev is very configurable. In this manual the default configuration will 103Libev is very configurable. In this manual the default (and most common)
90be described, which supports multiple event loops. For more info about 104configuration will be described, which supports multiple event loops. For
91various configuration options please have a look at B<EMBED> section in 105more info about various configuration options please have a look at
92this manual. If libev was configured without support for multiple event 106B<EMBED> section in this manual. If libev was configured without support
93loops, then all functions taking an initial argument of name C<loop> 107for multiple event loops, then all functions taking an initial argument of
94(which is always of type C<struct ev_loop *>) will not have this argument. 108name C<loop> (which is always of type C<struct ev_loop *>) will not have
109this argument.
95 110
96=head2 TIME REPRESENTATION 111=head2 TIME REPRESENTATION
97 112
98Libev represents time as a single floating point number, representing the 113Libev represents time as a single floating point number, representing the
99(fractional) number of seconds since the (POSIX) epoch (somewhere near 114(fractional) number of seconds since the (POSIX) epoch (somewhere near
181See the description of C<ev_embed> watchers for more info. 196See the description of C<ev_embed> watchers for more info.
182 197
183=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 198=item ev_set_allocator (void *(*cb)(void *ptr, long size))
184 199
185Sets the allocation function to use (the prototype is similar - the 200Sets the allocation function to use (the prototype is similar - the
186semantics is identical - to the realloc C function). It is used to 201semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
187allocate and free memory (no surprises here). If it returns zero when 202used to allocate and free memory (no surprises here). If it returns zero
188memory needs to be allocated, the library might abort or take some 203when memory needs to be allocated (C<size != 0>), the library might abort
189potentially destructive action. The default is your system realloc 204or take some potentially destructive action.
190function. 205
206Since some systems (at least OpenBSD and Darwin) fail to implement
207correct C<realloc> semantics, libev will use a wrapper around the system
208C<realloc> and C<free> functions by default.
191 209
192You could override this function in high-availability programs to, say, 210You could override this function in high-availability programs to, say,
193free some memory if it cannot allocate memory, to use a special allocator, 211free some memory if it cannot allocate memory, to use a special allocator,
194or even to sleep a while and retry until some memory is available. 212or even to sleep a while and retry until some memory is available.
195 213
196Example: Replace the libev allocator with one that waits a bit and then 214Example: Replace the libev allocator with one that waits a bit and then
197retries). 215retries (example requires a standards-compliant C<realloc>).
198 216
199 static void * 217 static void *
200 persistent_realloc (void *ptr, size_t size) 218 persistent_realloc (void *ptr, size_t size)
201 { 219 {
202 for (;;) 220 for (;;)
241 259
242An event loop is described by a C<struct ev_loop *>. The library knows two 260An event loop is described by a C<struct ev_loop *>. The library knows two
243types of such loops, the I<default> loop, which supports signals and child 261types of such loops, the I<default> loop, which supports signals and child
244events, and dynamically created loops which do not. 262events, and dynamically created loops which do not.
245 263
246If you use threads, a common model is to run the default event loop
247in your main thread (or in a separate thread) and for each thread you
248create, you also create another event loop. Libev itself does no locking
249whatsoever, so if you mix calls to the same event loop in different
250threads, make sure you lock (this is usually a bad idea, though, even if
251done correctly, because it's hideous and inefficient).
252
253=over 4 264=over 4
254 265
255=item struct ev_loop *ev_default_loop (unsigned int flags) 266=item struct ev_loop *ev_default_loop (unsigned int flags)
256 267
257This will initialise the default event loop if it hasn't been initialised 268This will initialise the default event loop if it hasn't been initialised
259false. If it already was initialised it simply returns it (and ignores the 270false. If it already was initialised it simply returns it (and ignores the
260flags. If that is troubling you, check C<ev_backend ()> afterwards). 271flags. If that is troubling you, check C<ev_backend ()> afterwards).
261 272
262If you don't know what event loop to use, use the one returned from this 273If you don't know what event loop to use, use the one returned from this
263function. 274function.
275
276Note that this function is I<not> thread-safe, so if you want to use it
277from multiple threads, you have to lock (note also that this is unlikely,
278as loops cannot bes hared easily between threads anyway).
264 279
265The default loop is the only loop that can handle C<ev_signal> and 280The default loop is the only loop that can handle C<ev_signal> and
266C<ev_child> watchers, and to do this, it always registers a handler 281C<ev_child> watchers, and to do this, it always registers a handler
267for C<SIGCHLD>. If this is a problem for your app you can either 282for C<SIGCHLD>. If this is a problem for your app you can either
268create a dynamic loop with C<ev_loop_new> that doesn't do that, or you 283create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
297enabling this flag. 312enabling this flag.
298 313
299This works by calling C<getpid ()> on every iteration of the loop, 314This works by calling C<getpid ()> on every iteration of the loop,
300and thus this might slow down your event loop if you do a lot of loop 315and thus this might slow down your event loop if you do a lot of loop
301iterations and little real work, but is usually not noticeable (on my 316iterations and little real work, but is usually not noticeable (on my
302Linux system for example, C<getpid> is actually a simple 5-insn sequence 317GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
303without a syscall and thus I<very> fast, but my Linux system also has 318without a syscall and thus I<very> fast, but my GNU/Linux system also has
304C<pthread_atfork> which is even faster). 319C<pthread_atfork> which is even faster).
305 320
306The big advantage of this flag is that you can forget about fork (and 321The big advantage of this flag is that you can forget about fork (and
307forget about forgetting to tell libev about forking) when you use this 322forget about forgetting to tell libev about forking) when you use this
308flag. 323flag.
321To get good performance out of this backend you need a high amount of 336To get good performance out of this backend you need a high amount of
322parallelity (most of the file descriptors should be busy). If you are 337parallelity (most of the file descriptors should be busy). If you are
323writing a server, you should C<accept ()> in a loop to accept as many 338writing a server, you should C<accept ()> in a loop to accept as many
324connections as possible during one iteration. You might also want to have 339connections as possible during one iteration. You might also want to have
325a look at C<ev_set_io_collect_interval ()> to increase the amount of 340a look at C<ev_set_io_collect_interval ()> to increase the amount of
326readyness notifications you get per iteration. 341readiness notifications you get per iteration.
327 342
328=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) 343=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
329 344
330And this is your standard poll(2) backend. It's more complicated 345And this is your standard poll(2) backend. It's more complicated
331than select, but handles sparse fds better and has no artificial 346than select, but handles sparse fds better and has no artificial
339For few fds, this backend is a bit little slower than poll and select, 354For few fds, this backend is a bit little slower than poll and select,
340but it scales phenomenally better. While poll and select usually scale 355but it scales phenomenally better. While poll and select usually scale
341like O(total_fds) where n is the total number of fds (or the highest fd), 356like O(total_fds) where n is the total number of fds (or the highest fd),
342epoll scales either O(1) or O(active_fds). The epoll design has a number 357epoll scales either O(1) or O(active_fds). The epoll design has a number
343of shortcomings, such as silently dropping events in some hard-to-detect 358of shortcomings, such as silently dropping events in some hard-to-detect
344cases and rewiring a syscall per fd change, no fork support and bad 359cases and requiring a syscall per fd change, no fork support and bad
345support for dup. 360support for dup.
346 361
347While stopping, setting and starting an I/O watcher in the same iteration 362While stopping, setting and starting an I/O watcher in the same iteration
348will result in some caching, there is still a syscall per such incident 363will result in some caching, there is still a syscall per such incident
349(because the fd could point to a different file description now), so its 364(because the fd could point to a different file description now), so its
410While this backend scales well, it requires one system call per active 425While this backend scales well, it requires one system call per active
411file descriptor per loop iteration. For small and medium numbers of file 426file descriptor per loop iteration. For small and medium numbers of file
412descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend 427descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
413might perform better. 428might perform better.
414 429
415On the positive side, ignoring the spurious readyness notifications, this 430On the positive side, ignoring the spurious readiness notifications, this
416backend actually performed to specification in all tests and is fully 431backend actually performed to specification in all tests and is fully
417embeddable, which is a rare feat among the OS-specific backends. 432embeddable, which is a rare feat among the OS-specific backends.
418 433
419=item C<EVBACKEND_ALL> 434=item C<EVBACKEND_ALL>
420 435
450 465
451Similar to C<ev_default_loop>, but always creates a new event loop that is 466Similar to C<ev_default_loop>, but always creates a new event loop that is
452always distinct from the default loop. Unlike the default loop, it cannot 467always distinct from the default loop. Unlike the default loop, it cannot
453handle signal and child watchers, and attempts to do so will be greeted by 468handle signal and child watchers, and attempts to do so will be greeted by
454undefined behaviour (or a failed assertion if assertions are enabled). 469undefined behaviour (or a failed assertion if assertions are enabled).
470
471Note that this function I<is> thread-safe, and the recommended way to use
472libev with threads is indeed to create one loop per thread, and using the
473default loop in the "main" or "initial" thread.
455 474
456Example: Try to create a event loop that uses epoll and nothing else. 475Example: Try to create a event loop that uses epoll and nothing else.
457 476
458 struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 477 struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
459 if (!epoller) 478 if (!epoller)
670interval to a value near C<0.1> or so, which is often enough for 689interval to a value near C<0.1> or so, which is often enough for
671interactive servers (of course not for games), likewise for timeouts. It 690interactive servers (of course not for games), likewise for timeouts. It
672usually doesn't make much sense to set it to a lower value than C<0.01>, 691usually doesn't make much sense to set it to a lower value than C<0.01>,
673as this approsaches the timing granularity of most systems. 692as this approsaches the timing granularity of most systems.
674 693
694=item ev_loop_verify (loop)
695
696This function only does something when C<EV_VERIFY> support has been
697compiled in. It tries to go through all internal structures and checks
698them for validity. If anything is found to be inconsistent, it will print
699an error message to standard error and call C<abort ()>.
700
701This can be used to catch bugs inside libev itself: under normal
702circumstances, this function will never abort as of course libev keeps its
703data structures consistent.
704
675=back 705=back
676 706
677 707
678=head1 ANATOMY OF A WATCHER 708=head1 ANATOMY OF A WATCHER
679 709
1013If you must do this, then force the use of a known-to-be-good backend 1043If you must do this, then force the use of a known-to-be-good backend
1014(at the time of this writing, this includes only C<EVBACKEND_SELECT> and 1044(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
1015C<EVBACKEND_POLL>). 1045C<EVBACKEND_POLL>).
1016 1046
1017Another thing you have to watch out for is that it is quite easy to 1047Another thing you have to watch out for is that it is quite easy to
1018receive "spurious" readyness notifications, that is your callback might 1048receive "spurious" readiness notifications, that is your callback might
1019be called with C<EV_READ> but a subsequent C<read>(2) will actually block 1049be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1020because there is no data. Not only are some backends known to create a 1050because there is no data. Not only are some backends known to create a
1021lot of those (for example solaris ports), it is very easy to get into 1051lot of those (for example solaris ports), it is very easy to get into
1022this situation even with a relatively standard program structure. Thus 1052this situation even with a relatively standard program structure. Thus
1023it is best to always use non-blocking I/O: An extra C<read>(2) returning 1053it is best to always use non-blocking I/O: An extra C<read>(2) returning
1070To support fork in your programs, you either have to call 1100To support fork in your programs, you either have to call
1071C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child, 1101C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1072enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or 1102enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1073C<EVBACKEND_POLL>. 1103C<EVBACKEND_POLL>.
1074 1104
1105=head3 The special problem of SIGPIPE
1106
1107While not really specific to libev, it is easy to forget about SIGPIPE:
1108when reading from a pipe whose other end has been closed, your program
1109gets send a SIGPIPE, which, by default, aborts your program. For most
1110programs this is sensible behaviour, for daemons, this is usually
1111undesirable.
1112
1113So when you encounter spurious, unexplained daemon exits, make sure you
1114ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1115somewhere, as that would have given you a big clue).
1116
1075 1117
1076=head3 Watcher-Specific Functions 1118=head3 Watcher-Specific Functions
1077 1119
1078=over 4 1120=over 4
1079 1121
1120 1162
1121Timer watchers are simple relative timers that generate an event after a 1163Timer watchers are simple relative timers that generate an event after a
1122given time, and optionally repeating in regular intervals after that. 1164given time, and optionally repeating in regular intervals after that.
1123 1165
1124The timers are based on real time, that is, if you register an event that 1166The timers are based on real time, that is, if you register an event that
1125times out after an hour and you reset your system clock to last years 1167times out after an hour and you reset your system clock to january last
1126time, it will still time out after (roughly) and hour. "Roughly" because 1168year, it will still time out after (roughly) and hour. "Roughly" because
1127detecting time jumps is hard, and some inaccuracies are unavoidable (the 1169detecting time jumps is hard, and some inaccuracies are unavoidable (the
1128monotonic clock option helps a lot here). 1170monotonic clock option helps a lot here).
1129 1171
1130The relative timeouts are calculated relative to the C<ev_now ()> 1172The relative timeouts are calculated relative to the C<ev_now ()>
1131time. This is usually the right thing as this timestamp refers to the time 1173time. This is usually the right thing as this timestamp refers to the time
1133you suspect event processing to be delayed and you I<need> to base the timeout 1175you suspect event processing to be delayed and you I<need> to base the timeout
1134on the current time, use something like this to adjust for this: 1176on the current time, use something like this to adjust for this:
1135 1177
1136 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 1178 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1137 1179
1138The callback is guarenteed to be invoked only when its timeout has passed, 1180The callback is guarenteed to be invoked only after its timeout has passed,
1139but if multiple timers become ready during the same loop iteration then 1181but if multiple timers become ready during the same loop iteration then
1140order of execution is undefined. 1182order of execution is undefined.
1141 1183
1142=head3 Watcher-Specific Functions and Data Members 1184=head3 Watcher-Specific Functions and Data Members
1143 1185
1145 1187
1146=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1188=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1147 1189
1148=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) 1190=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1149 1191
1150Configure the timer to trigger after C<after> seconds. If C<repeat> is 1192Configure the timer to trigger after C<after> seconds. If C<repeat>
1151C<0.>, then it will automatically be stopped. If it is positive, then the 1193is C<0.>, then it will automatically be stopped once the timeout is
1152timer will automatically be configured to trigger again C<repeat> seconds 1194reached. If it is positive, then the timer will automatically be
1153later, again, and again, until stopped manually. 1195configured to trigger again C<repeat> seconds later, again, and again,
1196until stopped manually.
1154 1197
1155The timer itself will do a best-effort at avoiding drift, that is, if you 1198The timer itself will do a best-effort at avoiding drift, that is, if
1156configure a timer to trigger every 10 seconds, then it will trigger at 1199you configure a timer to trigger every 10 seconds, then it will normally
1157exactly 10 second intervals. If, however, your program cannot keep up with 1200trigger at exactly 10 second intervals. If, however, your program cannot
1158the timer (because it takes longer than those 10 seconds to do stuff) the 1201keep up with the timer (because it takes longer than those 10 seconds to
1159timer will not fire more than once per event loop iteration. 1202do stuff) the timer will not fire more than once per event loop iteration.
1160 1203
1161=item ev_timer_again (loop, ev_timer *) 1204=item ev_timer_again (loop, ev_timer *)
1162 1205
1163This will act as if the timer timed out and restart it again if it is 1206This will act as if the timer timed out and restart it again if it is
1164repeating. The exact semantics are: 1207repeating. The exact semantics are:
1241Periodic watchers are also timers of a kind, but they are very versatile 1284Periodic watchers are also timers of a kind, but they are very versatile
1242(and unfortunately a bit complex). 1285(and unfortunately a bit complex).
1243 1286
1244Unlike C<ev_timer>'s, they are not based on real time (or relative time) 1287Unlike C<ev_timer>'s, they are not based on real time (or relative time)
1245but on wallclock time (absolute time). You can tell a periodic watcher 1288but on wallclock time (absolute time). You can tell a periodic watcher
1246to trigger "at" some specific point in time. For example, if you tell a 1289to trigger after some specific point in time. For example, if you tell a
1247periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now () 1290periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
1248+ 10.>) and then reset your system clock to the last year, then it will 1291+ 10.>, that is, an absolute time not a delay) and then reset your system
1292clock to january of the previous year, then it will take more than year
1249take a year to trigger the event (unlike an C<ev_timer>, which would trigger 1293to trigger the event (unlike an C<ev_timer>, which would still trigger
1250roughly 10 seconds later). 1294roughly 10 seconds later as it uses a relative timeout).
1251 1295
1252They can also be used to implement vastly more complex timers, such as 1296C<ev_periodic>s can also be used to implement vastly more complex timers,
1253triggering an event on each midnight, local time or other, complicated, 1297such as triggering an event on each "midnight, local time", or other
1254rules. 1298complicated, rules.
1255 1299
1256As with timers, the callback is guarenteed to be invoked only when the 1300As with timers, the callback is guarenteed to be invoked only when the
1257time (C<at>) has been passed, but if multiple periodic timers become ready 1301time (C<at>) has passed, but if multiple periodic timers become ready
1258during the same loop iteration then order of execution is undefined. 1302during the same loop iteration then order of execution is undefined.
1259 1303
1260=head3 Watcher-Specific Functions and Data Members 1304=head3 Watcher-Specific Functions and Data Members
1261 1305
1262=over 4 1306=over 4
1270 1314
1271=over 4 1315=over 4
1272 1316
1273=item * absolute timer (at = time, interval = reschedule_cb = 0) 1317=item * absolute timer (at = time, interval = reschedule_cb = 0)
1274 1318
1275In this configuration the watcher triggers an event at the wallclock time 1319In this configuration the watcher triggers an event after the wallclock
1276C<at> and doesn't repeat. It will not adjust when a time jump occurs, 1320time C<at> has passed and doesn't repeat. It will not adjust when a time
1277that is, if it is to be run at January 1st 2011 then it will run when the 1321jump occurs, that is, if it is to be run at January 1st 2011 then it will
1278system time reaches or surpasses this time. 1322run when the system time reaches or surpasses this time.
1279 1323
1280=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1324=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1281 1325
1282In this mode the watcher will always be scheduled to time out at the next 1326In this mode the watcher will always be scheduled to time out at the next
1283C<at + N * interval> time (for some integer N, which can also be negative) 1327C<at + N * interval> time (for some integer N, which can also be negative)
1284and then repeat, regardless of any time jumps. 1328and then repeat, regardless of any time jumps.
1285 1329
1286This can be used to create timers that do not drift with respect to system 1330This can be used to create timers that do not drift with respect to system
1287time: 1331time, for example, here is a C<ev_periodic> that triggers each hour, on
1332the hour:
1288 1333
1289 ev_periodic_set (&periodic, 0., 3600., 0); 1334 ev_periodic_set (&periodic, 0., 3600., 0);
1290 1335
1291This doesn't mean there will always be 3600 seconds in between triggers, 1336This doesn't mean there will always be 3600 seconds in between triggers,
1292but only that the the callback will be called when the system time shows a 1337but only that the the callback will be called when the system time shows a
1297C<ev_periodic> will try to run the callback in this mode at the next possible 1342C<ev_periodic> will try to run the callback in this mode at the next possible
1298time where C<time = at (mod interval)>, regardless of any time jumps. 1343time where C<time = at (mod interval)>, regardless of any time jumps.
1299 1344
1300For numerical stability it is preferable that the C<at> value is near 1345For numerical stability it is preferable that the C<at> value is near
1301C<ev_now ()> (the current time), but there is no range requirement for 1346C<ev_now ()> (the current time), but there is no range requirement for
1302this value. 1347this value, and in fact is often specified as zero.
1348
1349Note also that there is an upper limit to how often a timer can fire (cpu
1350speed for example), so if C<interval> is very small then timing stability
1351will of course detoriate. Libev itself tries to be exact to be about one
1352millisecond (if the OS supports it and the machine is fast enough).
1303 1353
1304=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) 1354=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1305 1355
1306In this mode the values for C<interval> and C<at> are both being 1356In this mode the values for C<interval> and C<at> are both being
1307ignored. Instead, each time the periodic watcher gets scheduled, the 1357ignored. Instead, each time the periodic watcher gets scheduled, the
1308reschedule callback will be called with the watcher as first, and the 1358reschedule callback will be called with the watcher as first, and the
1309current time as second argument. 1359current time as second argument.
1310 1360
1311NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, 1361NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1312ever, or make any event loop modifications>. If you need to stop it, 1362ever, or make ANY event loop modifications whatsoever>.
1313return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1314starting an C<ev_prepare> watcher, which is legal).
1315 1363
1364If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
1365it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1366only event loop modification you are allowed to do).
1367
1316Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, 1368The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic
1317ev_tstamp now)>, e.g.: 1369*w, ev_tstamp now)>, e.g.:
1318 1370
1319 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) 1371 static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
1320 { 1372 {
1321 return now + 60.; 1373 return now + 60.;
1322 } 1374 }
1324It must return the next time to trigger, based on the passed time value 1376It must return the next time to trigger, based on the passed time value
1325(that is, the lowest time value larger than to the second argument). It 1377(that is, the lowest time value larger than to the second argument). It
1326will usually be called just before the callback will be triggered, but 1378will usually be called just before the callback will be triggered, but
1327might be called at other times, too. 1379might be called at other times, too.
1328 1380
1329NOTE: I<< This callback must always return a time that is later than the 1381NOTE: I<< This callback must always return a time that is higher than or
1330passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger. 1382equal to the passed C<now> value >>.
1331 1383
1332This can be used to create very complex timers, such as a timer that 1384This can be used to create very complex timers, such as a timer that
1333triggers on each midnight, local time. To do this, you would calculate the 1385triggers on "next midnight, local time". To do this, you would calculate the
1334next midnight after C<now> and return the timestamp value for this. How 1386next midnight after C<now> and return the timestamp value for this. How
1335you do this is, again, up to you (but it is not trivial, which is the main 1387you do this is, again, up to you (but it is not trivial, which is the main
1336reason I omitted it as an example). 1388reason I omitted it as an example).
1337 1389
1338=back 1390=back
1342Simply stops and restarts the periodic watcher again. This is only useful 1394Simply stops and restarts the periodic watcher again. This is only useful
1343when you changed some parameters or the reschedule callback would return 1395when you changed some parameters or the reschedule callback would return
1344a different time than the last time it was called (e.g. in a crond like 1396a different time than the last time it was called (e.g. in a crond like
1345program when the crontabs have changed). 1397program when the crontabs have changed).
1346 1398
1399=item ev_tstamp ev_periodic_at (ev_periodic *)
1400
1401When active, returns the absolute time that the watcher is supposed to
1402trigger next.
1403
1347=item ev_tstamp offset [read-write] 1404=item ev_tstamp offset [read-write]
1348 1405
1349When repeating, this contains the offset value, otherwise this is the 1406When repeating, this contains the offset value, otherwise this is the
1350absolute point in time (the C<at> value passed to C<ev_periodic_set>). 1407absolute point in time (the C<at> value passed to C<ev_periodic_set>).
1351 1408
1361=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write] 1418=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]
1362 1419
1363The current reschedule callback, or C<0>, if this functionality is 1420The current reschedule callback, or C<0>, if this functionality is
1364switched off. Can be changed any time, but changes only take effect when 1421switched off. Can be changed any time, but changes only take effect when
1365the periodic timer fires or C<ev_periodic_again> is being called. 1422the periodic timer fires or C<ev_periodic_again> is being called.
1366
1367=item ev_tstamp at [read-only]
1368
1369When active, contains the absolute time that the watcher is supposed to
1370trigger next.
1371 1423
1372=back 1424=back
1373 1425
1374=head3 Examples 1426=head3 Examples
1375 1427
1419with the kernel (thus it coexists with your own signal handlers as long 1471with the kernel (thus it coexists with your own signal handlers as long
1420as you don't register any with libev). Similarly, when the last signal 1472as you don't register any with libev). Similarly, when the last signal
1421watcher for a signal is stopped libev will reset the signal handler to 1473watcher for a signal is stopped libev will reset the signal handler to
1422SIG_DFL (regardless of what it was set to before). 1474SIG_DFL (regardless of what it was set to before).
1423 1475
1476If possible and supported, libev will install its handlers with
1477C<SA_RESTART> behaviour enabled, so syscalls should not be unduly
1478interrupted. If you have a problem with syscalls getting interrupted by
1479signals you can block all signals in an C<ev_check> watcher and unblock
1480them in an C<ev_prepare> watcher.
1481
1424=head3 Watcher-Specific Functions and Data Members 1482=head3 Watcher-Specific Functions and Data Members
1425 1483
1426=over 4 1484=over 4
1427 1485
1428=item ev_signal_init (ev_signal *, callback, int signum) 1486=item ev_signal_init (ev_signal *, callback, int signum)
1454 1512
1455 1513
1456=head2 C<ev_child> - watch out for process status changes 1514=head2 C<ev_child> - watch out for process status changes
1457 1515
1458Child watchers trigger when your process receives a SIGCHLD in response to 1516Child watchers trigger when your process receives a SIGCHLD in response to
1459some child status changes (most typically when a child of yours dies). 1517some child status changes (most typically when a child of yours dies). It
1518is permissible to install a child watcher I<after> the child has been
1519forked (which implies it might have already exited), as long as the event
1520loop isn't entered (or is continued from a watcher).
1521
1522Only the default event loop is capable of handling signals, and therefore
1523you can only rgeister child watchers in the default event loop.
1524
1525=head3 Process Interaction
1526
1527Libev grabs C<SIGCHLD> as soon as the default event loop is
1528initialised. This is necessary to guarantee proper behaviour even if
1529the first child watcher is started after the child exits. The occurance
1530of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1531synchronously as part of the event loop processing. Libev always reaps all
1532children, even ones not watched.
1533
1534=head3 Overriding the Built-In Processing
1535
1536Libev offers no special support for overriding the built-in child
1537processing, but if your application collides with libev's default child
1538handler, you can override it easily by installing your own handler for
1539C<SIGCHLD> after initialising the default loop, and making sure the
1540default loop never gets destroyed. You are encouraged, however, to use an
1541event-based approach to child reaping and thus use libev's support for
1542that, so other libev users can use C<ev_child> watchers freely.
1460 1543
1461=head3 Watcher-Specific Functions and Data Members 1544=head3 Watcher-Specific Functions and Data Members
1462 1545
1463=over 4 1546=over 4
1464 1547
1488The process exit/trace status caused by C<rpid> (see your systems 1571The process exit/trace status caused by C<rpid> (see your systems
1489C<waitpid> and C<sys/wait.h> documentation for details). 1572C<waitpid> and C<sys/wait.h> documentation for details).
1490 1573
1491=back 1574=back
1492 1575
1576=head3 Examples
1577
1578Example: C<fork()> a new process and install a child handler to wait for
1579its completion.
1580
1581 ev_child cw;
1582
1583 static void
1584 child_cb (EV_P_ struct ev_child *w, int revents)
1585 {
1586 ev_child_stop (EV_A_ w);
1587 printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1588 }
1589
1590 pid_t pid = fork ();
1591
1592 if (pid < 0)
1593 // error
1594 else if (pid == 0)
1595 {
1596 // the forked child executes here
1597 exit (1);
1598 }
1599 else
1600 {
1601 ev_child_init (&cw, child_cb, pid, 0);
1602 ev_child_start (EV_DEFAULT_ &cw);
1603 }
1604
1493 1605
1494=head2 C<ev_stat> - did the file attributes just change? 1606=head2 C<ev_stat> - did the file attributes just change?
1495 1607
1496This watches a filesystem path for attribute changes. That is, it calls 1608This watches a filesystem path for attribute changes. That is, it calls
1497C<stat> regularly (or when the OS says it changed) and sees if it changed 1609C<stat> regularly (or when the OS says it changed) and sees if it changed
1519as even with OS-supported change notifications, this can be 1631as even with OS-supported change notifications, this can be
1520resource-intensive. 1632resource-intensive.
1521 1633
1522At the time of this writing, only the Linux inotify interface is 1634At the time of this writing, only the Linux inotify interface is
1523implemented (implementing kqueue support is left as an exercise for the 1635implemented (implementing kqueue support is left as an exercise for the
1636reader, note, however, that the author sees no way of implementing ev_stat
1524reader). Inotify will be used to give hints only and should not change the 1637semantics with kqueue). Inotify will be used to give hints only and should
1525semantics of C<ev_stat> watchers, which means that libev sometimes needs 1638not change the semantics of C<ev_stat> watchers, which means that libev
1526to fall back to regular polling again even with inotify, but changes are 1639sometimes needs to fall back to regular polling again even with inotify,
1527usually detected immediately, and if the file exists there will be no 1640but changes are usually detected immediately, and if the file exists there
1528polling. 1641will be no polling.
1642
1643=head3 ABI Issues (Largefile Support)
1644
1645Libev by default (unless the user overrides this) uses the default
1646compilation environment, which means that on systems with optionally
1647disabled large file support, you get the 32 bit version of the stat
1648structure. When using the library from programs that change the ABI to
1649use 64 bit file offsets the programs will fail. In that case you have to
1650compile libev with the same flags to get binary compatibility. This is
1651obviously the case with any flags that change the ABI, but the problem is
1652most noticably with ev_stat and largefile support.
1529 1653
1530=head3 Inotify 1654=head3 Inotify
1531 1655
1532When C<inotify (7)> support has been compiled into libev (generally only 1656When C<inotify (7)> support has been compiled into libev (generally only
1533available on Linux) and present at runtime, it will be used to speed up 1657available on Linux) and present at runtime, it will be used to speed up
1534change detection where possible. The inotify descriptor will be created lazily 1658change detection where possible. The inotify descriptor will be created lazily
1535when the first C<ev_stat> watcher is being started. 1659when the first C<ev_stat> watcher is being started.
1536 1660
1537Inotify presense does not change the semantics of C<ev_stat> watchers 1661Inotify presence does not change the semantics of C<ev_stat> watchers
1538except that changes might be detected earlier, and in some cases, to avoid 1662except that changes might be detected earlier, and in some cases, to avoid
1539making regular C<stat> calls. Even in the presense of inotify support 1663making regular C<stat> calls. Even in the presence of inotify support
1540there are many cases where libev has to resort to regular C<stat> polling. 1664there are many cases where libev has to resort to regular C<stat> polling.
1541 1665
1542(There is no support for kqueue, as apparently it cannot be used to 1666(There is no support for kqueue, as apparently it cannot be used to
1543implement this functionality, due to the requirement of having a file 1667implement this functionality, due to the requirement of having a file
1544descriptor open on the object at all times). 1668descriptor open on the object at all times).
1547 1671
1548The C<stat ()> syscall only supports full-second resolution portably, and 1672The C<stat ()> syscall only supports full-second resolution portably, and
1549even on systems where the resolution is higher, many filesystems still 1673even on systems where the resolution is higher, many filesystems still
1550only support whole seconds. 1674only support whole seconds.
1551 1675
1552That means that, if the time is the only thing that changes, you might 1676That means that, if the time is the only thing that changes, you can
1553miss updates: on the first update, C<ev_stat> detects a change and calls 1677easily miss updates: on the first update, C<ev_stat> detects a change and
1554your callback, which does something. When there is another update within 1678calls your callback, which does something. When there is another update
1555the same second, C<ev_stat> will be unable to detect it. 1679within the same second, C<ev_stat> will be unable to detect it as the stat
1680data does not change.
1556 1681
1557The solution to this is to delay acting on a change for a second (or till 1682The solution to this is to delay acting on a change for slightly more
1558the next second boundary), using a roughly one-second delay C<ev_timer> 1683than a second (or till slightly after the next full second boundary), using
1559(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01> 1684a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1560is added to work around small timing inconsistencies of some operating 1685ev_timer_again (loop, w)>).
1561systems. 1686
1687The C<.02> offset is added to work around small timing inconsistencies
1688of some operating systems (where the second counter of the current time
1689might be be delayed. One such system is the Linux kernel, where a call to
1690C<gettimeofday> might return a timestamp with a full second later than
1691a subsequent C<time> call - if the equivalent of C<time ()> is used to
1692update file times then there will be a small window where the kernel uses
1693the previous second to update file times but libev might already execute
1694the timer callback).
1562 1695
1563=head3 Watcher-Specific Functions and Data Members 1696=head3 Watcher-Specific Functions and Data Members
1564 1697
1565=over 4 1698=over 4
1566 1699
1572C<path>. The C<interval> is a hint on how quickly a change is expected to 1705C<path>. The C<interval> is a hint on how quickly a change is expected to
1573be detected and should normally be specified as C<0> to let libev choose 1706be detected and should normally be specified as C<0> to let libev choose
1574a suitable value. The memory pointed to by C<path> must point to the same 1707a suitable value. The memory pointed to by C<path> must point to the same
1575path for as long as the watcher is active. 1708path for as long as the watcher is active.
1576 1709
1577The callback will be receive C<EV_STAT> when a change was detected, 1710The callback will receive C<EV_STAT> when a change was detected, relative
1578relative to the attributes at the time the watcher was started (or the 1711to the attributes at the time the watcher was started (or the last change
1579last change was detected). 1712was detected).
1580 1713
1581=item ev_stat_stat (loop, ev_stat *) 1714=item ev_stat_stat (loop, ev_stat *)
1582 1715
1583Updates the stat buffer immediately with new values. If you change the 1716Updates the stat buffer immediately with new values. If you change the
1584watched path in your callback, you could call this fucntion to avoid 1717watched path in your callback, you could call this function to avoid
1585detecting this change (while introducing a race condition). Can also be 1718detecting this change (while introducing a race condition if you are not
1586useful simply to find out the new values. 1719the only one changing the path). Can also be useful simply to find out the
1720new values.
1587 1721
1588=item ev_statdata attr [read-only] 1722=item ev_statdata attr [read-only]
1589 1723
1590The most-recently detected attributes of the file. Although the type is of 1724The most-recently detected attributes of the file. Although the type is
1591C<ev_statdata>, this is usually the (or one of the) C<struct stat> types 1725C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
1592suitable for your system. If the C<st_nlink> member is C<0>, then there 1726suitable for your system, but you can only rely on the POSIX-standardised
1727members to be present. If the C<st_nlink> member is C<0>, then there was
1593was some error while C<stat>ing the file. 1728some error while C<stat>ing the file.
1594 1729
1595=item ev_statdata prev [read-only] 1730=item ev_statdata prev [read-only]
1596 1731
1597The previous attributes of the file. The callback gets invoked whenever 1732The previous attributes of the file. The callback gets invoked whenever
1598C<prev> != C<attr>. 1733C<prev> != C<attr>, or, more precisely, one or more of these members
1734differ: C<st_dev>, C<st_ino>, C<st_mode>, C<st_nlink>, C<st_uid>,
1735C<st_gid>, C<st_rdev>, C<st_size>, C<st_atime>, C<st_mtime>, C<st_ctime>.
1599 1736
1600=item ev_tstamp interval [read-only] 1737=item ev_tstamp interval [read-only]
1601 1738
1602The specified interval. 1739The specified interval.
1603 1740
1657 } 1794 }
1658 1795
1659 ... 1796 ...
1660 ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); 1797 ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1661 ev_stat_start (loop, &passwd); 1798 ev_stat_start (loop, &passwd);
1662 ev_timer_init (&timer, timer_cb, 0., 1.01); 1799 ev_timer_init (&timer, timer_cb, 0., 1.02);
1663 1800
1664 1801
1665=head2 C<ev_idle> - when you've got nothing better to do... 1802=head2 C<ev_idle> - when you've got nothing better to do...
1666 1803
1667Idle watchers trigger events when no other events of the same or higher 1804Idle watchers trigger events when no other events of the same or higher
1755 1892
1756It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 1893It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1757priority, to ensure that they are being run before any other watchers 1894priority, to ensure that they are being run before any other watchers
1758after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, 1895after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1759too) should not activate ("feed") events into libev. While libev fully 1896too) should not activate ("feed") events into libev. While libev fully
1760supports this, they will be called before other C<ev_check> watchers 1897supports this, they might get executed before other C<ev_check> watchers
1761did their job. As C<ev_check> watchers are often used to embed other 1898did their job. As C<ev_check> watchers are often used to embed other
1762(non-libev) event loops those other event loops might be in an unusable 1899(non-libev) event loops those other event loops might be in an unusable
1763state until their C<ev_check> watcher ran (always remind yourself to 1900state until their C<ev_check> watcher ran (always remind yourself to
1764coexist peacefully with others). 1901coexist peacefully with others).
1765 1902
1780=head3 Examples 1917=head3 Examples
1781 1918
1782There are a number of principal ways to embed other event loops or modules 1919There are a number of principal ways to embed other event loops or modules
1783into libev. Here are some ideas on how to include libadns into libev 1920into libev. Here are some ideas on how to include libadns into libev
1784(there is a Perl module named C<EV::ADNS> that does this, which you could 1921(there is a Perl module named C<EV::ADNS> that does this, which you could
1785use for an actually working example. Another Perl module named C<EV::Glib> 1922use as a working example. Another Perl module named C<EV::Glib> embeds a
1786embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV 1923Glib main context into libev, and finally, C<Glib::EV> embeds EV into the
1787into the Glib event loop). 1924Glib event loop).
1788 1925
1789Method 1: Add IO watchers and a timeout watcher in a prepare handler, 1926Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1790and in a check watcher, destroy them and call into libadns. What follows 1927and in a check watcher, destroy them and call into libadns. What follows
1791is pseudo-code only of course. This requires you to either use a low 1928is pseudo-code only of course. This requires you to either use a low
1792priority for the check watcher or use C<ev_clear_pending> explicitly, as 1929priority for the check watcher or use C<ev_clear_pending> explicitly, as
2102 { 2239 {
2103 sometype data; 2240 sometype data;
2104 2241
2105 // no locking etc. 2242 // no locking etc.
2106 queue_put (data); 2243 queue_put (data);
2107 ev_async_send (DEFAULT_ &mysig); 2244 ev_async_send (EV_DEFAULT_ &mysig);
2108 } 2245 }
2109 2246
2110 static void 2247 static void
2111 mysig_cb (EV_P_ ev_async *w, int revents) 2248 mysig_cb (EV_P_ ev_async *w, int revents)
2112 { 2249 {
2143 // only need to lock the actual queueing operation 2280 // only need to lock the actual queueing operation
2144 pthread_mutex_lock (&mymutex); 2281 pthread_mutex_lock (&mymutex);
2145 queue_put (data); 2282 queue_put (data);
2146 pthread_mutex_unlock (&mymutex); 2283 pthread_mutex_unlock (&mymutex);
2147 2284
2148 ev_async_send (DEFAULT_ &mysig); 2285 ev_async_send (EV_DEFAULT_ &mysig);
2149 } 2286 }
2150 2287
2151 static void 2288 static void
2152 mysig_cb (EV_P_ ev_async *w, int revents) 2289 mysig_cb (EV_P_ ev_async *w, int revents)
2153 { 2290 {
2181section below on what exactly this means). 2318section below on what exactly this means).
2182 2319
2183This call incurs the overhead of a syscall only once per loop iteration, 2320This call incurs the overhead of a syscall only once per loop iteration,
2184so while the overhead might be noticable, it doesn't apply to repeated 2321so while the overhead might be noticable, it doesn't apply to repeated
2185calls to C<ev_async_send>. 2322calls to C<ev_async_send>.
2323
2324=item bool = ev_async_pending (ev_async *)
2325
2326Returns a non-zero value when C<ev_async_send> has been called on the
2327watcher but the event has not yet been processed (or even noted) by the
2328event loop.
2329
2330C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2331the loop iterates next and checks for the watcher to have become active,
2332it will reset the flag again. C<ev_async_pending> can be used to very
2333quickly check wether invoking the loop might be a good idea.
2334
2335Not that this does I<not> check wether the watcher itself is pending, only
2336wether it has been requested to make this watcher pending.
2186 2337
2187=back 2338=back
2188 2339
2189 2340
2190=head1 OTHER FUNCTIONS 2341=head1 OTHER FUNCTIONS
2262 2413
2263=item * Priorities are not currently supported. Initialising priorities 2414=item * Priorities are not currently supported. Initialising priorities
2264will fail and all watchers will have the same priority, even though there 2415will fail and all watchers will have the same priority, even though there
2265is an ev_pri field. 2416is an ev_pri field.
2266 2417
2418=item * In libevent, the last base created gets the signals, in libev, the
2419first base created (== the default loop) gets the signals.
2420
2267=item * Other members are not supported. 2421=item * Other members are not supported.
2268 2422
2269=item * The libev emulation is I<not> ABI compatible to libevent, you need 2423=item * The libev emulation is I<not> ABI compatible to libevent, you need
2270to use the libev header file and library. 2424to use the libev header file and library.
2271 2425
2434 io.start (fd, ev::READ); 2588 io.start (fd, ev::READ);
2435 } 2589 }
2436 }; 2590 };
2437 2591
2438 2592
2593=head1 OTHER LANGUAGE BINDINGS
2594
2595Libev does not offer other language bindings itself, but bindings for a
2596numbe rof languages exist in the form of third-party packages. If you know
2597any interesting language binding in addition to the ones listed here, drop
2598me a note.
2599
2600=over 4
2601
2602=item Perl
2603
2604The EV module implements the full libev API and is actually used to test
2605libev. EV is developed together with libev. Apart from the EV core module,
2606there are additional modules that implement libev-compatible interfaces
2607to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the
2608C<libglib> event core (C<Glib::EV> and C<EV::Glib>).
2609
2610It can be found and installed via CPAN, its homepage is found at
2611L<http://software.schmorp.de/pkg/EV>.
2612
2613=item Ruby
2614
2615Tony Arcieri has written a ruby extension that offers access to a subset
2616of the libev API and adds filehandle abstractions, asynchronous DNS and
2617more on top of it. It can be found via gem servers. Its homepage is at
2618L<http://rev.rubyforge.org/>.
2619
2620=item D
2621
2622Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2623be found at L<http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.
2624
2625=back
2626
2627
2439=head1 MACRO MAGIC 2628=head1 MACRO MAGIC
2440 2629
2441Libev can be compiled with a variety of options, the most fundamantal 2630Libev can be compiled with a variety of options, the most fundamantal
2442of which is C<EV_MULTIPLICITY>. This option determines whether (most) 2631of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2443functions and callbacks have an initial C<struct ev_loop *> argument. 2632functions and callbacks have an initial C<struct ev_loop *> argument.
2477 2666
2478=item C<EV_DEFAULT>, C<EV_DEFAULT_> 2667=item C<EV_DEFAULT>, C<EV_DEFAULT_>
2479 2668
2480Similar to the other two macros, this gives you the value of the default 2669Similar to the other two macros, this gives you the value of the default
2481loop, if multiple loops are supported ("ev loop default"). 2670loop, if multiple loops are supported ("ev loop default").
2671
2672=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
2673
2674Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
2675default loop has been initialised (C<UC> == unchecked). Their behaviour
2676is undefined when the default loop has not been initialised by a previous
2677execution of C<EV_DEFAULT>, C<EV_DEFAULT_> or C<ev_default_init (...)>.
2678
2679It is often prudent to use C<EV_DEFAULT> when initialising the first
2680watcher in a function but use C<EV_DEFAULT_UC> afterwards.
2482 2681
2483=back 2682=back
2484 2683
2485Example: Declare and initialise a check watcher, utilising the above 2684Example: Declare and initialise a check watcher, utilising the above
2486macros so it will work regardless of whether multiple loops are supported 2685macros so it will work regardless of whether multiple loops are supported
2582 2781
2583 libev.m4 2782 libev.m4
2584 2783
2585=head2 PREPROCESSOR SYMBOLS/MACROS 2784=head2 PREPROCESSOR SYMBOLS/MACROS
2586 2785
2587Libev can be configured via a variety of preprocessor symbols you have to define 2786Libev can be configured via a variety of preprocessor symbols you have to
2588before including any of its files. The default is not to build for multiplicity 2787define before including any of its files. The default in the absense of
2589and only include the select backend. 2788autoconf is noted for every option.
2590 2789
2591=over 4 2790=over 4
2592 2791
2593=item EV_STANDALONE 2792=item EV_STANDALONE
2594 2793
2620=item EV_USE_NANOSLEEP 2819=item EV_USE_NANOSLEEP
2621 2820
2622If defined to be C<1>, libev will assume that C<nanosleep ()> is available 2821If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2623and will use it for delays. Otherwise it will use C<select ()>. 2822and will use it for delays. Otherwise it will use C<select ()>.
2624 2823
2824=item EV_USE_EVENTFD
2825
2826If defined to be C<1>, then libev will assume that C<eventfd ()> is
2827available and will probe for kernel support at runtime. This will improve
2828C<ev_signal> and C<ev_async> performance and reduce resource consumption.
2829If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
28302.7 or newer, otherwise disabled.
2831
2625=item EV_USE_SELECT 2832=item EV_USE_SELECT
2626 2833
2627If undefined or defined to be C<1>, libev will compile in support for the 2834If undefined or defined to be C<1>, libev will compile in support for the
2628C<select>(2) backend. No attempt at autodetection will be done: if no 2835C<select>(2) backend. No attempt at autodetection will be done: if no
2629other method takes over, select will be it. Otherwise the select backend 2836other method takes over, select will be it. Otherwise the select backend
2665 2872
2666=item EV_USE_EPOLL 2873=item EV_USE_EPOLL
2667 2874
2668If defined to be C<1>, libev will compile in support for the Linux 2875If defined to be C<1>, libev will compile in support for the Linux
2669C<epoll>(7) backend. Its availability will be detected at runtime, 2876C<epoll>(7) backend. Its availability will be detected at runtime,
2670otherwise another method will be used as fallback. This is the 2877otherwise another method will be used as fallback. This is the preferred
2671preferred backend for GNU/Linux systems. 2878backend for GNU/Linux systems. If undefined, it will be enabled if the
2879headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2672 2880
2673=item EV_USE_KQUEUE 2881=item EV_USE_KQUEUE
2674 2882
2675If defined to be C<1>, libev will compile in support for the BSD style 2883If defined to be C<1>, libev will compile in support for the BSD style
2676C<kqueue>(2) backend. Its actual availability will be detected at runtime, 2884C<kqueue>(2) backend. Its actual availability will be detected at runtime,
2695 2903
2696=item EV_USE_INOTIFY 2904=item EV_USE_INOTIFY
2697 2905
2698If defined to be C<1>, libev will compile in support for the Linux inotify 2906If defined to be C<1>, libev will compile in support for the Linux inotify
2699interface to speed up C<ev_stat> watchers. Its actual availability will 2907interface to speed up C<ev_stat> watchers. Its actual availability will
2700be detected at runtime. 2908be detected at runtime. If undefined, it will be enabled if the headers
2909indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2701 2910
2702=item EV_ATOMIC_T 2911=item EV_ATOMIC_T
2703 2912
2704Libev requires an integer type (suitable for storing C<0> or C<1>) whose 2913Libev requires an integer type (suitable for storing C<0> or C<1>) whose
2705access is atomic with respect to other threads or signal contexts. No such 2914access is atomic with respect to other threads or signal contexts. No such
2792defined to be C<0>, then they are not. 3001defined to be C<0>, then they are not.
2793 3002
2794=item EV_MINIMAL 3003=item EV_MINIMAL
2795 3004
2796If you need to shave off some kilobytes of code at the expense of some 3005If you need to shave off some kilobytes of code at the expense of some
2797speed, define this symbol to C<1>. Currently only used for gcc to override 3006speed, define this symbol to C<1>. Currently this is used to override some
2798some inlining decisions, saves roughly 30% codesize of amd64. 3007inlining decisions, saves roughly 30% codesize of amd64. It also selects a
3008much smaller 2-heap for timer management over the default 4-heap.
2799 3009
2800=item EV_PID_HASHSIZE 3010=item EV_PID_HASHSIZE
2801 3011
2802C<ev_child> watchers use a small hash table to distribute workload by 3012C<ev_child> watchers use a small hash table to distribute workload by
2803pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more 3013pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
2809C<ev_stat> watchers use a small hash table to distribute workload by 3019C<ev_stat> watchers use a small hash table to distribute workload by
2810inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), 3020inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2811usually more than enough. If you need to manage thousands of C<ev_stat> 3021usually more than enough. If you need to manage thousands of C<ev_stat>
2812watchers you might want to increase this value (I<must> be a power of 3022watchers you might want to increase this value (I<must> be a power of
2813two). 3023two).
3024
3025=item EV_USE_4HEAP
3026
3027Heaps are not very cache-efficient. To improve the cache-efficiency of the
3028timer and periodics heap, libev uses a 4-heap when this symbol is defined
3029to C<1>. The 4-heap uses more complicated (longer) code but has
3030noticably faster performance with many (thousands) of watchers.
3031
3032The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3033(disabled).
3034
3035=item EV_HEAP_CACHE_AT
3036
3037Heaps are not very cache-efficient. To improve the cache-efficiency of the
3038timer and periodics heap, libev can cache the timestamp (I<at>) within
3039the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3040which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3041but avoids random read accesses on heap changes. This improves performance
3042noticably with with many (hundreds) of watchers.
3043
3044The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3045(disabled).
3046
3047=item EV_VERIFY
3048
3049Controls how much internal verification (see C<ev_loop_verify ()>) will
3050be done: If set to C<0>, no internal verification code will be compiled
3051in. If set to C<1>, then verification code will be compiled in, but not
3052called. If set to C<2>, then the internal verification code will be
3053called once per loop, which can slow down libev. If set to C<3>, then the
3054verification code will be called very frequently, which will slow down
3055libev considerably.
3056
3057The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
3058C<0.>
2814 3059
2815=item EV_COMMON 3060=item EV_COMMON
2816 3061
2817By default, all watchers have a C<void *data> member. By redefining 3062By default, all watchers have a C<void *data> member. By redefining
2818this macro to a something else you can include more and other types of 3063this macro to a something else you can include more and other types of
2892 3137
2893 #include "ev_cpp.h" 3138 #include "ev_cpp.h"
2894 #include "ev.c" 3139 #include "ev.c"
2895 3140
2896 3141
3142=head1 THREADS AND COROUTINES
3143
3144=head2 THREADS
3145
3146Libev itself is completely threadsafe, but it uses no locking. This
3147means that you can use as many loops as you want in parallel, as long as
3148only one thread ever calls into one libev function with the same loop
3149parameter.
3150
3151Or put differently: calls with different loop parameters can be done in
3152parallel from multiple threads, calls with the same loop parameter must be
3153done serially (but can be done from different threads, as long as only one
3154thread ever is inside a call at any point in time, e.g. by using a mutex
3155per loop).
3156
3157If you want to know which design is best for your problem, then I cannot
3158help you but by giving some generic advice:
3159
3160=over 4
3161
3162=item * most applications have a main thread: use the default libev loop
3163in that thread, or create a seperate thread running only the default loop.
3164
3165This helps integrating other libraries or software modules that use libev
3166themselves and don't care/know about threading.
3167
3168=item * one loop per thread is usually a good model.
3169
3170Doing this is almost never wrong, sometimes a better-performance model
3171exists, but it is always a good start.
3172
3173=item * other models exist, such as the leader/follower pattern, where one
3174loop is handed through multiple threads in a kind of round-robbin fashion.
3175
3176Chosing a model is hard - look around, learn, know that usually you cna do
3177better than you currently do :-)
3178
3179=item * often you need to talk to some other thread which blocks in the
3180event loop - C<ev_async> watchers can be used to wake them up from other
3181threads safely (or from signal contexts...).
3182
3183=back
3184
3185=head2 COROUTINES
3186
3187Libev is much more accomodating to coroutines ("cooperative threads"):
3188libev fully supports nesting calls to it's functions from different
3189coroutines (e.g. you can call C<ev_loop> on the same loop from two
3190different coroutines and switch freely between both coroutines running the
3191loop, as long as you don't confuse yourself). The only exception is that
3192you must not do this from C<ev_periodic> reschedule callbacks.
3193
3194Care has been invested into making sure that libev does not keep local
3195state inside C<ev_loop>, and other calls do not usually allow coroutine
3196switches.
3197
3198
2897=head1 COMPLEXITIES 3199=head1 COMPLEXITIES
2898 3200
2899In this section the complexities of (many of) the algorithms used inside 3201In this section the complexities of (many of) the algorithms used inside
2900libev will be explained. For complexity discussions about backends see the 3202libev will be explained. For complexity discussions about backends see the
2901documentation for C<ev_default_init>. 3203documentation for C<ev_default_init>.
2931correct watcher to remove. The lists are usually short (you don't usually 3233correct watcher to remove. The lists are usually short (you don't usually
2932have many watchers waiting for the same fd or signal). 3234have many watchers waiting for the same fd or signal).
2933 3235
2934=item Finding the next timer in each loop iteration: O(1) 3236=item Finding the next timer in each loop iteration: O(1)
2935 3237
2936By virtue of using a binary heap, the next timer is always found at the 3238By virtue of using a binary or 4-heap, the next timer is always found at a
2937beginning of the storage array. 3239fixed position in the storage array.
2938 3240
2939=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) 3241=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2940 3242
2941A change means an I/O watcher gets started or stopped, which requires 3243A change means an I/O watcher gets started or stopped, which requires
2942libev to recalculate its status (and possibly tell the kernel, depending 3244libev to recalculate its status (and possibly tell the kernel, depending
2971model. Libev still offers limited functionality on this platform in 3273model. Libev still offers limited functionality on this platform in
2972the form of the C<EVBACKEND_SELECT> backend, and only supports socket 3274the form of the C<EVBACKEND_SELECT> backend, and only supports socket
2973descriptors. This only applies when using Win32 natively, not when using 3275descriptors. This only applies when using Win32 natively, not when using
2974e.g. cygwin. 3276e.g. cygwin.
2975 3277
3278Lifting these limitations would basically require the full
3279re-implementation of the I/O system. If you are into these kinds of
3280things, then note that glib does exactly that for you in a very portable
3281way (note also that glib is the slowest event library known to man).
3282
2976There is no supported compilation method available on windows except 3283There is no supported compilation method available on windows except
2977embedding it into other applications. 3284embedding it into other applications.
2978 3285
2979Due to the many, low, and arbitrary limits on the win32 platform and the 3286Due to the many, low, and arbitrary limits on the win32 platform and
2980abysmal performance of winsockets, using a large number of sockets is not 3287the abysmal performance of winsockets, using a large number of sockets
2981recommended (and not reasonable). If your program needs to use more than 3288is not recommended (and not reasonable). If your program needs to use
2982a hundred or so sockets, then likely it needs to use a totally different 3289more than a hundred or so sockets, then likely it needs to use a totally
2983implementation for windows, as libev offers the POSIX model, which cannot 3290different implementation for windows, as libev offers the POSIX readiness
2984be implemented efficiently on windows (microsoft monopoly games). 3291notification model, which cannot be implemented efficiently on windows
3292(microsoft monopoly games).
2985 3293
2986=over 4 3294=over 4
2987 3295
2988=item The winsocket select function 3296=item The winsocket select function
2989 3297
3003Note that winsockets handling of fd sets is O(n), so you can easily get a 3311Note that winsockets handling of fd sets is O(n), so you can easily get a
3004complexity in the O(n²) range when using win32. 3312complexity in the O(n²) range when using win32.
3005 3313
3006=item Limited number of file descriptors 3314=item Limited number of file descriptors
3007 3315
3008Windows has numerous arbitrary (and low) limits on things. Early versions 3316Windows has numerous arbitrary (and low) limits on things.
3009of winsocket's select only supported waiting for a max. of C<64> handles 3317
3318Early versions of winsocket's select only supported waiting for a maximum
3010(probably owning to the fact that all windows kernels can only wait for 3319of C<64> handles (probably owning to the fact that all windows kernels
3011C<64> things at the same time internally; microsoft recommends spawning a 3320can only wait for C<64> things at the same time internally; microsoft
3012chain of threads and wait for 63 handles and the previous thread in each). 3321recommends spawning a chain of threads and wait for 63 handles and the
3322previous thread in each. Great).
3013 3323
3014Newer versions support more handles, but you need to define C<FD_SETSIZE> 3324Newer versions support more handles, but you need to define C<FD_SETSIZE>
3015to some high number (e.g. C<2048>) before compiling the winsocket select 3325to some high number (e.g. C<2048>) before compiling the winsocket select
3016call (which might be in libev or elsewhere, for example, perl does its own 3326call (which might be in libev or elsewhere, for example, perl does its own
3017select emulation on windows). 3327select emulation on windows).
3029calling select (O(n²)) will likely make this unworkable. 3339calling select (O(n²)) will likely make this unworkable.
3030 3340
3031=back 3341=back
3032 3342
3033 3343
3344=head1 PORTABILITY REQUIREMENTS
3345
3346In addition to a working ISO-C implementation, libev relies on a few
3347additional extensions:
3348
3349=over 4
3350
3351=item C<sig_atomic_t volatile> must be thread-atomic as well
3352
3353The type C<sig_atomic_t volatile> (or whatever is defined as
3354C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different
3355threads. This is not part of the specification for C<sig_atomic_t>, but is
3356believed to be sufficiently portable.
3357
3358=item C<sigprocmask> must work in a threaded environment
3359
3360Libev uses C<sigprocmask> to temporarily block signals. This is not
3361allowed in a threaded program (C<pthread_sigmask> has to be used). Typical
3362pthread implementations will either allow C<sigprocmask> in the "main
3363thread" or will block signals process-wide, both behaviours would
3364be compatible with libev. Interaction between C<sigprocmask> and
3365C<pthread_sigmask> could complicate things, however.
3366
3367The most portable way to handle signals is to block signals in all threads
3368except the initial one, and run the default loop in the initial thread as
3369well.
3370
3371=item C<long> must be large enough for common memory allocation sizes
3372
3373To improve portability and simplify using libev, libev uses C<long>
3374internally instead of C<size_t> when allocating its data structures. On
3375non-POSIX systems (Microsoft...) this might be unexpectedly low, but
3376is still at least 31 bits everywhere, which is enough for hundreds of
3377millions of watchers.
3378
3379=item C<double> must hold a time value in seconds with enough accuracy
3380
3381The type C<double> is used to represent timestamps. It is required to
3382have at least 51 bits of mantissa (and 9 bits of exponent), which is good
3383enough for at least into the year 4000. This requirement is fulfilled by
3384implementations implementing IEEE 754 (basically all existing ones).
3385
3386=back
3387
3388If you know of other additional requirements drop me a note.
3389
3390
3391=head1 VALGRIND
3392
3393Valgrind has a special section here because it is a popular tool that is
3394highly useful, but valgrind reports are very hard to interpret.
3395
3396If you think you found a bug (memory leak, uninitialised data access etc.)
3397in libev, then check twice: If valgrind reports something like:
3398
3399 ==2274== definitely lost: 0 bytes in 0 blocks.
3400 ==2274== possibly lost: 0 bytes in 0 blocks.
3401 ==2274== still reachable: 256 bytes in 1 blocks.
3402
3403then there is no memory leak. Similarly, under some circumstances,
3404valgrind might report kernel bugs as if it were a bug in libev, or it
3405might be confused (it is a very good tool, but only a tool).
3406
3407If you are unsure about something, feel free to contact the mailing list
3408with the full valgrind report and an explanation on why you think this is
3409a bug in libev. However, don't be annoyed when you get a brisk "this is
3410no bug" answer and take the chance of learning how to interpret valgrind
3411properly.
3412
3413If you need, for some reason, empty reports from valgrind for your project
3414I suggest using suppression lists.
3415
3416
3034=head1 AUTHOR 3417=head1 AUTHOR
3035 3418
3036Marc Lehmann <libev@schmorp.de>. 3419Marc Lehmann <libev@schmorp.de>.
3037 3420

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines