… | |
… | |
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.1'; |
79 | our $VERSION = '3.42'; |
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 = |
… | |
… | |
124 | |
130 | |
125 | =item $loop->loop_fork |
131 | =item $loop->loop_fork |
126 | |
132 | |
127 | Must be called after a fork in the child, before entering or continuing |
133 | Must be called after a fork in the child, before entering or continuing |
128 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
134 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
129 | this fucntion automatically, at some performance loss (refer to the libev |
135 | this function automatically, at some performance loss (refer to the libev |
130 | documentation). |
136 | documentation). |
131 | |
137 | |
|
|
138 | =item $loop->loop_verify |
|
|
139 | |
|
|
140 | Calls C<ev_verify> to make internal consistency checks (for debugging |
|
|
141 | libev) and abort the program if any data structures wree found to be |
|
|
142 | corrupted. |
|
|
143 | |
132 | =item $loop = EV::default_loop [$flags] |
144 | =item $loop = EV::default_loop [$flags] |
133 | |
145 | |
134 | Return the default loop (which is a singleton object). |
146 | Return the default loop (which is a singleton object). Since this module |
|
|
147 | already creates the default loop with default flags, specifying flags here |
|
|
148 | will not have any effect unless you destroy the default loop. |
135 | |
149 | |
136 | =back |
150 | =back |
137 | |
151 | |
138 | |
152 | |
139 | =head1 BASIC INTERFACE |
153 | =head1 BASIC INTERFACE |
… | |
… | |
562 | time the periodic watcher gets scheduled, the reschedule callback |
576 | time the periodic watcher gets scheduled, the reschedule callback |
563 | ($reschedule_cb) will be called with the watcher as first, and the current |
577 | ($reschedule_cb) will be called with the watcher as first, and the current |
564 | time as second argument. |
578 | time as second argument. |
565 | |
579 | |
566 | I<This callback MUST NOT stop or destroy this or any other periodic |
580 | I<This callback MUST NOT stop or destroy this or any other periodic |
567 | watcher, ever>. If you need to stop it, return 1e30 and stop it |
581 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
568 | afterwards. |
582 | you need to stop it, return 1e30 and stop it afterwards. You may create |
|
|
583 | and start a C<EV::prepare> watcher for this task. |
569 | |
584 | |
570 | It must return the next time to trigger, based on the passed time value |
585 | It must return the next time to trigger, based on the passed time value |
571 | (that is, the lowest time value larger than to the second argument). It |
586 | (that is, the lowest time value larger than or equal to to the second |
572 | will usually be called just before the callback will be triggered, but |
587 | argument). It will usually be called just before the callback will be |
573 | might be called at other times, too. |
588 | triggered, but might be called at other times, too. |
574 | |
589 | |
575 | This can be used to create very complex timers, such as a timer that |
590 | This can be used to create very complex timers, such as a timer that |
576 | triggers on each midnight, local time (actually 24 hours after the last |
591 | triggers on each midnight, local time (actually 24 hours after the last |
577 | midnight, to keep the example simple. If you know a way to do it correctly |
592 | midnight, to keep the example simple. If you know a way to do it correctly |
578 | in about the same space (without requiring elaborate modules), drop me a |
593 | in about the same space (without requiring elaborate modules), drop me a |
… | |
… | |
979 | |
994 | |
980 | It is, however, possible to use them from the XS level. |
995 | It is, however, possible to use them from the XS level. |
981 | |
996 | |
982 | Please see the libev documentation for further details. |
997 | Please see the libev documentation for further details. |
983 | |
998 | |
|
|
999 | =over 4 |
|
|
1000 | |
|
|
1001 | =item $w = EV::async $callback |
|
|
1002 | |
|
|
1003 | =item $w = EV::async_ns $callback |
|
|
1004 | |
|
|
1005 | =item $w->send |
|
|
1006 | |
|
|
1007 | =item $bool = $w->async_pending |
|
|
1008 | |
|
|
1009 | =back |
|
|
1010 | |
984 | |
1011 | |
985 | =head1 PERL SIGNALS |
1012 | =head1 PERL SIGNALS |
986 | |
1013 | |
987 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
1014 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
988 | with EV is as the same as any other C library: Perl-signals will only be |
1015 | with EV is as the same as any other C library: Perl-signals will only be |
… | |
… | |
1037 | |
1064 | |
1038 | =head1 SEE ALSO |
1065 | =head1 SEE ALSO |
1039 | |
1066 | |
1040 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1067 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1041 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1068 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1042 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). |
1069 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
|
|
1070 | event-loop agnostic and portable event driven programming. |
1043 | |
1071 | |
1044 | =head1 AUTHOR |
1072 | =head1 AUTHOR |
1045 | |
1073 | |
1046 | Marc Lehmann <schmorp@schmorp.de> |
1074 | Marc Lehmann <schmorp@schmorp.de> |
1047 | http://home.schmorp.de/ |
1075 | http://home.schmorp.de/ |