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

Comparing libev/ev.pod (file contents):
Revision 1.97 by root, Sat Dec 22 05:48:02 2007 UTC vs.
Revision 1.117 by root, Wed Jan 9 04:15:39 2008 UTC

4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 #include <ev.h> 7 #include <ev.h>
8 8
9=head1 EXAMPLE PROGRAM 9=head2 EXAMPLE PROGRAM
10 10
11 #include <ev.h> 11 #include <ev.h>
12 12
13 ev_io stdin_watcher; 13 ev_io stdin_watcher;
14 ev_timer timeout_watcher; 14 ev_timer timeout_watcher;
65You register interest in certain events by registering so-called I<event 65You register interest in certain events by registering so-called I<event
66watchers>, which are relatively small C structures you initialise with the 66watchers>, which are relatively small C structures you initialise with the
67details of the event, and then hand it over to libev by I<starting> the 67details of the event, and then hand it over to libev by I<starting> the
68watcher. 68watcher.
69 69
70=head1 FEATURES 70=head2 FEATURES
71 71
72Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 72Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
73BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 73BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
74for file descriptor events (C<ev_io>), the Linux C<inotify> interface 74for file descriptor events (C<ev_io>), the Linux C<inotify> interface
75(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers 75(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
82 82
83It also is quite fast (see this 83It also is quite fast (see this
84L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent 84L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
85for example). 85for example).
86 86
87=head1 CONVENTIONS 87=head2 CONVENTIONS
88 88
89Libev is very configurable. In this manual the default configuration will 89Libev is very configurable. In this manual the default configuration will
90be described, which supports multiple event loops. For more info about 90be described, which supports multiple event loops. For more info about
91various configuration options please have a look at B<EMBED> section in 91various configuration options please have a look at B<EMBED> section in
92this manual. If libev was configured without support for multiple event 92this manual. If libev was configured without support for multiple event
93loops, then all functions taking an initial argument of name C<loop> 93loops, then all functions taking an initial argument of name C<loop>
94(which is always of type C<struct ev_loop *>) will not have this argument. 94(which is always of type C<struct ev_loop *>) will not have this argument.
95 95
96=head1 TIME REPRESENTATION 96=head2 TIME REPRESENTATION
97 97
98Libev represents time as a single floating point number, representing the 98Libev represents time as a single floating point number, representing the
99(fractional) number of seconds since the (POSIX) epoch (somewhere near 99(fractional) number of seconds since the (POSIX) epoch (somewhere near
100the beginning of 1970, details are complicated, don't ask). This type is 100the beginning of 1970, details are complicated, don't ask). This type is
101called C<ev_tstamp>, which is what you should use too. It usually aliases 101called C<ev_tstamp>, which is what you should use too. It usually aliases
306=item C<EVBACKEND_SELECT> (value 1, portable select backend) 306=item C<EVBACKEND_SELECT> (value 1, portable select backend)
307 307
308This is your standard select(2) backend. Not I<completely> standard, as 308This is your standard select(2) backend. Not I<completely> standard, as
309libev tries to roll its own fd_set with no limits on the number of fds, 309libev tries to roll its own fd_set with no limits on the number of fds,
310but if that fails, expect a fairly low limit on the number of fds when 310but if that fails, expect a fairly low limit on the number of fds when
311using this backend. It doesn't scale too well (O(highest_fd)), but its usually 311using this backend. It doesn't scale too well (O(highest_fd)), but its
312the fastest backend for a low number of fds. 312usually the fastest backend for a low number of (low-numbered :) fds.
313
314To get good performance out of this backend you need a high amount of
315parallelity (most of the file descriptors should be busy). If you are
316writing a server, you should C<accept ()> in a loop to accept as many
317connections as possible during one iteration. You might also want to have
318a look at C<ev_set_io_collect_interval ()> to increase the amount of
319readyness notifications you get per iteration.
313 320
314=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) 321=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
315 322
316And this is your standard poll(2) backend. It's more complicated than 323And this is your standard poll(2) backend. It's more complicated
317select, but handles sparse fds better and has no artificial limit on the 324than select, but handles sparse fds better and has no artificial
318number of fds you can use (except it will slow down considerably with a 325limit on the number of fds you can use (except it will slow down
319lot of inactive fds). It scales similarly to select, i.e. O(total_fds). 326considerably with a lot of inactive fds). It scales similarly to select,
327i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
328performance tips.
320 329
321=item C<EVBACKEND_EPOLL> (value 4, Linux) 330=item C<EVBACKEND_EPOLL> (value 4, Linux)
322 331
323For few fds, this backend is a bit little slower than poll and select, 332For few fds, this backend is a bit little slower than poll and select,
324but it scales phenomenally better. While poll and select usually scale 333but it scales phenomenally better. While poll and select usually scale
325like O(total_fds) where n is the total number of fds (or the highest fd), 334like O(total_fds) where n is the total number of fds (or the highest fd),
326epoll scales either O(1) or O(active_fds). The epoll design has a number 335epoll scales either O(1) or O(active_fds). The epoll design has a number
327of shortcomings, such as silently dropping events in some hard-to-detect 336of shortcomings, such as silently dropping events in some hard-to-detect
328cases and rewiring a syscall per fd change, no fork support and bad 337cases and rewiring a syscall per fd change, no fork support and bad
329support for dup: 338support for dup.
330 339
331While stopping, setting and starting an I/O watcher in the same iteration 340While stopping, setting and starting an I/O watcher in the same iteration
332will result in some caching, there is still a syscall per such incident 341will result in some caching, there is still a syscall per such incident
333(because the fd could point to a different file description now), so its 342(because the fd could point to a different file description now), so its
334best to avoid that. Also, C<dup ()>'ed file descriptors might not work 343best to avoid that. Also, C<dup ()>'ed file descriptors might not work
336 345
337Please note that epoll sometimes generates spurious notifications, so you 346Please note that epoll sometimes generates spurious notifications, so you
338need to use non-blocking I/O or other means to avoid blocking when no data 347need to use non-blocking I/O or other means to avoid blocking when no data
339(or space) is available. 348(or space) is available.
340 349
350Best performance from this backend is achieved by not unregistering all
351watchers for a file descriptor until it has been closed, if possible, i.e.
352keep at least one watcher active per fd at all times.
353
354While nominally embeddeble in other event loops, this feature is broken in
355all kernel versions tested so far.
356
341=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 357=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
342 358
343Kqueue deserves special mention, as at the time of this writing, it 359Kqueue deserves special mention, as at the time of this writing, it
344was broken on I<all> BSDs (usually it doesn't work with anything but 360was broken on all BSDs except NetBSD (usually it doesn't work reliably
345sockets and pipes, except on Darwin, where of course it's completely 361with anything but sockets and pipes, except on Darwin, where of course
346useless. On NetBSD, it seems to work for all the FD types I tested, so it
347is used by default there). For this reason it's not being "autodetected" 362it's completely useless). For this reason it's not being "autodetected"
348unless you explicitly specify it explicitly in the flags (i.e. using 363unless you explicitly specify it explicitly in the flags (i.e. using
349C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) 364C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
350system like NetBSD. 365system like NetBSD.
351 366
367You still can embed kqueue into a normal poll or select backend and use it
368only for sockets (after having made sure that sockets work with kqueue on
369the target platform). See C<ev_embed> watchers for more info.
370
352It scales in the same way as the epoll backend, but the interface to the 371It scales in the same way as the epoll backend, but the interface to the
353kernel is more efficient (which says nothing about its actual speed, 372kernel is more efficient (which says nothing about its actual speed, of
354of course). While stopping, setting and starting an I/O watcher does 373course). While stopping, setting and starting an I/O watcher does never
355never cause an extra syscall as with epoll, it still adds up to two event 374cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to
356changes per incident, support for C<fork ()> is very bad and it drops fds 375two event changes per incident, support for C<fork ()> is very bad and it
357silently in similarly hard-to-detetc cases. 376drops fds silently in similarly hard-to-detect cases.
377
378This backend usually performs well under most conditions.
379
380While nominally embeddable in other event loops, this doesn't work
381everywhere, so you might need to test for this. And since it is broken
382almost everywhere, you should only use it when you have a lot of sockets
383(for which it usually works), by embedding it into another event loop
384(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for
385sockets.
358 386
359=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) 387=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
360 388
361This is not implemented yet (and might never be). 389This is not implemented yet (and might never be, unless you send me an
390implementation). According to reports, C</dev/poll> only supports sockets
391and is not embeddable, which would limit the usefulness of this backend
392immensely.
362 393
363=item C<EVBACKEND_PORT> (value 32, Solaris 10) 394=item C<EVBACKEND_PORT> (value 32, Solaris 10)
364 395
365This uses the Solaris 10 event port mechanism. As with everything on Solaris, 396This uses the Solaris 10 event port mechanism. As with everything on Solaris,
366it's really slow, but it still scales very well (O(active_fds)). 397it's really slow, but it still scales very well (O(active_fds)).
367 398
368Please note that solaris event ports can deliver a lot of spurious 399Please note that solaris event ports can deliver a lot of spurious
369notifications, so you need to use non-blocking I/O or other means to avoid 400notifications, so you need to use non-blocking I/O or other means to avoid
370blocking when no data (or space) is available. 401blocking when no data (or space) is available.
371 402
403While this backend scales well, it requires one system call per active
404file descriptor per loop iteration. For small and medium numbers of file
405descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
406might perform better.
407
408On the positive side, ignoring the spurious readyness notifications, this
409backend actually performed to specification in all tests and is fully
410embeddable, which is a rare feat among the OS-specific backends.
411
372=item C<EVBACKEND_ALL> 412=item C<EVBACKEND_ALL>
373 413
374Try all backends (even potentially broken ones that wouldn't be tried 414Try all backends (even potentially broken ones that wouldn't be tried
375with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as 415with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
376C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. 416C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
377 417
418It is definitely not recommended to use this flag.
419
378=back 420=back
379 421
380If one or more of these are ored into the flags value, then only these 422If one or more of these are ored into the flags value, then only these
381backends will be tried (in the reverse order as given here). If none are 423backends will be tried (in the reverse order as listed here). If none are
382specified, most compiled-in backend will be tried, usually in reverse 424specified, all backends in C<ev_recommended_backends ()> will be tried.
383order of their flag values :)
384 425
385The most typical usage is like this: 426The most typical usage is like this:
386 427
387 if (!ev_default_loop (0)) 428 if (!ev_default_loop (0))
388 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 429 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
513usually a better approach for this kind of thing. 554usually a better approach for this kind of thing.
514 555
515Here are the gory details of what C<ev_loop> does: 556Here are the gory details of what C<ev_loop> does:
516 557
517 - Before the first iteration, call any pending watchers. 558 - Before the first iteration, call any pending watchers.
518 * If there are no active watchers (reference count is zero), return. 559 * If EVFLAG_FORKCHECK was used, check for a fork.
519 - Queue all prepare watchers and then call all outstanding watchers. 560 - If a fork was detected, queue and call all fork watchers.
561 - Queue and call all prepare watchers.
520 - If we have been forked, recreate the kernel state. 562 - If we have been forked, recreate the kernel state.
521 - Update the kernel state with all outstanding changes. 563 - Update the kernel state with all outstanding changes.
522 - Update the "event loop time". 564 - Update the "event loop time".
523 - Calculate for how long to block. 565 - Calculate for how long to sleep or block, if at all
566 (active idle watchers, EVLOOP_NONBLOCK or not having
567 any active watchers at all will result in not sleeping).
568 - Sleep if the I/O and timer collect interval say so.
524 - Block the process, waiting for any events. 569 - Block the process, waiting for any events.
525 - Queue all outstanding I/O (fd) events. 570 - Queue all outstanding I/O (fd) events.
526 - Update the "event loop time" and do time jump handling. 571 - Update the "event loop time" and do time jump handling.
527 - Queue all outstanding timers. 572 - Queue all outstanding timers.
528 - Queue all outstanding periodics. 573 - Queue all outstanding periodics.
529 - If no events are pending now, queue all idle watchers. 574 - If no events are pending now, queue all idle watchers.
530 - Queue all check watchers. 575 - Queue all check watchers.
531 - Call all queued watchers in reverse order (i.e. check watchers first). 576 - Call all queued watchers in reverse order (i.e. check watchers first).
532 Signals and child watchers are implemented as I/O watchers, and will 577 Signals and child watchers are implemented as I/O watchers, and will
533 be handled here by queueing them when their watcher gets executed. 578 be handled here by queueing them when their watcher gets executed.
534 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 579 - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
535 were used, return, otherwise continue with step *. 580 were used, or there are no active watchers, return, otherwise
581 continue with step *.
536 582
537Example: Queue some jobs and then loop until no events are outsanding 583Example: Queue some jobs and then loop until no events are outstanding
538anymore. 584anymore.
539 585
540 ... queue jobs here, make sure they register event watchers as long 586 ... queue jobs here, make sure they register event watchers as long
541 ... as they still have work to do (even an idle watcher will do..) 587 ... as they still have work to do (even an idle watcher will do..)
542 ev_loop (my_loop, 0); 588 ev_loop (my_loop, 0);
546 592
547Can be used to make a call to C<ev_loop> return early (but only after it 593Can be used to make a call to C<ev_loop> return early (but only after it
548has processed all outstanding events). The C<how> argument must be either 594has processed all outstanding events). The C<how> argument must be either
549C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or 595C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
550C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. 596C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
597
598This "unloop state" will be cleared when entering C<ev_loop> again.
551 599
552=item ev_ref (loop) 600=item ev_ref (loop)
553 601
554=item ev_unref (loop) 602=item ev_unref (loop)
555 603
560returning, ev_unref() after starting, and ev_ref() before stopping it. For 608returning, ev_unref() after starting, and ev_ref() before stopping it. For
561example, libev itself uses this for its internal signal pipe: It is not 609example, libev itself uses this for its internal signal pipe: It is not
562visible to the libev user and should not keep C<ev_loop> from exiting if 610visible to the libev user and should not keep C<ev_loop> from exiting if
563no event watchers registered by it are active. It is also an excellent 611no event watchers registered by it are active. It is also an excellent
564way to do this for generic recurring timers or from within third-party 612way to do this for generic recurring timers or from within third-party
565libraries. Just remember to I<unref after start> and I<ref before stop>. 613libraries. Just remember to I<unref after start> and I<ref before stop>
614(but only if the watcher wasn't active before, or was active before,
615respectively).
566 616
567Example: Create a signal watcher, but keep it from keeping C<ev_loop> 617Example: Create a signal watcher, but keep it from keeping C<ev_loop>
568running when nothing else is active. 618running when nothing else is active.
569 619
570 struct ev_signal exitsig; 620 struct ev_signal exitsig;
596overhead for the actual polling but can deliver many events at once. 646overhead for the actual polling but can deliver many events at once.
597 647
598By setting a higher I<io collect interval> you allow libev to spend more 648By setting a higher I<io collect interval> you allow libev to spend more
599time collecting I/O events, so you can handle more events per iteration, 649time collecting I/O events, so you can handle more events per iteration,
600at the cost of increasing latency. Timeouts (both C<ev_periodic> and 650at the cost of increasing latency. Timeouts (both C<ev_periodic> and
601C<ev_timer>) will be not affected. 651C<ev_timer>) will be not affected. Setting this to a non-null value will
652introduce an additional C<ev_sleep ()> call into most loop iterations.
602 653
603Likewise, by setting a higher I<timeout collect interval> you allow libev 654Likewise, by setting a higher I<timeout collect interval> you allow libev
604to spend more time collecting timeouts, at the expense of increased 655to spend more time collecting timeouts, at the expense of increased
605latency (the watcher callback will be called later). C<ev_io> watchers 656latency (the watcher callback will be called later). C<ev_io> watchers
606will not be affected. 657will not be affected. Setting this to a non-null value will not introduce
658any overhead in libev.
607 659
608Many programs can usually benefit by setting the io collect interval to 660Many (busy) programs can usually benefit by setting the io collect
609a value near C<0.1> or so, which is often enough for interactive servers 661interval to a value near C<0.1> or so, which is often enough for
610(of course not for games), likewise for timeouts. It usually doesn't make 662interactive servers (of course not for games), likewise for timeouts. It
611much sense to set it to a lower value than C<0.01>, as this approsaches 663usually doesn't make much sense to set it to a lower value than C<0.01>,
612the timing granularity of most systems. 664as this approsaches the timing granularity of most systems.
613 665
614=back 666=back
615 667
616 668
617=head1 ANATOMY OF A WATCHER 669=head1 ANATOMY OF A WATCHER
943In general you can register as many read and/or write event watchers per 995In general you can register as many read and/or write event watchers per
944fd as you want (as long as you don't confuse yourself). Setting all file 996fd as you want (as long as you don't confuse yourself). Setting all file
945descriptors to non-blocking mode is also usually a good idea (but not 997descriptors to non-blocking mode is also usually a good idea (but not
946required if you know what you are doing). 998required if you know what you are doing).
947 999
948You have to be careful with dup'ed file descriptors, though. Some backends
949(the linux epoll backend is a notable example) cannot handle dup'ed file
950descriptors correctly if you register interest in two or more fds pointing
951to the same underlying file/socket/etc. description (that is, they share
952the same underlying "file open").
953
954If you must do this, then force the use of a known-to-be-good backend 1000If you must do this, then force the use of a known-to-be-good backend
955(at the time of this writing, this includes only C<EVBACKEND_SELECT> and 1001(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
956C<EVBACKEND_POLL>). 1002C<EVBACKEND_POLL>).
957 1003
958Another thing you have to watch out for is that it is quite easy to 1004Another thing you have to watch out for is that it is quite easy to
992optimisations to libev. 1038optimisations to libev.
993 1039
994=head3 The special problem of dup'ed file descriptors 1040=head3 The special problem of dup'ed file descriptors
995 1041
996Some backends (e.g. epoll), cannot register events for file descriptors, 1042Some backends (e.g. epoll), cannot register events for file descriptors,
997but only events for the underlying file descriptions. That menas when you 1043but only events for the underlying file descriptions. That means when you
998have C<dup ()>'ed file descriptors and register events for them, only one 1044have C<dup ()>'ed file descriptors or weirder constellations, and register
999file descriptor might actually receive events. 1045events for them, only one file descriptor might actually receive events.
1000 1046
1001There is no workaorund possible except not registering events 1047There is no workaround possible except not registering events
1002for potentially C<dup ()>'ed file descriptors or to resort to 1048for potentially C<dup ()>'ed file descriptors, or to resort to
1003C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1049C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1004 1050
1005=head3 The special problem of fork 1051=head3 The special problem of fork
1006 1052
1007Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1053Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1033=item int events [read-only] 1079=item int events [read-only]
1034 1080
1035The events being watched. 1081The events being watched.
1036 1082
1037=back 1083=back
1084
1085=head3 Examples
1038 1086
1039Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well 1087Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1040readable, but only once. Since it is likely line-buffered, you could 1088readable, but only once. Since it is likely line-buffered, you could
1041attempt to read a whole line in the callback. 1089attempt to read a whole line in the callback.
1042 1090
1140or C<ev_timer_again> is called and determines the next timeout (if any), 1188or C<ev_timer_again> is called and determines the next timeout (if any),
1141which is also when any modifications are taken into account. 1189which is also when any modifications are taken into account.
1142 1190
1143=back 1191=back
1144 1192
1193=head3 Examples
1194
1145Example: Create a timer that fires after 60 seconds. 1195Example: Create a timer that fires after 60 seconds.
1146 1196
1147 static void 1197 static void
1148 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1198 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1149 { 1199 {
1306When active, contains the absolute time that the watcher is supposed to 1356When active, contains the absolute time that the watcher is supposed to
1307trigger next. 1357trigger next.
1308 1358
1309=back 1359=back
1310 1360
1361=head3 Examples
1362
1311Example: Call a callback every hour, or, more precisely, whenever the 1363Example: Call a callback every hour, or, more precisely, whenever the
1312system clock is divisible by 3600. The callback invocation times have 1364system clock is divisible by 3600. The callback invocation times have
1313potentially a lot of jittering, but good long-term stability. 1365potentially a lot of jittering, but good long-term stability.
1314 1366
1315 static void 1367 static void
1406 1458
1407The process exit/trace status caused by C<rpid> (see your systems 1459The process exit/trace status caused by C<rpid> (see your systems
1408C<waitpid> and C<sys/wait.h> documentation for details). 1460C<waitpid> and C<sys/wait.h> documentation for details).
1409 1461
1410=back 1462=back
1463
1464=head3 Examples
1411 1465
1412Example: Try to exit cleanly on SIGINT and SIGTERM. 1466Example: Try to exit cleanly on SIGINT and SIGTERM.
1413 1467
1414 static void 1468 static void
1415 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1469 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1456semantics of C<ev_stat> watchers, which means that libev sometimes needs 1510semantics of C<ev_stat> watchers, which means that libev sometimes needs
1457to fall back to regular polling again even with inotify, but changes are 1511to fall back to regular polling again even with inotify, but changes are
1458usually detected immediately, and if the file exists there will be no 1512usually detected immediately, and if the file exists there will be no
1459polling. 1513polling.
1460 1514
1515=head3 Inotify
1516
1517When C<inotify (7)> support has been compiled into libev (generally only
1518available on Linux) and present at runtime, it will be used to speed up
1519change detection where possible. The inotify descriptor will be created lazily
1520when the first C<ev_stat> watcher is being started.
1521
1522Inotify presense does not change the semantics of C<ev_stat> watchers
1523except that changes might be detected earlier, and in some cases, to avoid
1524making regular C<stat> calls. Even in the presense of inotify support
1525there are many cases where libev has to resort to regular C<stat> polling.
1526
1527(There is no support for kqueue, as apparently it cannot be used to
1528implement this functionality, due to the requirement of having a file
1529descriptor open on the object at all times).
1530
1531=head3 The special problem of stat time resolution
1532
1533The C<stat ()> syscall only supports full-second resolution portably, and
1534even on systems where the resolution is higher, many filesystems still
1535only support whole seconds.
1536
1537That means that, if the time is the only thing that changes, you might
1538miss updates: on the first update, C<ev_stat> detects a change and calls
1539your callback, which does something. When there is another update within
1540the same second, C<ev_stat> will be unable to detect it.
1541
1542The solution to this is to delay acting on a change for a second (or till
1543the next second boundary), using a roughly one-second delay C<ev_timer>
1544(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>
1545is added to work around small timing inconsistencies of some operating
1546systems.
1547
1461=head3 Watcher-Specific Functions and Data Members 1548=head3 Watcher-Specific Functions and Data Members
1462 1549
1463=over 4 1550=over 4
1464 1551
1465=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) 1552=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
1502=item const char *path [read-only] 1589=item const char *path [read-only]
1503 1590
1504The filesystem path that is being watched. 1591The filesystem path that is being watched.
1505 1592
1506=back 1593=back
1594
1595=head3 Examples
1507 1596
1508Example: Watch C</etc/passwd> for attribute changes. 1597Example: Watch C</etc/passwd> for attribute changes.
1509 1598
1510 static void 1599 static void
1511 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) 1600 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1524 } 1613 }
1525 1614
1526 ... 1615 ...
1527 ev_stat passwd; 1616 ev_stat passwd;
1528 1617
1529 ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); 1618 ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1530 ev_stat_start (loop, &passwd); 1619 ev_stat_start (loop, &passwd);
1620
1621Example: Like above, but additionally use a one-second delay so we do not
1622miss updates (however, frequent updates will delay processing, too, so
1623one might do the work both on C<ev_stat> callback invocation I<and> on
1624C<ev_timer> callback invocation).
1625
1626 static ev_stat passwd;
1627 static ev_timer timer;
1628
1629 static void
1630 timer_cb (EV_P_ ev_timer *w, int revents)
1631 {
1632 ev_timer_stop (EV_A_ w);
1633
1634 /* now it's one second after the most recent passwd change */
1635 }
1636
1637 static void
1638 stat_cb (EV_P_ ev_stat *w, int revents)
1639 {
1640 /* reset the one-second timer */
1641 ev_timer_again (EV_A_ &timer);
1642 }
1643
1644 ...
1645 ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1646 ev_stat_start (loop, &passwd);
1647 ev_timer_init (&timer, timer_cb, 0., 1.01);
1531 1648
1532 1649
1533=head2 C<ev_idle> - when you've got nothing better to do... 1650=head2 C<ev_idle> - when you've got nothing better to do...
1534 1651
1535Idle watchers trigger events when no other events of the same or higher 1652Idle watchers trigger events when no other events of the same or higher
1560Initialises and configures the idle watcher - it has no parameters of any 1677Initialises and configures the idle watcher - it has no parameters of any
1561kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 1678kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1562believe me. 1679believe me.
1563 1680
1564=back 1681=back
1682
1683=head3 Examples
1565 1684
1566Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the 1685Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1567callback, free it. Also, use no error checking, as usual. 1686callback, free it. Also, use no error checking, as usual.
1568 1687
1569 static void 1688 static void
1621 1740
1622It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 1741It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1623priority, to ensure that they are being run before any other watchers 1742priority, to ensure that they are being run before any other watchers
1624after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, 1743after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1625too) should not activate ("feed") events into libev. While libev fully 1744too) should not activate ("feed") events into libev. While libev fully
1626supports this, they will be called before other C<ev_check> watchers did 1745supports this, they will be called before other C<ev_check> watchers
1627their job. As C<ev_check> watchers are often used to embed other event 1746did their job. As C<ev_check> watchers are often used to embed other
1628loops those other event loops might be in an unusable state until their 1747(non-libev) event loops those other event loops might be in an unusable
1629C<ev_check> watcher ran (always remind yourself to coexist peacefully with 1748state until their C<ev_check> watcher ran (always remind yourself to
1630others). 1749coexist peacefully with others).
1631 1750
1632=head3 Watcher-Specific Functions and Data Members 1751=head3 Watcher-Specific Functions and Data Members
1633 1752
1634=over 4 1753=over 4
1635 1754
1640Initialises and configures the prepare or check watcher - they have no 1759Initialises and configures the prepare or check watcher - they have no
1641parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1760parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1642macros, but using them is utterly, utterly and completely pointless. 1761macros, but using them is utterly, utterly and completely pointless.
1643 1762
1644=back 1763=back
1764
1765=head3 Examples
1645 1766
1646There are a number of principal ways to embed other event loops or modules 1767There are a number of principal ways to embed other event loops or modules
1647into libev. Here are some ideas on how to include libadns into libev 1768into libev. Here are some ideas on how to include libadns into libev
1648(there is a Perl module named C<EV::ADNS> that does this, which you could 1769(there is a Perl module named C<EV::ADNS> that does this, which you could
1649use for an actually working example. Another Perl module named C<EV::Glib> 1770use for an actually working example. Another Perl module named C<EV::Glib>
1774=head2 C<ev_embed> - when one backend isn't enough... 1895=head2 C<ev_embed> - when one backend isn't enough...
1775 1896
1776This is a rather advanced watcher type that lets you embed one event loop 1897This is a rather advanced watcher type that lets you embed one event loop
1777into another (currently only C<ev_io> events are supported in the embedded 1898into another (currently only C<ev_io> events are supported in the embedded
1778loop, other types of watchers might be handled in a delayed or incorrect 1899loop, other types of watchers might be handled in a delayed or incorrect
1779fashion and must not be used). (See portability notes, below). 1900fashion and must not be used).
1780 1901
1781There are primarily two reasons you would want that: work around bugs and 1902There are primarily two reasons you would want that: work around bugs and
1782prioritise I/O. 1903prioritise I/O.
1783 1904
1784As an example for a bug workaround, the kqueue backend might only support 1905As an example for a bug workaround, the kqueue backend might only support
1818portable one. 1939portable one.
1819 1940
1820So when you want to use this feature you will always have to be prepared 1941So when you want to use this feature you will always have to be prepared
1821that you cannot get an embeddable loop. The recommended way to get around 1942that you cannot get an embeddable loop. The recommended way to get around
1822this is to have a separate variables for your embeddable loop, try to 1943this is to have a separate variables for your embeddable loop, try to
1823create it, and if that fails, use the normal loop for everything: 1944create it, and if that fails, use the normal loop for everything.
1945
1946=head3 Watcher-Specific Functions and Data Members
1947
1948=over 4
1949
1950=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
1951
1952=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
1953
1954Configures the watcher to embed the given loop, which must be
1955embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1956invoked automatically, otherwise it is the responsibility of the callback
1957to invoke it (it will continue to be called until the sweep has been done,
1958if you do not want thta, you need to temporarily stop the embed watcher).
1959
1960=item ev_embed_sweep (loop, ev_embed *)
1961
1962Make a single, non-blocking sweep over the embedded loop. This works
1963similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1964apropriate way for embedded loops.
1965
1966=item struct ev_loop *other [read-only]
1967
1968The embedded event loop.
1969
1970=back
1971
1972=head3 Examples
1973
1974Example: Try to get an embeddable event loop and embed it into the default
1975event loop. If that is not possible, use the default loop. The default
1976loop is stored in C<loop_hi>, while the mebeddable loop is stored in
1977C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be
1978used).
1824 1979
1825 struct ev_loop *loop_hi = ev_default_init (0); 1980 struct ev_loop *loop_hi = ev_default_init (0);
1826 struct ev_loop *loop_lo = 0; 1981 struct ev_loop *loop_lo = 0;
1827 struct ev_embed embed; 1982 struct ev_embed embed;
1828 1983
1839 ev_embed_start (loop_hi, &embed); 1994 ev_embed_start (loop_hi, &embed);
1840 } 1995 }
1841 else 1996 else
1842 loop_lo = loop_hi; 1997 loop_lo = loop_hi;
1843 1998
1844=head2 Portability notes 1999Example: Check if kqueue is available but not recommended and create
2000a kqueue backend for use with sockets (which usually work with any
2001kqueue implementation). Store the kqueue/socket-only event loop in
2002C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
1845 2003
1846Kqueue is nominally embeddable, but this is broken on all BSDs that I 2004 struct ev_loop *loop = ev_default_init (0);
1847tried, in various ways. Usually the embedded event loop will simply never 2005 struct ev_loop *loop_socket = 0;
1848receive events, sometimes it will only trigger a few times, sometimes in a 2006 struct ev_embed embed;
1849loop. Epoll is also nominally embeddable, but many Linux kernel versions 2007
1850will always eport the epoll fd as ready, even when no events are pending. 2008 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2009 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2010 {
2011 ev_embed_init (&embed, 0, loop_socket);
2012 ev_embed_start (loop, &embed);
2013 }
1851 2014
1852While libev allows embedding these backends (they are contained in 2015 if (!loop_socket)
1853C<ev_embeddable_backends ()>), take extreme care that it will actually 2016 loop_socket = loop;
1854work.
1855 2017
1856When in doubt, create a dynamic event loop forced to use sockets (this 2018 // now use loop_socket for all sockets, and loop for everything else
1857usually works) and possibly another thread and a pipe or so to report to
1858your main event loop.
1859
1860=head3 Watcher-Specific Functions and Data Members
1861
1862=over 4
1863
1864=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
1865
1866=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
1867
1868Configures the watcher to embed the given loop, which must be
1869embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1870invoked automatically, otherwise it is the responsibility of the callback
1871to invoke it (it will continue to be called until the sweep has been done,
1872if you do not want thta, you need to temporarily stop the embed watcher).
1873
1874=item ev_embed_sweep (loop, ev_embed *)
1875
1876Make a single, non-blocking sweep over the embedded loop. This works
1877similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1878apropriate way for embedded loops.
1879
1880=item struct ev_loop *other [read-only]
1881
1882The embedded event loop.
1883
1884=back
1885 2019
1886 2020
1887=head2 C<ev_fork> - the audacity to resume the event loop after a fork 2021=head2 C<ev_fork> - the audacity to resume the event loop after a fork
1888 2022
1889Fork watchers are called when a C<fork ()> was detected (usually because 2023Fork watchers are called when a C<fork ()> was detected (usually because
2368wants osf handles on win32 (this is the case when the select to 2502wants osf handles on win32 (this is the case when the select to
2369be used is the winsock select). This means that it will call 2503be used is the winsock select). This means that it will call
2370C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 2504C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
2371it is assumed that all these functions actually work on fds, even 2505it is assumed that all these functions actually work on fds, even
2372on win32. Should not be defined on non-win32 platforms. 2506on win32. Should not be defined on non-win32 platforms.
2507
2508=item EV_FD_TO_WIN32_HANDLE
2509
2510If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
2511file descriptors to socket handles. When not defining this symbol (the
2512default), then libev will call C<_get_osfhandle>, which is usually
2513correct. In some cases, programs use their own file descriptor management,
2514in which case they can provide this function to map fds to socket handles.
2373 2515
2374=item EV_USE_POLL 2516=item EV_USE_POLL
2375 2517
2376If defined to be C<1>, libev will compile in support for the C<poll>(2) 2518If defined to be C<1>, libev will compile in support for the C<poll>(2)
2377backend. Otherwise it will be enabled on non-win32 platforms. It 2519backend. Otherwise it will be enabled on non-win32 platforms. It
2414be detected at runtime. 2556be detected at runtime.
2415 2557
2416=item EV_H 2558=item EV_H
2417 2559
2418The name of the F<ev.h> header file used to include it. The default if 2560The name of the F<ev.h> header file used to include it. The default if
2419undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This 2561undefined is C<"ev.h"> in F<event.h> and F<ev.c>. This can be used to
2420can be used to virtually rename the F<ev.h> header file in case of conflicts. 2562virtually rename the F<ev.h> header file in case of conflicts.
2421 2563
2422=item EV_CONFIG_H 2564=item EV_CONFIG_H
2423 2565
2424If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 2566If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
2425F<ev.c>'s idea of where to find the F<config.h> file, similarly to 2567F<ev.c>'s idea of where to find the F<config.h> file, similarly to
2426C<EV_H>, above. 2568C<EV_H>, above.
2427 2569
2428=item EV_EVENT_H 2570=item EV_EVENT_H
2429 2571
2430Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 2572Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
2431of how the F<event.h> header can be found. 2573of how the F<event.h> header can be found, the dfeault is C<"event.h">.
2432 2574
2433=item EV_PROTOTYPES 2575=item EV_PROTOTYPES
2434 2576
2435If defined to be C<0>, then F<ev.h> will not define any function 2577If defined to be C<0>, then F<ev.h> will not define any function
2436prototypes, but still define all the structs and other symbols. This is 2578prototypes, but still define all the structs and other symbols. This is
2502than enough. If you need to manage thousands of children you might want to 2644than enough. If you need to manage thousands of children you might want to
2503increase this value (I<must> be a power of two). 2645increase this value (I<must> be a power of two).
2504 2646
2505=item EV_INOTIFY_HASHSIZE 2647=item EV_INOTIFY_HASHSIZE
2506 2648
2507C<ev_staz> watchers use a small hash table to distribute workload by 2649C<ev_stat> watchers use a small hash table to distribute workload by
2508inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), 2650inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2509usually more than enough. If you need to manage thousands of C<ev_stat> 2651usually more than enough. If you need to manage thousands of C<ev_stat>
2510watchers you might want to increase this value (I<must> be a power of 2652watchers you might want to increase this value (I<must> be a power of
2511two). 2653two).
2512 2654
2608 2750
2609=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) 2751=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2610 2752
2611This means that, when you have a watcher that triggers in one hour and 2753This means that, when you have a watcher that triggers in one hour and
2612there are 100 watchers that would trigger before that then inserting will 2754there are 100 watchers that would trigger before that then inserting will
2613have to skip those 100 watchers. 2755have to skip roughly seven (C<ld 100>) of these watchers.
2614 2756
2615=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) 2757=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2616 2758
2617That means that for changing a timer costs less than removing/adding them 2759That means that changing a timer costs less than removing/adding them
2618as only the relative motion in the event queue has to be paid for. 2760as only the relative motion in the event queue has to be paid for.
2619 2761
2620=item Starting io/check/prepare/idle/signal/child watchers: O(1) 2762=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2621 2763
2622These just add the watcher into an array or at the head of a list. 2764These just add the watcher into an array or at the head of a list.
2765
2623=item Stopping check/prepare/idle watchers: O(1) 2766=item Stopping check/prepare/idle watchers: O(1)
2624 2767
2625=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) 2768=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2626 2769
2627These watchers are stored in lists then need to be walked to find the 2770These watchers are stored in lists then need to be walked to find the
2628correct watcher to remove. The lists are usually short (you don't usually 2771correct watcher to remove. The lists are usually short (you don't usually
2629have many watchers waiting for the same fd or signal). 2772have many watchers waiting for the same fd or signal).
2630 2773
2631=item Finding the next timer per loop iteration: O(1) 2774=item Finding the next timer in each loop iteration: O(1)
2775
2776By virtue of using a binary heap, the next timer is always found at the
2777beginning of the storage array.
2632 2778
2633=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) 2779=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2634 2780
2635A change means an I/O watcher gets started or stopped, which requires 2781A change means an I/O watcher gets started or stopped, which requires
2636libev to recalculate its status (and possibly tell the kernel). 2782libev to recalculate its status (and possibly tell the kernel, depending
2783on backend and wether C<ev_io_set> was used).
2637 2784
2638=item Activating one watcher: O(1) 2785=item Activating one watcher (putting it into the pending state): O(1)
2639 2786
2640=item Priority handling: O(number_of_priorities) 2787=item Priority handling: O(number_of_priorities)
2641 2788
2642Priorities are implemented by allocating some space for each 2789Priorities are implemented by allocating some space for each
2643priority. When doing priority-based operations, libev usually has to 2790priority. When doing priority-based operations, libev usually has to
2644linearly search all the priorities. 2791linearly search all the priorities, but starting/stopping and activating
2792watchers becomes O(1) w.r.t. prioritiy handling.
2645 2793
2646=back 2794=back
2647 2795
2648 2796
2797=head1 Win32 platform limitations and workarounds
2798
2799Win32 doesn't support any of the standards (e.g. POSIX) that libev
2800requires, and its I/O model is fundamentally incompatible with the POSIX
2801model. Libev still offers limited functionality on this platform in
2802the form of the C<EVBACKEND_SELECT> backend, and only supports socket
2803descriptors. This only applies when using Win32 natively, not when using
2804e.g. cygwin.
2805
2806There is no supported compilation method available on windows except
2807embedding it into other applications.
2808
2809Due to the many, low, and arbitrary limits on the win32 platform and the
2810abysmal performance of winsockets, using a large number of sockets is not
2811recommended (and not reasonable). If your program needs to use more than
2812a hundred or so sockets, then likely it needs to use a totally different
2813implementation for windows, as libev offers the POSIX model, which cannot
2814be implemented efficiently on windows (microsoft monopoly games).
2815
2816=over 4
2817
2818=item The winsocket select function
2819
2820The winsocket C<select> function doesn't follow POSIX in that it requires
2821socket I<handles> and not socket I<file descriptors>. This makes select
2822very inefficient, and also requires a mapping from file descriptors
2823to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,
2824C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor
2825symbols for more info.
2826
2827The configuration for a "naked" win32 using the microsoft runtime
2828libraries and raw winsocket select is:
2829
2830 #define EV_USE_SELECT 1
2831 #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
2832
2833Note that winsockets handling of fd sets is O(n), so you can easily get a
2834complexity in the O(n²) range when using win32.
2835
2836=item Limited number of file descriptors
2837
2838Windows has numerous arbitrary (and low) limits on things. Early versions
2839of winsocket's select only supported waiting for a max. of C<64> handles
2840(probably owning to the fact that all windows kernels can only wait for
2841C<64> things at the same time internally; microsoft recommends spawning a
2842chain of threads and wait for 63 handles and the previous thread in each).
2843
2844Newer versions support more handles, but you need to define C<FD_SETSIZE>
2845to some high number (e.g. C<2048>) before compiling the winsocket select
2846call (which might be in libev or elsewhere, for example, perl does its own
2847select emulation on windows).
2848
2849Another limit is the number of file descriptors in the microsoft runtime
2850libraries, which by default is C<64> (there must be a hidden I<64> fetish
2851or something like this inside microsoft). You can increase this by calling
2852C<_setmaxstdio>, which can increase this limit to C<2048> (another
2853arbitrary limit), but is broken in many versions of the microsoft runtime
2854libraries.
2855
2856This might get you to about C<512> or C<2048> sockets (depending on
2857windows version and/or the phase of the moon). To get more, you need to
2858wrap all I/O functions and provide your own fd management, but the cost of
2859calling select (O(n²)) will likely make this unworkable.
2860
2861=back
2862
2863
2649=head1 AUTHOR 2864=head1 AUTHOR
2650 2865
2651Marc Lehmann <libev@schmorp.de>. 2866Marc Lehmann <libev@schmorp.de>.
2652 2867

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines