… | |
… | |
2 | |
2 | |
3 | EV - perl interface to libev, a high performance full-featured event loop |
3 | EV - perl interface to libev, a high performance full-featured event loop |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use EV; |
7 | use EV; |
|
|
8 | |
|
|
9 | # TIMERS |
|
|
10 | |
|
|
11 | my $w = EV::timer 2, 0, sub { |
|
|
12 | warn "is called after 2s"; |
|
|
13 | }; |
|
|
14 | |
|
|
15 | my $w = EV::timer 2, 2, sub { |
|
|
16 | warn "is called roughly every 2s (repeat = 2)"; |
|
|
17 | }; |
|
|
18 | |
|
|
19 | undef $w; # destroy event watcher again |
|
|
20 | |
|
|
21 | my $w = EV::periodic 0, 60, 0, sub { |
|
|
22 | warn "is called every minute, on the minute, exactly"; |
|
|
23 | }; |
|
|
24 | |
|
|
25 | # IO |
|
|
26 | |
|
|
27 | my $w = EV::io *STDIN, EV::READ, sub { |
|
|
28 | my ($w, $revents) = @_; # all callbacks receive the watcher and event mask |
|
|
29 | warn "stdin is readable, you entered: ", <STDIN>; |
|
|
30 | }; |
|
|
31 | |
|
|
32 | # SIGNALS |
|
|
33 | |
|
|
34 | my $w = EV::signal 'QUIT', sub { |
|
|
35 | warn "sigquit received\n"; |
|
|
36 | }; |
|
|
37 | |
|
|
38 | # CHILD/PID STATUS CHANGES |
8 | |
39 | |
9 | # TIMERS |
40 | my $w = EV::child 666, 0, sub { |
|
|
41 | my ($w, $revents) = @_; |
|
|
42 | my $status = $w->rstatus; |
|
|
43 | }; |
10 | |
44 | |
11 | my $w = EV::timer 2, 0, sub { |
|
|
12 | warn "is called after 2s"; |
|
|
13 | }; |
|
|
14 | |
|
|
15 | my $w = EV::timer 2, 2, sub { |
|
|
16 | warn "is called roughly every 2s (repeat = 2)"; |
|
|
17 | }; |
|
|
18 | |
|
|
19 | undef $w; # destroy event watcher again |
|
|
20 | |
|
|
21 | my $w = EV::periodic 0, 60, 0, sub { |
|
|
22 | warn "is called every minute, on the minute, exactly"; |
|
|
23 | }; |
|
|
24 | |
|
|
25 | # IO |
|
|
26 | |
|
|
27 | my $w = EV::io *STDIN, EV::READ, sub { |
|
|
28 | my ($w, $revents) = @_; # all callbacks receive the watcher and event mask |
|
|
29 | warn "stdin is readable, you entered: ", <STDIN>; |
|
|
30 | }; |
|
|
31 | |
|
|
32 | # SIGNALS |
|
|
33 | |
|
|
34 | my $w = EV::signal 'QUIT', sub { |
|
|
35 | warn "sigquit received\n"; |
|
|
36 | }; |
|
|
37 | |
|
|
38 | # CHILD/PID STATUS CHANGES |
|
|
39 | |
|
|
40 | my $w = EV::child 666, 0, sub { |
|
|
41 | my ($w, $revents) = @_; |
|
|
42 | my $status = $w->rstatus; |
|
|
43 | }; |
|
|
44 | |
|
|
45 | # STAT CHANGES |
45 | # STAT CHANGES |
46 | my $w = EV::stat "/etc/passwd", 10, sub { |
46 | my $w = EV::stat "/etc/passwd", 10, sub { |
47 | my ($w, $revents) = @_; |
47 | my ($w, $revents) = @_; |
48 | warn $w->path, " has changed somehow.\n"; |
48 | warn $w->path, " has changed somehow.\n"; |
49 | }; |
49 | }; |
50 | |
50 | |
51 | # MAINLOOP |
51 | # MAINLOOP |
52 | EV::loop; # loop until EV::unloop is called or all watchers stop |
52 | EV::loop; # loop until EV::unloop is called or all watchers stop |
53 | EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled |
53 | EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled |
54 | EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
54 | EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
55 | |
55 | |
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 |
61 | itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on |
61 | libev itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod> or |
62 | watcher semantics or some discussion on the available backends, or how to |
62 | F<perldoc EV::libev>) for more subtle details on watcher semantics or some |
63 | force a specific backend with C<LIBEV_FLAGS>, or just about in any case |
63 | discussion on the available backends, or how to force a specific backend |
64 | because it has much more detailed information. |
64 | with C<LIBEV_FLAGS>, or just about in any case because it has much more |
|
|
65 | detailed information. |
|
|
66 | |
|
|
67 | This module is very fast and scalable. It is actually so fast that you |
|
|
68 | can use it through the L<AnyEvent> module, stay portable to other event |
|
|
69 | loops (if you don't rely on any watcher types not available through it) |
|
|
70 | and still be faster than with any other event loop currently supported in |
|
|
71 | Perl. |
65 | |
72 | |
66 | =cut |
73 | =cut |
67 | |
74 | |
68 | package EV; |
75 | package EV; |
69 | |
76 | |
|
|
77 | no warnings; |
70 | use strict; |
78 | use strict; |
71 | |
79 | |
72 | BEGIN { |
80 | BEGIN { |
73 | our $VERSION = '3.0'; |
81 | our $VERSION = '3.44'; |
74 | use XSLoader; |
82 | use XSLoader; |
75 | XSLoader::load "EV", $VERSION; |
83 | XSLoader::load "EV", $VERSION; |
76 | } |
84 | } |
77 | |
85 | |
78 | @EV::IO::ISA = |
86 | @EV::IO::ISA = |
… | |
… | |
84 | @EV::Idle::ISA = |
92 | @EV::Idle::ISA = |
85 | @EV::Prepare::ISA = |
93 | @EV::Prepare::ISA = |
86 | @EV::Check::ISA = |
94 | @EV::Check::ISA = |
87 | @EV::Embed::ISA = |
95 | @EV::Embed::ISA = |
88 | @EV::Fork::ISA = |
96 | @EV::Fork::ISA = |
|
|
97 | @EV::Async::ISA = |
89 | "EV::Watcher"; |
98 | "EV::Watcher"; |
90 | |
99 | |
91 | @EV::Loop::Default::ISA = "EV::Loop"; |
100 | @EV::Loop::Default::ISA = "EV::Loop"; |
92 | |
101 | |
93 | =head1 EVENT LOOPS |
102 | =head1 EVENT LOOPS |
… | |
… | |
104 | default loop as this is fastest (perl-wise), best supported by other |
113 | default loop as this is fastest (perl-wise), best supported by other |
105 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
114 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
106 | |
115 | |
107 | For specific programs you can create additional event loops dynamically. |
116 | For specific programs you can create additional event loops dynamically. |
108 | |
117 | |
|
|
118 | If you want to take avdantage of kqueue (which often works properly for |
|
|
119 | sockets only) even though the default loop doesn't enable it, you can |
|
|
120 | I<embed> a kqueue loop into the default loop: running the default loop |
|
|
121 | will then also service the kqueue loop to some extent. See the example in |
|
|
122 | the section about embed watchers for an example on how to achieve that. |
|
|
123 | |
109 | =over 4 |
124 | =over 4 |
110 | |
125 | |
111 | =item $loop = new EV::loop [$flags] |
126 | =item $loop = new EV::loop [$flags] |
112 | |
127 | |
113 | Create a new event loop as per the specified flags. Please refer to the |
128 | Create a new event loop as per the specified flags. Please refer to |
114 | C<ev_loop_new ()> function description in the libev documentation |
129 | the C<ev_loop_new ()> function description in the libev documentation |
115 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>) |
130 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
116 | for more info. |
131 | or locally-installed as F<EV::libev> manpage) for more info. |
117 | |
132 | |
118 | The loop will automatically be destroyed when it is no longer referenced |
133 | The loop will automatically be destroyed when it is no longer referenced |
119 | by any watcher and the loop object goes out of scope. |
134 | by any watcher and the loop object goes out of scope. |
120 | |
135 | |
121 | Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop |
136 | If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> |
122 | is protected by this module. |
137 | is recommended, as only the default event loop is protected by this |
|
|
138 | module. If you I<are> embedding this loop in the default loop, this is not |
|
|
139 | necessary, as C<EV::embed> automatically does the right thing on fork. |
123 | |
140 | |
124 | =item $loop->loop_fork |
141 | =item $loop->loop_fork |
125 | |
142 | |
126 | Must be called after a fork in the child, before entering or continuing |
143 | 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 |
144 | 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 |
145 | this function automatically, at some performance loss (refer to the libev |
129 | documentation). |
146 | documentation). |
130 | |
147 | |
|
|
148 | =item $loop->loop_verify |
|
|
149 | |
|
|
150 | Calls C<ev_verify> to make internal consistency checks (for debugging |
|
|
151 | libev) and abort the program if any data structures were found to be |
|
|
152 | corrupted. |
|
|
153 | |
131 | =item $loop = EV::default_loop [$flags] |
154 | =item $loop = EV::default_loop [$flags] |
132 | |
155 | |
133 | Return the default loop (which is a singleton object). |
156 | Return the default loop (which is a singleton object). Since this module |
|
|
157 | already creates the default loop with default flags, specifying flags here |
|
|
158 | will not have any effect unless you destroy the default loop first, which |
|
|
159 | isn't supported. So in short: don't do it, and if you break it, you get to |
|
|
160 | keep the pieces. |
134 | |
161 | |
135 | =back |
162 | =back |
136 | |
163 | |
137 | |
164 | |
138 | =head1 BASIC INTERFACE |
165 | =head1 BASIC INTERFACE |
… | |
… | |
256 | |
283 | |
257 | =item $loop->set_timeout_collect_interval ($time) |
284 | =item $loop->set_timeout_collect_interval ($time) |
258 | |
285 | |
259 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
286 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
260 | wait interval for timer events. See the libev documentation at |
287 | wait interval for timer events. See the libev documentation at |
261 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for |
288 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
262 | a more detailed discussion. |
289 | (locally installed as F<EV::libev>) for a more detailed discussion. |
263 | |
290 | |
264 | =back |
291 | =back |
265 | |
292 | |
266 | |
293 | |
267 | =head1 WATCHER OBJECTS |
294 | =head1 WATCHER OBJECTS |
268 | |
295 | |
269 | A watcher is an object that gets created to record your interest in some |
296 | A watcher is an object that gets created to record your interest in some |
270 | event. For instance, if you want to wait for STDIN to become readable, you |
297 | event. For instance, if you want to wait for STDIN to become readable, you |
271 | would create an EV::io watcher for that: |
298 | would create an EV::io watcher for that: |
272 | |
299 | |
273 | my $watcher = EV::io *STDIN, EV::READ, sub { |
300 | my $watcher = EV::io *STDIN, EV::READ, sub { |
274 | my ($watcher, $revents) = @_; |
301 | my ($watcher, $revents) = @_; |
275 | warn "yeah, STDIN should now be readable without blocking!\n" |
302 | warn "yeah, STDIN should now be readable without blocking!\n" |
276 | }; |
303 | }; |
277 | |
304 | |
278 | All watchers can be active (waiting for events) or inactive (paused). Only |
305 | All watchers can be active (waiting for events) or inactive (paused). Only |
279 | active watchers will have their callbacks invoked. All callbacks will be |
306 | active watchers will have their callbacks invoked. All callbacks will be |
280 | called with at least two arguments: the watcher and a bitmask of received |
307 | called with at least two arguments: the watcher and a bitmask of received |
281 | events. |
308 | events. |
… | |
… | |
394 | Example: Register an I/O watcher for some UDP socket but do not keep the |
421 | Example: Register an I/O watcher for some UDP socket but do not keep the |
395 | event loop from running just because of that watcher. |
422 | event loop from running just because of that watcher. |
396 | |
423 | |
397 | my $udp_socket = ... |
424 | my $udp_socket = ... |
398 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
425 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
399 | $1000udp_watcher->keepalive (0); |
426 | $udp_watcher->keepalive (0); |
400 | |
427 | |
401 | =item $loop = $w->loop |
428 | =item $loop = $w->loop |
402 | |
429 | |
403 | Return the loop that this watcher is attached to. |
430 | Return the loop that this watcher is attached to. |
404 | |
431 | |
… | |
… | |
533 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
560 | 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 |
561 | 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 |
562 | at January 1st 2011 then it will run when the system time reaches or |
536 | surpasses this time. |
563 | surpasses this time. |
537 | |
564 | |
538 | =item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) |
565 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
539 | |
566 | |
540 | In this mode the watcher will always be scheduled to time out at the |
567 | 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, |
568 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
542 | regardless of any time jumps. |
569 | regardless of any time jumps. |
543 | |
570 | |
… | |
… | |
561 | time the periodic watcher gets scheduled, the reschedule callback |
588 | time the periodic watcher gets scheduled, the reschedule callback |
562 | ($reschedule_cb) will be called with the watcher as first, and the current |
589 | ($reschedule_cb) will be called with the watcher as first, and the current |
563 | time as second argument. |
590 | time as second argument. |
564 | |
591 | |
565 | I<This callback MUST NOT stop or destroy this or any other periodic |
592 | 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 |
593 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
567 | afterwards. |
594 | you need to stop it, return 1e30 and stop it afterwards. You may create |
|
|
595 | and start a C<EV::prepare> watcher for this task. |
568 | |
596 | |
569 | It must return the next time to trigger, based on the passed time value |
597 | 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 |
598 | (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 |
599 | argument). It will usually be called just before the callback will be |
572 | might be called at other times, too. |
600 | triggered, but might be called at other times, too. |
573 | |
601 | |
574 | This can be used to create very complex timers, such as a timer that |
602 | 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 |
603 | 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 |
604 | 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 |
605 | in about the same space (without requiring elaborate modules), drop me a |
… | |
… | |
930 | loop, other types of watchers might be handled in a delayed or incorrect |
958 | loop, other types of watchers might be handled in a delayed or incorrect |
931 | fashion and must not be used). |
959 | fashion and must not be used). |
932 | |
960 | |
933 | See the libev documentation at |
961 | See the libev documentation at |
934 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
962 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
935 | for more details. |
963 | (locally installed as F<EV::libev>) for more details. |
936 | |
964 | |
937 | In short, this watcher is most useful on BSD systems without working |
965 | In short, this watcher is most useful on BSD systems without working |
938 | kqueue to still be able to handle a large number of sockets: |
966 | kqueue to still be able to handle a large number of sockets: |
939 | |
967 | |
940 | my $socket_loop; |
968 | my $socket_loop; |
941 | |
969 | |
942 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
970 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
943 | if ( |
971 | if ( |
944 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
972 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
945 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
973 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
946 | ) { |
974 | ) { |
947 | # use kqueue for sockets |
975 | # use kqueue for sockets |
948 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
976 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
949 | } |
977 | } |
950 | |
978 | |
951 | # use the default loop otherwise |
979 | # use the default loop otherwise |
952 | $socket_loop ||= EV::default_loop; |
980 | $socket_loop ||= EV::default_loop; |
953 | |
981 | |
954 | =over 4 |
982 | =over 4 |
955 | |
983 | |
956 | =item $w = EV::embed $otherloop, $callback |
984 | =item $w = EV::embed $otherloop[, $callback] |
957 | |
985 | |
958 | =item $w = EV::embed_ns $otherloop, $callback |
986 | =item $w = EV::embed_ns $otherloop[, $callback] |
959 | |
987 | |
960 | =item $w = $loop->embed ($otherloop, $callback) |
988 | =item $w = $loop->embed ($otherloop[, $callback]) |
961 | |
989 | |
962 | =item $w = $loop->embed_ns ($otherloop, $callback) |
990 | =item $w = $loop->embed_ns ($otherloop[, $callback]) |
963 | |
991 | |
964 | Call the callback when the embedded event loop (C<$otherloop>) has any |
992 | Call the callback when the embedded event loop (C<$otherloop>) has any |
965 | I/O activity. The C<$callback> should alwas be specified as C<undef> in |
993 | I/O activity. The C<$callback> is optional: if it is missing, then the |
966 | this version of EV, which means the embedded event loop will be managed |
994 | embedded event loop will be managed automatically (which is recommended), |
967 | automatically. |
995 | otherwise you have to invoke C<sweep> yourself. |
968 | |
996 | |
969 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
997 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
|
|
998 | |
|
|
999 | =back |
|
|
1000 | |
|
|
1001 | =head3 ASYNC WATCHERS - how to wake up another event loop |
|
|
1002 | |
|
|
1003 | Async watchers are provided by EV, but have little use in perl directly, as perl |
|
|
1004 | neither supports threads nor direct access to signal handlers or other |
|
|
1005 | contexts where they could be of value. |
|
|
1006 | |
|
|
1007 | It is, however, possible to use them from the XS level. |
|
|
1008 | |
|
|
1009 | Please see the libev documentation for further details. |
|
|
1010 | |
|
|
1011 | =over 4 |
|
|
1012 | |
|
|
1013 | =item $w = EV::async $callback |
|
|
1014 | |
|
|
1015 | =item $w = EV::async_ns $callback |
|
|
1016 | |
|
|
1017 | =item $w->send |
|
|
1018 | |
|
|
1019 | =item $bool = $w->async_pending |
970 | |
1020 | |
971 | =back |
1021 | =back |
972 | |
1022 | |
973 | |
1023 | |
974 | =head1 PERL SIGNALS |
1024 | =head1 PERL SIGNALS |
… | |
… | |
1026 | |
1076 | |
1027 | =head1 SEE ALSO |
1077 | =head1 SEE ALSO |
1028 | |
1078 | |
1029 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1079 | 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 |
1080 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1031 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). |
1081 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
|
|
1082 | event-loop agnostic and portable event driven programming. |
1032 | |
1083 | |
1033 | =head1 AUTHOR |
1084 | =head1 AUTHOR |
1034 | |
1085 | |
1035 | Marc Lehmann <schmorp@schmorp.de> |
1086 | Marc Lehmann <schmorp@schmorp.de> |
1036 | http://home.schmorp.de/ |
1087 | http://home.schmorp.de/ |
1037 | |
1088 | |
1038 | =cut |
1089 | =cut |
1039 | |
1090 | |