… | |
… | |
10 | |
10 | |
11 | my $w = EV::timer 2, 0, sub { |
11 | my $w = EV::timer 2, 0, sub { |
12 | warn "is called after 2s"; |
12 | warn "is called after 2s"; |
13 | }; |
13 | }; |
14 | |
14 | |
15 | my $w = EV::timer 2, 1, sub { |
15 | my $w = EV::timer 2, 2, sub { |
16 | warn "is called roughly every 2s (repeat = 1)"; |
16 | warn "is called roughly every 2s (repeat = 2)"; |
17 | }; |
17 | }; |
18 | |
18 | |
19 | undef $w; # destroy event watcher again |
19 | undef $w; # destroy event watcher again |
20 | |
20 | |
21 | my $w = EV::periodic 0, 60, 0, sub { |
21 | my $w = EV::periodic 0, 60, 0, sub { |
… | |
… | |
23 | }; |
23 | }; |
24 | |
24 | |
25 | # IO |
25 | # IO |
26 | |
26 | |
27 | my $w = EV::io *STDIN, EV::READ, sub { |
27 | my $w = EV::io *STDIN, EV::READ, sub { |
28 | my ($w, $revents) = @_; # all callbacks get the watcher object and event mask |
28 | my ($w, $revents) = @_; # all callbacks receive the watcher and event mask |
29 | warn "stdin is readable, you entered: ", <STDIN>; |
29 | warn "stdin is readable, you entered: ", <STDIN>; |
30 | }; |
30 | }; |
31 | |
31 | |
32 | # SIGNALS |
32 | # SIGNALS |
33 | |
33 | |
34 | my $w = EV::signal 'QUIT', sub { |
34 | my $w = EV::signal 'QUIT', sub { |
35 | warn "sigquit received\n"; |
35 | warn "sigquit received\n"; |
36 | }; |
36 | }; |
37 | |
37 | |
38 | my $w = EV::signal 3, sub { |
|
|
39 | warn "sigquit received (this is GNU/Linux, right?)\n"; |
|
|
40 | }; |
|
|
41 | |
|
|
42 | # CHILD/PID STATUS CHANGES |
38 | # CHILD/PID STATUS CHANGES |
43 | |
39 | |
44 | my $w = EV::child 666, sub { |
40 | my $w = EV::child 666, sub { |
45 | my ($w, $revents) = @_; |
41 | my ($w, $revents) = @_; |
46 | # my $pid = $w->rpid; |
|
|
47 | my $status = $w->rstatus; |
42 | my $status = $w->rstatus; |
48 | }; |
43 | }; |
49 | |
44 | |
50 | # MAINLOOP |
45 | # MAINLOOP |
51 | EV::loop; # loop until EV::loop_done is called |
46 | EV::loop; # loop until EV::unloop is called or all watchers stop |
52 | EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled |
47 | EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled |
53 | EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
48 | EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
54 | |
49 | |
55 | =head1 DESCRIPTION |
50 | =head1 DESCRIPTION |
56 | |
51 | |
57 | This module provides an interface to libev |
52 | This module provides an interface to libev |
58 | (L<http://software.schmorp.de/pkg/libev.html>). |
53 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
|
|
54 | below is comprehensive, one might also consult the documentation of libev |
|
|
55 | itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on |
|
|
56 | watcher semantics or some discussion on the available backends, or how to |
|
|
57 | force a specific backend with C<LIBEV_FLAGS>. |
59 | |
58 | |
60 | =cut |
59 | =cut |
61 | |
60 | |
62 | package EV; |
61 | package EV; |
63 | |
62 | |
64 | use strict; |
63 | use strict; |
65 | |
64 | |
66 | BEGIN { |
65 | BEGIN { |
67 | our $VERSION = '0.7'; |
66 | our $VERSION = '1.3'; |
68 | use XSLoader; |
67 | use XSLoader; |
69 | XSLoader::load "EV", $VERSION; |
68 | XSLoader::load "EV", $VERSION; |
70 | } |
69 | } |
71 | |
70 | |
72 | @EV::Io::ISA = |
71 | @EV::IO::ISA = |
73 | @EV::Timer::ISA = |
72 | @EV::Timer::ISA = |
74 | @EV::Periodic::ISA = |
73 | @EV::Periodic::ISA = |
75 | @EV::Signal::ISA = |
74 | @EV::Signal::ISA = |
76 | @EV::Idle::ISA = |
75 | @EV::Idle::ISA = |
77 | @EV::Prepare::ISA = |
76 | @EV::Prepare::ISA = |
… | |
… | |
98 | |
97 | |
99 | Returns the time the last event loop iteration has been started. This |
98 | Returns the time the last event loop iteration has been started. This |
100 | is the time that (relative) timers are based on, and refering to it is |
99 | is the time that (relative) timers are based on, and refering to it is |
101 | usually faster then calling EV::time. |
100 | usually faster then calling EV::time. |
102 | |
101 | |
103 | =item $method = EV::ev_method |
102 | =item $method = EV::method |
104 | |
103 | |
105 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
104 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
106 | or EV::METHOD_EPOLL). |
105 | or EV::METHOD_EPOLL). |
107 | |
106 | |
108 | =item EV::loop [$flags] |
107 | =item EV::loop [$flags] |
109 | |
108 | |
110 | Begin checking for events and calling callbacks. It returns when a |
109 | Begin checking for events and calling callbacks. It returns when a |
111 | callback calls EV::loop_done. |
110 | callback calls EV::unloop. |
112 | |
111 | |
113 | The $flags argument can be one of the following: |
112 | The $flags argument can be one of the following: |
114 | |
113 | |
115 | 0 as above |
114 | 0 as above |
116 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
115 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
117 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
116 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
118 | |
117 | |
119 | =item EV::loop_done [$how] |
118 | =item EV::unloop [$how] |
120 | |
119 | |
121 | When called with no arguments or an argument of 1, makes the innermost |
120 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
122 | call to EV::loop return. |
121 | innermost call to EV::loop return. |
123 | |
122 | |
124 | When called with an agrument of 2, all calls to EV::loop will return as |
123 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
125 | fast as possible. |
124 | fast as possible. |
|
|
125 | |
|
|
126 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
|
|
127 | |
|
|
128 | This function rolls together an I/O and a timer watcher for a single |
|
|
129 | one-shot event without the need for managing a watcher object. |
|
|
130 | |
|
|
131 | If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> |
|
|
132 | must be a bitset containing either C<EV::READ>, C<EV::WRITE> or C<EV::READ |
|
|
133 | | EV::WRITE>, indicating the type of I/O event you want to wait for. If |
|
|
134 | you do not want to wait for some I/O event, specify C<undef> for |
|
|
135 | C<$fh_or_undef> and C<0> for C<$events>). |
|
|
136 | |
|
|
137 | If timeout is C<undef> or negative, then there will be no |
|
|
138 | timeout. Otherwise a EV::timer with this value will be started. |
|
|
139 | |
|
|
140 | When an error occurs or either the timeout or I/O watcher triggers, then |
|
|
141 | the callback will be called with the received event set (in general |
|
|
142 | you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>, |
|
|
143 | C<EV::WRITE> and C<EV::TIMEOUT>). |
|
|
144 | |
|
|
145 | EV::once doesn't return anything: the watchers stay active till either |
|
|
146 | of them triggers, then they will be stopped and freed, and the callback |
|
|
147 | invoked. |
126 | |
148 | |
127 | =back |
149 | =back |
128 | |
150 | |
129 | =head2 WATCHER |
151 | =head2 WATCHER |
130 | |
152 | |
… | |
… | |
215 | watchers with higher priority will be invoked first. The valid range of |
237 | watchers with higher priority will be invoked first. The valid range of |
216 | priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default |
238 | priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default |
217 | -2). If the priority is outside this range it will automatically be |
239 | -2). If the priority is outside this range it will automatically be |
218 | normalised to the nearest valid priority. |
240 | normalised to the nearest valid priority. |
219 | |
241 | |
220 | The default priority of any newly-created weatcher is 0. |
242 | The default priority of any newly-created watcher is 0. |
|
|
243 | |
|
|
244 | Note that the priority semantics have not yet been fleshed out and are |
|
|
245 | subject to almost certain change. |
221 | |
246 | |
222 | =item $w->trigger ($revents) |
247 | =item $w->trigger ($revents) |
223 | |
248 | |
224 | Call the callback *now* with the given event mask. |
249 | Call the callback *now* with the given event mask. |
225 | |
250 | |
|
|
251 | =item $previous_state = $w->keepalive ($bool) |
|
|
252 | |
|
|
253 | Normally, C<EV::loop> will return when there are no active watchers |
|
|
254 | (which is a "deadlock" because no progress can be made anymore). This is |
|
|
255 | convinient because it allows you to start your watchers (and your jobs), |
|
|
256 | call C<EV::loop> once and when it returns you know that all your jobs are |
|
|
257 | finished (or they forgot to register some watchers for their task :). |
|
|
258 | |
|
|
259 | Sometimes, however, this gets in your way, for example when you the module |
|
|
260 | that calls C<EV::loop> (usually the main program) is not the same module |
|
|
261 | as a long-living watcher (for example a DNS client module written by |
|
|
262 | somebody else even). Then you might want any outstanding requests to be |
|
|
263 | handled, but you would not want to keep C<EV::loop> from returning just |
|
|
264 | because you happen to have this long-running UDP port watcher. |
|
|
265 | |
|
|
266 | In this case you can clear the keepalive status, which means that even |
|
|
267 | though your watcher is active, it won't keep C<EV::loop> from returning. |
|
|
268 | |
|
|
269 | The initial value for keepalive is true (enabled), and you cna change it |
|
|
270 | any time. |
|
|
271 | |
|
|
272 | Example: Register an IO watcher for some UDP socket but do not keep the |
|
|
273 | event loop from running just because of that watcher. |
|
|
274 | |
|
|
275 | my $udp_socket = ... |
|
|
276 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
|
|
277 | $udp_watcher->keepalive (0); |
226 | |
278 | |
227 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
279 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
228 | |
280 | |
229 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
281 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
230 | |
282 | |
… | |
… | |
263 | Calls the callback after C<$after> seconds. If C<$repeat> is non-zero, |
315 | Calls the callback after C<$after> seconds. If C<$repeat> is non-zero, |
264 | the timer will be restarted (with the $repeat value as $after) after the |
316 | the timer will be restarted (with the $repeat value as $after) after the |
265 | callback returns. |
317 | callback returns. |
266 | |
318 | |
267 | This means that the callback would be called roughly after C<$after> |
319 | This means that the callback would be called roughly after C<$after> |
268 | seconds, and then every C<$repeat> seconds. "Roughly" because the time of |
320 | seconds, and then every C<$repeat> seconds. The timer does his best not |
269 | callback processing is not taken into account, so the timer will slowly |
321 | to drift, but it will not invoke the timer more often then once per event |
270 | drift. If that isn't acceptable, look at EV::periodic. |
322 | loop iteration, and might drift in other cases. If that isn't acceptable, |
|
|
323 | look at EV::periodic, which can provide long-term stable timers. |
271 | |
324 | |
272 | The timer is based on a monotonic clock, that is if somebody is sitting |
325 | The timer is based on a monotonic clock, that is, if somebody is sitting |
273 | in front of the machine while the timer is running and changes the system |
326 | in front of the machine while the timer is running and changes the system |
274 | clock, the timer will nevertheless run (roughly) the same time. |
327 | clock, the timer will nevertheless run (roughly) the same time. |
275 | |
328 | |
276 | The C<timer_ns> variant doesn't start (activate) the newly created watcher. |
329 | The C<timer_ns> variant doesn't start (activate) the newly created watcher. |
277 | |
330 | |
… | |
… | |
282 | |
335 | |
283 | =item $w->again |
336 | =item $w->again |
284 | |
337 | |
285 | Similar to the C<start> method, but has special semantics for repeating timers: |
338 | Similar to the C<start> method, but has special semantics for repeating timers: |
286 | |
339 | |
|
|
340 | If the timer is active and non-repeating, it will be stopped. |
|
|
341 | |
287 | If the timer is active and repeating, reset the timeout to occur |
342 | If the timer is active and repeating, reset the timeout to occur |
288 | C<$repeat> seconds after now. |
343 | C<$repeat> seconds after now. |
289 | |
344 | |
290 | If the timer is active and non-repeating, it will be stopped. |
|
|
291 | |
|
|
292 | If the timer is in active and repeating, start it. |
345 | If the timer is inactive and repeating, start it using the repeat value. |
293 | |
346 | |
294 | Otherwise do nothing. |
347 | Otherwise do nothing. |
295 | |
348 | |
296 | This behaviour is useful when you have a timeout for some IO |
349 | This behaviour is useful when you have a timeout for some IO |
297 | operation. You create a timer object with the same value for C<$after> and |
350 | operation. You create a timer object with the same value for C<$after> and |
… | |
… | |
341 | possible time where C<$time = $at (mod $interval)>, regardless of any time |
394 | possible time where C<$time = $at (mod $interval)>, regardless of any time |
342 | jumps. |
395 | jumps. |
343 | |
396 | |
344 | =item * manual reschedule mode ($reschedule_cb = coderef) |
397 | =item * manual reschedule mode ($reschedule_cb = coderef) |
345 | |
398 | |
346 | In this mode $interval and $at are both being ignored. Instead, each time |
399 | In this mode $interval and $at are both being ignored. Instead, each |
347 | the periodic watcher gets scheduled, the first callback ($reschedule_cb) |
400 | time the periodic watcher gets scheduled, the reschedule callback |
348 | will be called with the watcher as first, and the current time as second |
401 | ($reschedule_cb) will be called with the watcher as first, and the current |
349 | argument. |
402 | time as second argument. |
350 | |
403 | |
351 | I<This callback MUST NOT stop or destroy this or any other periodic |
404 | I<This callback MUST NOT stop or destroy this or any other periodic |
352 | watcher, ever>. If you need to stop it, return 1e30 and stop it |
405 | watcher, ever>. If you need to stop it, return 1e30 and stop it |
353 | afterwards. |
406 | afterwards. |
354 | |
407 | |
… | |
… | |
497 | # do nothing unless active |
550 | # do nothing unless active |
498 | $dispatcher->{_event_queue_h} |
551 | $dispatcher->{_event_queue_h} |
499 | or return; |
552 | or return; |
500 | |
553 | |
501 | # make the dispatcher handle any outstanding stuff |
554 | # make the dispatcher handle any outstanding stuff |
|
|
555 | ... not shown |
502 | |
556 | |
503 | # create an IO watcher for each and every socket |
557 | # create an IO watcher for each and every socket |
504 | @snmp_watcher = ( |
558 | @snmp_watcher = ( |
505 | (map { EV::io $_, EV::READ, sub { } } |
559 | (map { EV::io $_, EV::READ, sub { } } |
506 | keys %{ $dispatcher->{_descriptors} }), |
560 | keys %{ $dispatcher->{_descriptors} }), |
|
|
561 | |
|
|
562 | EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE] |
|
|
563 | ? $event->[Net::SNMP::Dispatcher::_TIME] - EV::now : 0), |
|
|
564 | 0, sub { }, |
507 | ); |
565 | ); |
508 | |
|
|
509 | # if there are any timeouts, also create a timer |
|
|
510 | push @snmp_watcher, EV::timer $event->[Net::SNMP::Dispatcher::_TIME] - EV::now, 0, sub { } |
|
|
511 | if $event->[Net::SNMP::Dispatcher::_ACTIVE]; |
|
|
512 | }; |
566 | }; |
513 | |
567 | |
514 | The callbacks are irrelevant, the only purpose of those watchers is |
568 | The callbacks are irrelevant (and are not even being called), the |
515 | to wake up the process as soon as one of those events occurs (socket |
569 | only purpose of those watchers is to wake up the process as soon as |
516 | readable, or timer timed out). The corresponding EV::check watcher will then |
570 | one of those events occurs (socket readable, or timer timed out). The |
517 | clean up: |
571 | corresponding EV::check watcher will then clean up: |
518 | |
572 | |
519 | our $snmp_check = EV::check sub { |
573 | our $snmp_check = EV::check sub { |
520 | # destroy all watchers |
574 | # destroy all watchers |
521 | @snmp_watcher = (); |
575 | @snmp_watcher = (); |
522 | |
576 | |
523 | # make the dispatcher handle any new stuff |
577 | # make the dispatcher handle any new stuff |
|
|
578 | ... not shown |
524 | }; |
579 | }; |
525 | |
580 | |
526 | The callbacks of the created watchers will not be called as the watchers |
581 | The callbacks of the created watchers will not be called as the watchers |
527 | are destroyed before this cna happen (remember EV::check gets called |
582 | are destroyed before this cna happen (remember EV::check gets called |
528 | first). |
583 | first). |
… | |
… | |
531 | |
586 | |
532 | =back |
587 | =back |
533 | |
588 | |
534 | =head1 THREADS |
589 | =head1 THREADS |
535 | |
590 | |
536 | Threads are not supported by this in any way. Perl pseudo-threads is evil |
591 | Threads are not supported by this module in any way. Perl pseudo-threads |
537 | stuff and must die. |
592 | is evil stuff and must die. As soon as Perl gains real threads I will work |
|
|
593 | on thread support for it. |
|
|
594 | |
|
|
595 | =head1 FORK |
|
|
596 | |
|
|
597 | Most of the "improved" event delivering mechanisms of modern operating |
|
|
598 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
|
|
599 | not supported and usually destructive). Libev makes it possible to work |
|
|
600 | around this by having a function that recreates the kernel state after |
|
|
601 | fork in the child. |
|
|
602 | |
|
|
603 | On non-win32 platforms, this module requires the pthread_atfork |
|
|
604 | functionality to do this automatically for you. This function is quite |
|
|
605 | buggy on most BSDs, though, so YMMV. The overhead for this is quite |
|
|
606 | negligible, because everything the function currently does is set a flag |
|
|
607 | that is checked only when the event loop gets used the next time, so when |
|
|
608 | you do fork but not use EV, the overhead is minimal. |
|
|
609 | |
|
|
610 | On win32, there is no notion of fork so all this doesn't apply, of course. |
538 | |
611 | |
539 | =cut |
612 | =cut |
540 | |
613 | |
541 | our $DIED = sub { |
614 | our $DIED = sub { |
542 | warn "EV: error in callback (ignoring): $@"; |
615 | warn "EV: error in callback (ignoring): $@"; |
… | |
… | |
547 | |
620 | |
548 | 1; |
621 | 1; |
549 | |
622 | |
550 | =head1 SEE ALSO |
623 | =head1 SEE ALSO |
551 | |
624 | |
552 | L<EV::DNS>, L<EV::AnyEvent>. |
625 | L<EV::DNS>. |
553 | |
626 | |
554 | =head1 AUTHOR |
627 | =head1 AUTHOR |
555 | |
628 | |
556 | Marc Lehmann <schmorp@schmorp.de> |
629 | Marc Lehmann <schmorp@schmorp.de> |
557 | http://home.schmorp.de/ |
630 | http://home.schmorp.de/ |