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

Comparing libev/ev.pod (file contents):
Revision 1.99 by root, Sat Dec 22 06:16:36 2007 UTC vs.
Revision 1.118 by root, Thu Jan 10 06:00:55 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
260flags. If that is troubling you, check C<ev_backend ()> afterwards). 260flags. If that is troubling you, check C<ev_backend ()> afterwards).
261 261
262If you don't know what event loop to use, use the one returned from this 262If you don't know what event loop to use, use the one returned from this
263function. 263function.
264 264
265The 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
267for 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
269can simply overwrite the C<SIGCHLD> signal handler I<after> calling
270C<ev_default_init>.
271
265The flags argument can be used to specify special behaviour or specific 272The flags argument can be used to specify special behaviour or specific
266backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). 273backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
267 274
268The following flags are supported: 275The following flags are supported:
269 276
306=item C<EVBACKEND_SELECT> (value 1, portable select backend) 313=item C<EVBACKEND_SELECT> (value 1, portable select backend)
307 314
308This is your standard select(2) backend. Not I<completely> standard, as 315This 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, 316libev 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 317but 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 318using this backend. It doesn't scale too well (O(highest_fd)), but its
312the fastest backend for a low number of fds. 319usually the fastest backend for a low number of (low-numbered :) fds.
320
321To 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
323writing 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
325a look at C<ev_set_io_collect_interval ()> to increase the amount of
326readyness notifications you get per iteration.
313 327
314=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) 328=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
315 329
316And this is your standard poll(2) backend. It's more complicated than 330And this is your standard poll(2) backend. It's more complicated
317select, but handles sparse fds better and has no artificial limit on the 331than select, but handles sparse fds better and has no artificial
318number of fds you can use (except it will slow down considerably with a 332limit 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). 333considerably with a lot of inactive fds). It scales similarly to select,
334i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
335performance tips.
320 336
321=item C<EVBACKEND_EPOLL> (value 4, Linux) 337=item C<EVBACKEND_EPOLL> (value 4, Linux)
322 338
323For few fds, this backend is a bit little slower than poll and select, 339For few fds, this backend is a bit little slower than poll and select,
324but it scales phenomenally better. While poll and select usually scale 340but 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), 341like 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 342epoll 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 343of shortcomings, such as silently dropping events in some hard-to-detect
328cases and rewiring a syscall per fd change, no fork support and bad 344cases and rewiring a syscall per fd change, no fork support and bad
329support for dup: 345support for dup.
330 346
331While stopping, setting and starting an I/O watcher in the same iteration 347While 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 348will 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 349(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 350best to avoid that. Also, C<dup ()>'ed file descriptors might not work
336 352
337Please note that epoll sometimes generates spurious notifications, so you 353Please 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 354need to use non-blocking I/O or other means to avoid blocking when no data
339(or space) is available. 355(or space) is available.
340 356
357Best performance from this backend is achieved by not unregistering all
358watchers for a file descriptor until it has been closed, if possible, i.e.
359keep at least one watcher active per fd at all times.
360
361While nominally embeddeble in other event loops, this feature is broken in
362all kernel versions tested so far.
363
341=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 364=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
342 365
343Kqueue deserves special mention, as at the time of this writing, it 366Kqueue 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 367was broken on all BSDs except NetBSD (usually it doesn't work reliably
345sockets and pipes, except on Darwin, where of course it's completely 368with 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" 369it's completely useless). For this reason it's not being "autodetected"
348unless you explicitly specify it explicitly in the flags (i.e. using 370unless 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) 371C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
350system like NetBSD. 372system like NetBSD.
351 373
374You still can embed kqueue into a normal poll or select backend and use it
375only for sockets (after having made sure that sockets work with kqueue on
376the target platform). See C<ev_embed> watchers for more info.
377
352It scales in the same way as the epoll backend, but the interface to the 378It 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, 379kernel is more efficient (which says nothing about its actual speed, of
354of course). While stopping, setting and starting an I/O watcher does 380course). 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 381cause 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 382two event changes per incident, support for C<fork ()> is very bad and it
357silently in similarly hard-to-detetc cases. 383drops fds silently in similarly hard-to-detect cases.
384
385This backend usually performs well under most conditions.
386
387While nominally embeddable in other event loops, this doesn't work
388everywhere, so you might need to test for this. And since it is broken
389almost everywhere, you should only use it when you have a lot of sockets
390(for which it usually works), by embedding it into another event loop
391(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for
392sockets.
358 393
359=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) 394=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
360 395
361This is not implemented yet (and might never be). 396This is not implemented yet (and might never be, unless you send me an
397implementation). According to reports, C</dev/poll> only supports sockets
398and is not embeddable, which would limit the usefulness of this backend
399immensely.
362 400
363=item C<EVBACKEND_PORT> (value 32, Solaris 10) 401=item C<EVBACKEND_PORT> (value 32, Solaris 10)
364 402
365This uses the Solaris 10 event port mechanism. As with everything on Solaris, 403This 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)). 404it's really slow, but it still scales very well (O(active_fds)).
367 405
368Please note that solaris event ports can deliver a lot of spurious 406Please 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 407notifications, so you need to use non-blocking I/O or other means to avoid
370blocking when no data (or space) is available. 408blocking when no data (or space) is available.
371 409
410While this backend scales well, it requires one system call per active
411file descriptor per loop iteration. For small and medium numbers of file
412descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
413might perform better.
414
415On the positive side, ignoring the spurious readyness notifications, this
416backend actually performed to specification in all tests and is fully
417embeddable, which is a rare feat among the OS-specific backends.
418
372=item C<EVBACKEND_ALL> 419=item C<EVBACKEND_ALL>
373 420
374Try all backends (even potentially broken ones that wouldn't be tried 421Try 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 422with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
376C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. 423C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
377 424
425It is definitely not recommended to use this flag.
426
378=back 427=back
379 428
380If one or more of these are ored into the flags value, then only these 429If 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 430backends will be tried (in the reverse order as listed here). If none are
382specified, most compiled-in backend will be tried, usually in reverse 431specified, all backends in C<ev_recommended_backends ()> will be tried.
383order of their flag values :)
384 432
385The most typical usage is like this: 433The most typical usage is like this:
386 434
387 if (!ev_default_loop (0)) 435 if (!ev_default_loop (0))
388 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 436 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
513usually a better approach for this kind of thing. 561usually a better approach for this kind of thing.
514 562
515Here are the gory details of what C<ev_loop> does: 563Here are the gory details of what C<ev_loop> does:
516 564
517 - Before the first iteration, call any pending watchers. 565 - Before the first iteration, call any pending watchers.
518 * If there are no active watchers (reference count is zero), return. 566 * If EVFLAG_FORKCHECK was used, check for a fork.
519 - Queue all prepare watchers and then call all outstanding watchers. 567 - If a fork was detected, queue and call all fork watchers.
568 - Queue and call all prepare watchers.
520 - If we have been forked, recreate the kernel state. 569 - If we have been forked, recreate the kernel state.
521 - Update the kernel state with all outstanding changes. 570 - Update the kernel state with all outstanding changes.
522 - Update the "event loop time". 571 - Update the "event loop time".
523 - Calculate for how long to block. 572 - Calculate for how long to sleep or block, if at all
573 (active idle watchers, EVLOOP_NONBLOCK or not having
574 any active watchers at all will result in not sleeping).
575 - Sleep if the I/O and timer collect interval say so.
524 - Block the process, waiting for any events. 576 - Block the process, waiting for any events.
525 - Queue all outstanding I/O (fd) events. 577 - Queue all outstanding I/O (fd) events.
526 - Update the "event loop time" and do time jump handling. 578 - Update the "event loop time" and do time jump handling.
527 - Queue all outstanding timers. 579 - Queue all outstanding timers.
528 - Queue all outstanding periodics. 580 - Queue all outstanding periodics.
529 - If no events are pending now, queue all idle watchers. 581 - If no events are pending now, queue all idle watchers.
530 - Queue all check watchers. 582 - Queue all check watchers.
531 - Call all queued watchers in reverse order (i.e. check watchers first). 583 - 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 584 Signals and child watchers are implemented as I/O watchers, and will
533 be handled here by queueing them when their watcher gets executed. 585 be handled here by queueing them when their watcher gets executed.
534 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 586 - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
535 were used, return, otherwise continue with step *. 587 were used, or there are no active watchers, return, otherwise
588 continue with step *.
536 589
537Example: Queue some jobs and then loop until no events are outsanding 590Example: Queue some jobs and then loop until no events are outstanding
538anymore. 591anymore.
539 592
540 ... queue jobs here, make sure they register event watchers as long 593 ... 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..) 594 ... as they still have work to do (even an idle watcher will do..)
542 ev_loop (my_loop, 0); 595 ev_loop (my_loop, 0);
546 599
547Can be used to make a call to C<ev_loop> return early (but only after it 600Can 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 601has 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 602C<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. 603C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
604
605This "unloop state" will be cleared when entering C<ev_loop> again.
551 606
552=item ev_ref (loop) 607=item ev_ref (loop)
553 608
554=item ev_unref (loop) 609=item ev_unref (loop)
555 610
560returning, ev_unref() after starting, and ev_ref() before stopping it. For 615returning, ev_unref() after starting, and ev_ref() before stopping it. For
561example, libev itself uses this for its internal signal pipe: It is not 616example, 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 617visible 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 618no 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 619way 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>. 620libraries. Just remember to I<unref after start> and I<ref before stop>
621(but only if the watcher wasn't active before, or was active before,
622respectively).
566 623
567Example: Create a signal watcher, but keep it from keeping C<ev_loop> 624Example: Create a signal watcher, but keep it from keeping C<ev_loop>
568running when nothing else is active. 625running when nothing else is active.
569 626
570 struct ev_signal exitsig; 627 struct ev_signal exitsig;
596overhead for the actual polling but can deliver many events at once. 653overhead for the actual polling but can deliver many events at once.
597 654
598By setting a higher I<io collect interval> you allow libev to spend more 655By 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, 656time collecting I/O events, so you can handle more events per iteration,
600at the cost of increasing latency. Timeouts (both C<ev_periodic> and 657at the cost of increasing latency. Timeouts (both C<ev_periodic> and
601C<ev_timer>) will be not affected. Setting this to a non-null bvalue will 658C<ev_timer>) will be not affected. Setting this to a non-null value will
602introduce an additional C<ev_sleep ()> call into most loop iterations. 659introduce an additional C<ev_sleep ()> call into most loop iterations.
603 660
604Likewise, by setting a higher I<timeout collect interval> you allow libev 661Likewise, by setting a higher I<timeout collect interval> you allow libev
605to spend more time collecting timeouts, at the expense of increased 662to spend more time collecting timeouts, at the expense of increased
606latency (the watcher callback will be called later). C<ev_io> watchers 663latency (the watcher callback will be called later). C<ev_io> watchers
945In general you can register as many read and/or write event watchers per 1002In general you can register as many read and/or write event watchers per
946fd as you want (as long as you don't confuse yourself). Setting all file 1003fd as you want (as long as you don't confuse yourself). Setting all file
947descriptors to non-blocking mode is also usually a good idea (but not 1004descriptors to non-blocking mode is also usually a good idea (but not
948required if you know what you are doing). 1005required if you know what you are doing).
949 1006
950You have to be careful with dup'ed file descriptors, though. Some backends
951(the linux epoll backend is a notable example) cannot handle dup'ed file
952descriptors correctly if you register interest in two or more fds pointing
953to the same underlying file/socket/etc. description (that is, they share
954the same underlying "file open").
955
956If you must do this, then force the use of a known-to-be-good backend 1007If you must do this, then force the use of a known-to-be-good backend
957(at the time of this writing, this includes only C<EVBACKEND_SELECT> and 1008(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
958C<EVBACKEND_POLL>). 1009C<EVBACKEND_POLL>).
959 1010
960Another thing you have to watch out for is that it is quite easy to 1011Another thing you have to watch out for is that it is quite easy to
994optimisations to libev. 1045optimisations to libev.
995 1046
996=head3 The special problem of dup'ed file descriptors 1047=head3 The special problem of dup'ed file descriptors
997 1048
998Some backends (e.g. epoll), cannot register events for file descriptors, 1049Some backends (e.g. epoll), cannot register events for file descriptors,
999but only events for the underlying file descriptions. That menas when you 1050but only events for the underlying file descriptions. That means when you
1000have C<dup ()>'ed file descriptors and register events for them, only one 1051have C<dup ()>'ed file descriptors or weirder constellations, and register
1001file descriptor might actually receive events. 1052events for them, only one file descriptor might actually receive events.
1002 1053
1003There is no workaorund possible except not registering events 1054There is no workaround possible except not registering events
1004for potentially C<dup ()>'ed file descriptors or to resort to 1055for potentially C<dup ()>'ed file descriptors, or to resort to
1005C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1056C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1006 1057
1007=head3 The special problem of fork 1058=head3 The special problem of fork
1008 1059
1009Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1060Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1035=item int events [read-only] 1086=item int events [read-only]
1036 1087
1037The events being watched. 1088The events being watched.
1038 1089
1039=back 1090=back
1091
1092=head3 Examples
1040 1093
1041Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well 1094Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1042readable, but only once. Since it is likely line-buffered, you could 1095readable, but only once. Since it is likely line-buffered, you could
1043attempt to read a whole line in the callback. 1096attempt to read a whole line in the callback.
1044 1097
1142or C<ev_timer_again> is called and determines the next timeout (if any), 1195or C<ev_timer_again> is called and determines the next timeout (if any),
1143which is also when any modifications are taken into account. 1196which is also when any modifications are taken into account.
1144 1197
1145=back 1198=back
1146 1199
1200=head3 Examples
1201
1147Example: Create a timer that fires after 60 seconds. 1202Example: Create a timer that fires after 60 seconds.
1148 1203
1149 static void 1204 static void
1150 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1205 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1151 { 1206 {
1308When active, contains the absolute time that the watcher is supposed to 1363When active, contains the absolute time that the watcher is supposed to
1309trigger next. 1364trigger next.
1310 1365
1311=back 1366=back
1312 1367
1368=head3 Examples
1369
1313Example: Call a callback every hour, or, more precisely, whenever the 1370Example: Call a callback every hour, or, more precisely, whenever the
1314system clock is divisible by 3600. The callback invocation times have 1371system clock is divisible by 3600. The callback invocation times have
1315potentially a lot of jittering, but good long-term stability. 1372potentially a lot of jittering, but good long-term stability.
1316 1373
1317 static void 1374 static void
1408 1465
1409The process exit/trace status caused by C<rpid> (see your systems 1466The process exit/trace status caused by C<rpid> (see your systems
1410C<waitpid> and C<sys/wait.h> documentation for details). 1467C<waitpid> and C<sys/wait.h> documentation for details).
1411 1468
1412=back 1469=back
1470
1471=head3 Examples
1413 1472
1414Example: Try to exit cleanly on SIGINT and SIGTERM. 1473Example: Try to exit cleanly on SIGINT and SIGTERM.
1415 1474
1416 static void 1475 static void
1417 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1476 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1458semantics of C<ev_stat> watchers, which means that libev sometimes needs 1517semantics of C<ev_stat> watchers, which means that libev sometimes needs
1459to fall back to regular polling again even with inotify, but changes are 1518to fall back to regular polling again even with inotify, but changes are
1460usually detected immediately, and if the file exists there will be no 1519usually detected immediately, and if the file exists there will be no
1461polling. 1520polling.
1462 1521
1522=head3 Inotify
1523
1524When C<inotify (7)> support has been compiled into libev (generally only
1525available on Linux) and present at runtime, it will be used to speed up
1526change detection where possible. The inotify descriptor will be created lazily
1527when the first C<ev_stat> watcher is being started.
1528
1529Inotify presense does not change the semantics of C<ev_stat> watchers
1530except that changes might be detected earlier, and in some cases, to avoid
1531making regular C<stat> calls. Even in the presense of inotify support
1532there are many cases where libev has to resort to regular C<stat> polling.
1533
1534(There is no support for kqueue, as apparently it cannot be used to
1535implement this functionality, due to the requirement of having a file
1536descriptor open on the object at all times).
1537
1538=head3 The special problem of stat time resolution
1539
1540The C<stat ()> syscall only supports full-second resolution portably, and
1541even on systems where the resolution is higher, many filesystems still
1542only support whole seconds.
1543
1544That means that, if the time is the only thing that changes, you might
1545miss updates: on the first update, C<ev_stat> detects a change and calls
1546your callback, which does something. When there is another update within
1547the same second, C<ev_stat> will be unable to detect it.
1548
1549The solution to this is to delay acting on a change for a second (or till
1550the next second boundary), using a roughly one-second delay C<ev_timer>
1551(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>
1552is added to work around small timing inconsistencies of some operating
1553systems.
1554
1463=head3 Watcher-Specific Functions and Data Members 1555=head3 Watcher-Specific Functions and Data Members
1464 1556
1465=over 4 1557=over 4
1466 1558
1467=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) 1559=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
1504=item const char *path [read-only] 1596=item const char *path [read-only]
1505 1597
1506The filesystem path that is being watched. 1598The filesystem path that is being watched.
1507 1599
1508=back 1600=back
1601
1602=head3 Examples
1509 1603
1510Example: Watch C</etc/passwd> for attribute changes. 1604Example: Watch C</etc/passwd> for attribute changes.
1511 1605
1512 static void 1606 static void
1513 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) 1607 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1526 } 1620 }
1527 1621
1528 ... 1622 ...
1529 ev_stat passwd; 1623 ev_stat passwd;
1530 1624
1531 ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); 1625 ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1532 ev_stat_start (loop, &passwd); 1626 ev_stat_start (loop, &passwd);
1627
1628Example: Like above, but additionally use a one-second delay so we do not
1629miss updates (however, frequent updates will delay processing, too, so
1630one might do the work both on C<ev_stat> callback invocation I<and> on
1631C<ev_timer> callback invocation).
1632
1633 static ev_stat passwd;
1634 static ev_timer timer;
1635
1636 static void
1637 timer_cb (EV_P_ ev_timer *w, int revents)
1638 {
1639 ev_timer_stop (EV_A_ w);
1640
1641 /* now it's one second after the most recent passwd change */
1642 }
1643
1644 static void
1645 stat_cb (EV_P_ ev_stat *w, int revents)
1646 {
1647 /* reset the one-second timer */
1648 ev_timer_again (EV_A_ &timer);
1649 }
1650
1651 ...
1652 ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1653 ev_stat_start (loop, &passwd);
1654 ev_timer_init (&timer, timer_cb, 0., 1.01);
1533 1655
1534 1656
1535=head2 C<ev_idle> - when you've got nothing better to do... 1657=head2 C<ev_idle> - when you've got nothing better to do...
1536 1658
1537Idle watchers trigger events when no other events of the same or higher 1659Idle watchers trigger events when no other events of the same or higher
1562Initialises and configures the idle watcher - it has no parameters of any 1684Initialises and configures the idle watcher - it has no parameters of any
1563kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 1685kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1564believe me. 1686believe me.
1565 1687
1566=back 1688=back
1689
1690=head3 Examples
1567 1691
1568Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the 1692Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1569callback, free it. Also, use no error checking, as usual. 1693callback, free it. Also, use no error checking, as usual.
1570 1694
1571 static void 1695 static void
1623 1747
1624It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 1748It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1625priority, to ensure that they are being run before any other watchers 1749priority, to ensure that they are being run before any other watchers
1626after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, 1750after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1627too) should not activate ("feed") events into libev. While libev fully 1751too) should not activate ("feed") events into libev. While libev fully
1628supports this, they will be called before other C<ev_check> watchers did 1752supports this, they will be called before other C<ev_check> watchers
1629their job. As C<ev_check> watchers are often used to embed other event 1753did their job. As C<ev_check> watchers are often used to embed other
1630loops those other event loops might be in an unusable state until their 1754(non-libev) event loops those other event loops might be in an unusable
1631C<ev_check> watcher ran (always remind yourself to coexist peacefully with 1755state until their C<ev_check> watcher ran (always remind yourself to
1632others). 1756coexist peacefully with others).
1633 1757
1634=head3 Watcher-Specific Functions and Data Members 1758=head3 Watcher-Specific Functions and Data Members
1635 1759
1636=over 4 1760=over 4
1637 1761
1642Initialises and configures the prepare or check watcher - they have no 1766Initialises and configures the prepare or check watcher - they have no
1643parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1767parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1644macros, but using them is utterly, utterly and completely pointless. 1768macros, but using them is utterly, utterly and completely pointless.
1645 1769
1646=back 1770=back
1771
1772=head3 Examples
1647 1773
1648There are a number of principal ways to embed other event loops or modules 1774There are a number of principal ways to embed other event loops or modules
1649into libev. Here are some ideas on how to include libadns into libev 1775into libev. Here are some ideas on how to include libadns into libev
1650(there is a Perl module named C<EV::ADNS> that does this, which you could 1776(there is a Perl module named C<EV::ADNS> that does this, which you could
1651use for an actually working example. Another Perl module named C<EV::Glib> 1777use for an actually working example. Another Perl module named C<EV::Glib>
1776=head2 C<ev_embed> - when one backend isn't enough... 1902=head2 C<ev_embed> - when one backend isn't enough...
1777 1903
1778This is a rather advanced watcher type that lets you embed one event loop 1904This is a rather advanced watcher type that lets you embed one event loop
1779into another (currently only C<ev_io> events are supported in the embedded 1905into another (currently only C<ev_io> events are supported in the embedded
1780loop, other types of watchers might be handled in a delayed or incorrect 1906loop, other types of watchers might be handled in a delayed or incorrect
1781fashion and must not be used). (See portability notes, below). 1907fashion and must not be used).
1782 1908
1783There are primarily two reasons you would want that: work around bugs and 1909There are primarily two reasons you would want that: work around bugs and
1784prioritise I/O. 1910prioritise I/O.
1785 1911
1786As an example for a bug workaround, the kqueue backend might only support 1912As an example for a bug workaround, the kqueue backend might only support
1820portable one. 1946portable one.
1821 1947
1822So when you want to use this feature you will always have to be prepared 1948So when you want to use this feature you will always have to be prepared
1823that you cannot get an embeddable loop. The recommended way to get around 1949that you cannot get an embeddable loop. The recommended way to get around
1824this is to have a separate variables for your embeddable loop, try to 1950this is to have a separate variables for your embeddable loop, try to
1825create it, and if that fails, use the normal loop for everything: 1951create it, and if that fails, use the normal loop for everything.
1952
1953=head3 Watcher-Specific Functions and Data Members
1954
1955=over 4
1956
1957=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
1958
1959=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
1960
1961Configures the watcher to embed the given loop, which must be
1962embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1963invoked automatically, otherwise it is the responsibility of the callback
1964to invoke it (it will continue to be called until the sweep has been done,
1965if you do not want thta, you need to temporarily stop the embed watcher).
1966
1967=item ev_embed_sweep (loop, ev_embed *)
1968
1969Make a single, non-blocking sweep over the embedded loop. This works
1970similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1971apropriate way for embedded loops.
1972
1973=item struct ev_loop *other [read-only]
1974
1975The embedded event loop.
1976
1977=back
1978
1979=head3 Examples
1980
1981Example: Try to get an embeddable event loop and embed it into the default
1982event loop. If that is not possible, use the default loop. The default
1983loop is stored in C<loop_hi>, while the mebeddable loop is stored in
1984C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be
1985used).
1826 1986
1827 struct ev_loop *loop_hi = ev_default_init (0); 1987 struct ev_loop *loop_hi = ev_default_init (0);
1828 struct ev_loop *loop_lo = 0; 1988 struct ev_loop *loop_lo = 0;
1829 struct ev_embed embed; 1989 struct ev_embed embed;
1830 1990
1841 ev_embed_start (loop_hi, &embed); 2001 ev_embed_start (loop_hi, &embed);
1842 } 2002 }
1843 else 2003 else
1844 loop_lo = loop_hi; 2004 loop_lo = loop_hi;
1845 2005
1846=head2 Portability notes 2006Example: Check if kqueue is available but not recommended and create
2007a kqueue backend for use with sockets (which usually work with any
2008kqueue implementation). Store the kqueue/socket-only event loop in
2009C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
1847 2010
1848Kqueue is nominally embeddable, but this is broken on all BSDs that I 2011 struct ev_loop *loop = ev_default_init (0);
1849tried, in various ways. Usually the embedded event loop will simply never 2012 struct ev_loop *loop_socket = 0;
1850receive events, sometimes it will only trigger a few times, sometimes in a 2013 struct ev_embed embed;
1851loop. Epoll is also nominally embeddable, but many Linux kernel versions 2014
1852will always eport the epoll fd as ready, even when no events are pending. 2015 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2016 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2017 {
2018 ev_embed_init (&embed, 0, loop_socket);
2019 ev_embed_start (loop, &embed);
2020 }
1853 2021
1854While libev allows embedding these backends (they are contained in 2022 if (!loop_socket)
1855C<ev_embeddable_backends ()>), take extreme care that it will actually 2023 loop_socket = loop;
1856work.
1857 2024
1858When in doubt, create a dynamic event loop forced to use sockets (this 2025 // now use loop_socket for all sockets, and loop for everything else
1859usually works) and possibly another thread and a pipe or so to report to
1860your main event loop.
1861
1862=head3 Watcher-Specific Functions and Data Members
1863
1864=over 4
1865
1866=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
1867
1868=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
1869
1870Configures the watcher to embed the given loop, which must be
1871embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1872invoked automatically, otherwise it is the responsibility of the callback
1873to invoke it (it will continue to be called until the sweep has been done,
1874if you do not want thta, you need to temporarily stop the embed watcher).
1875
1876=item ev_embed_sweep (loop, ev_embed *)
1877
1878Make a single, non-blocking sweep over the embedded loop. This works
1879similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1880apropriate way for embedded loops.
1881
1882=item struct ev_loop *other [read-only]
1883
1884The embedded event loop.
1885
1886=back
1887 2026
1888 2027
1889=head2 C<ev_fork> - the audacity to resume the event loop after a fork 2028=head2 C<ev_fork> - the audacity to resume the event loop after a fork
1890 2029
1891Fork watchers are called when a C<fork ()> was detected (usually because 2030Fork watchers are called when a C<fork ()> was detected (usually because
2370wants osf handles on win32 (this is the case when the select to 2509wants osf handles on win32 (this is the case when the select to
2371be used is the winsock select). This means that it will call 2510be used is the winsock select). This means that it will call
2372C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 2511C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
2373it is assumed that all these functions actually work on fds, even 2512it is assumed that all these functions actually work on fds, even
2374on win32. Should not be defined on non-win32 platforms. 2513on win32. Should not be defined on non-win32 platforms.
2514
2515=item EV_FD_TO_WIN32_HANDLE
2516
2517If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
2518file descriptors to socket handles. When not defining this symbol (the
2519default), then libev will call C<_get_osfhandle>, which is usually
2520correct. In some cases, programs use their own file descriptor management,
2521in which case they can provide this function to map fds to socket handles.
2375 2522
2376=item EV_USE_POLL 2523=item EV_USE_POLL
2377 2524
2378If defined to be C<1>, libev will compile in support for the C<poll>(2) 2525If defined to be C<1>, libev will compile in support for the C<poll>(2)
2379backend. Otherwise it will be enabled on non-win32 platforms. It 2526backend. Otherwise it will be enabled on non-win32 platforms. It
2416be detected at runtime. 2563be detected at runtime.
2417 2564
2418=item EV_H 2565=item EV_H
2419 2566
2420The name of the F<ev.h> header file used to include it. The default if 2567The name of the F<ev.h> header file used to include it. The default if
2421undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This 2568undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
2422can be used to virtually rename the F<ev.h> header file in case of conflicts. 2569used to virtually rename the F<ev.h> header file in case of conflicts.
2423 2570
2424=item EV_CONFIG_H 2571=item EV_CONFIG_H
2425 2572
2426If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 2573If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
2427F<ev.c>'s idea of where to find the F<config.h> file, similarly to 2574F<ev.c>'s idea of where to find the F<config.h> file, similarly to
2428C<EV_H>, above. 2575C<EV_H>, above.
2429 2576
2430=item EV_EVENT_H 2577=item EV_EVENT_H
2431 2578
2432Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 2579Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
2433of how the F<event.h> header can be found. 2580of how the F<event.h> header can be found, the default is C<"event.h">.
2434 2581
2435=item EV_PROTOTYPES 2582=item EV_PROTOTYPES
2436 2583
2437If defined to be C<0>, then F<ev.h> will not define any function 2584If defined to be C<0>, then F<ev.h> will not define any function
2438prototypes, but still define all the structs and other symbols. This is 2585prototypes, but still define all the structs and other symbols. This is
2504than enough. If you need to manage thousands of children you might want to 2651than enough. If you need to manage thousands of children you might want to
2505increase this value (I<must> be a power of two). 2652increase this value (I<must> be a power of two).
2506 2653
2507=item EV_INOTIFY_HASHSIZE 2654=item EV_INOTIFY_HASHSIZE
2508 2655
2509C<ev_staz> watchers use a small hash table to distribute workload by 2656C<ev_stat> watchers use a small hash table to distribute workload by
2510inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), 2657inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2511usually more than enough. If you need to manage thousands of C<ev_stat> 2658usually more than enough. If you need to manage thousands of C<ev_stat>
2512watchers you might want to increase this value (I<must> be a power of 2659watchers you might want to increase this value (I<must> be a power of
2513two). 2660two).
2514 2661
2610 2757
2611=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) 2758=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2612 2759
2613This means that, when you have a watcher that triggers in one hour and 2760This means that, when you have a watcher that triggers in one hour and
2614there are 100 watchers that would trigger before that then inserting will 2761there are 100 watchers that would trigger before that then inserting will
2615have to skip those 100 watchers. 2762have to skip roughly seven (C<ld 100>) of these watchers.
2616 2763
2617=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) 2764=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2618 2765
2619That means that for changing a timer costs less than removing/adding them 2766That means that changing a timer costs less than removing/adding them
2620as only the relative motion in the event queue has to be paid for. 2767as only the relative motion in the event queue has to be paid for.
2621 2768
2622=item Starting io/check/prepare/idle/signal/child watchers: O(1) 2769=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2623 2770
2624These just add the watcher into an array or at the head of a list. 2771These just add the watcher into an array or at the head of a list.
2772
2625=item Stopping check/prepare/idle watchers: O(1) 2773=item Stopping check/prepare/idle watchers: O(1)
2626 2774
2627=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) 2775=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2628 2776
2629These watchers are stored in lists then need to be walked to find the 2777These watchers are stored in lists then need to be walked to find the
2630correct watcher to remove. The lists are usually short (you don't usually 2778correct watcher to remove. The lists are usually short (you don't usually
2631have many watchers waiting for the same fd or signal). 2779have many watchers waiting for the same fd or signal).
2632 2780
2633=item Finding the next timer per loop iteration: O(1) 2781=item Finding the next timer in each loop iteration: O(1)
2782
2783By virtue of using a binary heap, the next timer is always found at the
2784beginning of the storage array.
2634 2785
2635=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) 2786=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2636 2787
2637A change means an I/O watcher gets started or stopped, which requires 2788A change means an I/O watcher gets started or stopped, which requires
2638libev to recalculate its status (and possibly tell the kernel). 2789libev to recalculate its status (and possibly tell the kernel, depending
2790on backend and wether C<ev_io_set> was used).
2639 2791
2640=item Activating one watcher: O(1) 2792=item Activating one watcher (putting it into the pending state): O(1)
2641 2793
2642=item Priority handling: O(number_of_priorities) 2794=item Priority handling: O(number_of_priorities)
2643 2795
2644Priorities are implemented by allocating some space for each 2796Priorities are implemented by allocating some space for each
2645priority. When doing priority-based operations, libev usually has to 2797priority. When doing priority-based operations, libev usually has to
2646linearly search all the priorities. 2798linearly search all the priorities, but starting/stopping and activating
2799watchers becomes O(1) w.r.t. prioritiy handling.
2647 2800
2648=back 2801=back
2649 2802
2650 2803
2804=head1 Win32 platform limitations and workarounds
2805
2806Win32 doesn't support any of the standards (e.g. POSIX) that libev
2807requires, and its I/O model is fundamentally incompatible with the POSIX
2808model. Libev still offers limited functionality on this platform in
2809the form of the C<EVBACKEND_SELECT> backend, and only supports socket
2810descriptors. This only applies when using Win32 natively, not when using
2811e.g. cygwin.
2812
2813There is no supported compilation method available on windows except
2814embedding it into other applications.
2815
2816Due to the many, low, and arbitrary limits on the win32 platform and the
2817abysmal performance of winsockets, using a large number of sockets is not
2818recommended (and not reasonable). If your program needs to use more than
2819a hundred or so sockets, then likely it needs to use a totally different
2820implementation for windows, as libev offers the POSIX model, which cannot
2821be implemented efficiently on windows (microsoft monopoly games).
2822
2823=over 4
2824
2825=item The winsocket select function
2826
2827The winsocket C<select> function doesn't follow POSIX in that it requires
2828socket I<handles> and not socket I<file descriptors>. This makes select
2829very inefficient, and also requires a mapping from file descriptors
2830to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,
2831C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor
2832symbols for more info.
2833
2834The configuration for a "naked" win32 using the microsoft runtime
2835libraries and raw winsocket select is:
2836
2837 #define EV_USE_SELECT 1
2838 #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
2839
2840Note that winsockets handling of fd sets is O(n), so you can easily get a
2841complexity in the O(n²) range when using win32.
2842
2843=item Limited number of file descriptors
2844
2845Windows has numerous arbitrary (and low) limits on things. Early versions
2846of winsocket's select only supported waiting for a max. of C<64> handles
2847(probably owning to the fact that all windows kernels can only wait for
2848C<64> things at the same time internally; microsoft recommends spawning a
2849chain of threads and wait for 63 handles and the previous thread in each).
2850
2851Newer versions support more handles, but you need to define C<FD_SETSIZE>
2852to some high number (e.g. C<2048>) before compiling the winsocket select
2853call (which might be in libev or elsewhere, for example, perl does its own
2854select emulation on windows).
2855
2856Another limit is the number of file descriptors in the microsoft runtime
2857libraries, which by default is C<64> (there must be a hidden I<64> fetish
2858or something like this inside microsoft). You can increase this by calling
2859C<_setmaxstdio>, which can increase this limit to C<2048> (another
2860arbitrary limit), but is broken in many versions of the microsoft runtime
2861libraries.
2862
2863This might get you to about C<512> or C<2048> sockets (depending on
2864windows version and/or the phase of the moon). To get more, you need to
2865wrap all I/O functions and provide your own fd management, but the cost of
2866calling select (O(n²)) will likely make this unworkable.
2867
2868=back
2869
2870
2651=head1 AUTHOR 2871=head1 AUTHOR
2652 2872
2653Marc Lehmann <libev@schmorp.de>. 2873Marc Lehmann <libev@schmorp.de>.
2654 2874

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines