… | |
… | |
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, 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. |
|
|
72 | |
|
|
73 | =head2 MODULE EXPORTS |
|
|
74 | |
|
|
75 | This module does not export any symbols. |
65 | |
76 | |
66 | =cut |
77 | =cut |
67 | |
78 | |
68 | package EV; |
79 | package EV; |
69 | |
80 | |
|
|
81 | no warnings; |
70 | use strict; |
82 | use strict; |
71 | |
83 | |
72 | BEGIN { |
84 | BEGIN { |
73 | our $VERSION = '1.8'; |
85 | our $VERSION = '3.45'; |
74 | use XSLoader; |
86 | use XSLoader; |
75 | XSLoader::load "EV", $VERSION; |
87 | XSLoader::load "EV", $VERSION; |
76 | } |
88 | } |
77 | |
89 | |
78 | @EV::IO::ISA = |
90 | @EV::IO::ISA = |
… | |
… | |
84 | @EV::Idle::ISA = |
96 | @EV::Idle::ISA = |
85 | @EV::Prepare::ISA = |
97 | @EV::Prepare::ISA = |
86 | @EV::Check::ISA = |
98 | @EV::Check::ISA = |
87 | @EV::Embed::ISA = |
99 | @EV::Embed::ISA = |
88 | @EV::Fork::ISA = |
100 | @EV::Fork::ISA = |
|
|
101 | @EV::Async::ISA = |
89 | "EV::Watcher"; |
102 | "EV::Watcher"; |
90 | |
103 | |
|
|
104 | @EV::Loop::Default::ISA = "EV::Loop"; |
|
|
105 | |
|
|
106 | =head1 EVENT LOOPS |
|
|
107 | |
|
|
108 | EV supports multiple event loops: There is a single "default event loop" |
|
|
109 | that can handle everything including signals and child watchers, and any |
|
|
110 | number of "dynamic event loops" that can use different backends (with |
|
|
111 | various limitations), but no child and signal watchers. |
|
|
112 | |
|
|
113 | You do not have to do anything to create the default event loop: When |
|
|
114 | the module is loaded a suitable backend is selected on the premise of |
|
|
115 | selecting a working backend (which for example rules out kqueue on most |
|
|
116 | BSDs). Modules should, unless they have "special needs" always use the |
|
|
117 | default loop as this is fastest (perl-wise), best supported by other |
|
|
118 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
|
|
119 | |
|
|
120 | For specific programs you can create additional event loops dynamically. |
|
|
121 | |
|
|
122 | If you want to take avdantage 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 | |
|
|
128 | =over 4 |
|
|
129 | |
|
|
130 | =item $loop = new EV::loop [$flags] |
|
|
131 | |
|
|
132 | Create a new event loop as per the specified flags. Please refer to |
|
|
133 | the C<ev_loop_new ()> function description in the libev documentation |
|
|
134 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
|
|
135 | or locally-installed as F<EV::libev> manpage) for more info. |
|
|
136 | |
|
|
137 | The loop will automatically be destroyed when it is no longer referenced |
|
|
138 | by any watcher and the loop object goes out of scope. |
|
|
139 | |
|
|
140 | If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> |
|
|
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. |
|
|
144 | |
|
|
145 | =item $loop->loop_fork |
|
|
146 | |
|
|
147 | Must be called after a fork in the child, before entering or continuing |
|
|
148 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
|
|
149 | this function automatically, at some performance loss (refer to the libev |
|
|
150 | documentation). |
|
|
151 | |
|
|
152 | =item $loop->loop_verify |
|
|
153 | |
|
|
154 | Calls C<ev_verify> to make internal consistency checks (for debugging |
|
|
155 | libev) and abort the program if any data structures were found to be |
|
|
156 | corrupted. |
|
|
157 | |
|
|
158 | =item $loop = EV::default_loop [$flags] |
|
|
159 | |
|
|
160 | Return the default loop (which is a singleton object). Since this module |
|
|
161 | already creates the default loop with default flags, specifying flags here |
|
|
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. |
|
|
165 | |
|
|
166 | =back |
|
|
167 | |
|
|
168 | |
91 | =head1 BASIC INTERFACE |
169 | =head1 BASIC INTERFACE |
92 | |
170 | |
93 | =over 4 |
171 | =over 4 |
94 | |
172 | |
95 | =item $EV::DIED |
173 | =item $EV::DIED |
96 | |
174 | |
97 | Must contain a reference to a function that is called when a callback |
175 | Must contain a reference to a function that is called when a callback |
98 | throws an exception (with $@ containing thr error). The default prints an |
176 | throws an exception (with $@ containing the error). The default prints an |
99 | informative message and continues. |
177 | informative message and continues. |
100 | |
178 | |
101 | If this callback throws an exception it will be silently ignored. |
179 | If this callback throws an exception it will be silently ignored. |
102 | |
180 | |
|
|
181 | =item $flags = EV::supported_backends |
|
|
182 | |
|
|
183 | =item $flags = EV::recommended_backends |
|
|
184 | |
|
|
185 | =item $flags = EV::embeddable_backends |
|
|
186 | |
|
|
187 | Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this |
|
|
188 | instance of EV, the set of recommended backends (supposed to be good) for |
|
|
189 | this platform and the set of embeddable backends (see EMBED WATCHERS). |
|
|
190 | |
|
|
191 | =item EV::sleep $seconds |
|
|
192 | |
|
|
193 | Block the process for the given number of (fractional) seconds. |
|
|
194 | |
103 | =item $time = EV::time |
195 | =item $time = EV::time |
104 | |
196 | |
105 | Returns the current time in (fractional) seconds since the epoch. |
197 | Returns the current time in (fractional) seconds since the epoch. |
106 | |
198 | |
107 | =item $time = EV::now |
199 | =item $time = EV::now |
|
|
200 | |
|
|
201 | =item $time = $loop->now |
108 | |
202 | |
109 | 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 |
110 | 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 refering to it is |
111 | usually faster then calling EV::time. |
205 | usually faster then calling EV::time. |
112 | |
206 | |
113 | =item $method = EV::method |
207 | =item $backend = EV::backend |
|
|
208 | |
|
|
209 | =item $backend = $loop->backend |
114 | |
210 | |
115 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
211 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
116 | or EV::METHOD_EPOLL). |
212 | or EV::METHOD_EPOLL). |
117 | |
213 | |
118 | =item EV::loop [$flags] |
214 | =item EV::loop [$flags] |
|
|
215 | |
|
|
216 | =item $loop->loop ([$flags]) |
119 | |
217 | |
120 | Begin checking for events and calling callbacks. It returns when a |
218 | Begin checking for events and calling callbacks. It returns when a |
121 | callback calls EV::unloop. |
219 | callback calls EV::unloop. |
122 | |
220 | |
123 | The $flags argument can be one of the following: |
221 | The $flags argument can be one of the following: |
… | |
… | |
126 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
224 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
127 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
225 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
128 | |
226 | |
129 | =item EV::unloop [$how] |
227 | =item EV::unloop [$how] |
130 | |
228 | |
|
|
229 | =item $loop->unloop ([$how]) |
|
|
230 | |
131 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
231 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
132 | innermost call to EV::loop return. |
232 | innermost call to EV::loop return. |
133 | |
233 | |
134 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
234 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
135 | fast as possible. |
235 | fast as possible. |
136 | |
236 | |
137 | =item $count = EV::loop_count |
237 | =item $count = EV::loop_count |
138 | |
238 | |
|
|
239 | =item $count = $loop->loop_count |
|
|
240 | |
139 | 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 |
140 | events. Sometiems useful as a generation counter. |
242 | events. Sometiems useful as a generation counter. |
141 | |
243 | |
142 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
244 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
|
|
245 | |
|
|
246 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
143 | |
247 | |
144 | This function rolls together an I/O and a timer watcher for a single |
248 | This function rolls together an I/O and a timer watcher for a single |
145 | one-shot event without the need for managing a watcher object. |
249 | one-shot event without the need for managing a watcher object. |
146 | |
250 | |
147 | If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> |
251 | If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> |
… | |
… | |
153 | If timeout is C<undef> or negative, then there will be no |
257 | If timeout is C<undef> or negative, then there will be no |
154 | timeout. Otherwise a EV::timer with this value will be started. |
258 | timeout. Otherwise a EV::timer with this value will be started. |
155 | |
259 | |
156 | When an error occurs or either the timeout or I/O watcher triggers, then |
260 | When an error occurs or either the timeout or I/O watcher triggers, then |
157 | the callback will be called with the received event set (in general |
261 | the callback will be called with the received event set (in general |
158 | you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>, |
262 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
159 | C<EV::WRITE> and C<EV::TIMEOUT>). |
263 | C<EV::WRITE> and C<EV::TIMEOUT>). |
160 | |
264 | |
161 | EV::once doesn't return anything: the watchers stay active till either |
265 | EV::once doesn't return anything: the watchers stay active till either |
162 | of them triggers, then they will be stopped and freed, and the callback |
266 | of them triggers, then they will be stopped and freed, and the callback |
163 | invoked. |
267 | invoked. |
164 | |
268 | |
165 | =back |
269 | =item EV::feed_fd_event ($fd, $revents) |
166 | |
270 | |
|
|
271 | =item $loop->feed_fd_event ($fd, $revents) |
|
|
272 | |
|
|
273 | Feed an event on a file descriptor into EV. EV will react to this call as |
|
|
274 | if the readyness notifications specified by C<$revents> (a combination of |
|
|
275 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
|
|
276 | |
|
|
277 | =item EV::feed_signal_event ($signal) |
|
|
278 | |
|
|
279 | Feed a signal event into EV. EV will react to this call as if the signal |
|
|
280 | specified by C<$signal> had occured. |
|
|
281 | |
|
|
282 | =item EV::set_io_collect_interval $time |
|
|
283 | |
|
|
284 | =item $loop->set_io_collect_interval ($time) |
|
|
285 | |
|
|
286 | =item EV::set_timeout_collect_interval $time |
|
|
287 | |
|
|
288 | =item $loop->set_timeout_collect_interval ($time) |
|
|
289 | |
|
|
290 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
|
|
291 | wait interval for timer events. See the libev documentation at |
|
|
292 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
|
|
293 | (locally installed as F<EV::libev>) for a more detailed discussion. |
|
|
294 | |
|
|
295 | =back |
|
|
296 | |
|
|
297 | |
167 | =head2 WATCHER OBJECTS |
298 | =head1 WATCHER OBJECTS |
168 | |
299 | |
169 | 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 |
170 | 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 |
171 | would create an EV::io watcher for that: |
302 | would create an EV::io watcher for that: |
172 | |
303 | |
173 | my $watcher = EV::io *STDIN, EV::READ, sub { |
304 | my $watcher = EV::io *STDIN, EV::READ, sub { |
174 | my ($watcher, $revents) = @_; |
305 | my ($watcher, $revents) = @_; |
175 | warn "yeah, STDIN should not be readable without blocking!\n" |
306 | warn "yeah, STDIN should now be readable without blocking!\n" |
176 | }; |
307 | }; |
177 | |
308 | |
178 | 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 |
179 | active watchers will have their callbacks invoked. All callbacks will be |
310 | active watchers will have their callbacks invoked. All callbacks will be |
180 | 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 |
181 | events. |
312 | events. |
… | |
… | |
253 | The default priority of any newly-created watcher is 0. |
384 | The default priority of any newly-created watcher is 0. |
254 | |
385 | |
255 | Note that the priority semantics have not yet been fleshed out and are |
386 | Note that the priority semantics have not yet been fleshed out and are |
256 | subject to almost certain change. |
387 | subject to almost certain change. |
257 | |
388 | |
258 | =item $w->trigger ($revents) |
389 | =item $w->invoke ($revents) |
259 | |
390 | |
260 | Call the callback *now* with the given event mask. |
391 | Call the callback *now* with the given event mask. |
|
|
392 | |
|
|
393 | =item $w->feed_event ($revents) |
|
|
394 | |
|
|
395 | Feed some events on this watcher into EV. EV will react to this call as if |
|
|
396 | the watcher had received the given C<$revents> mask. |
|
|
397 | |
|
|
398 | =item $revents = $w->clear_pending |
|
|
399 | |
|
|
400 | If the watcher is pending, this function clears its pending status and |
|
|
401 | returns its C<$revents> bitset (as if its callback was invoked). If the |
|
|
402 | watcher isn't pending it does nothing and returns C<0>. |
261 | |
403 | |
262 | =item $previous_state = $w->keepalive ($bool) |
404 | =item $previous_state = $w->keepalive ($bool) |
263 | |
405 | |
264 | Normally, C<EV::loop> will return when there are no active watchers |
406 | Normally, C<EV::loop> will return when there are no active watchers |
265 | (which is a "deadlock" because no progress can be made anymore). This is |
407 | (which is a "deadlock" because no progress can be made anymore). This is |
266 | convinient because it allows you to start your watchers (and your jobs), |
408 | convinient because it allows you to start your watchers (and your jobs), |
267 | call C<EV::loop> once and when it returns you know that all your jobs are |
409 | call C<EV::loop> once and when it returns you know that all your jobs are |
268 | finished (or they forgot to register some watchers for their task :). |
410 | finished (or they forgot to register some watchers for their task :). |
269 | |
411 | |
270 | Sometimes, however, this gets in your way, for example when you the module |
412 | Sometimes, however, this gets in your way, for example when the module |
271 | that calls C<EV::loop> (usually the main program) is not the same module |
413 | that calls C<EV::loop> (usually the main program) is not the same module |
272 | as a long-living watcher (for example a DNS client module written by |
414 | as a long-living watcher (for example a DNS client module written by |
273 | somebody else even). Then you might want any outstanding requests to be |
415 | somebody else even). Then you might want any outstanding requests to be |
274 | handled, but you would not want to keep C<EV::loop> from returning just |
416 | handled, but you would not want to keep C<EV::loop> from returning just |
275 | because you happen to have this long-running UDP port watcher. |
417 | because you happen to have this long-running UDP port watcher. |
… | |
… | |
285 | |
427 | |
286 | my $udp_socket = ... |
428 | my $udp_socket = ... |
287 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
429 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
288 | $udp_watcher->keepalive (0); |
430 | $udp_watcher->keepalive (0); |
289 | |
431 | |
290 | =back |
432 | =item $loop = $w->loop |
291 | |
433 | |
|
|
434 | Return the loop that this watcher is attached to. |
292 | |
435 | |
|
|
436 | =back |
|
|
437 | |
|
|
438 | |
293 | =head2 WATCHER TYPES |
439 | =head1 WATCHER TYPES |
294 | |
440 | |
295 | Each of the following subsections describes a single watcher type. |
441 | Each of the following subsections describes a single watcher type. |
296 | |
442 | |
297 | =head3 I/O WATCHERS - is this file descriptor readable or writable? |
443 | =head3 I/O WATCHERS - is this file descriptor readable or writable? |
298 | |
444 | |
299 | =over 4 |
445 | =over 4 |
300 | |
446 | |
301 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
447 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
302 | |
448 | |
303 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
449 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
|
|
450 | |
|
|
451 | =item $w = $loop->io ($fileno_or_fh, $eventmask, $callback) |
|
|
452 | |
|
|
453 | =item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback) |
304 | |
454 | |
305 | As long as the returned watcher object is alive, call the C<$callback> |
455 | As long as the returned watcher object is alive, call the C<$callback> |
306 | when at least one of events specified in C<$eventmask> occurs. |
456 | when at least one of events specified in C<$eventmask> occurs. |
307 | |
457 | |
308 | The $eventmask can be one or more of these constants ORed together: |
458 | The $eventmask can be one or more of these constants ORed together: |
… | |
… | |
337 | =over 4 |
487 | =over 4 |
338 | |
488 | |
339 | =item $w = EV::timer $after, $repeat, $callback |
489 | =item $w = EV::timer $after, $repeat, $callback |
340 | |
490 | |
341 | =item $w = EV::timer_ns $after, $repeat, $callback |
491 | =item $w = EV::timer_ns $after, $repeat, $callback |
|
|
492 | |
|
|
493 | =item $w = $loop->timer ($after, $repeat, $callback) |
|
|
494 | |
|
|
495 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
342 | |
496 | |
343 | Calls the callback after C<$after> seconds (which may be fractional). If |
497 | Calls the callback after C<$after> seconds (which may be fractional). If |
344 | C<$repeat> is non-zero, the timer will be restarted (with the $repeat |
498 | C<$repeat> is non-zero, the timer will be restarted (with the $repeat |
345 | value as $after) after the callback returns. |
499 | value as $after) after the callback returns. |
346 | |
500 | |
… | |
… | |
387 | =over 4 |
541 | =over 4 |
388 | |
542 | |
389 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
543 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
390 | |
544 | |
391 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
545 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
|
|
546 | |
|
|
547 | =item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback) |
|
|
548 | |
|
|
549 | =item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback) |
392 | |
550 | |
393 | Similar to EV::timer, but is not based on relative timeouts but on |
551 | Similar to EV::timer, but is not based on relative timeouts but on |
394 | absolute times. Apart from creating "simple" timers that trigger "at" the |
552 | absolute times. Apart from creating "simple" timers that trigger "at" the |
395 | specified time, it can also be used for non-drifting absolute timers and |
553 | specified time, it can also be used for non-drifting absolute timers and |
396 | more complex, cron-like, setups that are not adversely affected by time |
554 | more complex, cron-like, setups that are not adversely affected by time |
… | |
… | |
406 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
564 | This time simply fires at the wallclock time C<$at> and doesn't repeat. It |
407 | will not adjust when a time jump occurs, that is, if it is to be run |
565 | will not adjust when a time jump occurs, that is, if it is to be run |
408 | at January 1st 2011 then it will run when the system time reaches or |
566 | at January 1st 2011 then it will run when the system time reaches or |
409 | surpasses this time. |
567 | surpasses this time. |
410 | |
568 | |
411 | =item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) |
569 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
412 | |
570 | |
413 | In this mode the watcher will always be scheduled to time out at the |
571 | In this mode the watcher will always be scheduled to time out at the |
414 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
572 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
415 | regardless of any time jumps. |
573 | regardless of any time jumps. |
416 | |
574 | |
… | |
… | |
434 | time the periodic watcher gets scheduled, the reschedule callback |
592 | time the periodic watcher gets scheduled, the reschedule callback |
435 | ($reschedule_cb) will be called with the watcher as first, and the current |
593 | ($reschedule_cb) will be called with the watcher as first, and the current |
436 | time as second argument. |
594 | time as second argument. |
437 | |
595 | |
438 | I<This callback MUST NOT stop or destroy this or any other periodic |
596 | I<This callback MUST NOT stop or destroy this or any other periodic |
439 | watcher, ever>. If you need to stop it, return 1e30 and stop it |
597 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
440 | afterwards. |
598 | you need to stop it, return 1e30 and stop it afterwards. You may create |
|
|
599 | and start a C<EV::prepare> watcher for this task. |
441 | |
600 | |
442 | It must return the next time to trigger, based on the passed time value |
601 | It must return the next time to trigger, based on the passed time value |
443 | (that is, the lowest time value larger than to the second argument). It |
602 | (that is, the lowest time value larger than or equal to to the second |
444 | will usually be called just before the callback will be triggered, but |
603 | argument). It will usually be called just before the callback will be |
445 | might be called at other times, too. |
604 | triggered, but might be called at other times, too. |
446 | |
605 | |
447 | This can be used to create very complex timers, such as a timer that |
606 | This can be used to create very complex timers, such as a timer that |
448 | triggers on each midnight, local time (actually 24 hours after the last |
607 | triggers on each midnight, local time (actually 24 hours after the last |
449 | midnight, to keep the example simple. If you know a way to do it correctly |
608 | midnight, to keep the example simple. If you know a way to do it correctly |
450 | in about the same space (without requiring elaborate modules), drop me a |
609 | in about the same space (without requiring elaborate modules), drop me a |
… | |
… | |
471 | |
630 | |
472 | =item $w->again |
631 | =item $w->again |
473 | |
632 | |
474 | Simply stops and starts the watcher again. |
633 | Simply stops and starts the watcher again. |
475 | |
634 | |
|
|
635 | =item $time = $w->at |
|
|
636 | |
|
|
637 | Return the time that the watcher is expected to trigger next. |
|
|
638 | |
476 | =back |
639 | =back |
477 | |
640 | |
478 | |
641 | |
479 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
642 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
480 | |
643 | |
… | |
… | |
513 | |
676 | |
514 | =head3 CHILD WATCHERS - watch out for process status changes |
677 | =head3 CHILD WATCHERS - watch out for process status changes |
515 | |
678 | |
516 | =over 4 |
679 | =over 4 |
517 | |
680 | |
518 | =item $w = EV::child $pid, $callback |
681 | =item $w = EV::child $pid, $trace, $callback |
519 | |
682 | |
520 | =item $w = EV::child_ns $pid, $callback |
683 | =item $w = EV::child_ns $pid, $trace, $callback |
521 | |
684 | |
|
|
685 | =item $w = $loop->child ($pid, $trace, $callback) |
|
|
686 | |
|
|
687 | =item $w = $loop->child_ns ($pid, $trace, $callback) |
|
|
688 | |
522 | Call the callback when a status change for pid C<$pid> (or any pid if |
689 | Call the callback when a status change for pid C<$pid> (or any pid |
523 | C<$pid> is 0) has been received. More precisely: when the process receives |
690 | if C<$pid> is 0) has been received (a status change happens when the |
|
|
691 | process terminates or is killed, or, when trace is true, additionally when |
|
|
692 | it is stopped or continued). More precisely: when the process receives |
524 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
693 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
525 | changed/zombie children and call the callback. |
694 | changed/zombie children and call the callback. |
526 | |
695 | |
527 | It is valid (and fully supported) to install a child watcher after a child |
696 | It is valid (and fully supported) to install a child watcher after a child |
528 | has exited but before the event loop has started its next iteration (for |
697 | has exited but before the event loop has started its next iteration (for |
… | |
… | |
535 | You can have as many pid watchers per pid as you want, they will all be |
704 | You can have as many pid watchers per pid as you want, they will all be |
536 | called. |
705 | called. |
537 | |
706 | |
538 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
707 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
539 | |
708 | |
540 | =item $w->set ($pid) |
709 | =item $w->set ($pid, $trace) |
541 | |
710 | |
542 | Reconfigures the watcher, see the constructor above for details. Can be called at |
711 | Reconfigures the watcher, see the constructor above for details. Can be called at |
543 | any time. |
712 | any time. |
544 | |
713 | |
545 | =item $current_pid = $w->pid |
714 | =item $current_pid = $w->pid |
546 | |
715 | |
547 | =item $old_pid = $w->pid ($new_pid) |
|
|
548 | |
|
|
549 | Returns the previously set process id and optionally set a new one. |
716 | Returns the previously set process id and optionally set a new one. |
550 | |
717 | |
551 | =item $exit_status = $w->rstatus |
718 | =item $exit_status = $w->rstatus |
552 | |
719 | |
553 | Return the exit/wait status (as returned by waitpid, see the waitpid entry |
720 | Return the exit/wait status (as returned by waitpid, see the waitpid entry |
… | |
… | |
566 | =over 4 |
733 | =over 4 |
567 | |
734 | |
568 | =item $w = EV::stat $path, $interval, $callback |
735 | =item $w = EV::stat $path, $interval, $callback |
569 | |
736 | |
570 | =item $w = EV::stat_ns $path, $interval, $callback |
737 | =item $w = EV::stat_ns $path, $interval, $callback |
|
|
738 | |
|
|
739 | =item $w = $loop->stat ($path, $interval, $callback) |
|
|
740 | |
|
|
741 | =item $w = $loop->stat_ns ($path, $interval, $callback) |
571 | |
742 | |
572 | Call the callback when a file status change has been detected on |
743 | Call the callback when a file status change has been detected on |
573 | C<$path>. The C<$path> does not need to exist, changing from "path exists" |
744 | C<$path>. The C<$path> does not need to exist, changing from "path exists" |
574 | to "path does not exist" is a status change like any other. |
745 | to "path does not exist" is a status change like any other. |
575 | |
746 | |
… | |
… | |
645 | =over 4 |
816 | =over 4 |
646 | |
817 | |
647 | =item $w = EV::idle $callback |
818 | =item $w = EV::idle $callback |
648 | |
819 | |
649 | =item $w = EV::idle_ns $callback |
820 | =item $w = EV::idle_ns $callback |
|
|
821 | |
|
|
822 | =item $w = $loop->idle ($callback) |
|
|
823 | |
|
|
824 | =item $w = $loop->idle_ns ($callback) |
650 | |
825 | |
651 | Call the callback when there are no other pending watchers of the same or |
826 | Call the callback when there are no other pending watchers of the same or |
652 | higher priority (excluding check, prepare and other idle watchers of the |
827 | higher priority (excluding check, prepare and other idle watchers of the |
653 | same or lower priority, of course). They are called idle watchers because |
828 | same or lower priority, of course). They are called idle watchers because |
654 | when the watcher is the highest priority pending event in the process, the |
829 | when the watcher is the highest priority pending event in the process, the |
… | |
… | |
677 | |
852 | |
678 | =item $w = EV::prepare $callback |
853 | =item $w = EV::prepare $callback |
679 | |
854 | |
680 | =item $w = EV::prepare_ns $callback |
855 | =item $w = EV::prepare_ns $callback |
681 | |
856 | |
|
|
857 | =item $w = $loop->prepare ($callback) |
|
|
858 | |
|
|
859 | =item $w = $loop->prepare_ns ($callback) |
|
|
860 | |
682 | Call the callback just before the process would block. You can still |
861 | Call the callback just before the process would block. You can still |
683 | create/modify any watchers at this point. |
862 | create/modify any watchers at this point. |
684 | |
863 | |
685 | See the EV::check watcher, below, for explanations and an example. |
864 | See the EV::check watcher, below, for explanations and an example. |
686 | |
865 | |
… | |
… | |
694 | =over 4 |
873 | =over 4 |
695 | |
874 | |
696 | =item $w = EV::check $callback |
875 | =item $w = EV::check $callback |
697 | |
876 | |
698 | =item $w = EV::check_ns $callback |
877 | =item $w = EV::check_ns $callback |
|
|
878 | |
|
|
879 | =item $w = $loop->check ($callback) |
|
|
880 | |
|
|
881 | =item $w = $loop->check_ns ($callback) |
699 | |
882 | |
700 | Call the callback just after the process wakes up again (after it has |
883 | Call the callback just after the process wakes up again (after it has |
701 | gathered events), but before any other callbacks have been invoked. |
884 | gathered events), but before any other callbacks have been invoked. |
702 | |
885 | |
703 | This is used to integrate other event-based software into the EV |
886 | This is used to integrate other event-based software into the EV |
… | |
… | |
758 | |
941 | |
759 | =item $w = EV::fork $callback |
942 | =item $w = EV::fork $callback |
760 | |
943 | |
761 | =item $w = EV::fork_ns $callback |
944 | =item $w = EV::fork_ns $callback |
762 | |
945 | |
|
|
946 | =item $w = $loop->fork ($callback) |
|
|
947 | |
|
|
948 | =item $w = $loop->fork_ns ($callback) |
|
|
949 | |
763 | Call the callback before the event loop is resumed in the child process |
950 | Call the callback before the event loop is resumed in the child process |
764 | after a fork. |
951 | after a fork. |
765 | |
952 | |
766 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
953 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
|
|
954 | |
|
|
955 | =back |
|
|
956 | |
|
|
957 | |
|
|
958 | =head3 EMBED WATCHERS - when one backend isn't enough... |
|
|
959 | |
|
|
960 | This is a rather advanced watcher type that lets you embed one event loop |
|
|
961 | into another (currently only IO events are supported in the embedded |
|
|
962 | loop, other types of watchers might be handled in a delayed or incorrect |
|
|
963 | fashion and must not be used). |
|
|
964 | |
|
|
965 | See the libev documentation at |
|
|
966 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
|
|
967 | (locally installed as F<EV::libev>) for more details. |
|
|
968 | |
|
|
969 | In short, this watcher is most useful on BSD systems without working |
|
|
970 | kqueue to still be able to handle a large number of sockets: |
|
|
971 | |
|
|
972 | my $socket_loop; |
|
|
973 | |
|
|
974 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
|
|
975 | if ( |
|
|
976 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
|
|
977 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
|
|
978 | ) { |
|
|
979 | # use kqueue for sockets |
|
|
980 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
|
|
981 | } |
|
|
982 | |
|
|
983 | # use the default loop otherwise |
|
|
984 | $socket_loop ||= EV::default_loop; |
|
|
985 | |
|
|
986 | =over 4 |
|
|
987 | |
|
|
988 | =item $w = EV::embed $otherloop[, $callback] |
|
|
989 | |
|
|
990 | =item $w = EV::embed_ns $otherloop[, $callback] |
|
|
991 | |
|
|
992 | =item $w = $loop->embed ($otherloop[, $callback]) |
|
|
993 | |
|
|
994 | =item $w = $loop->embed_ns ($otherloop[, $callback]) |
|
|
995 | |
|
|
996 | Call the callback when the embedded event loop (C<$otherloop>) has any |
|
|
997 | I/O activity. The C<$callback> is optional: if it is missing, then the |
|
|
998 | embedded event loop will be managed automatically (which is recommended), |
|
|
999 | otherwise you have to invoke C<sweep> yourself. |
|
|
1000 | |
|
|
1001 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1002 | |
|
|
1003 | =back |
|
|
1004 | |
|
|
1005 | =head3 ASYNC WATCHERS - how to wake up another event loop |
|
|
1006 | |
|
|
1007 | Async watchers are provided by EV, but have little use in perl directly, as perl |
|
|
1008 | neither supports threads nor direct access to signal handlers or other |
|
|
1009 | contexts where they could be of value. |
|
|
1010 | |
|
|
1011 | It is, however, possible to use them from the XS level. |
|
|
1012 | |
|
|
1013 | Please see the libev documentation for further details. |
|
|
1014 | |
|
|
1015 | =over 4 |
|
|
1016 | |
|
|
1017 | =item $w = EV::async $callback |
|
|
1018 | |
|
|
1019 | =item $w = EV::async_ns $callback |
|
|
1020 | |
|
|
1021 | =item $w->send |
|
|
1022 | |
|
|
1023 | =item $bool = $w->async_pending |
767 | |
1024 | |
768 | =back |
1025 | =back |
769 | |
1026 | |
770 | |
1027 | |
771 | =head1 PERL SIGNALS |
1028 | =head1 PERL SIGNALS |
… | |
… | |
782 | to be called on every event loop iteration by installing a C<EV::check> |
1039 | to be called on every event loop iteration by installing a C<EV::check> |
783 | watcher: |
1040 | watcher: |
784 | |
1041 | |
785 | my $async_check = EV::check sub { }; |
1042 | my $async_check = EV::check sub { }; |
786 | |
1043 | |
787 | This ensures that perl shortly gets into control for a short time, and |
1044 | This ensures that perl gets into control for a short time to handle any |
788 | also ensures slower overall operation. |
1045 | pending signals, and also ensures (slightly) slower overall operation. |
789 | |
1046 | |
790 | =head1 THREADS |
1047 | =head1 THREADS |
791 | |
1048 | |
792 | Threads are not supported by this module in any way. Perl pseudo-threads |
1049 | Threads are not supported by this module in any way. Perl pseudo-threads |
793 | is evil stuff and must die. As soon as Perl gains real threads I will work |
1050 | is evil stuff and must die. As soon as Perl gains real threads I will work |
… | |
… | |
815 | our $DIED = sub { |
1072 | our $DIED = sub { |
816 | warn "EV: error in callback (ignoring): $@"; |
1073 | warn "EV: error in callback (ignoring): $@"; |
817 | }; |
1074 | }; |
818 | |
1075 | |
819 | default_loop |
1076 | default_loop |
820 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; |
1077 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?'; |
821 | |
1078 | |
822 | 1; |
1079 | 1; |
823 | |
1080 | |
824 | =head1 SEE ALSO |
1081 | =head1 SEE ALSO |
825 | |
1082 | |
826 | L<EV::ADNS> (asynchronous dns), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1083 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
827 | event loop), L<Coro::EV> (efficient coroutines with EV). |
1084 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
|
|
1085 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
|
|
1086 | event-loop agnostic and portable event driven programming. |
828 | |
1087 | |
829 | =head1 AUTHOR |
1088 | =head1 AUTHOR |
830 | |
1089 | |
831 | Marc Lehmann <schmorp@schmorp.de> |
1090 | Marc Lehmann <schmorp@schmorp.de> |
832 | http://home.schmorp.de/ |
1091 | http://home.schmorp.de/ |
833 | |
1092 | |
834 | =cut |
1093 | =cut |
835 | |
1094 | |