ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/EV/README
(Generate patch)

Comparing EV/README (file contents):
Revision 1.22 by root, Mon Jan 28 12:24:05 2008 UTC vs.
Revision 1.26 by root, Wed May 21 23:40:08 2008 UTC

54 54
55DESCRIPTION 55DESCRIPTION
56 This module provides an interface to libev 56 This module provides an interface to libev
57 (<http://software.schmorp.de/pkg/libev.html>). While the documentation 57 (<http://software.schmorp.de/pkg/libev.html>). While the documentation
58 below is comprehensive, one might also consult the documentation of 58 below is comprehensive, one might also consult the documentation of
59 libev itself (<http://cvs.schmorp.de/libev/ev.html>) for more subtle 59 libev itself (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>)
60 details on watcher semantics or some discussion on the available 60 for more subtle details on watcher semantics or some discussion on the
61 backends, or how to force a specific backend with "LIBEV_FLAGS", or just 61 available backends, or how to force a specific backend with
62 about in any case because it has much more detailed information. 62 "LIBEV_FLAGS", or just about in any case because it has much more
63 detailed information.
64
65 This module is very fast and scalable. It is actually so fast that you
66 can use it through the AnyEvent module, stay portable to other event
67 loops (if you don't rely on any watcher types not available through it)
68 and still be faster than with any other event loop currently supported
69 in Perl.
63 70
64EVENT LOOPS 71EVENT LOOPS
65 EV supports multiple event loops: There is a single "default event loop" 72 EV supports multiple event loops: There is a single "default event loop"
66 that can handle everything including signals and child watchers, and any 73 that can handle everything including signals and child watchers, and any
67 number of "dynamic event loops" that can use different backends (with 74 number of "dynamic event loops" that can use different backends (with
421 This time simply fires at the wallclock time $at and doesn't 428 This time simply fires at the wallclock time $at and doesn't
422 repeat. It will not adjust when a time jump occurs, that is, if 429 repeat. It will not adjust when a time jump occurs, that is, if
423 it is to be run at January 1st 2011 then it will run when the 430 it is to be run at January 1st 2011 then it will run when the
424 system time reaches or surpasses this time. 431 system time reaches or surpasses this time.
425 432
426 * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) 433 * repeating interval timer ($interval > 0, $reschedule_cb = 0)
427 434
428 In this mode the watcher will always be scheduled to time out at 435 In this mode the watcher will always be scheduled to time out at
429 the next "$at + N * $interval" time (for some integer N) and 436 the next "$at + N * $interval" time (for some integer N) and
430 then repeat, regardless of any time jumps. 437 then repeat, regardless of any time jumps.
431 438
449 each time the periodic watcher gets scheduled, the reschedule 456 each time the periodic watcher gets scheduled, the reschedule
450 callback ($reschedule_cb) will be called with the watcher as 457 callback ($reschedule_cb) will be called with the watcher as
451 first, and the current time as second argument. 458 first, and the current time as second argument.
452 459
453 *This callback MUST NOT stop or destroy this or any other 460 *This callback MUST NOT stop or destroy this or any other
461 periodic watcher, ever, and MUST NOT call any event loop
454 periodic watcher, ever*. If you need to stop it, return 1e30 and 462 functions or methods*. If you need to stop it, return 1e30 and
455 stop it afterwards. 463 stop it afterwards. You may create and start a "EV::prepare"
464 watcher for this task.
456 465
457 It must return the next time to trigger, based on the passed 466 It must return the next time to trigger, based on the passed
458 time value (that is, the lowest time value larger than to the 467 time value (that is, the lowest time value larger than or equal
459 second argument). It will usually be called just before the 468 to to the second argument). It will usually be called just
460 callback will be triggered, but might be called at other times, 469 before the callback will be triggered, but might be called at
461 too. 470 other times, too.
462 471
463 This can be used to create very complex timers, such as a timer 472 This can be used to create very complex timers, such as a timer
464 that triggers on each midnight, local time (actually 24 hours 473 that triggers on each midnight, local time (actually 24 hours
465 after the last midnight, to keep the example simple. If you know 474 after the last midnight, to keep the example simple. If you know
466 a way to do it correctly in about the same space (without 475 a way to do it correctly in about the same space (without
776 managed automatically. 785 managed automatically.
777 786
778 The "embed_ns" variant doesn't start (activate) the newly created 787 The "embed_ns" variant doesn't start (activate) the newly created
779 watcher. 788 watcher.
780 789
790 ASYNC WATCHERS - how to wake up another event loop
791 Async watchers are provided by EV, but have little use in perl directly,
792 as perl neither supports threads nor direct access to signal handlers or
793 other contexts where they could be of value.
794
795 It is, however, possible to use them from the XS level.
796
797 Please see the libev documentation for further details.
798
799 $w = EV::async $callback
800 $w = EV::async_ns $callback
801 $w->send
802 $bool = $w->async_pending
803
781PERL SIGNALS 804PERL SIGNALS
782 While Perl signal handling (%SIG) is not affected by EV, the behaviour 805 While Perl signal handling (%SIG) is not affected by EV, the behaviour
783 with EV is as the same as any other C library: Perl-signals will only be 806 with EV is as the same as any other C library: Perl-signals will only be
784 handled when Perl runs, which means your signal handler might be invoked 807 handled when Perl runs, which means your signal handler might be invoked
785 only the next time an event callback is invoked. 808 only the next time an event callback is invoked.
819 course. 842 course.
820 843
821SEE ALSO 844SEE ALSO
822 EV::ADNS (asynchronous DNS), Glib::EV (makes Glib/Gtk2 use EV as event 845 EV::ADNS (asynchronous DNS), Glib::EV (makes Glib/Gtk2 use EV as event
823 loop), EV::Glib (embed Glib into EV), Coro::EV (efficient coroutines 846 loop), EV::Glib (embed Glib into EV), Coro::EV (efficient coroutines
824 with EV), Net::SNMP::EV (asynchronous SNMP). 847 with EV), Net::SNMP::EV (asynchronous SNMP), AnyEvent for event-loop
848 agnostic and portable event driven programming.
825 849
826AUTHOR 850AUTHOR
827 Marc Lehmann <schmorp@schmorp.de> 851 Marc Lehmann <schmorp@schmorp.de>
828 http://home.schmorp.de/ 852 http://home.schmorp.de/
829 853

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines