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

Comparing libev/ev.pod (file contents):
Revision 1.173 by root, Thu Aug 7 19:24:56 2008 UTC vs.
Revision 1.184 by root, Tue Sep 23 09:11:14 2008 UTC

359writing a server, you should C<accept ()> in a loop to accept as many 359writing a server, you should C<accept ()> in a loop to accept as many
360connections as possible during one iteration. You might also want to have 360connections as possible during one iteration. You might also want to have
361a look at C<ev_set_io_collect_interval ()> to increase the amount of 361a look at C<ev_set_io_collect_interval ()> to increase the amount of
362readiness notifications you get per iteration. 362readiness notifications you get per iteration.
363 363
364This backend maps C<EV_READ> to the C<readfds> set and C<EV_WRITE> to the
365C<writefds> set (and to work around Microsoft Windows bugs, also onto the
366C<exceptfds> set on that platform).
367
364=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) 368=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
365 369
366And this is your standard poll(2) backend. It's more complicated 370And this is your standard poll(2) backend. It's more complicated
367than select, but handles sparse fds better and has no artificial 371than select, but handles sparse fds better and has no artificial
368limit on the number of fds you can use (except it will slow down 372limit on the number of fds you can use (except it will slow down
369considerably with a lot of inactive fds). It scales similarly to select, 373considerably with a lot of inactive fds). It scales similarly to select,
370i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for 374i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
371performance tips. 375performance tips.
376
377This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
378C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
372 379
373=item C<EVBACKEND_EPOLL> (value 4, Linux) 380=item C<EVBACKEND_EPOLL> (value 4, Linux)
374 381
375For few fds, this backend is a bit little slower than poll and select, 382For few fds, this backend is a bit little slower than poll and select,
376but it scales phenomenally better. While poll and select usually scale 383but it scales phenomenally better. While poll and select usually scale
389Please note that epoll sometimes generates spurious notifications, so you 396Please note that epoll sometimes generates spurious notifications, so you
390need to use non-blocking I/O or other means to avoid blocking when no data 397need to use non-blocking I/O or other means to avoid blocking when no data
391(or space) is available. 398(or space) is available.
392 399
393Best performance from this backend is achieved by not unregistering all 400Best performance from this backend is achieved by not unregistering all
394watchers for a file descriptor until it has been closed, if possible, i.e. 401watchers for a file descriptor until it has been closed, if possible,
395keep at least one watcher active per fd at all times. 402i.e. keep at least one watcher active per fd at all times. Stopping and
403starting a watcher (without re-setting it) also usually doesn't cause
404extra overhead.
396 405
397While nominally embeddable in other event loops, this feature is broken in 406While nominally embeddable in other event loops, this feature is broken in
398all kernel versions tested so far. 407all kernel versions tested so far.
399 408
409This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
410C<EVBACKEND_POLL>.
411
400=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 412=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
401 413
402Kqueue deserves special mention, as at the time of this writing, it 414Kqueue deserves special mention, as at the time of this writing, it was
403was broken on all BSDs except NetBSD (usually it doesn't work reliably 415broken on all BSDs except NetBSD (usually it doesn't work reliably with
404with anything but sockets and pipes, except on Darwin, where of course 416anything but sockets and pipes, except on Darwin, where of course it's
405it's completely useless). For this reason it's not being "auto-detected" 417completely useless). For this reason it's not being "auto-detected" unless
406unless you explicitly specify it explicitly in the flags (i.e. using 418you explicitly specify it in the flags (i.e. using C<EVBACKEND_KQUEUE>) or
407C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) 419libev was compiled on a known-to-be-good (-enough) system like NetBSD.
408system like NetBSD.
409 420
410You still can embed kqueue into a normal poll or select backend and use it 421You still can embed kqueue into a normal poll or select backend and use it
411only for sockets (after having made sure that sockets work with kqueue on 422only for sockets (after having made sure that sockets work with kqueue on
412the target platform). See C<ev_embed> watchers for more info. 423the target platform). See C<ev_embed> watchers for more info.
413 424
414It scales in the same way as the epoll backend, but the interface to the 425It scales in the same way as the epoll backend, but the interface to the
415kernel is more efficient (which says nothing about its actual speed, of 426kernel is more efficient (which says nothing about its actual speed, of
416course). While stopping, setting and starting an I/O watcher does never 427course). While stopping, setting and starting an I/O watcher does never
417cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to 428cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
418two event changes per incident, support for C<fork ()> is very bad and it 429two event changes per incident. Support for C<fork ()> is very bad and it
419drops fds silently in similarly hard-to-detect cases. 430drops fds silently in similarly hard-to-detect cases.
420 431
421This backend usually performs well under most conditions. 432This backend usually performs well under most conditions.
422 433
423While nominally embeddable in other event loops, this doesn't work 434While nominally embeddable in other event loops, this doesn't work
424everywhere, so you might need to test for this. And since it is broken 435everywhere, so you might need to test for this. And since it is broken
425almost everywhere, you should only use it when you have a lot of sockets 436almost everywhere, you should only use it when you have a lot of sockets
426(for which it usually works), by embedding it into another event loop 437(for which it usually works), by embedding it into another event loop
427(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for 438(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and, did I mention it,
428sockets. 439using it only for sockets.
440
441This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with
442C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
443C<NOTE_EOF>.
429 444
430=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) 445=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
431 446
432This is not implemented yet (and might never be, unless you send me an 447This is not implemented yet (and might never be, unless you send me an
433implementation). According to reports, C</dev/poll> only supports sockets 448implementation). According to reports, C</dev/poll> only supports sockets
446While this backend scales well, it requires one system call per active 461While this backend scales well, it requires one system call per active
447file descriptor per loop iteration. For small and medium numbers of file 462file descriptor per loop iteration. For small and medium numbers of file
448descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend 463descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
449might perform better. 464might perform better.
450 465
451On the positive side, ignoring the spurious readiness notifications, this 466On the positive side, with the exception of the spurious readiness
452backend actually performed to specification in all tests and is fully 467notifications, this backend actually performed fully to specification
453embeddable, which is a rare feat among the OS-specific backends. 468in all tests and is fully embeddable, which is a rare feat among the
469OS-specific backends.
470
471This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
472C<EVBACKEND_POLL>.
454 473
455=item C<EVBACKEND_ALL> 474=item C<EVBACKEND_ALL>
456 475
457Try all backends (even potentially broken ones that wouldn't be tried 476Try all backends (even potentially broken ones that wouldn't be tried
458with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as 477with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
464 483
465If one or more of these are or'ed into the flags value, then only these 484If one or more of these are or'ed into the flags value, then only these
466backends will be tried (in the reverse order as listed here). If none are 485backends will be tried (in the reverse order as listed here). If none are
467specified, all backends in C<ev_recommended_backends ()> will be tried. 486specified, all backends in C<ev_recommended_backends ()> will be tried.
468 487
469The most typical usage is like this: 488Example: This is the most typical usage.
470 489
471 if (!ev_default_loop (0)) 490 if (!ev_default_loop (0))
472 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 491 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
473 492
474Restrict libev to the select and poll backends, and do not allow 493Example: Restrict libev to the select and poll backends, and do not allow
475environment settings to be taken into account: 494environment settings to be taken into account:
476 495
477 ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); 496 ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
478 497
479Use whatever libev has to offer, but make sure that kqueue is used if 498Example: Use whatever libev has to offer, but make sure that kqueue is
480available (warning, breaks stuff, best use only with your own private 499used if available (warning, breaks stuff, best use only with your own
481event loop and only if you know the OS supports your types of fds): 500private event loop and only if you know the OS supports your types of
501fds):
482 502
483 ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); 503 ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
484 504
485=item struct ev_loop *ev_loop_new (unsigned int flags) 505=item struct ev_loop *ev_loop_new (unsigned int flags)
486 506
544 564
545=item ev_loop_fork (loop) 565=item ev_loop_fork (loop)
546 566
547Like C<ev_default_fork>, but acts on an event loop created by 567Like C<ev_default_fork>, but acts on an event loop created by
548C<ev_loop_new>. Yes, you have to call this on every allocated event loop 568C<ev_loop_new>. Yes, you have to call this on every allocated event loop
549after fork, and how you do this is entirely your own problem. 569after fork that you want to re-use in the child, and how you do this is
570entirely your own problem.
550 571
551=item int ev_is_default_loop (loop) 572=item int ev_is_default_loop (loop)
552 573
553Returns true when the given loop actually is the default loop, false otherwise. 574Returns true when the given loop is, in fact, the default loop, and false
575otherwise.
554 576
555=item unsigned int ev_loop_count (loop) 577=item unsigned int ev_loop_count (loop)
556 578
557Returns the count of loop iterations for the loop, which is identical to 579Returns the count of loop iterations for the loop, which is identical to
558the number of times libev did poll for new events. It starts at C<0> and 580the number of times libev did poll for new events. It starts at C<0> and
573received events and started processing them. This timestamp does not 595received events and started processing them. This timestamp does not
574change as long as callbacks are being processed, and this is also the base 596change as long as callbacks are being processed, and this is also the base
575time used for relative timers. You can treat it as the timestamp of the 597time used for relative timers. You can treat it as the timestamp of the
576event occurring (or more correctly, libev finding out about it). 598event occurring (or more correctly, libev finding out about it).
577 599
600=item ev_now_update (loop)
601
602Establishes the current time by querying the kernel, updating the time
603returned by C<ev_now ()> in the progress. This is a costly operation and
604is usually done automatically within C<ev_loop ()>.
605
606This function is rarely useful, but when some event callback runs for a
607very long time without entering the event loop, updating libev's idea of
608the current time is a good idea.
609
610See also "The special problem of time updates" in the C<ev_timer> section.
611
578=item ev_loop (loop, int flags) 612=item ev_loop (loop, int flags)
579 613
580Finally, this is it, the event handler. This function usually is called 614Finally, this is it, the event handler. This function usually is called
581after you initialised all your watchers and you want to start handling 615after you initialised all your watchers and you want to start handling
582events. 616events.
584If the flags argument is specified as C<0>, it will not return until 618If the flags argument is specified as C<0>, it will not return until
585either no event watchers are active anymore or C<ev_unloop> was called. 619either no event watchers are active anymore or C<ev_unloop> was called.
586 620
587Please note that an explicit C<ev_unloop> is usually better than 621Please note that an explicit C<ev_unloop> is usually better than
588relying on all watchers to be stopped when deciding when a program has 622relying on all watchers to be stopped when deciding when a program has
589finished (especially in interactive programs), but having a program that 623finished (especially in interactive programs), but having a program
590automatically loops as long as it has to and no longer by virtue of 624that automatically loops as long as it has to and no longer by virtue
591relying on its watchers stopping correctly is a thing of beauty. 625of relying on its watchers stopping correctly, that is truly a thing of
626beauty.
592 627
593A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle 628A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
594those events and any outstanding ones, but will not block your process in 629those events and any already outstanding ones, but will not block your
595case there are no events and will return after one iteration of the loop. 630process in case there are no events and will return after one iteration of
631the loop.
596 632
597A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if 633A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
598necessary) and will handle those and any outstanding ones. It will block 634necessary) and will handle those and any already outstanding ones. It
599your process until at least one new event arrives, and will return after 635will block your process until at least one new event arrives (which could
600one iteration of the loop. This is useful if you are waiting for some 636be an event internal to libev itself, so there is no guarentee that a
601external event in conjunction with something not expressible using other 637user-registered callback will be called), and will return after one
638iteration of the loop.
639
640This is useful if you are waiting for some external event in conjunction
641with something not expressible using other libev watchers (i.e. "roll your
602libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is 642own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
603usually a better approach for this kind of thing. 643usually a better approach for this kind of thing.
604 644
605Here are the gory details of what C<ev_loop> does: 645Here are the gory details of what C<ev_loop> does:
606 646
607 - Before the first iteration, call any pending watchers. 647 - Before the first iteration, call any pending watchers.
617 any active watchers at all will result in not sleeping). 657 any active watchers at all will result in not sleeping).
618 - Sleep if the I/O and timer collect interval say so. 658 - Sleep if the I/O and timer collect interval say so.
619 - Block the process, waiting for any events. 659 - Block the process, waiting for any events.
620 - Queue all outstanding I/O (fd) events. 660 - Queue all outstanding I/O (fd) events.
621 - Update the "event loop time" (ev_now ()), and do time jump adjustments. 661 - Update the "event loop time" (ev_now ()), and do time jump adjustments.
622 - Queue all outstanding timers. 662 - Queue all expired timers.
623 - Queue all outstanding periodics. 663 - Queue all expired periodics.
624 - Unless any events are pending now, queue all idle watchers. 664 - Unless any events are pending now, queue all idle watchers.
625 - Queue all check watchers. 665 - Queue all check watchers.
626 - Call all queued watchers in reverse order (i.e. check watchers first). 666 - Call all queued watchers in reverse order (i.e. check watchers first).
627 Signals and child watchers are implemented as I/O watchers, and will 667 Signals and child watchers are implemented as I/O watchers, and will
628 be handled here by queueing them when their watcher gets executed. 668 be handled here by queueing them when their watcher gets executed.
651 691
652=item ev_unref (loop) 692=item ev_unref (loop)
653 693
654Ref/unref can be used to add or remove a reference count on the event 694Ref/unref can be used to add or remove a reference count on the event
655loop: Every watcher keeps one reference, and as long as the reference 695loop: Every watcher keeps one reference, and as long as the reference
656count is nonzero, C<ev_loop> will not return on its own. If you have 696count is nonzero, C<ev_loop> will not return on its own.
697
657a watcher you never unregister that should not keep C<ev_loop> from 698If you have a watcher you never unregister that should not keep C<ev_loop>
658returning, ev_unref() after starting, and ev_ref() before stopping it. For 699from returning, call ev_unref() after starting, and ev_ref() before
700stopping it.
701
659example, libev itself uses this for its internal signal pipe: It is not 702As an example, libev itself uses this for its internal signal pipe: It is
660visible to the libev user and should not keep C<ev_loop> from exiting if 703not visible to the libev user and should not keep C<ev_loop> from exiting
661no event watchers registered by it are active. It is also an excellent 704if no event watchers registered by it are active. It is also an excellent
662way to do this for generic recurring timers or from within third-party 705way to do this for generic recurring timers or from within third-party
663libraries. Just remember to I<unref after start> and I<ref before stop> 706libraries. Just remember to I<unref after start> and I<ref before stop>
664(but only if the watcher wasn't active before, or was active before, 707(but only if the watcher wasn't active before, or was active before,
665respectively). 708respectively).
666 709
689Setting these to a higher value (the C<interval> I<must> be >= C<0>) 732Setting these to a higher value (the C<interval> I<must> be >= C<0>)
690allows libev to delay invocation of I/O and timer/periodic callbacks 733allows libev to delay invocation of I/O and timer/periodic callbacks
691to increase efficiency of loop iterations (or to increase power-saving 734to increase efficiency of loop iterations (or to increase power-saving
692opportunities). 735opportunities).
693 736
694The background is that sometimes your program runs just fast enough to 737The idea is that sometimes your program runs just fast enough to handle
695handle one (or very few) event(s) per loop iteration. While this makes 738one (or very few) event(s) per loop iteration. While this makes the
696the program responsive, it also wastes a lot of CPU time to poll for new 739program responsive, it also wastes a lot of CPU time to poll for new
697events, especially with backends like C<select ()> which have a high 740events, especially with backends like C<select ()> which have a high
698overhead for the actual polling but can deliver many events at once. 741overhead for the actual polling but can deliver many events at once.
699 742
700By setting a higher I<io collect interval> you allow libev to spend more 743By setting a higher I<io collect interval> you allow libev to spend more
701time collecting I/O events, so you can handle more events per iteration, 744time collecting I/O events, so you can handle more events per iteration,
703C<ev_timer>) will be not affected. Setting this to a non-null value will 746C<ev_timer>) will be not affected. Setting this to a non-null value will
704introduce an additional C<ev_sleep ()> call into most loop iterations. 747introduce an additional C<ev_sleep ()> call into most loop iterations.
705 748
706Likewise, by setting a higher I<timeout collect interval> you allow libev 749Likewise, by setting a higher I<timeout collect interval> you allow libev
707to spend more time collecting timeouts, at the expense of increased 750to spend more time collecting timeouts, at the expense of increased
708latency (the watcher callback will be called later). C<ev_io> watchers 751latency/jitter/inexactness (the watcher callback will be called
709will not be affected. Setting this to a non-null value will not introduce 752later). C<ev_io> watchers will not be affected. Setting this to a non-null
710any overhead in libev. 753value will not introduce any overhead in libev.
711 754
712Many (busy) programs can usually benefit by setting the I/O collect 755Many (busy) programs can usually benefit by setting the I/O collect
713interval to a value near C<0.1> or so, which is often enough for 756interval to a value near C<0.1> or so, which is often enough for
714interactive servers (of course not for games), likewise for timeouts. It 757interactive servers (of course not for games), likewise for timeouts. It
715usually doesn't make much sense to set it to a lower value than C<0.01>, 758usually doesn't make much sense to set it to a lower value than C<0.01>,
723they fire on, say, one-second boundaries only. 766they fire on, say, one-second boundaries only.
724 767
725=item ev_loop_verify (loop) 768=item ev_loop_verify (loop)
726 769
727This function only does something when C<EV_VERIFY> support has been 770This function only does something when C<EV_VERIFY> support has been
728compiled in. It tries to go through all internal structures and checks 771compiled in. which is the default for non-minimal builds. It tries to go
729them for validity. If anything is found to be inconsistent, it will print 772through all internal structures and checks them for validity. If anything
730an error message to standard error and call C<abort ()>. 773is found to be inconsistent, it will print an error message to standard
774error and call C<abort ()>.
731 775
732This can be used to catch bugs inside libev itself: under normal 776This can be used to catch bugs inside libev itself: under normal
733circumstances, this function will never abort as of course libev keeps its 777circumstances, this function will never abort as of course libev keeps its
734data structures consistent. 778data structures consistent.
735 779
851happen because the watcher could not be properly started because libev 895happen because the watcher could not be properly started because libev
852ran out of memory, a file descriptor was found to be closed or any other 896ran out of memory, a file descriptor was found to be closed or any other
853problem. You best act on it by reporting the problem and somehow coping 897problem. You best act on it by reporting the problem and somehow coping
854with the watcher being stopped. 898with the watcher being stopped.
855 899
856Libev will usually signal a few "dummy" events together with an error, 900Libev will usually signal a few "dummy" events together with an error, for
857for example it might indicate that a fd is readable or writable, and if 901example it might indicate that a fd is readable or writable, and if your
858your callbacks is well-written it can just attempt the operation and cope 902callbacks is well-written it can just attempt the operation and cope with
859with the error from read() or write(). This will not work in multi-threaded 903the error from read() or write(). This will not work in multi-threaded
860programs, though, so beware. 904programs, though, as the fd could already be closed and reused for another
905thing, so beware.
861 906
862=back 907=back
863 908
864=head2 GENERIC WATCHER FUNCTIONS 909=head2 GENERIC WATCHER FUNCTIONS
865 910
881(or never started) and there are no pending events outstanding. 926(or never started) and there are no pending events outstanding.
882 927
883The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher, 928The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher,
884int revents)>. 929int revents)>.
885 930
931Example: Initialise an C<ev_io> watcher in two steps.
932
933 ev_io w;
934 ev_init (&w, my_cb);
935 ev_io_set (&w, STDIN_FILENO, EV_READ);
936
886=item C<ev_TYPE_set> (ev_TYPE *, [args]) 937=item C<ev_TYPE_set> (ev_TYPE *, [args])
887 938
888This macro initialises the type-specific parts of a watcher. You need to 939This macro initialises the type-specific parts of a watcher. You need to
889call C<ev_init> at least once before you call this macro, but you can 940call C<ev_init> at least once before you call this macro, but you can
890call C<ev_TYPE_set> any number of times. You must not, however, call this 941call C<ev_TYPE_set> any number of times. You must not, however, call this
892difference to the C<ev_init> macro). 943difference to the C<ev_init> macro).
893 944
894Although some watcher types do not have type-specific arguments 945Although some watcher types do not have type-specific arguments
895(e.g. C<ev_prepare>) you still need to call its C<set> macro. 946(e.g. C<ev_prepare>) you still need to call its C<set> macro.
896 947
948See C<ev_init>, above, for an example.
949
897=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args]) 950=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
898 951
899This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro 952This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
900calls into a single call. This is the most convenient method to initialise 953calls into a single call. This is the most convenient method to initialise
901a watcher. The same limitations apply, of course. 954a watcher. The same limitations apply, of course.
902 955
956Example: Initialise and set an C<ev_io> watcher in one step.
957
958 ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
959
903=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) 960=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
904 961
905Starts (activates) the given watcher. Only active watchers will receive 962Starts (activates) the given watcher. Only active watchers will receive
906events. If the watcher is already active nothing will happen. 963events. If the watcher is already active nothing will happen.
964
965Example: Start the C<ev_io> watcher that is being abused as example in this
966whole section.
967
968 ev_io_start (EV_DEFAULT_UC, &w);
907 969
908=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) 970=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)
909 971
910Stops the given watcher again (if active) and clears the pending 972Stops the given watcher again (if active) and clears the pending
911status. It is possible that stopped watchers are pending (for example, 973status. It is possible that stopped watchers are pending (for example,
968 1030
969=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1031=item ev_invoke (loop, ev_TYPE *watcher, int revents)
970 1032
971Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1033Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
972C<loop> nor C<revents> need to be valid as long as the watcher callback 1034C<loop> nor C<revents> need to be valid as long as the watcher callback
973can deal with that fact. 1035can deal with that fact, as both are simply passed through to the
1036callback.
974 1037
975=item int ev_clear_pending (loop, ev_TYPE *watcher) 1038=item int ev_clear_pending (loop, ev_TYPE *watcher)
976 1039
977If the watcher is pending, this function returns clears its pending status 1040If the watcher is pending, this function clears its pending status and
978and returns its C<revents> bitset (as if its callback was invoked). If the 1041returns its C<revents> bitset (as if its callback was invoked). If the
979watcher isn't pending it does nothing and returns C<0>. 1042watcher isn't pending it does nothing and returns C<0>.
980 1043
1044Sometimes it can be useful to "poll" a watcher instead of waiting for its
1045callback to be invoked, which can be accomplished with this function.
1046
981=back 1047=back
982 1048
983 1049
984=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER 1050=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
985 1051
986Each watcher has, by default, a member C<void *data> that you can change 1052Each watcher has, by default, a member C<void *data> that you can change
987and read at any time, libev will completely ignore it. This can be used 1053and read at any time: libev will completely ignore it. This can be used
988to associate arbitrary data with your watcher. If you need more data and 1054to associate arbitrary data with your watcher. If you need more data and
989don't want to allocate memory and store a pointer to it in that data 1055don't want to allocate memory and store a pointer to it in that data
990member, you can also "subclass" the watcher type and provide your own 1056member, you can also "subclass" the watcher type and provide your own
991data: 1057data:
992 1058
994 { 1060 {
995 struct ev_io io; 1061 struct ev_io io;
996 int otherfd; 1062 int otherfd;
997 void *somedata; 1063 void *somedata;
998 struct whatever *mostinteresting; 1064 struct whatever *mostinteresting;
999 } 1065 };
1066
1067 ...
1068 struct my_io w;
1069 ev_io_init (&w.io, my_cb, fd, EV_READ);
1000 1070
1001And since your callback will be called with a pointer to the watcher, you 1071And since your callback will be called with a pointer to the watcher, you
1002can cast it back to your own type: 1072can cast it back to your own type:
1003 1073
1004 static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents) 1074 static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)
1008 } 1078 }
1009 1079
1010More interesting and less C-conformant ways of casting your callback type 1080More interesting and less C-conformant ways of casting your callback type
1011instead have been omitted. 1081instead have been omitted.
1012 1082
1013Another common scenario is having some data structure with multiple 1083Another common scenario is to use some data structure with multiple
1014watchers: 1084embedded watchers:
1015 1085
1016 struct my_biggy 1086 struct my_biggy
1017 { 1087 {
1018 int some_data; 1088 int some_data;
1019 ev_timer t1; 1089 ev_timer t1;
1020 ev_timer t2; 1090 ev_timer t2;
1021 } 1091 }
1022 1092
1023In this case getting the pointer to C<my_biggy> is a bit more complicated, 1093In this case getting the pointer to C<my_biggy> is a bit more
1024you need to use C<offsetof>: 1094complicated: Either you store the address of your C<my_biggy> struct
1095in the C<data> member of the watcher (for woozies), or you need to use
1096some pointer arithmetic using C<offsetof> inside your watchers (for real
1097programmers):
1025 1098
1026 #include <stddef.h> 1099 #include <stddef.h>
1027 1100
1028 static void 1101 static void
1029 t1_cb (EV_P_ struct ev_timer *w, int revents) 1102 t1_cb (EV_P_ struct ev_timer *w, int revents)
1069In general you can register as many read and/or write event watchers per 1142In general you can register as many read and/or write event watchers per
1070fd as you want (as long as you don't confuse yourself). Setting all file 1143fd as you want (as long as you don't confuse yourself). Setting all file
1071descriptors to non-blocking mode is also usually a good idea (but not 1144descriptors to non-blocking mode is also usually a good idea (but not
1072required if you know what you are doing). 1145required if you know what you are doing).
1073 1146
1074If you must do this, then force the use of a known-to-be-good backend 1147If you cannot use non-blocking mode, then force the use of a
1075(at the time of this writing, this includes only C<EVBACKEND_SELECT> and 1148known-to-be-good backend (at the time of this writing, this includes only
1076C<EVBACKEND_POLL>). 1149C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>).
1077 1150
1078Another thing you have to watch out for is that it is quite easy to 1151Another thing you have to watch out for is that it is quite easy to
1079receive "spurious" readiness notifications, that is your callback might 1152receive "spurious" readiness notifications, that is your callback might
1080be called with C<EV_READ> but a subsequent C<read>(2) will actually block 1153be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1081because there is no data. Not only are some backends known to create a 1154because there is no data. Not only are some backends known to create a
1082lot of those (for example Solaris ports), it is very easy to get into 1155lot of those (for example Solaris ports), it is very easy to get into
1083this situation even with a relatively standard program structure. Thus 1156this situation even with a relatively standard program structure. Thus
1084it is best to always use non-blocking I/O: An extra C<read>(2) returning 1157it is best to always use non-blocking I/O: An extra C<read>(2) returning
1085C<EAGAIN> is far preferable to a program hanging until some data arrives. 1158C<EAGAIN> is far preferable to a program hanging until some data arrives.
1086 1159
1087If you cannot run the fd in non-blocking mode (for example you should not 1160If you cannot run the fd in non-blocking mode (for example you should
1088play around with an Xlib connection), then you have to separately re-test 1161not play around with an Xlib connection), then you have to separately
1089whether a file descriptor is really ready with a known-to-be good interface 1162re-test whether a file descriptor is really ready with a known-to-be good
1090such as poll (fortunately in our Xlib example, Xlib already does this on 1163interface such as poll (fortunately in our Xlib example, Xlib already
1091its own, so its quite safe to use). 1164does this on its own, so its quite safe to use). Some people additionally
1165use C<SIGALRM> and an interval timer, just to be sure you won't block
1166indefinitely.
1167
1168But really, best use non-blocking mode.
1092 1169
1093=head3 The special problem of disappearing file descriptors 1170=head3 The special problem of disappearing file descriptors
1094 1171
1095Some backends (e.g. kqueue, epoll) need to be told about closing a file 1172Some backends (e.g. kqueue, epoll) need to be told about closing a file
1096descriptor (either by calling C<close> explicitly or by any other means, 1173descriptor (either due to calling C<close> explicitly or any other means,
1097such as C<dup>). The reason is that you register interest in some file 1174such as C<dup2>). The reason is that you register interest in some file
1098descriptor, but when it goes away, the operating system will silently drop 1175descriptor, but when it goes away, the operating system will silently drop
1099this interest. If another file descriptor with the same number then is 1176this interest. If another file descriptor with the same number then is
1100registered with libev, there is no efficient way to see that this is, in 1177registered with libev, there is no efficient way to see that this is, in
1101fact, a different file descriptor. 1178fact, a different file descriptor.
1102 1179
1133enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or 1210enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1134C<EVBACKEND_POLL>. 1211C<EVBACKEND_POLL>.
1135 1212
1136=head3 The special problem of SIGPIPE 1213=head3 The special problem of SIGPIPE
1137 1214
1138While not really specific to libev, it is easy to forget about SIGPIPE: 1215While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1139when reading from a pipe whose other end has been closed, your program 1216when writing to a pipe whose other end has been closed, your program gets
1140gets send a SIGPIPE, which, by default, aborts your program. For most 1217sent a SIGPIPE, which, by default, aborts your program. For most programs
1141programs this is sensible behaviour, for daemons, this is usually 1218this is sensible behaviour, for daemons, this is usually undesirable.
1142undesirable.
1143 1219
1144So when you encounter spurious, unexplained daemon exits, make sure you 1220So when you encounter spurious, unexplained daemon exits, make sure you
1145ignore SIGPIPE (and maybe make sure you log the exit status of your daemon 1221ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1146somewhere, as that would have given you a big clue). 1222somewhere, as that would have given you a big clue).
1147 1223
1153=item ev_io_init (ev_io *, callback, int fd, int events) 1229=item ev_io_init (ev_io *, callback, int fd, int events)
1154 1230
1155=item ev_io_set (ev_io *, int fd, int events) 1231=item ev_io_set (ev_io *, int fd, int events)
1156 1232
1157Configures an C<ev_io> watcher. The C<fd> is the file descriptor to 1233Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1158receive events for and events is either C<EV_READ>, C<EV_WRITE> or 1234receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or
1159C<EV_READ | EV_WRITE> to receive the given events. 1235C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1160 1236
1161=item int fd [read-only] 1237=item int fd [read-only]
1162 1238
1163The file descriptor being watched. 1239The file descriptor being watched.
1164 1240
1176 1252
1177 static void 1253 static void
1178 stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1254 stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1179 { 1255 {
1180 ev_io_stop (loop, w); 1256 ev_io_stop (loop, w);
1181 .. read from stdin here (or from w->fd) and haqndle any I/O errors 1257 .. read from stdin here (or from w->fd) and handle any I/O errors
1182 } 1258 }
1183 1259
1184 ... 1260 ...
1185 struct ev_loop *loop = ev_default_init (0); 1261 struct ev_loop *loop = ev_default_init (0);
1186 struct ev_io stdin_readable; 1262 struct ev_io stdin_readable;
1194Timer watchers are simple relative timers that generate an event after a 1270Timer watchers are simple relative timers that generate an event after a
1195given time, and optionally repeating in regular intervals after that. 1271given time, and optionally repeating in regular intervals after that.
1196 1272
1197The timers are based on real time, that is, if you register an event that 1273The timers are based on real time, that is, if you register an event that
1198times out after an hour and you reset your system clock to January last 1274times out after an hour and you reset your system clock to January last
1199year, it will still time out after (roughly) and hour. "Roughly" because 1275year, it will still time out after (roughly) one hour. "Roughly" because
1200detecting time jumps is hard, and some inaccuracies are unavoidable (the 1276detecting time jumps is hard, and some inaccuracies are unavoidable (the
1201monotonic clock option helps a lot here). 1277monotonic clock option helps a lot here).
1278
1279The callback is guaranteed to be invoked only I<after> its timeout has
1280passed, but if multiple timers become ready during the same loop iteration
1281then order of execution is undefined.
1282
1283=head3 The special problem of time updates
1284
1285Establishing the current time is a costly operation (it usually takes at
1286least two system calls): EV therefore updates its idea of the current
1287time only before and after C<ev_loop> collects new events, which causes a
1288growing difference between C<ev_now ()> and C<ev_time ()> when handling
1289lots of events in one iteration.
1202 1290
1203The relative timeouts are calculated relative to the C<ev_now ()> 1291The relative timeouts are calculated relative to the C<ev_now ()>
1204time. This is usually the right thing as this timestamp refers to the time 1292time. This is usually the right thing as this timestamp refers to the time
1205of the event triggering whatever timeout you are modifying/starting. If 1293of the event triggering whatever timeout you are modifying/starting. If
1206you suspect event processing to be delayed and you I<need> to base the timeout 1294you suspect event processing to be delayed and you I<need> to base the
1207on the current time, use something like this to adjust for this: 1295timeout on the current time, use something like this to adjust for this:
1208 1296
1209 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 1297 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1210 1298
1211The callback is guaranteed to be invoked only after its timeout has passed, 1299If the event loop is suspended for a long time, you can also force an
1212but if multiple timers become ready during the same loop iteration then 1300update of the time returned by C<ev_now ()> by calling C<ev_now_update
1213order of execution is undefined. 1301()>.
1214 1302
1215=head3 Watcher-Specific Functions and Data Members 1303=head3 Watcher-Specific Functions and Data Members
1216 1304
1217=over 4 1305=over 4
1218 1306
1267 ev_timer_again (loop, timer); 1355 ev_timer_again (loop, timer);
1268 1356
1269This is more slightly efficient then stopping/starting the timer each time 1357This is more slightly efficient then stopping/starting the timer each time
1270you want to modify its timeout value. 1358you want to modify its timeout value.
1271 1359
1360Note, however, that it is often even more efficient to remember the
1361time of the last activity and let the timer time-out naturally. In the
1362callback, you then check whether the time-out is real, or, if there was
1363some activity, you reschedule the watcher to time-out in "last_activity +
1364timeout - ev_now ()" seconds.
1365
1272=item ev_tstamp repeat [read-write] 1366=item ev_tstamp repeat [read-write]
1273 1367
1274The current C<repeat> value. Will be used each time the watcher times out 1368The current C<repeat> value. Will be used each time the watcher times out
1275or C<ev_timer_again> is called and determines the next timeout (if any), 1369or C<ev_timer_again> is called, and determines the next timeout (if any),
1276which is also when any modifications are taken into account. 1370which is also when any modifications are taken into account.
1277 1371
1278=back 1372=back
1279 1373
1280=head3 Examples 1374=head3 Examples
1324to trigger the event (unlike an C<ev_timer>, which would still trigger 1418to trigger the event (unlike an C<ev_timer>, which would still trigger
1325roughly 10 seconds later as it uses a relative timeout). 1419roughly 10 seconds later as it uses a relative timeout).
1326 1420
1327C<ev_periodic>s can also be used to implement vastly more complex timers, 1421C<ev_periodic>s can also be used to implement vastly more complex timers,
1328such as triggering an event on each "midnight, local time", or other 1422such as triggering an event on each "midnight, local time", or other
1329complicated, rules. 1423complicated rules.
1330 1424
1331As with timers, the callback is guaranteed to be invoked only when the 1425As with timers, the callback is guaranteed to be invoked only when the
1332time (C<at>) has passed, but if multiple periodic timers become ready 1426time (C<at>) has passed, but if multiple periodic timers become ready
1333during the same loop iteration then order of execution is undefined. 1427during the same loop iteration, then order of execution is undefined.
1334 1428
1335=head3 Watcher-Specific Functions and Data Members 1429=head3 Watcher-Specific Functions and Data Members
1336 1430
1337=over 4 1431=over 4
1338 1432
1339=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) 1433=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
1340 1434
1341=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) 1435=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
1342 1436
1343Lots of arguments, lets sort it out... There are basically three modes of 1437Lots of arguments, lets sort it out... There are basically three modes of
1344operation, and we will explain them from simplest to complex: 1438operation, and we will explain them from simplest to most complex:
1345 1439
1346=over 4 1440=over 4
1347 1441
1348=item * absolute timer (at = time, interval = reschedule_cb = 0) 1442=item * absolute timer (at = time, interval = reschedule_cb = 0)
1349 1443
1350In this configuration the watcher triggers an event after the wall clock 1444In this configuration the watcher triggers an event after the wall clock
1351time C<at> has passed and doesn't repeat. It will not adjust when a time 1445time C<at> has passed. It will not repeat and will not adjust when a time
1352jump occurs, that is, if it is to be run at January 1st 2011 then it will 1446jump occurs, that is, if it is to be run at January 1st 2011 then it will
1353run when the system time reaches or surpasses this time. 1447only run when the system clock reaches or surpasses this time.
1354 1448
1355=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1449=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1356 1450
1357In this mode the watcher will always be scheduled to time out at the next 1451In this mode the watcher will always be scheduled to time out at the next
1358C<at + N * interval> time (for some integer N, which can also be negative) 1452C<at + N * interval> time (for some integer N, which can also be negative)
1359and then repeat, regardless of any time jumps. 1453and then repeat, regardless of any time jumps.
1360 1454
1361This can be used to create timers that do not drift with respect to system 1455This can be used to create timers that do not drift with respect to the
1362time, for example, here is a C<ev_periodic> that triggers each hour, on 1456system clock, for example, here is a C<ev_periodic> that triggers each
1363the hour: 1457hour, on the hour:
1364 1458
1365 ev_periodic_set (&periodic, 0., 3600., 0); 1459 ev_periodic_set (&periodic, 0., 3600., 0);
1366 1460
1367This doesn't mean there will always be 3600 seconds in between triggers, 1461This doesn't mean there will always be 3600 seconds in between triggers,
1368but only that the callback will be called when the system time shows a 1462but only that the callback will be called when the system time shows a
1455=back 1549=back
1456 1550
1457=head3 Examples 1551=head3 Examples
1458 1552
1459Example: Call a callback every hour, or, more precisely, whenever the 1553Example: Call a callback every hour, or, more precisely, whenever the
1460system clock is divisible by 3600. The callback invocation times have 1554system time is divisible by 3600. The callback invocation times have
1461potentially a lot of jitter, but good long-term stability. 1555potentially a lot of jitter, but good long-term stability.
1462 1556
1463 static void 1557 static void
1464 clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1558 clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1465 { 1559 {
1475 #include <math.h> 1569 #include <math.h>
1476 1570
1477 static ev_tstamp 1571 static ev_tstamp
1478 my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 1572 my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
1479 { 1573 {
1480 return fmod (now, 3600.) + 3600.; 1574 return now + (3600. - fmod (now, 3600.));
1481 } 1575 }
1482 1576
1483 ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1577 ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1484 1578
1485Example: Call a callback every hour, starting now: 1579Example: Call a callback every hour, starting now:
1495Signal watchers will trigger an event when the process receives a specific 1589Signal watchers will trigger an event when the process receives a specific
1496signal one or more times. Even though signals are very asynchronous, libev 1590signal one or more times. Even though signals are very asynchronous, libev
1497will try it's best to deliver signals synchronously, i.e. as part of the 1591will try it's best to deliver signals synchronously, i.e. as part of the
1498normal event processing, like any other event. 1592normal event processing, like any other event.
1499 1593
1594If you want signals asynchronously, just use C<sigaction> as you would
1595do without libev and forget about sharing the signal. You can even use
1596C<ev_async> from a signal handler to synchronously wake up an event loop.
1597
1500You can configure as many watchers as you like per signal. Only when the 1598You can configure as many watchers as you like per signal. Only when the
1501first watcher gets started will libev actually register a signal watcher 1599first watcher gets started will libev actually register a signal handler
1502with the kernel (thus it coexists with your own signal handlers as long 1600with the kernel (thus it coexists with your own signal handlers as long as
1503as you don't register any with libev). Similarly, when the last signal 1601you don't register any with libev for the same signal). Similarly, when
1504watcher for a signal is stopped libev will reset the signal handler to 1602the last signal watcher for a signal is stopped, libev will reset the
1505SIG_DFL (regardless of what it was set to before). 1603signal handler to SIG_DFL (regardless of what it was set to before).
1506 1604
1507If possible and supported, libev will install its handlers with 1605If possible and supported, libev will install its handlers with
1508C<SA_RESTART> behaviour enabled, so system calls should not be unduly 1606C<SA_RESTART> behaviour enabled, so system calls should not be unduly
1509interrupted. If you have a problem with system calls getting interrupted by 1607interrupted. If you have a problem with system calls getting interrupted by
1510signals you can block all signals in an C<ev_check> watcher and unblock 1608signals you can block all signals in an C<ev_check> watcher and unblock
1543 1641
1544 1642
1545=head2 C<ev_child> - watch out for process status changes 1643=head2 C<ev_child> - watch out for process status changes
1546 1644
1547Child watchers trigger when your process receives a SIGCHLD in response to 1645Child watchers trigger when your process receives a SIGCHLD in response to
1548some child status changes (most typically when a child of yours dies). It 1646some child status changes (most typically when a child of yours dies or
1549is permissible to install a child watcher I<after> the child has been 1647exits). It is permissible to install a child watcher I<after> the child
1550forked (which implies it might have already exited), as long as the event 1648has been forked (which implies it might have already exited), as long
1551loop isn't entered (or is continued from a watcher). 1649as the event loop isn't entered (or is continued from a watcher), i.e.,
1650forking and then immediately registering a watcher for the child is fine,
1651but forking and registering a watcher a few event loop iterations later is
1652not.
1552 1653
1553Only the default event loop is capable of handling signals, and therefore 1654Only the default event loop is capable of handling signals, and therefore
1554you can only register child watchers in the default event loop. 1655you can only register child watchers in the default event loop.
1555 1656
1556=head3 Process Interaction 1657=head3 Process Interaction
1654the stat buffer having unspecified contents. 1755the stat buffer having unspecified contents.
1655 1756
1656The path I<should> be absolute and I<must not> end in a slash. If it is 1757The path I<should> be absolute and I<must not> end in a slash. If it is
1657relative and your working directory changes, the behaviour is undefined. 1758relative and your working directory changes, the behaviour is undefined.
1658 1759
1659Since there is no standard to do this, the portable implementation simply 1760Since there is no standard kernel interface to do this, the portable
1660calls C<stat (2)> regularly on the path to see if it changed somehow. You 1761implementation simply calls C<stat (2)> regularly on the path to see if
1661can specify a recommended polling interval for this case. If you specify 1762it changed somehow. You can specify a recommended polling interval for
1662a polling interval of C<0> (highly recommended!) then a I<suitable, 1763this case. If you specify a polling interval of C<0> (highly recommended!)
1663unspecified default> value will be used (which you can expect to be around 1764then a I<suitable, unspecified default> value will be used (which
1664five seconds, although this might change dynamically). Libev will also 1765you can expect to be around five seconds, although this might change
1665impose a minimum interval which is currently around C<0.1>, but thats 1766dynamically). Libev will also impose a minimum interval which is currently
1666usually overkill. 1767around C<0.1>, but thats usually overkill.
1667 1768
1668This watcher type is not meant for massive numbers of stat watchers, 1769This watcher type is not meant for massive numbers of stat watchers,
1669as even with OS-supported change notifications, this can be 1770as even with OS-supported change notifications, this can be
1670resource-intensive. 1771resource-intensive.
1671 1772
1672At the time of this writing, only the Linux inotify interface is 1773At the time of this writing, the only OS-specific interface implemented
1673implemented (implementing kqueue support is left as an exercise for the 1774is the Linux inotify interface (implementing kqueue support is left as
1674reader, note, however, that the author sees no way of implementing ev_stat 1775an exercise for the reader. Note, however, that the author sees no way
1675semantics with kqueue). Inotify will be used to give hints only and should 1776of implementing C<ev_stat> semantics with kqueue).
1676not change the semantics of C<ev_stat> watchers, which means that libev
1677sometimes needs to fall back to regular polling again even with inotify,
1678but changes are usually detected immediately, and if the file exists there
1679will be no polling.
1680 1777
1681=head3 ABI Issues (Largefile Support) 1778=head3 ABI Issues (Largefile Support)
1682 1779
1683Libev by default (unless the user overrides this) uses the default 1780Libev by default (unless the user overrides this) uses the default
1684compilation environment, which means that on systems with large file 1781compilation environment, which means that on systems with large file
1693file interfaces available by default (as e.g. FreeBSD does) and not 1790file interfaces available by default (as e.g. FreeBSD does) and not
1694optional. Libev cannot simply switch on large file support because it has 1791optional. Libev cannot simply switch on large file support because it has
1695to exchange stat structures with application programs compiled using the 1792to exchange stat structures with application programs compiled using the
1696default compilation environment. 1793default compilation environment.
1697 1794
1698=head3 Inotify 1795=head3 Inotify and Kqueue
1699 1796
1700When C<inotify (7)> support has been compiled into libev (generally only 1797When C<inotify (7)> support has been compiled into libev (generally only
1701available on Linux) and present at runtime, it will be used to speed up 1798available with Linux) and present at runtime, it will be used to speed up
1702change detection where possible. The inotify descriptor will be created lazily 1799change detection where possible. The inotify descriptor will be created lazily
1703when the first C<ev_stat> watcher is being started. 1800when the first C<ev_stat> watcher is being started.
1704 1801
1705Inotify presence does not change the semantics of C<ev_stat> watchers 1802Inotify presence does not change the semantics of C<ev_stat> watchers
1706except that changes might be detected earlier, and in some cases, to avoid 1803except that changes might be detected earlier, and in some cases, to avoid
1707making regular C<stat> calls. Even in the presence of inotify support 1804making regular C<stat> calls. Even in the presence of inotify support
1708there are many cases where libev has to resort to regular C<stat> polling. 1805there are many cases where libev has to resort to regular C<stat> polling,
1806but as long as the path exists, libev usually gets away without polling.
1709 1807
1710(There is no support for kqueue, as apparently it cannot be used to 1808There is no support for kqueue, as apparently it cannot be used to
1711implement this functionality, due to the requirement of having a file 1809implement this functionality, due to the requirement of having a file
1712descriptor open on the object at all times). 1810descriptor open on the object at all times, and detecting renames, unlinks
1811etc. is difficult.
1713 1812
1714=head3 The special problem of stat time resolution 1813=head3 The special problem of stat time resolution
1715 1814
1716The C<stat ()> system call only supports full-second resolution portably, and 1815The C<stat ()> system call only supports full-second resolution portably, and
1717even on systems where the resolution is higher, many file systems still 1816even on systems where the resolution is higher, most file systems still
1718only support whole seconds. 1817only support whole seconds.
1719 1818
1720That means that, if the time is the only thing that changes, you can 1819That means that, if the time is the only thing that changes, you can
1721easily miss updates: on the first update, C<ev_stat> detects a change and 1820easily miss updates: on the first update, C<ev_stat> detects a change and
1722calls your callback, which does something. When there is another update 1821calls your callback, which does something. When there is another update
1723within the same second, C<ev_stat> will be unable to detect it as the stat 1822within the same second, C<ev_stat> will be unable to detect unless the
1724data does not change. 1823stat data does change in other ways (e.g. file size).
1725 1824
1726The solution to this is to delay acting on a change for slightly more 1825The solution to this is to delay acting on a change for slightly more
1727than a second (or till slightly after the next full second boundary), using 1826than a second (or till slightly after the next full second boundary), using
1728a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02); 1827a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1729ev_timer_again (loop, w)>). 1828ev_timer_again (loop, w)>).
1749C<path>. The C<interval> is a hint on how quickly a change is expected to 1848C<path>. The C<interval> is a hint on how quickly a change is expected to
1750be detected and should normally be specified as C<0> to let libev choose 1849be detected and should normally be specified as C<0> to let libev choose
1751a suitable value. The memory pointed to by C<path> must point to the same 1850a suitable value. The memory pointed to by C<path> must point to the same
1752path for as long as the watcher is active. 1851path for as long as the watcher is active.
1753 1852
1754The callback will receive C<EV_STAT> when a change was detected, relative 1853The callback will receive an C<EV_STAT> event when a change was detected,
1755to the attributes at the time the watcher was started (or the last change 1854relative to the attributes at the time the watcher was started (or the
1756was detected). 1855last change was detected).
1757 1856
1758=item ev_stat_stat (loop, ev_stat *) 1857=item ev_stat_stat (loop, ev_stat *)
1759 1858
1760Updates the stat buffer immediately with new values. If you change the 1859Updates the stat buffer immediately with new values. If you change the
1761watched path in your callback, you could call this function to avoid 1860watched path in your callback, you could call this function to avoid
1844 1943
1845 1944
1846=head2 C<ev_idle> - when you've got nothing better to do... 1945=head2 C<ev_idle> - when you've got nothing better to do...
1847 1946
1848Idle watchers trigger events when no other events of the same or higher 1947Idle watchers trigger events when no other events of the same or higher
1849priority are pending (prepare, check and other idle watchers do not 1948priority are pending (prepare, check and other idle watchers do not count
1850count). 1949as receiving "events").
1851 1950
1852That is, as long as your process is busy handling sockets or timeouts 1951That is, as long as your process is busy handling sockets or timeouts
1853(or even signals, imagine) of the same or higher priority it will not be 1952(or even signals, imagine) of the same or higher priority it will not be
1854triggered. But when your process is idle (or only lower-priority watchers 1953triggered. But when your process is idle (or only lower-priority watchers
1855are pending), the idle watchers are being called once per event loop 1954are pending), the idle watchers are being called once per event loop
1894 ev_idle_start (loop, idle_cb); 1993 ev_idle_start (loop, idle_cb);
1895 1994
1896 1995
1897=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 1996=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1898 1997
1899Prepare and check watchers are usually (but not always) used in tandem: 1998Prepare and check watchers are usually (but not always) used in pairs:
1900prepare watchers get invoked before the process blocks and check watchers 1999prepare watchers get invoked before the process blocks and check watchers
1901afterwards. 2000afterwards.
1902 2001
1903You I<must not> call C<ev_loop> or similar functions that enter 2002You I<must not> call C<ev_loop> or similar functions that enter
1904the current event loop from either C<ev_prepare> or C<ev_check> 2003the current event loop from either C<ev_prepare> or C<ev_check>
1907those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, 2006those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
1908C<ev_check> so if you have one watcher of each kind they will always be 2007C<ev_check> so if you have one watcher of each kind they will always be
1909called in pairs bracketing the blocking call. 2008called in pairs bracketing the blocking call.
1910 2009
1911Their main purpose is to integrate other event mechanisms into libev and 2010Their main purpose is to integrate other event mechanisms into libev and
1912their use is somewhat advanced. This could be used, for example, to track 2011their use is somewhat advanced. They could be used, for example, to track
1913variable changes, implement your own watchers, integrate net-snmp or a 2012variable changes, implement your own watchers, integrate net-snmp or a
1914coroutine library and lots more. They are also occasionally useful if 2013coroutine library and lots more. They are also occasionally useful if
1915you cache some data and want to flush it before blocking (for example, 2014you cache some data and want to flush it before blocking (for example,
1916in X programs you might want to do an C<XFlush ()> in an C<ev_prepare> 2015in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
1917watcher). 2016watcher).
1918 2017
1919This is done by examining in each prepare call which file descriptors need 2018This is done by examining in each prepare call which file descriptors
1920to be watched by the other library, registering C<ev_io> watchers for 2019need to be watched by the other library, registering C<ev_io> watchers
1921them and starting an C<ev_timer> watcher for any timeouts (many libraries 2020for them and starting an C<ev_timer> watcher for any timeouts (many
1922provide just this functionality). Then, in the check watcher you check for 2021libraries provide exactly this functionality). Then, in the check watcher,
1923any events that occurred (by checking the pending status of all watchers 2022you check for any events that occurred (by checking the pending status
1924and stopping them) and call back into the library. The I/O and timer 2023of all watchers and stopping them) and call back into the library. The
1925callbacks will never actually be called (but must be valid nevertheless, 2024I/O and timer callbacks will never actually be called (but must be valid
1926because you never know, you know?). 2025nevertheless, because you never know, you know?).
1927 2026
1928As another example, the Perl Coro module uses these hooks to integrate 2027As another example, the Perl Coro module uses these hooks to integrate
1929coroutines into libev programs, by yielding to other active coroutines 2028coroutines into libev programs, by yielding to other active coroutines
1930during each prepare and only letting the process block if no coroutines 2029during each prepare and only letting the process block if no coroutines
1931are ready to run (it's actually more complicated: it only runs coroutines 2030are ready to run (it's actually more complicated: it only runs coroutines
1934loop from blocking if lower-priority coroutines are active, thus mapping 2033loop from blocking if lower-priority coroutines are active, thus mapping
1935low-priority coroutines to idle/background tasks). 2034low-priority coroutines to idle/background tasks).
1936 2035
1937It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 2036It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1938priority, to ensure that they are being run before any other watchers 2037priority, to ensure that they are being run before any other watchers
2038after the poll (this doesn't matter for C<ev_prepare> watchers).
2039
1939after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, 2040Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
1940too) should not activate ("feed") events into libev. While libev fully 2041activate ("feed") events into libev. While libev fully supports this, they
1941supports this, they might get executed before other C<ev_check> watchers 2042might get executed before other C<ev_check> watchers did their job. As
1942did their job. As C<ev_check> watchers are often used to embed other 2043C<ev_check> watchers are often used to embed other (non-libev) event
1943(non-libev) event loops those other event loops might be in an unusable 2044loops those other event loops might be in an unusable state until their
1944state until their C<ev_check> watcher ran (always remind yourself to 2045C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1945coexist peacefully with others). 2046others).
1946 2047
1947=head3 Watcher-Specific Functions and Data Members 2048=head3 Watcher-Specific Functions and Data Members
1948 2049
1949=over 4 2050=over 4
1950 2051
1952 2053
1953=item ev_check_init (ev_check *, callback) 2054=item ev_check_init (ev_check *, callback)
1954 2055
1955Initialises and configures the prepare or check watcher - they have no 2056Initialises and configures the prepare or check watcher - they have no
1956parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 2057parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1957macros, but using them is utterly, utterly and completely pointless. 2058macros, but using them is utterly, utterly, utterly and completely
2059pointless.
1958 2060
1959=back 2061=back
1960 2062
1961=head3 Examples 2063=head3 Examples
1962 2064
2055 } 2157 }
2056 2158
2057 // do not ever call adns_afterpoll 2159 // do not ever call adns_afterpoll
2058 2160
2059Method 4: Do not use a prepare or check watcher because the module you 2161Method 4: Do not use a prepare or check watcher because the module you
2060want to embed is too inflexible to support it. Instead, you can override 2162want to embed is not flexible enough to support it. Instead, you can
2061their poll function. The drawback with this solution is that the main 2163override their poll function. The drawback with this solution is that the
2062loop is now no longer controllable by EV. The C<Glib::EV> module does 2164main loop is now no longer controllable by EV. The C<Glib::EV> module uses
2063this. 2165this approach, effectively embedding EV as a client into the horrible
2166libglib event loop.
2064 2167
2065 static gint 2168 static gint
2066 event_poll_func (GPollFD *fds, guint nfds, gint timeout) 2169 event_poll_func (GPollFD *fds, guint nfds, gint timeout)
2067 { 2170 {
2068 int got_events = 0; 2171 int got_events = 0;
2099prioritise I/O. 2202prioritise I/O.
2100 2203
2101As an example for a bug workaround, the kqueue backend might only support 2204As an example for a bug workaround, the kqueue backend might only support
2102sockets on some platform, so it is unusable as generic backend, but you 2205sockets on some platform, so it is unusable as generic backend, but you
2103still want to make use of it because you have many sockets and it scales 2206still want to make use of it because you have many sockets and it scales
2104so nicely. In this case, you would create a kqueue-based loop and embed it 2207so nicely. In this case, you would create a kqueue-based loop and embed
2105into your default loop (which might use e.g. poll). Overall operation will 2208it into your default loop (which might use e.g. poll). Overall operation
2106be a bit slower because first libev has to poll and then call kevent, but 2209will be a bit slower because first libev has to call C<poll> and then
2107at least you can use both at what they are best. 2210C<kevent>, but at least you can use both mechanisms for what they are
2211best: C<kqueue> for scalable sockets and C<poll> if you want it to work :)
2108 2212
2109As for prioritising I/O: rarely you have the case where some fds have 2213As for prioritising I/O: under rare circumstances you have the case where
2110to be watched and handled very quickly (with low latency), and even 2214some fds have to be watched and handled very quickly (with low latency),
2111priorities and idle watchers might have too much overhead. In this case 2215and even priorities and idle watchers might have too much overhead. In
2112you would put all the high priority stuff in one loop and all the rest in 2216this case you would put all the high priority stuff in one loop and all
2113a second one, and embed the second one in the first. 2217the rest in a second one, and embed the second one in the first.
2114 2218
2115As long as the watcher is active, the callback will be invoked every time 2219As long as the watcher is active, the callback will be invoked every time
2116there might be events pending in the embedded loop. The callback must then 2220there might be events pending in the embedded loop. The callback must then
2117call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke 2221call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke
2118their callbacks (you could also start an idle watcher to give the embedded 2222their callbacks (you could also start an idle watcher to give the embedded
2126interested in that. 2230interested in that.
2127 2231
2128Also, there have not currently been made special provisions for forking: 2232Also, there have not currently been made special provisions for forking:
2129when you fork, you not only have to call C<ev_loop_fork> on both loops, 2233when you fork, you not only have to call C<ev_loop_fork> on both loops,
2130but you will also have to stop and restart any C<ev_embed> watchers 2234but you will also have to stop and restart any C<ev_embed> watchers
2131yourself. 2235yourself - but you can use a fork watcher to handle this automatically,
2236and future versions of libev might do just that.
2132 2237
2133Unfortunately, not all backends are embeddable, only the ones returned by 2238Unfortunately, not all backends are embeddable: only the ones returned by
2134C<ev_embeddable_backends> are, which, unfortunately, does not include any 2239C<ev_embeddable_backends> are, which, unfortunately, does not include any
2135portable one. 2240portable one.
2136 2241
2137So when you want to use this feature you will always have to be prepared 2242So when you want to use this feature you will always have to be prepared
2138that you cannot get an embeddable loop. The recommended way to get around 2243that you cannot get an embeddable loop. The recommended way to get around
2263is that the author does not know of a simple (or any) algorithm for a 2368is that the author does not know of a simple (or any) algorithm for a
2264multiple-writer-single-reader queue that works in all cases and doesn't 2369multiple-writer-single-reader queue that works in all cases and doesn't
2265need elaborate support such as pthreads. 2370need elaborate support such as pthreads.
2266 2371
2267That means that if you want to queue data, you have to provide your own 2372That means that if you want to queue data, you have to provide your own
2268queue. But at least I can tell you would implement locking around your 2373queue. But at least I can tell you how to implement locking around your
2269queue: 2374queue:
2270 2375
2271=over 4 2376=over 4
2272 2377
2273=item queueing from a signal handler context 2378=item queueing from a signal handler context
2349 2454
2350=item ev_async_init (ev_async *, callback) 2455=item ev_async_init (ev_async *, callback)
2351 2456
2352Initialises and configures the async watcher - it has no parameters of any 2457Initialises and configures the async watcher - it has no parameters of any
2353kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless, 2458kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,
2354believe me. 2459trust me.
2355 2460
2356=item ev_async_send (loop, ev_async *) 2461=item ev_async_send (loop, ev_async *)
2357 2462
2358Sends/signals/activates the given C<ev_async> watcher, that is, feeds 2463Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2359an C<EV_ASYNC> event on the watcher into the event loop. Unlike 2464an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2360C<ev_feed_event>, this call is safe to do in other threads, signal or 2465C<ev_feed_event>, this call is safe to do from other threads, signal or
2361similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding 2466similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2362section below on what exactly this means). 2467section below on what exactly this means).
2363 2468
2364This call incurs the overhead of a system call only once per loop iteration, 2469This call incurs the overhead of a system call only once per loop iteration,
2365so while the overhead might be noticeable, it doesn't apply to repeated 2470so while the overhead might be noticeable, it doesn't apply to repeated
2571 2676
2572The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>. 2677The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
2573 2678
2574See the method-C<set> above for more details. 2679See the method-C<set> above for more details.
2575 2680
2576Example: 2681Example: Use a plain function as callback.
2577 2682
2578 static void io_cb (ev::io &w, int revents) { } 2683 static void io_cb (ev::io &w, int revents) { }
2579 iow.set <io_cb> (); 2684 iow.set <io_cb> ();
2580 2685
2581=item w->set (struct ev_loop *) 2686=item w->set (struct ev_loop *)
2619Example: Define a class with an IO and idle watcher, start one of them in 2724Example: Define a class with an IO and idle watcher, start one of them in
2620the constructor. 2725the constructor.
2621 2726
2622 class myclass 2727 class myclass
2623 { 2728 {
2624 ev::io io; void io_cb (ev::io &w, int revents); 2729 ev::io io ; void io_cb (ev::io &w, int revents);
2625 ev:idle idle void idle_cb (ev::idle &w, int revents); 2730 ev::idle idle; void idle_cb (ev::idle &w, int revents);
2626 2731
2627 myclass (int fd) 2732 myclass (int fd)
2628 { 2733 {
2629 io .set <myclass, &myclass::io_cb > (this); 2734 io .set <myclass, &myclass::io_cb > (this);
2630 idle.set <myclass, &myclass::idle_cb> (this); 2735 idle.set <myclass, &myclass::idle_cb> (this);
2646=item Perl 2751=item Perl
2647 2752
2648The EV module implements the full libev API and is actually used to test 2753The EV module implements the full libev API and is actually used to test
2649libev. EV is developed together with libev. Apart from the EV core module, 2754libev. EV is developed together with libev. Apart from the EV core module,
2650there are additional modules that implement libev-compatible interfaces 2755there are additional modules that implement libev-compatible interfaces
2651to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the 2756to C<libadns> (C<EV::ADNS>, but C<AnyEvent::DNS> is preferred nowadays),
2652C<libglib> event core (C<Glib::EV> and C<EV::Glib>). 2757C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV>
2758and C<EV::Glib>).
2653 2759
2654It can be found and installed via CPAN, its homepage is at 2760It can be found and installed via CPAN, its homepage is at
2655L<http://software.schmorp.de/pkg/EV>. 2761L<http://software.schmorp.de/pkg/EV>.
2656 2762
2657=item Python 2763=item Python
2836 2942
2837=head2 PREPROCESSOR SYMBOLS/MACROS 2943=head2 PREPROCESSOR SYMBOLS/MACROS
2838 2944
2839Libev can be configured via a variety of preprocessor symbols you have to 2945Libev can be configured via a variety of preprocessor symbols you have to
2840define before including any of its files. The default in the absence of 2946define before including any of its files. The default in the absence of
2841autoconf is noted for every option. 2947autoconf is documented for every option.
2842 2948
2843=over 4 2949=over 4
2844 2950
2845=item EV_STANDALONE 2951=item EV_STANDALONE
2846 2952
3016When doing priority-based operations, libev usually has to linearly search 3122When doing priority-based operations, libev usually has to linearly search
3017all the priorities, so having many of them (hundreds) uses a lot of space 3123all the priorities, so having many of them (hundreds) uses a lot of space
3018and time, so using the defaults of five priorities (-2 .. +2) is usually 3124and time, so using the defaults of five priorities (-2 .. +2) is usually
3019fine. 3125fine.
3020 3126
3021If your embedding application does not need any priorities, defining these both to 3127If your embedding application does not need any priorities, defining these
3022C<0> will save some memory and CPU. 3128both to C<0> will save some memory and CPU.
3023 3129
3024=item EV_PERIODIC_ENABLE 3130=item EV_PERIODIC_ENABLE
3025 3131
3026If undefined or defined to be C<1>, then periodic timers are supported. If 3132If undefined or defined to be C<1>, then periodic timers are supported. If
3027defined to be C<0>, then they are not. Disabling them saves a few kB of 3133defined to be C<0>, then they are not. Disabling them saves a few kB of
3034code. 3140code.
3035 3141
3036=item EV_EMBED_ENABLE 3142=item EV_EMBED_ENABLE
3037 3143
3038If undefined or defined to be C<1>, then embed watchers are supported. If 3144If undefined or defined to be C<1>, then embed watchers are supported. If
3039defined to be C<0>, then they are not. 3145defined to be C<0>, then they are not. Embed watchers rely on most other
3146watcher types, which therefore must not be disabled.
3040 3147
3041=item EV_STAT_ENABLE 3148=item EV_STAT_ENABLE
3042 3149
3043If undefined or defined to be C<1>, then stat watchers are supported. If 3150If undefined or defined to be C<1>, then stat watchers are supported. If
3044defined to be C<0>, then they are not. 3151defined to be C<0>, then they are not.
3076two). 3183two).
3077 3184
3078=item EV_USE_4HEAP 3185=item EV_USE_4HEAP
3079 3186
3080Heaps are not very cache-efficient. To improve the cache-efficiency of the 3187Heaps are not very cache-efficient. To improve the cache-efficiency of the
3081timer and periodics heap, libev uses a 4-heap when this symbol is defined 3188timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3082to C<1>. The 4-heap uses more complicated (longer) code but has 3189to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3083noticeably faster performance with many (thousands) of watchers. 3190faster performance with many (thousands) of watchers.
3084 3191
3085The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> 3192The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3086(disabled). 3193(disabled).
3087 3194
3088=item EV_HEAP_CACHE_AT 3195=item EV_HEAP_CACHE_AT
3089 3196
3090Heaps are not very cache-efficient. To improve the cache-efficiency of the 3197Heaps are not very cache-efficient. To improve the cache-efficiency of the
3091timer and periodics heap, libev can cache the timestamp (I<at>) within 3198timer and periodics heaps, libev can cache the timestamp (I<at>) within
3092the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), 3199the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3093which uses 8-12 bytes more per watcher and a few hundred bytes more code, 3200which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3094but avoids random read accesses on heap changes. This improves performance 3201but avoids random read accesses on heap changes. This improves performance
3095noticeably with with many (hundreds) of watchers. 3202noticeably with many (hundreds) of watchers.
3096 3203
3097The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> 3204The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3098(disabled). 3205(disabled).
3099 3206
3100=item EV_VERIFY 3207=item EV_VERIFY
3106called once per loop, which can slow down libev. If set to C<3>, then the 3213called once per loop, which can slow down libev. If set to C<3>, then the
3107verification code will be called very frequently, which will slow down 3214verification code will be called very frequently, which will slow down
3108libev considerably. 3215libev considerably.
3109 3216
3110The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be 3217The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
3111C<0.> 3218C<0>.
3112 3219
3113=item EV_COMMON 3220=item EV_COMMON
3114 3221
3115By default, all watchers have a C<void *data> member. By redefining 3222By default, all watchers have a C<void *data> member. By redefining
3116this macro to a something else you can include more and other types of 3223this macro to a something else you can include more and other types of
3194 3301
3195=head1 THREADS AND COROUTINES 3302=head1 THREADS AND COROUTINES
3196 3303
3197=head2 THREADS 3304=head2 THREADS
3198 3305
3199Libev itself is completely thread-safe, but it uses no locking. This 3306Libev itself is thread-safe (unless the opposite is specifically
3307documented for a function), but it uses no locking itself. This means that
3200means that you can use as many loops as you want in parallel, as long as 3308you can use as many loops as you want in parallel, as long as only one
3201only one thread ever calls into one libev function with the same loop 3309thread ever calls into one libev function with the same loop parameter:
3202parameter. 3310libev guarantees that different event loops share no data structures that
3311need locking.
3203 3312
3204Or put differently: calls with different loop parameters can be done in 3313Or to put it differently: calls with different loop parameters can be done
3205parallel from multiple threads, calls with the same loop parameter must be 3314concurrently from multiple threads, calls with the same loop parameter
3206done serially (but can be done from different threads, as long as only one 3315must be done serially (but can be done from different threads, as long as
3207thread ever is inside a call at any point in time, e.g. by using a mutex 3316only one thread ever is inside a call at any point in time, e.g. by using
3208per loop). 3317a mutex per loop).
3318
3319Specifically to support threads (and signal handlers), libev implements
3320so-called C<ev_async> watchers, which allow some limited form of
3321concurrency on the same event loop.
3209 3322
3210If you want to know which design (one loop, locking, or multiple loops 3323If you want to know which design (one loop, locking, or multiple loops
3211without or something else still) is best for your problem, then I cannot 3324without or something else still) is best for your problem, then I cannot
3212help you. I can give some generic advice however: 3325help you. I can give some generic advice however:
3213 3326
3229 3342
3230Choosing a model is hard - look around, learn, know that usually you can do 3343Choosing a model is hard - look around, learn, know that usually you can do
3231better than you currently do :-) 3344better than you currently do :-)
3232 3345
3233=item * often you need to talk to some other thread which blocks in the 3346=item * often you need to talk to some other thread which blocks in the
3347event loop.
3348
3234event loop - C<ev_async> watchers can be used to wake them up from other 3349C<ev_async> watchers can be used to wake them up from other threads safely
3235threads safely (or from signal contexts...). 3350(or from signal contexts...).
3351
3352An example use would be to communicate signals or other events that only
3353work in the default loop by registering the signal watcher with the
3354default loop and triggering an C<ev_async> watcher from the default loop
3355watcher callback into the event loop interested in the signal.
3236 3356
3237=back 3357=back
3238 3358
3239=head2 COROUTINES 3359=head2 COROUTINES
3240 3360
3243coroutines (e.g. you can call C<ev_loop> on the same loop from two 3363coroutines (e.g. you can call C<ev_loop> on the same loop from two
3244different coroutines and switch freely between both coroutines running the 3364different coroutines and switch freely between both coroutines running the
3245loop, as long as you don't confuse yourself). The only exception is that 3365loop, as long as you don't confuse yourself). The only exception is that
3246you must not do this from C<ev_periodic> reschedule callbacks. 3366you must not do this from C<ev_periodic> reschedule callbacks.
3247 3367
3248Care has been invested into making sure that libev does not keep local 3368Care has been taken to ensure that libev does not keep local state inside
3249state inside C<ev_loop>, and other calls do not usually allow coroutine 3369C<ev_loop>, and other calls do not usually allow coroutine switches.
3250switches.
3251 3370
3252 3371
3253=head1 COMPLEXITIES 3372=head1 COMPLEXITIES
3254 3373
3255In this section the complexities of (many of) the algorithms used inside 3374In this section the complexities of (many of) the algorithms used inside
3303=item Priority handling: O(number_of_priorities) 3422=item Priority handling: O(number_of_priorities)
3304 3423
3305Priorities are implemented by allocating some space for each 3424Priorities are implemented by allocating some space for each
3306priority. When doing priority-based operations, libev usually has to 3425priority. When doing priority-based operations, libev usually has to
3307linearly search all the priorities, but starting/stopping and activating 3426linearly search all the priorities, but starting/stopping and activating
3308watchers becomes O(1) w.r.t. priority handling. 3427watchers becomes O(1) with respect to priority handling.
3309 3428
3310=item Sending an ev_async: O(1) 3429=item Sending an ev_async: O(1)
3311 3430
3312=item Processing ev_async_send: O(number_of_async_watchers) 3431=item Processing ev_async_send: O(number_of_async_watchers)
3313 3432
3339 3458
3340Not a libev limitation but worth mentioning: windows apparently doesn't 3459Not a libev limitation but worth mentioning: windows apparently doesn't
3341accept large writes: instead of resulting in a partial write, windows will 3460accept large writes: instead of resulting in a partial write, windows will
3342either accept everything or return C<ENOBUFS> if the buffer is too large, 3461either accept everything or return C<ENOBUFS> if the buffer is too large,
3343so make sure you only write small amounts into your sockets (less than a 3462so make sure you only write small amounts into your sockets (less than a
3344megabyte seems safe, but thsi apparently depends on the amount of memory 3463megabyte seems safe, but this apparently depends on the amount of memory
3345available). 3464available).
3346 3465
3347Due to the many, low, and arbitrary limits on the win32 platform and 3466Due to the many, low, and arbitrary limits on the win32 platform and
3348the abysmal performance of winsockets, using a large number of sockets 3467the abysmal performance of winsockets, using a large number of sockets
3349is not recommended (and not reasonable). If your program needs to use 3468is not recommended (and not reasonable). If your program needs to use
3360 #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */ 3479 #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
3361 3480
3362 #include "ev.h" 3481 #include "ev.h"
3363 3482
3364And compile the following F<evwrap.c> file into your project (make sure 3483And compile the following F<evwrap.c> file into your project (make sure
3365you do I<not> compile the F<ev.c> or any other embedded soruce files!): 3484you do I<not> compile the F<ev.c> or any other embedded source files!):
3366 3485
3367 #include "evwrap.h" 3486 #include "evwrap.h"
3368 #include "ev.c" 3487 #include "ev.c"
3369 3488
3370=over 4 3489=over 4
3435calls them using an C<ev_watcher *> internally. 3554calls them using an C<ev_watcher *> internally.
3436 3555
3437=item C<sig_atomic_t volatile> must be thread-atomic as well 3556=item C<sig_atomic_t volatile> must be thread-atomic as well
3438 3557
3439The type C<sig_atomic_t volatile> (or whatever is defined as 3558The type C<sig_atomic_t volatile> (or whatever is defined as
3440C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different 3559C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
3441threads. This is not part of the specification for C<sig_atomic_t>, but is 3560threads. This is not part of the specification for C<sig_atomic_t>, but is
3442believed to be sufficiently portable. 3561believed to be sufficiently portable.
3443 3562
3444=item C<sigprocmask> must work in a threaded environment 3563=item C<sigprocmask> must work in a threaded environment
3445 3564

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines