… | |
… | |
38 | # CHILD/PID STATUS CHANGES |
38 | # CHILD/PID STATUS CHANGES |
39 | |
39 | |
40 | my $w = EV::child 666, sub { |
40 | my $w = EV::child 666, sub { |
41 | my ($w, $revents) = @_; |
41 | my ($w, $revents) = @_; |
42 | my $status = $w->rstatus; |
42 | my $status = $w->rstatus; |
|
|
43 | }; |
|
|
44 | |
|
|
45 | # STAT CHANGES |
|
|
46 | my $w = EV::stat "/etc/passwd", 10, sub { |
|
|
47 | my ($w, $revents) = @_; |
|
|
48 | warn $w->path, " has changed somehow.\n"; |
43 | }; |
49 | }; |
44 | |
50 | |
45 | # MAINLOOP |
51 | # MAINLOOP |
46 | 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 |
47 | 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 |
… | |
… | |
61 | package EV; |
67 | package EV; |
62 | |
68 | |
63 | use strict; |
69 | use strict; |
64 | |
70 | |
65 | BEGIN { |
71 | BEGIN { |
66 | our $VERSION = '1.3'; |
72 | our $VERSION = '1.5'; |
67 | use XSLoader; |
73 | use XSLoader; |
68 | XSLoader::load "EV", $VERSION; |
74 | XSLoader::load "EV", $VERSION; |
69 | } |
75 | } |
70 | |
76 | |
71 | @EV::IO::ISA = |
77 | @EV::IO::ISA = |
72 | @EV::Timer::ISA = |
78 | @EV::Timer::ISA = |
73 | @EV::Periodic::ISA = |
79 | @EV::Periodic::ISA = |
74 | @EV::Signal::ISA = |
80 | @EV::Signal::ISA = |
|
|
81 | @EV::Child::ISA = |
|
|
82 | @EV::Stat::ISA = |
75 | @EV::Idle::ISA = |
83 | @EV::Idle::ISA = |
76 | @EV::Prepare::ISA = |
84 | @EV::Prepare::ISA = |
77 | @EV::Check::ISA = |
85 | @EV::Check::ISA = |
78 | @EV::Child::ISA = "EV::Watcher"; |
86 | @EV::Embed::ISA = |
|
|
87 | @EV::Fork::ISA = |
|
|
88 | "EV::Watcher"; |
79 | |
89 | |
80 | =head1 BASIC INTERFACE |
90 | =head1 BASIC INTERFACE |
81 | |
91 | |
82 | =over 4 |
92 | =over 4 |
83 | |
93 | |
… | |
… | |
146 | of them triggers, then they will be stopped and freed, and the callback |
156 | of them triggers, then they will be stopped and freed, and the callback |
147 | invoked. |
157 | invoked. |
148 | |
158 | |
149 | =back |
159 | =back |
150 | |
160 | |
151 | =head2 WATCHER |
161 | =head2 WATCHER OBJECTS |
152 | |
162 | |
153 | A watcher is an object that gets created to record your interest in some |
163 | A watcher is an object that gets created to record your interest in some |
154 | event. For instance, if you want to wait for STDIN to become readable, you |
164 | event. For instance, if you want to wait for STDIN to become readable, you |
155 | would create an EV::io watcher for that: |
165 | would create an EV::io watcher for that: |
156 | |
166 | |
… | |
… | |
181 | |
191 | |
182 | Also, all methods changing some aspect of a watcher (->set, ->priority, |
192 | Also, all methods changing some aspect of a watcher (->set, ->priority, |
183 | ->fh and so on) automatically stop and start it again if it is active, |
193 | ->fh and so on) automatically stop and start it again if it is active, |
184 | which means pending events get lost. |
194 | which means pending events get lost. |
185 | |
195 | |
186 | =head2 WATCHER TYPES |
196 | =head2 COMMON WATCHER METHODS |
187 | |
197 | |
188 | Now lets move to the existing watcher types and asociated methods. |
198 | This section lists methods common to all watchers. |
189 | |
|
|
190 | The following methods are available for all watchers. Then followes a |
|
|
191 | description of each watcher constructor (EV::io, EV::timer, EV::periodic, |
|
|
192 | EV::signal, EV::child, EV::idle, EV::prepare and EV::check), followed by |
|
|
193 | any type-specific methods (if any). |
|
|
194 | |
199 | |
195 | =over 4 |
200 | =over 4 |
196 | |
201 | |
197 | =item $w->start |
202 | =item $w->start |
198 | |
203 | |
… | |
… | |
274 | |
279 | |
275 | my $udp_socket = ... |
280 | my $udp_socket = ... |
276 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
281 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
277 | $udp_watcher->keepalive (0); |
282 | $udp_watcher->keepalive (0); |
278 | |
283 | |
|
|
284 | =back |
|
|
285 | |
|
|
286 | |
|
|
287 | =head2 WATCHER TYPES |
|
|
288 | |
|
|
289 | Each of the following subsections describes a single watcher type. |
|
|
290 | |
|
|
291 | =head3 IO WATCHERS - is this file descriptor readable or writable? |
|
|
292 | |
|
|
293 | =over 4 |
|
|
294 | |
279 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
295 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
280 | |
296 | |
281 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
297 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
282 | |
298 | |
283 | As long as the returned watcher object is alive, call the C<$callback> |
299 | As long as the returned watcher object is alive, call the C<$callback> |
284 | when the events specified in C<$eventmask>. |
300 | when at least one of events specified in C<$eventmask> occurs. |
285 | |
301 | |
286 | The $eventmask can be one or more of these constants ORed together: |
302 | The $eventmask can be one or more of these constants ORed together: |
287 | |
303 | |
288 | EV::READ wait until read() wouldn't block anymore |
304 | EV::READ wait until read() wouldn't block anymore |
289 | EV::WRITE wait until write() wouldn't block anymore |
305 | EV::WRITE wait until write() wouldn't block anymore |
… | |
… | |
305 | |
321 | |
306 | =item $old_eventmask = $w->events ($new_eventmask) |
322 | =item $old_eventmask = $w->events ($new_eventmask) |
307 | |
323 | |
308 | Returns the previously set event mask and optionally set a new one. |
324 | Returns the previously set event mask and optionally set a new one. |
309 | |
325 | |
|
|
326 | =back |
|
|
327 | |
|
|
328 | |
|
|
329 | =head3 TIMER WATCHERS - relative and optionally repeating timeouts |
|
|
330 | |
|
|
331 | =over 4 |
310 | |
332 | |
311 | =item $w = EV::timer $after, $repeat, $callback |
333 | =item $w = EV::timer $after, $repeat, $callback |
312 | |
334 | |
313 | =item $w = EV::timer_ns $after, $repeat, $callback |
335 | =item $w = EV::timer_ns $after, $repeat, $callback |
314 | |
336 | |
… | |
… | |
328 | |
350 | |
329 | The C<timer_ns> variant doesn't start (activate) the newly created watcher. |
351 | The C<timer_ns> variant doesn't start (activate) the newly created watcher. |
330 | |
352 | |
331 | =item $w->set ($after, $repeat) |
353 | =item $w->set ($after, $repeat) |
332 | |
354 | |
333 | Reconfigures the watcher, see the constructor above for details. Can be at |
355 | Reconfigures the watcher, see the constructor above for details. Can be called at |
334 | any time. |
356 | any time. |
335 | |
357 | |
336 | =item $w->again |
358 | =item $w->again |
337 | |
359 | |
338 | Similar to the C<start> method, but has special semantics for repeating timers: |
360 | Similar to the C<start> method, but has special semantics for repeating timers: |
… | |
… | |
349 | This behaviour is useful when you have a timeout for some IO |
371 | This behaviour is useful when you have a timeout for some IO |
350 | operation. You create a timer object with the same value for C<$after> and |
372 | operation. You create a timer object with the same value for C<$after> and |
351 | C<$repeat>, and then, in the read/write watcher, run the C<again> method |
373 | C<$repeat>, and then, in the read/write watcher, run the C<again> method |
352 | on the timeout. |
374 | on the timeout. |
353 | |
375 | |
|
|
376 | =back |
|
|
377 | |
|
|
378 | |
|
|
379 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
|
|
380 | |
|
|
381 | =over 4 |
354 | |
382 | |
355 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
383 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
356 | |
384 | |
357 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
385 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
358 | |
386 | |
… | |
… | |
430 | |
458 | |
431 | The C<periodic_ns> variant doesn't start (activate) the newly created watcher. |
459 | The C<periodic_ns> variant doesn't start (activate) the newly created watcher. |
432 | |
460 | |
433 | =item $w->set ($at, $interval, $reschedule_cb) |
461 | =item $w->set ($at, $interval, $reschedule_cb) |
434 | |
462 | |
435 | Reconfigures the watcher, see the constructor above for details. Can be at |
463 | Reconfigures the watcher, see the constructor above for details. Can be called at |
436 | any time. |
464 | any time. |
437 | |
465 | |
438 | =item $w->again |
466 | =item $w->again |
439 | |
467 | |
440 | Simply stops and starts the watcher again. |
468 | Simply stops and starts the watcher again. |
441 | |
469 | |
|
|
470 | =back |
|
|
471 | |
|
|
472 | |
|
|
473 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
|
|
474 | |
|
|
475 | =over 4 |
442 | |
476 | |
443 | =item $w = EV::signal $signal, $callback |
477 | =item $w = EV::signal $signal, $callback |
444 | |
478 | |
445 | =item $w = EV::signal_ns $signal, $callback |
479 | =item $w = EV::signal_ns $signal, $callback |
446 | |
480 | |
447 | Call the callback when $signal is received (the signal can be specified |
481 | Call the callback when $signal is received (the signal can be specified by |
448 | by number or by name, just as with kill or %SIG). |
482 | number or by name, just as with C<kill> or C<%SIG>). |
449 | |
483 | |
450 | EV will grab the signal for the process (the kernel only allows one |
484 | EV will grab the signal for the process (the kernel only allows one |
451 | component to receive a signal at a time) when you start a signal watcher, |
485 | component to receive a signal at a time) when you start a signal watcher, |
452 | and removes it again when you stop it. Perl does the same when you |
486 | and removes it again when you stop it. Perl does the same when you |
453 | add/remove callbacks to %SIG, so watch out. |
487 | add/remove callbacks to C<%SIG>, so watch out. |
454 | |
488 | |
455 | You can have as many signal watchers per signal as you want. |
489 | You can have as many signal watchers per signal as you want. |
456 | |
490 | |
457 | The C<signal_ns> variant doesn't start (activate) the newly created watcher. |
491 | The C<signal_ns> variant doesn't start (activate) the newly created watcher. |
458 | |
492 | |
459 | =item $w->set ($signal) |
493 | =item $w->set ($signal) |
460 | |
494 | |
461 | Reconfigures the watcher, see the constructor above for details. Can be at |
495 | Reconfigures the watcher, see the constructor above for details. Can be |
462 | any time. |
496 | called at any time. |
463 | |
497 | |
464 | =item $current_signum = $w->signal |
498 | =item $current_signum = $w->signal |
465 | |
499 | |
466 | =item $old_signum = $w->signal ($new_signal) |
500 | =item $old_signum = $w->signal ($new_signal) |
467 | |
501 | |
468 | Returns the previously set signal (always as a number not name) and |
502 | Returns the previously set signal (always as a number not name) and |
469 | optionally set a new one. |
503 | optionally set a new one. |
470 | |
504 | |
|
|
505 | =back |
|
|
506 | |
|
|
507 | |
|
|
508 | =head3 CHILD WATCHERS - watch out for process status changes |
|
|
509 | |
|
|
510 | =over 4 |
471 | |
511 | |
472 | =item $w = EV::child $pid, $callback |
512 | =item $w = EV::child $pid, $callback |
473 | |
513 | |
474 | =item $w = EV::child_ns $pid, $callback |
514 | =item $w = EV::child_ns $pid, $callback |
475 | |
515 | |
476 | Call the callback when a status change for pid C<$pid> (or any pid |
516 | Call the callback when a status change for pid C<$pid> (or any pid if |
477 | if C<$pid> is 0) has been received. More precisely: when the process |
517 | C<$pid> is 0) has been received. More precisely: when the process receives |
478 | receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all |
518 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
479 | changed/zombie children and call the callback. |
519 | changed/zombie children and call the callback. |
480 | |
520 | |
481 | You can access both status and pid by using the C<rstatus> and C<rpid> |
521 | It is valid (and fully supported) to install a child watcher after a child |
482 | methods on the watcher object. |
522 | has exited but before the event loop has started its next iteration (for |
|
|
523 | example, first you C<fork>, then the new child process might exit, and |
|
|
524 | only then do you install a child watcher in the parent for the new pid). |
483 | |
525 | |
|
|
526 | You can access both exit (or tracing) status and pid by using the |
|
|
527 | C<rstatus> and C<rpid> methods on the watcher object. |
|
|
528 | |
484 | You can have as many pid watchers per pid as you want. |
529 | You can have as many pid watchers per pid as you want, they will all be |
|
|
530 | called. |
485 | |
531 | |
486 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
532 | The C<child_ns> variant doesn't start (activate) the newly created watcher. |
487 | |
533 | |
488 | =item $w->set ($pid) |
534 | =item $w->set ($pid) |
489 | |
535 | |
490 | Reconfigures the watcher, see the constructor above for details. Can be at |
536 | Reconfigures the watcher, see the constructor above for details. Can be called at |
491 | any time. |
537 | any time. |
492 | |
538 | |
493 | =item $current_pid = $w->pid |
539 | =item $current_pid = $w->pid |
494 | |
540 | |
495 | =item $old_pid = $w->pid ($new_pid) |
541 | =item $old_pid = $w->pid ($new_pid) |
… | |
… | |
504 | =item $pid = $w->rpid |
550 | =item $pid = $w->rpid |
505 | |
551 | |
506 | Return the pid of the awaited child (useful when you have installed a |
552 | Return the pid of the awaited child (useful when you have installed a |
507 | watcher for all pids). |
553 | watcher for all pids). |
508 | |
554 | |
|
|
555 | =back |
|
|
556 | |
|
|
557 | |
|
|
558 | =head3 STAT WATCHERS - did the file attributes just change? |
|
|
559 | |
|
|
560 | =over 4 |
|
|
561 | |
|
|
562 | =item $w = EV::stat $path, $interval, $callback |
|
|
563 | |
|
|
564 | =item $w = EV::stat_ns $path, $interval, $callback |
|
|
565 | |
|
|
566 | Call the callback when a file status change has been detected on |
|
|
567 | C<$path>. The C<$path> does not need to exist, changing from "path exists" |
|
|
568 | to "path does not exist" is a status change like any other. |
|
|
569 | |
|
|
570 | The C<$interval> is a recommended polling interval for systems where |
|
|
571 | OS-supported change notifications don't exist or are not supported. If |
|
|
572 | you use C<0> then an unspecified default is used (which is highly |
|
|
573 | recommended!), which is to be expected to be around five seconds usually. |
|
|
574 | |
|
|
575 | This watcher type is not meant for massive numbers of stat watchers, |
|
|
576 | as even with OS-supported change notifications, this can be |
|
|
577 | resource-intensive. |
|
|
578 | |
|
|
579 | The C<stat_ns> variant doesn't start (activate) the newly created watcher. |
|
|
580 | |
|
|
581 | =item ... = $w->stat |
|
|
582 | |
|
|
583 | This call is very similar to the perl C<stat> built-in: It stats (using |
|
|
584 | C<lstat>) the path specified in the watcher and sets perls stat cache (as |
|
|
585 | well as EV's idea of the current stat values) to the values found. |
|
|
586 | |
|
|
587 | In scalar context, a boolean is return indicating success or failure of |
|
|
588 | the stat. In list context, the same 13-value list as with stat is returned |
|
|
589 | (except that the blksize and blocks fields are not reliable). |
|
|
590 | |
|
|
591 | In the case of an error, errno is set to C<ENOENT> (regardless of the |
|
|
592 | actual error value) and the C<nlink> value is forced to zero (if the stat |
|
|
593 | was successful then nlink is guaranteed to be non-zero). |
|
|
594 | |
|
|
595 | See also the next two entries for more info. |
|
|
596 | |
|
|
597 | =item ... = $w->attr |
|
|
598 | |
|
|
599 | Just like C<< $w->stat >>, but without the initial stat'ing: this returns |
|
|
600 | the values most recently detected by EV. See the next entry for more info. |
|
|
601 | |
|
|
602 | =item ... = $w->prev |
|
|
603 | |
|
|
604 | Just like C<< $w->stat >>, but without the initial stat'ing: this returns |
|
|
605 | the previous set of values, before the change. |
|
|
606 | |
|
|
607 | That is, when the watcher callback is invoked, C<< $w->prev >> will be set |
|
|
608 | to the values found I<before> a change was detected, while C<< $w->attr >> |
|
|
609 | returns the values found leading to the change detection. The difference (if any) |
|
|
610 | between C<prev> and C<attr> is what triggered the callback. |
|
|
611 | |
|
|
612 | If you did something to the filesystem object and do not want to trigger |
|
|
613 | yet another change, you can call C<stat> to update EV's idea of what the |
|
|
614 | current attributes are. |
|
|
615 | |
|
|
616 | =item $w->set ($path, $interval) |
|
|
617 | |
|
|
618 | Reconfigures the watcher, see the constructor above for details. Can be |
|
|
619 | called at any time. |
|
|
620 | |
|
|
621 | =item $current_path = $w->path |
|
|
622 | |
|
|
623 | =item $old_path = $w->path ($new_path) |
|
|
624 | |
|
|
625 | Returns the previously set path and optionally set a new one. |
|
|
626 | |
|
|
627 | =item $current_interval = $w->interval |
|
|
628 | |
|
|
629 | =item $old_interval = $w->interval ($new_interval) |
|
|
630 | |
|
|
631 | Returns the previously set interval and optionally set a new one. Can be |
|
|
632 | used to query the actual interval used. |
|
|
633 | |
|
|
634 | =back |
|
|
635 | |
|
|
636 | |
|
|
637 | =head3 IDLE WATCHERS - when you've got nothing better to do... |
|
|
638 | |
|
|
639 | =over 4 |
509 | |
640 | |
510 | =item $w = EV::idle $callback |
641 | =item $w = EV::idle $callback |
511 | |
642 | |
512 | =item $w = EV::idle_ns $callback |
643 | =item $w = EV::idle_ns $callback |
513 | |
644 | |
… | |
… | |
517 | The process will not block as long as any idle watchers are active, and |
648 | The process will not block as long as any idle watchers are active, and |
518 | they will be called repeatedly until stopped. |
649 | they will be called repeatedly until stopped. |
519 | |
650 | |
520 | The C<idle_ns> variant doesn't start (activate) the newly created watcher. |
651 | The C<idle_ns> variant doesn't start (activate) the newly created watcher. |
521 | |
652 | |
|
|
653 | =back |
|
|
654 | |
|
|
655 | |
|
|
656 | =head3 PREPARE WATCHERS - customise your event loop! |
|
|
657 | |
|
|
658 | =over 4 |
522 | |
659 | |
523 | =item $w = EV::prepare $callback |
660 | =item $w = EV::prepare $callback |
524 | |
661 | |
525 | =item $w = EV::prepare_ns $callback |
662 | =item $w = EV::prepare_ns $callback |
526 | |
663 | |
… | |
… | |
529 | |
666 | |
530 | See the EV::check watcher, below, for explanations and an example. |
667 | See the EV::check watcher, below, for explanations and an example. |
531 | |
668 | |
532 | The C<prepare_ns> variant doesn't start (activate) the newly created watcher. |
669 | The C<prepare_ns> variant doesn't start (activate) the newly created watcher. |
533 | |
670 | |
|
|
671 | =back |
|
|
672 | |
|
|
673 | |
|
|
674 | =head3 CHECK WATCHERS - customise your event loop even more! |
|
|
675 | |
|
|
676 | =over 4 |
534 | |
677 | |
535 | =item $w = EV::check $callback |
678 | =item $w = EV::check $callback |
536 | |
679 | |
537 | =item $w = EV::check_ns $callback |
680 | =item $w = EV::check_ns $callback |
538 | |
681 | |
… | |
… | |
583 | first). |
726 | first). |
584 | |
727 | |
585 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
728 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
586 | |
729 | |
587 | =back |
730 | =back |
|
|
731 | |
|
|
732 | |
|
|
733 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
|
|
734 | |
|
|
735 | Fork watchers are called when a C<fork ()> was detected. The invocation |
|
|
736 | is done before the event loop blocks next and before C<check> watchers |
|
|
737 | are being called, and only in the child after the fork. |
|
|
738 | |
|
|
739 | =over 4 |
|
|
740 | |
|
|
741 | =item $w = EV::fork $callback |
|
|
742 | |
|
|
743 | =item $w = EV::fork_ns $callback |
|
|
744 | |
|
|
745 | Call the callback before the event loop is resumed in the child process |
|
|
746 | after a fork. |
|
|
747 | |
|
|
748 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
|
|
749 | |
|
|
750 | =back |
|
|
751 | |
588 | |
752 | |
589 | =head1 THREADS |
753 | =head1 THREADS |
590 | |
754 | |
591 | Threads are not supported by this module in any way. Perl pseudo-threads |
755 | Threads are not supported by this module in any way. Perl pseudo-threads |
592 | is evil stuff and must die. As soon as Perl gains real threads I will work |
756 | is evil stuff and must die. As soon as Perl gains real threads I will work |
… | |
… | |
620 | |
784 | |
621 | 1; |
785 | 1; |
622 | |
786 | |
623 | =head1 SEE ALSO |
787 | =head1 SEE ALSO |
624 | |
788 | |
625 | L<EV::DNS>. |
789 | L<EV::ADNS> (asynchronous dns), L<Glib::EV> (makes Glib/Gtk2 use EV as |
|
|
790 | event loop), L<Coro::EV> (efficient coroutines with EV). |
626 | |
791 | |
627 | =head1 AUTHOR |
792 | =head1 AUTHOR |
628 | |
793 | |
629 | Marc Lehmann <schmorp@schmorp.de> |
794 | Marc Lehmann <schmorp@schmorp.de> |
630 | http://home.schmorp.de/ |
795 | http://home.schmorp.de/ |