… | |
… | |
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 |
… | |
… | |
111 | 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 |
112 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
112 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
113 | |
113 | |
114 | For specific programs you can create additional event loops dynamically. |
114 | For specific programs you can create additional event loops dynamically. |
115 | |
115 | |
|
|
116 | If you want to take avdantage of kqueue (which often works properly for |
|
|
117 | sockets only) even though the default loop doesn't enable it, you can |
|
|
118 | I<embed> a kqueue loop into the default loop: running the default loop |
|
|
119 | will then also service the kqueue loop to some extent. See the example in |
|
|
120 | the section about embed watchers for an example on how to achieve that. |
|
|
121 | |
116 | =over 4 |
122 | =over 4 |
117 | |
123 | |
118 | =item $loop = new EV::loop [$flags] |
124 | =item $loop = new EV::loop [$flags] |
119 | |
125 | |
120 | Create a new event loop as per the specified flags. Please refer to the |
126 | Create a new event loop as per the specified flags. Please refer to the |
… | |
… | |
136 | documentation). |
142 | documentation). |
137 | |
143 | |
138 | =item $loop->loop_verify |
144 | =item $loop->loop_verify |
139 | |
145 | |
140 | Calls C<ev_verify> to make internal consistency checks (for debugging |
146 | 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 |
147 | libev) and abort the program if any data structures were found to be |
142 | corrupted. |
148 | corrupted. |
143 | |
149 | |
144 | =item $loop = EV::default_loop [$flags] |
150 | =item $loop = EV::default_loop [$flags] |
145 | |
151 | |
146 | Return the default loop (which is a singleton object). Since this module |
152 | Return the default loop (which is a singleton object). Since this module |
147 | already creates the default loop with default flags, specifying flags here |
153 | already creates the default loop with default flags, specifying flags here |
148 | will not have any effect unless you destroy the default loop. |
154 | will not have any effect unless you destroy the default loop first, which |
|
|
155 | isn't supported. So in short: don't do it, and if you break it, you get to |
|
|
156 | keep the pieces. |
149 | |
157 | |
150 | =back |
158 | =back |
151 | |
159 | |
152 | |
160 | |
153 | =head1 BASIC INTERFACE |
161 | =head1 BASIC INTERFACE |
… | |
… | |
283 | |
291 | |
284 | A watcher is an object that gets created to record your interest in some |
292 | 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 |
293 | event. For instance, if you want to wait for STDIN to become readable, you |
286 | would create an EV::io watcher for that: |
294 | would create an EV::io watcher for that: |
287 | |
295 | |
288 | my $watcher = EV::io *STDIN, EV::READ, sub { |
296 | my $watcher = EV::io *STDIN, EV::READ, sub { |
289 | my ($watcher, $revents) = @_; |
297 | my ($watcher, $revents) = @_; |
290 | warn "yeah, STDIN should now be readable without blocking!\n" |
298 | warn "yeah, STDIN should now be readable without blocking!\n" |
291 | }; |
299 | }; |
292 | |
300 | |
293 | All watchers can be active (waiting for events) or inactive (paused). Only |
301 | All watchers can be active (waiting for events) or inactive (paused). Only |
294 | active watchers will have their callbacks invoked. All callbacks will be |
302 | 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 |
303 | called with at least two arguments: the watcher and a bitmask of received |
296 | events. |
304 | events. |
… | |
… | |
409 | Example: Register an I/O watcher for some UDP socket but do not keep the |
417 | 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. |
418 | event loop from running just because of that watcher. |
411 | |
419 | |
412 | my $udp_socket = ... |
420 | my $udp_socket = ... |
413 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
421 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
414 | $1000udp_watcher->keepalive (0); |
422 | $udp_watcher->keepalive (0); |
415 | |
423 | |
416 | =item $loop = $w->loop |
424 | =item $loop = $w->loop |
417 | |
425 | |
418 | Return the loop that this watcher is attached to. |
426 | Return the loop that this watcher is attached to. |
419 | |
427 | |
… | |
… | |
951 | for more details. |
959 | for more details. |
952 | |
960 | |
953 | In short, this watcher is most useful on BSD systems without working |
961 | 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: |
962 | kqueue to still be able to handle a large number of sockets: |
955 | |
963 | |
956 | my $socket_loop; |
964 | my $socket_loop; |
957 | |
965 | |
958 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
966 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
959 | if ( |
967 | if ( |
960 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
968 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
961 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
969 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
962 | ) { |
970 | ) { |
963 | # use kqueue for sockets |
971 | # use kqueue for sockets |
964 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
972 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
965 | } |
973 | } |
966 | |
974 | |
967 | # use the default loop otherwise |
975 | # use the default loop otherwise |
968 | $socket_loop ||= EV::default_loop; |
976 | $socket_loop ||= EV::default_loop; |
969 | |
977 | |
970 | =over 4 |
978 | =over 4 |
971 | |
979 | |
972 | =item $w = EV::embed $otherloop, $callback |
980 | =item $w = EV::embed $otherloop, $callback |
973 | |
981 | |
… | |
… | |
1069 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1077 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1070 | event-loop agnostic and portable event driven programming. |
1078 | event-loop agnostic and portable event driven programming. |
1071 | |
1079 | |
1072 | =head1 AUTHOR |
1080 | =head1 AUTHOR |
1073 | |
1081 | |
1074 | Marc Lehmann <schmorp@schmorp.de> |
1082 | Marc Lehmann <schmorp@schmorp.de> |
1075 | http://home.schmorp.de/ |
1083 | http://home.schmorp.de/ |
1076 | |
1084 | |
1077 | =cut |
1085 | =cut |
1078 | |
1086 | |