… | |
… | |
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 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 | |
|
|
76 | no warnings; |
70 | use strict; |
77 | use strict; |
71 | |
78 | |
72 | BEGIN { |
79 | BEGIN { |
73 | our $VERSION = '3.2'; |
80 | our $VERSION = '3.44'; |
74 | use XSLoader; |
81 | use XSLoader; |
75 | XSLoader::load "EV", $VERSION; |
82 | XSLoader::load "EV", $VERSION; |
76 | } |
83 | } |
77 | |
84 | |
78 | @EV::IO::ISA = |
85 | @EV::IO::ISA = |
… | |
… | |
105 | default loop as this is fastest (perl-wise), best supported by other |
112 | default loop as this is fastest (perl-wise), best supported by other |
106 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
113 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
107 | |
114 | |
108 | For specific programs you can create additional event loops dynamically. |
115 | For specific programs you can create additional event loops dynamically. |
109 | |
116 | |
|
|
117 | If you want to take avdantage of kqueue (which often works properly for |
|
|
118 | sockets only) even though the default loop doesn't enable it, you can |
|
|
119 | I<embed> a kqueue loop into the default loop: running the default loop |
|
|
120 | will then also service the kqueue loop to some extent. See the example in |
|
|
121 | the section about embed watchers for an example on how to achieve that. |
|
|
122 | |
110 | =over 4 |
123 | =over 4 |
111 | |
124 | |
112 | =item $loop = new EV::loop [$flags] |
125 | =item $loop = new EV::loop [$flags] |
113 | |
126 | |
114 | Create a new event loop as per the specified flags. Please refer to the |
127 | Create a new event loop as per the specified flags. Please refer to the |
… | |
… | |
117 | for more info. |
130 | for more info. |
118 | |
131 | |
119 | The loop will automatically be destroyed when it is no longer referenced |
132 | The loop will automatically be destroyed when it is no longer referenced |
120 | by any watcher and the loop object goes out of scope. |
133 | by any watcher and the loop object goes out of scope. |
121 | |
134 | |
122 | Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop |
135 | If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> |
123 | is protected by this module. |
136 | is recommended, as only the default event loop is protected by this |
|
|
137 | module. If you I<are> embedding this loop in the default loop, this is not |
|
|
138 | necessary, as C<EV::embed> automatically does the right thing on fork. |
124 | |
139 | |
125 | =item $loop->loop_fork |
140 | =item $loop->loop_fork |
126 | |
141 | |
127 | Must be called after a fork in the child, before entering or continuing |
142 | 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 |
143 | 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 |
144 | this function automatically, at some performance loss (refer to the libev |
130 | documentation). |
145 | documentation). |
131 | |
146 | |
|
|
147 | =item $loop->loop_verify |
|
|
148 | |
|
|
149 | Calls C<ev_verify> to make internal consistency checks (for debugging |
|
|
150 | libev) and abort the program if any data structures were found to be |
|
|
151 | corrupted. |
|
|
152 | |
132 | =item $loop = EV::default_loop [$flags] |
153 | =item $loop = EV::default_loop [$flags] |
133 | |
154 | |
134 | Return the default loop (which is a singleton object). |
155 | Return the default loop (which is a singleton object). Since this module |
|
|
156 | already creates the default loop with default flags, specifying flags here |
|
|
157 | will not have any effect unless you destroy the default loop first, which |
|
|
158 | isn't supported. So in short: don't do it, and if you break it, you get to |
|
|
159 | keep the pieces. |
135 | |
160 | |
136 | =back |
161 | =back |
137 | |
162 | |
138 | |
163 | |
139 | =head1 BASIC INTERFACE |
164 | =head1 BASIC INTERFACE |
… | |
… | |
269 | |
294 | |
270 | A watcher is an object that gets created to record your interest in some |
295 | A watcher is an object that gets created to record your interest in some |
271 | event. For instance, if you want to wait for STDIN to become readable, you |
296 | event. For instance, if you want to wait for STDIN to become readable, you |
272 | would create an EV::io watcher for that: |
297 | would create an EV::io watcher for that: |
273 | |
298 | |
274 | my $watcher = EV::io *STDIN, EV::READ, sub { |
299 | my $watcher = EV::io *STDIN, EV::READ, sub { |
275 | my ($watcher, $revents) = @_; |
300 | my ($watcher, $revents) = @_; |
276 | warn "yeah, STDIN should now be readable without blocking!\n" |
301 | warn "yeah, STDIN should now be readable without blocking!\n" |
277 | }; |
302 | }; |
278 | |
303 | |
279 | All watchers can be active (waiting for events) or inactive (paused). Only |
304 | All watchers can be active (waiting for events) or inactive (paused). Only |
280 | active watchers will have their callbacks invoked. All callbacks will be |
305 | active watchers will have their callbacks invoked. All callbacks will be |
281 | called with at least two arguments: the watcher and a bitmask of received |
306 | called with at least two arguments: the watcher and a bitmask of received |
282 | events. |
307 | events. |
… | |
… | |
395 | Example: Register an I/O watcher for some UDP socket but do not keep the |
420 | Example: Register an I/O watcher for some UDP socket but do not keep the |
396 | event loop from running just because of that watcher. |
421 | event loop from running just because of that watcher. |
397 | |
422 | |
398 | my $udp_socket = ... |
423 | my $udp_socket = ... |
399 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
424 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
400 | $1000udp_watcher->keepalive (0); |
425 | $udp_watcher->keepalive (0); |
401 | |
426 | |
402 | =item $loop = $w->loop |
427 | =item $loop = $w->loop |
403 | |
428 | |
404 | Return the loop that this watcher is attached to. |
429 | Return the loop that this watcher is attached to. |
405 | |
430 | |
… | |
… | |
562 | time the periodic watcher gets scheduled, the reschedule callback |
587 | time the periodic watcher gets scheduled, the reschedule callback |
563 | ($reschedule_cb) will be called with the watcher as first, and the current |
588 | ($reschedule_cb) will be called with the watcher as first, and the current |
564 | time as second argument. |
589 | time as second argument. |
565 | |
590 | |
566 | I<This callback MUST NOT stop or destroy this or any other periodic |
591 | 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 |
592 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
568 | afterwards. |
593 | you need to stop it, return 1e30 and stop it afterwards. You may create |
|
|
594 | and start a C<EV::prepare> watcher for this task. |
569 | |
595 | |
570 | It must return the next time to trigger, based on the passed time value |
596 | 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 |
597 | (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 |
598 | argument). It will usually be called just before the callback will be |
573 | might be called at other times, too. |
599 | triggered, but might be called at other times, too. |
574 | |
600 | |
575 | This can be used to create very complex timers, such as a timer that |
601 | 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 |
602 | 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 |
603 | 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 |
604 | in about the same space (without requiring elaborate modules), drop me a |
… | |
… | |
936 | for more details. |
962 | for more details. |
937 | |
963 | |
938 | In short, this watcher is most useful on BSD systems without working |
964 | In short, this watcher is most useful on BSD systems without working |
939 | kqueue to still be able to handle a large number of sockets: |
965 | kqueue to still be able to handle a large number of sockets: |
940 | |
966 | |
941 | my $socket_loop; |
967 | my $socket_loop; |
942 | |
968 | |
943 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
969 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
944 | if ( |
970 | if ( |
945 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
971 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
946 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
972 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
947 | ) { |
973 | ) { |
948 | # use kqueue for sockets |
974 | # use kqueue for sockets |
949 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
975 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
950 | } |
976 | } |
951 | |
977 | |
952 | # use the default loop otherwise |
978 | # use the default loop otherwise |
953 | $socket_loop ||= EV::default_loop; |
979 | $socket_loop ||= EV::default_loop; |
954 | |
980 | |
955 | =over 4 |
981 | =over 4 |
956 | |
982 | |
957 | =item $w = EV::embed $otherloop, $callback |
983 | =item $w = EV::embed $otherloop[, $callback] |
958 | |
984 | |
959 | =item $w = EV::embed_ns $otherloop, $callback |
985 | =item $w = EV::embed_ns $otherloop[, $callback] |
960 | |
986 | |
961 | =item $w = $loop->embed ($otherloop, $callback) |
987 | =item $w = $loop->embed ($otherloop[, $callback]) |
962 | |
988 | |
963 | =item $w = $loop->embed_ns ($otherloop, $callback) |
989 | =item $w = $loop->embed_ns ($otherloop[, $callback]) |
964 | |
990 | |
965 | Call the callback when the embedded event loop (C<$otherloop>) has any |
991 | Call the callback when the embedded event loop (C<$otherloop>) has any |
966 | I/O activity. The C<$callback> should alwas be specified as C<undef> in |
992 | I/O activity. The C<$callback> is optional: if it is missing, then the |
967 | this version of EV, which means the embedded event loop will be managed |
993 | embedded event loop will be managed automatically (which is recommended), |
968 | automatically. |
994 | otherwise you have to invoke C<sweep> yourself. |
969 | |
995 | |
970 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
996 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
971 | |
997 | |
972 | =back |
998 | =back |
973 | |
999 | |
… | |
… | |
1049 | |
1075 | |
1050 | =head1 SEE ALSO |
1076 | =head1 SEE ALSO |
1051 | |
1077 | |
1052 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1078 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1053 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1079 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1054 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). |
1080 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
|
|
1081 | event-loop agnostic and portable event driven programming. |
1055 | |
1082 | |
1056 | =head1 AUTHOR |
1083 | =head1 AUTHOR |
1057 | |
1084 | |
1058 | Marc Lehmann <schmorp@schmorp.de> |
1085 | Marc Lehmann <schmorp@schmorp.de> |
1059 | http://home.schmorp.de/ |
1086 | http://home.schmorp.de/ |
1060 | |
1087 | |
1061 | =cut |
1088 | =cut |
1062 | |
1089 | |