… | |
… | |
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 |
… | |
… | |
61 | itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on |
61 | itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on |
62 | watcher semantics or some discussion on the available backends, or how to |
62 | watcher semantics or some discussion on the available backends, or how to |
63 | force a specific backend with C<LIBEV_FLAGS>, or just about in any case |
63 | force a specific backend with C<LIBEV_FLAGS>, or just about in any case |
64 | because it has much more detailed information. |
64 | because it has much more detailed information. |
65 | |
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. |
|
|
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.31'; |
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 |
… | |
… | |
102 | selecting a working backend (which for example rules out kqueue on most |
109 | selecting a working backend (which for example rules out kqueue on most |
103 | BSDs). Modules should, unless they have "special needs" always use the |
110 | BSDs). Modules should, unless they have "special needs" always use the |
104 | default loop as this is fastest (perl-wise), best supported by other |
111 | default loop as this is fastest (perl-wise), best supported by other |
105 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
112 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
106 | |
113 | |
107 | For specific programs you cna create additional event loops dynamically. |
114 | For specific programs you can create additional event loops dynamically. |
108 | |
115 | |
109 | =over 4 |
116 | =over 4 |
110 | |
117 | |
111 | =item $loop = new EV::loop [$flags] |
118 | =item $loop = new EV::loop [$flags] |
112 | |
119 | |
… | |
… | |
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 fucntion automatically, at some performance loss (refer to the libev |
129 | documentation). |
136 | documentation). |
130 | |
137 | |
|
|
138 | =item $loop = EV::default_loop [$flags] |
|
|
139 | |
|
|
140 | Return the default loop (which is a singleton object). |
|
|
141 | |
131 | =back |
142 | =back |
132 | |
143 | |
133 | |
144 | |
134 | =head1 BASIC INTERFACE |
145 | =head1 BASIC INTERFACE |
135 | |
146 | |
… | |
… | |
140 | Must contain a reference to a function that is called when a callback |
151 | Must contain a reference to a function that is called when a callback |
141 | throws an exception (with $@ containing the error). The default prints an |
152 | throws an exception (with $@ containing the error). The default prints an |
142 | informative message and continues. |
153 | informative message and continues. |
143 | |
154 | |
144 | If this callback throws an exception it will be silently ignored. |
155 | If this callback throws an exception it will be silently ignored. |
|
|
156 | |
|
|
157 | =item $flags = EV::supported_backends |
|
|
158 | |
|
|
159 | =item $flags = EV::recommended_backends |
|
|
160 | |
|
|
161 | =item $flags = EV::embeddable_backends |
|
|
162 | |
|
|
163 | Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this |
|
|
164 | instance of EV, the set of recommended backends (supposed to be good) for |
|
|
165 | this platform and the set of embeddable backends (see EMBED WATCHERS). |
|
|
166 | |
|
|
167 | =item EV::sleep $seconds |
|
|
168 | |
|
|
169 | Block the process for the given number of (fractional) seconds. |
145 | |
170 | |
146 | =item $time = EV::time |
171 | =item $time = EV::time |
147 | |
172 | |
148 | Returns the current time in (fractional) seconds since the epoch. |
173 | Returns the current time in (fractional) seconds since the epoch. |
149 | |
174 | |
… | |
… | |
227 | |
252 | |
228 | =item EV::feed_signal_event ($signal) |
253 | =item EV::feed_signal_event ($signal) |
229 | |
254 | |
230 | Feed a signal event into EV. EV will react to this call as if the signal |
255 | Feed a signal event into EV. EV will react to this call as if the signal |
231 | specified by C<$signal> had occured. |
256 | specified by C<$signal> had occured. |
|
|
257 | |
|
|
258 | =item EV::set_io_collect_interval $time |
|
|
259 | |
|
|
260 | =item $loop->set_io_collect_interval ($time) |
|
|
261 | |
|
|
262 | =item EV::set_timeout_collect_interval $time |
|
|
263 | |
|
|
264 | =item $loop->set_timeout_collect_interval ($time) |
|
|
265 | |
|
|
266 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
|
|
267 | wait interval for timer events. See the libev documentation at |
|
|
268 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for |
|
|
269 | a more detailed discussion. |
232 | |
270 | |
233 | =back |
271 | =back |
234 | |
272 | |
235 | |
273 | |
236 | =head1 WATCHER OBJECTS |
274 | =head1 WATCHER OBJECTS |
… | |
… | |
502 | 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 |
503 | 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 |
504 | 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 |
505 | surpasses this time. |
543 | surpasses this time. |
506 | |
544 | |
507 | =item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) |
545 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
508 | |
546 | |
509 | 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 |
510 | 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, |
511 | regardless of any time jumps. |
549 | regardless of any time jumps. |
512 | |
550 | |
… | |
… | |
613 | |
651 | |
614 | =head3 CHILD WATCHERS - watch out for process status changes |
652 | =head3 CHILD WATCHERS - watch out for process status changes |
615 | |
653 | |
616 | =over 4 |
654 | =over 4 |
617 | |
655 | |
618 | =item $w = EV::child $pid, $callback |
656 | =item $w = EV::child $pid, $trace, $callback |
619 | |
657 | |
620 | =item $w = EV::child_ns $pid, $callback |
658 | =item $w = EV::child_ns $pid, $trace, $callback |
621 | |
659 | |
622 | =item $w = $loop->child ($pid, $callback) |
660 | =item $w = $loop->child ($pid, $trace, $callback) |
623 | |
661 | |
624 | =item $w = $loop->child_ns ($pid, $callback) |
662 | =item $w = $loop->child_ns ($pid, $trace, $callback) |
625 | |
663 | |
626 | Call the callback when a status change for pid C<$pid> (or any pid if |
664 | Call the callback when a status change for pid C<$pid> (or any pid |
627 | C<$pid> is 0) has been received. More precisely: when the process receives |
665 | if C<$pid> is 0) has been received (a status change happens when the |
|
|
666 | process terminates or is killed, or, when trace is true, additionally when |
|
|
667 | it is stopped or continued). More precisely: when the process receives |
628 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
668 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
629 | changed/zombie children and call the callback. |
669 | changed/zombie children and call the callback. |
630 | |
670 | |
631 | It is valid (and fully supported) to install a child watcher after a child |
671 | It is valid (and fully supported) to install a child watcher after a child |
632 | has exited but before the event loop has started its next iteration (for |
672 | has exited but before the event loop has started its next iteration (for |
… | |
… | |
639 | You can have as many pid watchers per pid as you want, they will all be |
679 | You can have as many pid watchers per pid as you want, they will all be |
640 | called. |
680 | called. |
641 | |
681 | |
642 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
682 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
643 | |
683 | |
644 | =item $w->set ($pid) |
684 | =item $w->set ($pid, $trace) |
645 | |
685 | |
646 | Reconfigures the watcher, see the constructor above for details. Can be called at |
686 | Reconfigures the watcher, see the constructor above for details. Can be called at |
647 | any time. |
687 | any time. |
648 | |
688 | |
649 | =item $current_pid = $w->pid |
689 | =item $current_pid = $w->pid |
650 | |
|
|
651 | =item $old_pid = $w->pid ($new_pid) |
|
|
652 | |
690 | |
653 | Returns the previously set process id and optionally set a new one. |
691 | Returns the previously set process id and optionally set a new one. |
654 | |
692 | |
655 | =item $exit_status = $w->rstatus |
693 | =item $exit_status = $w->rstatus |
656 | |
694 | |
… | |
… | |
886 | |
924 | |
887 | Call the callback before the event loop is resumed in the child process |
925 | Call the callback before the event loop is resumed in the child process |
888 | after a fork. |
926 | after a fork. |
889 | |
927 | |
890 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
928 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
|
|
929 | |
|
|
930 | =back |
|
|
931 | |
|
|
932 | |
|
|
933 | =head3 EMBED WATCHERS - when one backend isn't enough... |
|
|
934 | |
|
|
935 | This is a rather advanced watcher type that lets you embed one event loop |
|
|
936 | into another (currently only IO events are supported in the embedded |
|
|
937 | loop, other types of watchers might be handled in a delayed or incorrect |
|
|
938 | fashion and must not be used). |
|
|
939 | |
|
|
940 | See the libev documentation at |
|
|
941 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
|
|
942 | for more details. |
|
|
943 | |
|
|
944 | In short, this watcher is most useful on BSD systems without working |
|
|
945 | kqueue to still be able to handle a large number of sockets: |
|
|
946 | |
|
|
947 | my $socket_loop; |
|
|
948 | |
|
|
949 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
|
|
950 | if ( |
|
|
951 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
|
|
952 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
|
|
953 | ) { |
|
|
954 | # use kqueue for sockets |
|
|
955 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
|
|
956 | } |
|
|
957 | |
|
|
958 | # use the default loop otherwise |
|
|
959 | $socket_loop ||= EV::default_loop; |
|
|
960 | |
|
|
961 | =over 4 |
|
|
962 | |
|
|
963 | =item $w = EV::embed $otherloop, $callback |
|
|
964 | |
|
|
965 | =item $w = EV::embed_ns $otherloop, $callback |
|
|
966 | |
|
|
967 | =item $w = $loop->embed ($otherloop, $callback) |
|
|
968 | |
|
|
969 | =item $w = $loop->embed_ns ($otherloop, $callback) |
|
|
970 | |
|
|
971 | Call the callback when the embedded event loop (C<$otherloop>) has any |
|
|
972 | I/O activity. The C<$callback> should alwas be specified as C<undef> in |
|
|
973 | this version of EV, which means the embedded event loop will be managed |
|
|
974 | automatically. |
|
|
975 | |
|
|
976 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
|
|
977 | |
|
|
978 | =back |
|
|
979 | |
|
|
980 | =head3 ASYNC WATCHERS - how to wake up another event loop |
|
|
981 | |
|
|
982 | Async watchers are provided by EV, but have little use in perl directly, as perl |
|
|
983 | neither supports threads nor direct access to signal handlers or other |
|
|
984 | contexts where they could be of value. |
|
|
985 | |
|
|
986 | It is, however, possible to use them from the XS level. |
|
|
987 | |
|
|
988 | Please see the libev documentation for further details. |
|
|
989 | |
|
|
990 | =over 4 |
|
|
991 | |
|
|
992 | =item $w = EV::async $callback |
|
|
993 | |
|
|
994 | =item $w = EV::async_ns $callback |
|
|
995 | |
|
|
996 | =item $w->send |
|
|
997 | |
|
|
998 | =item $bool = $w->async_pending |
891 | |
999 | |
892 | =back |
1000 | =back |
893 | |
1001 | |
894 | |
1002 | |
895 | =head1 PERL SIGNALS |
1003 | =head1 PERL SIGNALS |
… | |
… | |
947 | |
1055 | |
948 | =head1 SEE ALSO |
1056 | =head1 SEE ALSO |
949 | |
1057 | |
950 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1058 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
951 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1059 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
952 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). |
1060 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
|
|
1061 | event-loop agnostic and portable event driven programming. |
953 | |
1062 | |
954 | =head1 AUTHOR |
1063 | =head1 AUTHOR |
955 | |
1064 | |
956 | Marc Lehmann <schmorp@schmorp.de> |
1065 | Marc Lehmann <schmorp@schmorp.de> |
957 | http://home.schmorp.de/ |
1066 | http://home.schmorp.de/ |