… | |
… | |
35 | warn "sigquit received\n"; |
35 | warn "sigquit received\n"; |
36 | }; |
36 | }; |
37 | |
37 | |
38 | # CHILD/PID STATUS CHANGES |
38 | # CHILD/PID STATUS CHANGES |
39 | |
39 | |
40 | my $w = EV::child 666, sub { |
40 | my $w = EV::child 666, 0, sub { |
41 | my ($w, $revents) = @_; |
41 | my ($w, $revents) = @_; |
42 | my $status = $w->rstatus; |
42 | my $status = $w->rstatus; |
43 | }; |
43 | }; |
44 | |
44 | |
45 | # STAT CHANGES |
45 | # STAT CHANGES |
… | |
… | |
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 = '2.0'; |
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 = |
… | |
… | |
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 |
… | |
… | |
123 | |
130 | |
124 | =item $loop->loop_fork |
131 | =item $loop->loop_fork |
125 | |
132 | |
126 | 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 |
127 | 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 |
128 | this fucntion automatically, at some performance loss (refer to the libev |
135 | this function automatically, at some performance loss (refer to the libev |
129 | documentation). |
136 | documentation). |
130 | |
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 | |
131 | =item $loop = EV::default_loop [$flags] |
144 | =item $loop = EV::default_loop [$flags] |
132 | |
145 | |
133 | 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. |
134 | |
149 | |
135 | =back |
150 | =back |
136 | |
151 | |
137 | |
152 | |
138 | =head1 BASIC INTERFACE |
153 | =head1 BASIC INTERFACE |
… | |
… | |
154 | =item $flags = EV::embeddable_backends |
169 | =item $flags = EV::embeddable_backends |
155 | |
170 | |
156 | Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this |
171 | Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this |
157 | instance of EV, the set of recommended backends (supposed to be good) for |
172 | instance of EV, the set of recommended backends (supposed to be good) for |
158 | this platform and the set of embeddable backends (see EMBED WATCHERS). |
173 | this platform and the set of embeddable backends (see EMBED WATCHERS). |
|
|
174 | |
|
|
175 | =item EV::sleep $seconds |
|
|
176 | |
|
|
177 | Block the process for the given number of (fractional) seconds. |
159 | |
178 | |
160 | =item $time = EV::time |
179 | =item $time = EV::time |
161 | |
180 | |
162 | Returns the current time in (fractional) seconds since the epoch. |
181 | Returns the current time in (fractional) seconds since the epoch. |
163 | |
182 | |
… | |
… | |
529 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
548 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
530 | will not adjust when a time jump occurs, that is, if it is to be run |
549 | will not adjust when a time jump occurs, that is, if it is to be run |
531 | at January 1st 2011 then it will run when the system time reaches or |
550 | at January 1st 2011 then it will run when the system time reaches or |
532 | surpasses this time. |
551 | surpasses this time. |
533 | |
552 | |
534 | =item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) |
553 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
535 | |
554 | |
536 | In this mode the watcher will always be scheduled to time out at the |
555 | In this mode the watcher will always be scheduled to time out at the |
537 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
556 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
538 | regardless of any time jumps. |
557 | regardless of any time jumps. |
539 | |
558 | |
… | |
… | |
557 | time the periodic watcher gets scheduled, the reschedule callback |
576 | time the periodic watcher gets scheduled, the reschedule callback |
558 | ($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 |
559 | time as second argument. |
578 | time as second argument. |
560 | |
579 | |
561 | 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 |
562 | 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 |
563 | 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. |
564 | |
584 | |
565 | 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 |
566 | (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 |
567 | 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 |
568 | might be called at other times, too. |
588 | triggered, but might be called at other times, too. |
569 | |
589 | |
570 | 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 |
571 | 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 |
572 | 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 |
573 | 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 |
… | |
… | |
640 | |
660 | |
641 | =head3 CHILD WATCHERS - watch out for process status changes |
661 | =head3 CHILD WATCHERS - watch out for process status changes |
642 | |
662 | |
643 | =over 4 |
663 | =over 4 |
644 | |
664 | |
645 | =item $w = EV::child $pid, $callback |
665 | =item $w = EV::child $pid, $trace, $callback |
646 | |
666 | |
647 | =item $w = EV::child_ns $pid, $callback |
667 | =item $w = EV::child_ns $pid, $trace, $callback |
648 | |
668 | |
649 | =item $w = $loop->child ($pid, $callback) |
669 | =item $w = $loop->child ($pid, $trace, $callback) |
650 | |
670 | |
651 | =item $w = $loop->child_ns ($pid, $callback) |
671 | =item $w = $loop->child_ns ($pid, $trace, $callback) |
652 | |
672 | |
653 | Call the callback when a status change for pid C<$pid> (or any pid if |
673 | Call the callback when a status change for pid C<$pid> (or any pid |
654 | C<$pid> is 0) has been received. More precisely: when the process receives |
674 | if C<$pid> is 0) has been received (a status change happens when the |
|
|
675 | process terminates or is killed, or, when trace is true, additionally when |
|
|
676 | it is stopped or continued). More precisely: when the process receives |
655 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
677 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
656 | changed/zombie children and call the callback. |
678 | changed/zombie children and call the callback. |
657 | |
679 | |
658 | It is valid (and fully supported) to install a child watcher after a child |
680 | It is valid (and fully supported) to install a child watcher after a child |
659 | has exited but before the event loop has started its next iteration (for |
681 | has exited but before the event loop has started its next iteration (for |
… | |
… | |
666 | You can have as many pid watchers per pid as you want, they will all be |
688 | You can have as many pid watchers per pid as you want, they will all be |
667 | called. |
689 | called. |
668 | |
690 | |
669 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
691 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
670 | |
692 | |
671 | =item $w->set ($pid) |
693 | =item $w->set ($pid, $trace) |
672 | |
694 | |
673 | Reconfigures the watcher, see the constructor above for details. Can be called at |
695 | Reconfigures the watcher, see the constructor above for details. Can be called at |
674 | any time. |
696 | any time. |
675 | |
697 | |
676 | =item $current_pid = $w->pid |
698 | =item $current_pid = $w->pid |
677 | |
|
|
678 | =item $old_pid = $w->pid ($new_pid) |
|
|
679 | |
699 | |
680 | Returns the previously set process id and optionally set a new one. |
700 | Returns the previously set process id and optionally set a new one. |
681 | |
701 | |
682 | =item $exit_status = $w->rstatus |
702 | =item $exit_status = $w->rstatus |
683 | |
703 | |
… | |
… | |
964 | |
984 | |
965 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
985 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
966 | |
986 | |
967 | =back |
987 | =back |
968 | |
988 | |
|
|
989 | =head3 ASYNC WATCHERS - how to wake up another event loop |
|
|
990 | |
|
|
991 | Async watchers are provided by EV, but have little use in perl directly, as perl |
|
|
992 | neither supports threads nor direct access to signal handlers or other |
|
|
993 | contexts where they could be of value. |
|
|
994 | |
|
|
995 | It is, however, possible to use them from the XS level. |
|
|
996 | |
|
|
997 | Please see the libev documentation for further details. |
|
|
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 | |
969 | |
1011 | |
970 | =head1 PERL SIGNALS |
1012 | =head1 PERL SIGNALS |
971 | |
1013 | |
972 | 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 |
973 | 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 |
… | |
… | |
1022 | |
1064 | |
1023 | =head1 SEE ALSO |
1065 | =head1 SEE ALSO |
1024 | |
1066 | |
1025 | 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 |
1026 | 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 |
1027 | 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. |
1028 | |
1071 | |
1029 | =head1 AUTHOR |
1072 | =head1 AUTHOR |
1030 | |
1073 | |
1031 | Marc Lehmann <schmorp@schmorp.de> |
1074 | Marc Lehmann <schmorp@schmorp.de> |
1032 | http://home.schmorp.de/ |
1075 | http://home.schmorp.de/ |