… | |
… | |
56 | =head1 DESCRIPTION |
56 | =head1 DESCRIPTION |
57 | |
57 | |
58 | This module provides an interface to libev |
58 | This module provides an interface to libev |
59 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
59 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
60 | below is comprehensive, one might also consult the documentation of libev |
60 | below is comprehensive, one might also consult the documentation of libev |
61 | itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on |
61 | itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>) for more |
62 | watcher semantics or some discussion on the available backends, or how to |
62 | subtle details on watcher semantics or some discussion on the available |
63 | force a specific backend with C<LIBEV_FLAGS>, or just about in any case |
63 | backends, or how to force a specific backend with C<LIBEV_FLAGS>, or just |
64 | because it has much more detailed information. |
64 | about in any case because it has much more detailed information. |
|
|
65 | |
|
|
66 | This module is very fast and scalable. It is actually so fast that you |
|
|
67 | can use it through the L<AnyEvent> module, stay portable to other event |
|
|
68 | loops (if you don't rely on any watcher types not available through it) |
|
|
69 | and still be faster than with any other event loop currently supported in |
|
|
70 | Perl. |
65 | |
71 | |
66 | =cut |
72 | =cut |
67 | |
73 | |
68 | package EV; |
74 | package EV; |
69 | |
75 | |
70 | use strict; |
76 | use strict; |
71 | |
77 | |
72 | BEGIN { |
78 | BEGIN { |
73 | our $VERSION = '3.0'; |
79 | our $VERSION = '3.4'; |
74 | use XSLoader; |
80 | use XSLoader; |
75 | XSLoader::load "EV", $VERSION; |
81 | XSLoader::load "EV", $VERSION; |
76 | } |
82 | } |
77 | |
83 | |
78 | @EV::IO::ISA = |
84 | @EV::IO::ISA = |
… | |
… | |
84 | @EV::Idle::ISA = |
90 | @EV::Idle::ISA = |
85 | @EV::Prepare::ISA = |
91 | @EV::Prepare::ISA = |
86 | @EV::Check::ISA = |
92 | @EV::Check::ISA = |
87 | @EV::Embed::ISA = |
93 | @EV::Embed::ISA = |
88 | @EV::Fork::ISA = |
94 | @EV::Fork::ISA = |
|
|
95 | @EV::Async::ISA = |
89 | "EV::Watcher"; |
96 | "EV::Watcher"; |
90 | |
97 | |
91 | @EV::Loop::Default::ISA = "EV::Loop"; |
98 | @EV::Loop::Default::ISA = "EV::Loop"; |
92 | |
99 | |
93 | =head1 EVENT LOOPS |
100 | =head1 EVENT LOOPS |
… | |
… | |
533 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
540 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
534 | will not adjust when a time jump occurs, that is, if it is to be run |
541 | will not adjust when a time jump occurs, that is, if it is to be run |
535 | at January 1st 2011 then it will run when the system time reaches or |
542 | at January 1st 2011 then it will run when the system time reaches or |
536 | surpasses this time. |
543 | surpasses this time. |
537 | |
544 | |
538 | =item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) |
545 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
539 | |
546 | |
540 | In this mode the watcher will always be scheduled to time out at the |
547 | In this mode the watcher will always be scheduled to time out at the |
541 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
548 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
542 | regardless of any time jumps. |
549 | regardless of any time jumps. |
543 | |
550 | |
… | |
… | |
561 | time the periodic watcher gets scheduled, the reschedule callback |
568 | time the periodic watcher gets scheduled, the reschedule callback |
562 | ($reschedule_cb) will be called with the watcher as first, and the current |
569 | ($reschedule_cb) will be called with the watcher as first, and the current |
563 | time as second argument. |
570 | time as second argument. |
564 | |
571 | |
565 | I<This callback MUST NOT stop or destroy this or any other periodic |
572 | I<This callback MUST NOT stop or destroy this or any other periodic |
566 | watcher, ever>. If you need to stop it, return 1e30 and stop it |
573 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
567 | afterwards. |
574 | you need to stop it, return 1e30 and stop it afterwards. You may create |
|
|
575 | and start a C<EV::prepare> watcher for this task. |
568 | |
576 | |
569 | It must return the next time to trigger, based on the passed time value |
577 | It must return the next time to trigger, based on the passed time value |
570 | (that is, the lowest time value larger than to the second argument). It |
578 | (that is, the lowest time value larger than or equal to to the second |
571 | will usually be called just before the callback will be triggered, but |
579 | argument). It will usually be called just before the callback will be |
572 | might be called at other times, too. |
580 | triggered, but might be called at other times, too. |
573 | |
581 | |
574 | This can be used to create very complex timers, such as a timer that |
582 | This can be used to create very complex timers, such as a timer that |
575 | triggers on each midnight, local time (actually 24 hours after the last |
583 | triggers on each midnight, local time (actually 24 hours after the last |
576 | midnight, to keep the example simple. If you know a way to do it correctly |
584 | midnight, to keep the example simple. If you know a way to do it correctly |
577 | in about the same space (without requiring elaborate modules), drop me a |
585 | in about the same space (without requiring elaborate modules), drop me a |
… | |
… | |
968 | |
976 | |
969 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
977 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
970 | |
978 | |
971 | =back |
979 | =back |
972 | |
980 | |
|
|
981 | =head3 ASYNC WATCHERS - how to wake up another event loop |
|
|
982 | |
|
|
983 | Async watchers are provided by EV, but have little use in perl directly, as perl |
|
|
984 | neither supports threads nor direct access to signal handlers or other |
|
|
985 | contexts where they could be of value. |
|
|
986 | |
|
|
987 | It is, however, possible to use them from the XS level. |
|
|
988 | |
|
|
989 | Please see the libev documentation for further details. |
|
|
990 | |
|
|
991 | =over 4 |
|
|
992 | |
|
|
993 | =item $w = EV::async $callback |
|
|
994 | |
|
|
995 | =item $w = EV::async_ns $callback |
|
|
996 | |
|
|
997 | =item $w->send |
|
|
998 | |
|
|
999 | =item $bool = $w->async_pending |
|
|
1000 | |
|
|
1001 | =back |
|
|
1002 | |
973 | |
1003 | |
974 | =head1 PERL SIGNALS |
1004 | =head1 PERL SIGNALS |
975 | |
1005 | |
976 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
1006 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
977 | with EV is as the same as any other C library: Perl-signals will only be |
1007 | with EV is as the same as any other C library: Perl-signals will only be |
… | |
… | |
1026 | |
1056 | |
1027 | =head1 SEE ALSO |
1057 | =head1 SEE ALSO |
1028 | |
1058 | |
1029 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1059 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1030 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1060 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1031 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). |
1061 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
|
|
1062 | event-loop agnostic and portable event driven programming. |
1032 | |
1063 | |
1033 | =head1 AUTHOR |
1064 | =head1 AUTHOR |
1034 | |
1065 | |
1035 | Marc Lehmann <schmorp@schmorp.de> |
1066 | Marc Lehmann <schmorp@schmorp.de> |
1036 | http://home.schmorp.de/ |
1067 | http://home.schmorp.de/ |