… | |
… | |
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://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>) for more |
61 | libev itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod> or |
62 | subtle details on watcher semantics or some discussion on the available |
62 | F<perldoc EV::libev>) for more subtle details on watcher semantics or some |
63 | backends, or how to force a specific backend with C<LIBEV_FLAGS>, or just |
63 | discussion on the available backends, or how to force a specific backend |
64 | about in any case 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. |
65 | |
66 | |
66 | This module is very fast and scalable. It is actually so fast that you |
67 | 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 | 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 | 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 | and still be faster than with any other event loop currently supported in |
70 | Perl. |
71 | Perl. |
71 | |
72 | |
|
|
73 | =head2 MODULE EXPORTS |
|
|
74 | |
|
|
75 | This module does not export any symbols. |
|
|
76 | |
72 | =cut |
77 | =cut |
73 | |
78 | |
74 | package EV; |
79 | package EV; |
75 | |
80 | |
|
|
81 | no warnings; |
76 | use strict; |
82 | use strict; |
77 | |
83 | |
78 | BEGIN { |
84 | BEGIN { |
79 | our $VERSION = '3.42'; |
85 | our $VERSION = '3.48'; |
80 | use XSLoader; |
86 | use XSLoader; |
81 | XSLoader::load "EV", $VERSION; |
87 | XSLoader::load "EV", $VERSION; |
82 | } |
88 | } |
83 | |
89 | |
84 | @EV::IO::ISA = |
90 | @EV::IO::ISA = |
… | |
… | |
111 | default loop as this is fastest (perl-wise), best supported by other |
117 | default loop as this is fastest (perl-wise), best supported by other |
112 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
118 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
113 | |
119 | |
114 | For specific programs you can create additional event loops dynamically. |
120 | For specific programs you can create additional event loops dynamically. |
115 | |
121 | |
|
|
122 | If you want to take advantage of kqueue (which often works properly for |
|
|
123 | sockets only) even though the default loop doesn't enable it, you can |
|
|
124 | I<embed> a kqueue loop into the default loop: running the default loop |
|
|
125 | will then also service the kqueue loop to some extent. See the example in |
|
|
126 | the section about embed watchers for an example on how to achieve that. |
|
|
127 | |
116 | =over 4 |
128 | =over 4 |
117 | |
129 | |
118 | =item $loop = new EV::loop [$flags] |
130 | =item $loop = new EV::loop [$flags] |
119 | |
131 | |
120 | Create a new event loop as per the specified flags. Please refer to the |
132 | Create a new event loop as per the specified flags. Please refer to |
121 | C<ev_loop_new ()> function description in the libev documentation |
133 | the C<ev_loop_new ()> function description in the libev documentation |
122 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>) |
134 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
123 | for more info. |
135 | or locally-installed as F<EV::libev> manpage) for more info. |
124 | |
136 | |
125 | The loop will automatically be destroyed when it is no longer referenced |
137 | The loop will automatically be destroyed when it is no longer referenced |
126 | by any watcher and the loop object goes out of scope. |
138 | by any watcher and the loop object goes out of scope. |
127 | |
139 | |
128 | Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop |
140 | If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> |
129 | is protected by this module. |
141 | is recommended, as only the default event loop is protected by this |
|
|
142 | module. If you I<are> embedding this loop in the default loop, this is not |
|
|
143 | necessary, as C<EV::embed> automatically does the right thing on fork. |
130 | |
144 | |
131 | =item $loop->loop_fork |
145 | =item $loop->loop_fork |
132 | |
146 | |
133 | Must be called after a fork in the child, before entering or continuing |
147 | Must be called after a fork in the child, before entering or continuing |
134 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
148 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
… | |
… | |
136 | documentation). |
150 | documentation). |
137 | |
151 | |
138 | =item $loop->loop_verify |
152 | =item $loop->loop_verify |
139 | |
153 | |
140 | Calls C<ev_verify> to make internal consistency checks (for debugging |
154 | 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 |
155 | libev) and abort the program if any data structures were found to be |
142 | corrupted. |
156 | corrupted. |
143 | |
157 | |
144 | =item $loop = EV::default_loop [$flags] |
158 | =item $loop = EV::default_loop [$flags] |
145 | |
159 | |
146 | Return the default loop (which is a singleton object). Since this module |
160 | Return the default loop (which is a singleton object). Since this module |
147 | already creates the default loop with default flags, specifying flags here |
161 | already creates the default loop with default flags, specifying flags here |
148 | will not have any effect unless you destroy the default loop. |
162 | will not have any effect unless you destroy the default loop first, which |
|
|
163 | isn't supported. So in short: don't do it, and if you break it, you get to |
|
|
164 | keep the pieces. |
149 | |
165 | |
150 | =back |
166 | =back |
151 | |
167 | |
152 | |
168 | |
153 | =head1 BASIC INTERFACE |
169 | =head1 BASIC INTERFACE |
… | |
… | |
183 | =item $time = EV::now |
199 | =item $time = EV::now |
184 | |
200 | |
185 | =item $time = $loop->now |
201 | =item $time = $loop->now |
186 | |
202 | |
187 | Returns the time the last event loop iteration has been started. This |
203 | Returns the time the last event loop iteration has been started. This |
188 | is the time that (relative) timers are based on, and refering to it is |
204 | is the time that (relative) timers are based on, and referring to it is |
189 | usually faster then calling EV::time. |
205 | usually faster then calling EV::time. |
190 | |
206 | |
191 | =item $backend = EV::backend |
207 | =item $backend = EV::backend |
192 | |
208 | |
193 | =item $backend = $loop->backend |
209 | =item $backend = $loop->backend |
194 | |
210 | |
195 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
211 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
196 | or EV::METHOD_EPOLL). |
212 | or EV::BACKEND_EPOLL). |
197 | |
213 | |
198 | =item EV::loop [$flags] |
214 | =item EV::loop [$flags] |
199 | |
215 | |
200 | =item $loop->loop ([$flags]) |
216 | =item $loop->loop ([$flags]) |
201 | |
217 | |
… | |
… | |
221 | =item $count = EV::loop_count |
237 | =item $count = EV::loop_count |
222 | |
238 | |
223 | =item $count = $loop->loop_count |
239 | =item $count = $loop->loop_count |
224 | |
240 | |
225 | Return the number of times the event loop has polled for new |
241 | Return the number of times the event loop has polled for new |
226 | events. Sometiems useful as a generation counter. |
242 | events. Sometimes useful as a generation counter. |
227 | |
243 | |
228 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
244 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
229 | |
245 | |
230 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
246 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
231 | |
247 | |
… | |
… | |
271 | |
287 | |
272 | =item $loop->set_timeout_collect_interval ($time) |
288 | =item $loop->set_timeout_collect_interval ($time) |
273 | |
289 | |
274 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
290 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
275 | wait interval for timer events. See the libev documentation at |
291 | wait interval for timer events. See the libev documentation at |
276 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for |
292 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
277 | a more detailed discussion. |
293 | (locally installed as F<EV::libev>) for a more detailed discussion. |
278 | |
294 | |
279 | =back |
295 | =back |
280 | |
296 | |
281 | |
297 | |
282 | =head1 WATCHER OBJECTS |
298 | =head1 WATCHER OBJECTS |
283 | |
299 | |
284 | A watcher is an object that gets created to record your interest in some |
300 | A watcher is an object that gets created to record your interest in some |
285 | event. For instance, if you want to wait for STDIN to become readable, you |
301 | event. For instance, if you want to wait for STDIN to become readable, you |
286 | would create an EV::io watcher for that: |
302 | would create an EV::io watcher for that: |
287 | |
303 | |
288 | my $watcher = EV::io *STDIN, EV::READ, sub { |
304 | my $watcher = EV::io *STDIN, EV::READ, sub { |
289 | my ($watcher, $revents) = @_; |
305 | my ($watcher, $revents) = @_; |
290 | warn "yeah, STDIN should now be readable without blocking!\n" |
306 | warn "yeah, STDIN should now be readable without blocking!\n" |
291 | }; |
307 | }; |
292 | |
308 | |
293 | All watchers can be active (waiting for events) or inactive (paused). Only |
309 | All watchers can be active (waiting for events) or inactive (paused). Only |
294 | active watchers will have their callbacks invoked. All callbacks will be |
310 | active watchers will have their callbacks invoked. All callbacks will be |
295 | called with at least two arguments: the watcher and a bitmask of received |
311 | called with at least two arguments: the watcher and a bitmask of received |
296 | events. |
312 | events. |
297 | |
313 | |
298 | Each watcher type has its associated bit in revents, so you can use the |
314 | Each watcher type has its associated bit in revents, so you can use the |
299 | same callback for multiple watchers. The event mask is named after the |
315 | same callback for multiple watchers. The event mask is named after the |
300 | type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
316 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
301 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
317 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
302 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
318 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
303 | uses EV::TIMEOUT). |
319 | uses EV::TIMEOUT). |
304 | |
320 | |
305 | In the rare case where one wants to create a watcher but not start it at |
321 | In the rare case where one wants to create a watcher but not start it at |
… | |
… | |
401 | because you happen to have this long-running UDP port watcher. |
417 | because you happen to have this long-running UDP port watcher. |
402 | |
418 | |
403 | In this case you can clear the keepalive status, which means that even |
419 | In this case you can clear the keepalive status, which means that even |
404 | though your watcher is active, it won't keep C<EV::loop> from returning. |
420 | though your watcher is active, it won't keep C<EV::loop> from returning. |
405 | |
421 | |
406 | The initial value for keepalive is true (enabled), and you cna change it |
422 | The initial value for keepalive is true (enabled), and you can change it |
407 | any time. |
423 | any time. |
408 | |
424 | |
409 | Example: Register an I/O watcher for some UDP socket but do not keep the |
425 | Example: Register an I/O watcher for some UDP socket but do not keep the |
410 | event loop from running just because of that watcher. |
426 | event loop from running just because of that watcher. |
411 | |
427 | |
412 | my $udp_socket = ... |
428 | my $udp_socket = ... |
413 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
429 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
414 | $1000udp_watcher->keepalive (0); |
430 | $udp_watcher->keepalive (0); |
415 | |
431 | |
416 | =item $loop = $w->loop |
432 | =item $loop = $w->loop |
417 | |
433 | |
418 | Return the loop that this watcher is attached to. |
434 | Return the loop that this watcher is attached to. |
419 | |
435 | |
… | |
… | |
905 | # make the dispatcher handle any new stuff |
921 | # make the dispatcher handle any new stuff |
906 | ... not shown |
922 | ... not shown |
907 | }; |
923 | }; |
908 | |
924 | |
909 | The callbacks of the created watchers will not be called as the watchers |
925 | The callbacks of the created watchers will not be called as the watchers |
910 | are destroyed before this cna happen (remember EV::check gets called |
926 | are destroyed before this can happen (remember EV::check gets called |
911 | first). |
927 | first). |
912 | |
928 | |
913 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
929 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
914 | |
930 | |
915 | =back |
931 | =back |
… | |
… | |
946 | loop, other types of watchers might be handled in a delayed or incorrect |
962 | loop, other types of watchers might be handled in a delayed or incorrect |
947 | fashion and must not be used). |
963 | fashion and must not be used). |
948 | |
964 | |
949 | See the libev documentation at |
965 | See the libev documentation at |
950 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
966 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
951 | for more details. |
967 | (locally installed as F<EV::libev>) for more details. |
952 | |
968 | |
953 | In short, this watcher is most useful on BSD systems without working |
969 | In short, this watcher is most useful on BSD systems without working |
954 | kqueue to still be able to handle a large number of sockets: |
970 | kqueue to still be able to handle a large number of sockets: |
955 | |
971 | |
956 | my $socket_loop; |
972 | my $socket_loop; |
957 | |
973 | |
958 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
974 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
959 | if ( |
975 | if ( |
960 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
976 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
961 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
977 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
962 | ) { |
978 | ) { |
963 | # use kqueue for sockets |
979 | # use kqueue for sockets |
964 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
980 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
965 | } |
981 | } |
966 | |
982 | |
967 | # use the default loop otherwise |
983 | # use the default loop otherwise |
968 | $socket_loop ||= EV::default_loop; |
984 | $socket_loop ||= EV::default_loop; |
969 | |
985 | |
970 | =over 4 |
986 | =over 4 |
971 | |
987 | |
972 | =item $w = EV::embed $otherloop, $callback |
988 | =item $w = EV::embed $otherloop[, $callback] |
973 | |
989 | |
974 | =item $w = EV::embed_ns $otherloop, $callback |
990 | =item $w = EV::embed_ns $otherloop[, $callback] |
975 | |
991 | |
976 | =item $w = $loop->embed ($otherloop, $callback) |
992 | =item $w = $loop->embed ($otherloop[, $callback]) |
977 | |
993 | |
978 | =item $w = $loop->embed_ns ($otherloop, $callback) |
994 | =item $w = $loop->embed_ns ($otherloop[, $callback]) |
979 | |
995 | |
980 | Call the callback when the embedded event loop (C<$otherloop>) has any |
996 | Call the callback when the embedded event loop (C<$otherloop>) has any |
981 | I/O activity. The C<$callback> should alwas be specified as C<undef> in |
997 | I/O activity. The C<$callback> is optional: if it is missing, then the |
982 | this version of EV, which means the embedded event loop will be managed |
998 | embedded event loop will be managed automatically (which is recommended), |
983 | automatically. |
999 | otherwise you have to invoke C<sweep> yourself. |
984 | |
1000 | |
985 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
1001 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
986 | |
1002 | |
987 | =back |
1003 | =back |
988 | |
1004 | |
… | |
… | |
1069 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1085 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1070 | event-loop agnostic and portable event driven programming. |
1086 | event-loop agnostic and portable event driven programming. |
1071 | |
1087 | |
1072 | =head1 AUTHOR |
1088 | =head1 AUTHOR |
1073 | |
1089 | |
1074 | Marc Lehmann <schmorp@schmorp.de> |
1090 | Marc Lehmann <schmorp@schmorp.de> |
1075 | http://home.schmorp.de/ |
1091 | http://home.schmorp.de/ |
1076 | |
1092 | |
1077 | =cut |
1093 | =cut |
1078 | |
1094 | |