| … | |
… | |
| 2 | EV - perl interface to libev, a high performance full-featured event |
2 | EV - perl interface to libev, a high performance full-featured event |
| 3 | loop |
3 | loop |
| 4 | |
4 | |
| 5 | SYNOPSIS |
5 | SYNOPSIS |
| 6 | use EV; |
6 | use EV; |
| 7 | |
7 | |
| 8 | # TIMERS |
8 | # TIMERS |
| 9 | |
9 | |
| 10 | my $w = EV::timer 2, 0, sub { |
10 | my $w = EV::timer 2, 0, sub { |
| 11 | warn "is called after 2s"; |
11 | warn "is called after 2s"; |
| 12 | }; |
12 | }; |
| 13 | |
13 | |
| 14 | my $w = EV::timer 2, 2, sub { |
14 | my $w = EV::timer 2, 2, sub { |
| 15 | warn "is called roughly every 2s (repeat = 2)"; |
15 | warn "is called roughly every 2s (repeat = 2)"; |
| 16 | }; |
16 | }; |
| 17 | |
17 | |
| 18 | undef $w; # destroy event watcher again |
18 | undef $w; # destroy event watcher again |
| 19 | |
19 | |
| 20 | my $w = EV::periodic 0, 60, 0, sub { |
20 | my $w = EV::periodic 0, 60, 0, sub { |
| 21 | warn "is called every minute, on the minute, exactly"; |
21 | warn "is called every minute, on the minute, exactly"; |
| 22 | }; |
22 | }; |
| 23 | |
|
|
| 24 | # IO |
23 | |
| 25 | |
24 | # IO |
|
|
25 | |
| 26 | my $w = EV::io *STDIN, EV::READ, sub { |
26 | my $w = EV::io *STDIN, EV::READ, sub { |
| 27 | my ($w, $revents) = @_; # all callbacks receive the watcher and event mask |
27 | my ($w, $revents) = @_; # all callbacks receive the watcher and event mask |
| 28 | warn "stdin is readable, you entered: ", <STDIN>; |
28 | warn "stdin is readable, you entered: ", <STDIN>; |
| 29 | }; |
29 | }; |
| 30 | |
30 | |
| 31 | # SIGNALS |
31 | # SIGNALS |
| 32 | |
32 | |
| 33 | my $w = EV::signal 'QUIT', sub { |
33 | my $w = EV::signal 'QUIT', sub { |
| 34 | warn "sigquit received\n"; |
34 | warn "sigquit received\n"; |
| 35 | }; |
35 | }; |
| 36 | |
36 | |
| 37 | # CHILD/PID STATUS CHANGES |
37 | # CHILD/PID STATUS CHANGES |
| 38 | |
38 | |
| 39 | my $w = EV::child 666, sub { |
39 | my $w = EV::child 666, 0, sub { |
| 40 | my ($w, $revents) = @_; |
40 | my ($w, $revents) = @_; |
| 41 | my $status = $w->rstatus; |
41 | my $status = $w->rstatus; |
| 42 | }; |
42 | }; |
| 43 | |
43 | |
| 44 | # STAT CHANGES |
44 | # STAT CHANGES |
| 45 | my $w = EV::stat "/etc/passwd", 10, sub { |
45 | my $w = EV::stat "/etc/passwd", 10, sub { |
| 46 | my ($w, $revents) = @_; |
46 | my ($w, $revents) = @_; |
| 47 | warn $w->path, " has changed somehow.\n"; |
47 | warn $w->path, " has changed somehow.\n"; |
| 48 | }; |
48 | }; |
| 49 | |
49 | |
| 50 | # MAINLOOP |
50 | # MAINLOOP |
| 51 | EV::loop; # loop until EV::unloop is called or all watchers stop |
51 | 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 |
52 | 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 |
53 | EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
| 54 | |
54 | |
| 55 | DESCRIPTION |
55 | DESCRIPTION |
| 56 | This module provides an interface to libev |
56 | This module provides an interface to libev |
| 57 | (<http://software.schmorp.de/pkg/libev.html>). While the documentation |
57 | (<http://software.schmorp.de/pkg/libev.html>). While the documentation |
| 58 | below is comprehensive, one might also consult the documentation of |
58 | below is comprehensive, one might also consult the documentation of |
| 59 | libev itself (<http://cvs.schmorp.de/libev/ev.html>) for more subtle |
59 | libev itself (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>) |
| 60 | details on watcher semantics or some discussion on the available |
60 | for more subtle details on watcher semantics or some discussion on the |
| 61 | backends, or how to force a specific backend with "LIBEV_FLAGS", or just |
61 | available backends, or how to force a specific backend with |
| 62 | about in any case because it has much more detailed information. |
62 | "LIBEV_FLAGS", or just about in any case because it has much more |
|
|
63 | detailed information. |
|
|
64 | |
|
|
65 | This module is very fast and scalable. It is actually so fast that you |
|
|
66 | can use it through the AnyEvent module, stay portable to other event |
|
|
67 | loops (if you don't rely on any watcher types not available through it) |
|
|
68 | and still be faster than with any other event loop currently supported |
|
|
69 | in Perl. |
| 63 | |
70 | |
| 64 | EVENT LOOPS |
71 | EVENT LOOPS |
| 65 | EV supports multiple event loops: There is a single "default event loop" |
72 | EV supports multiple event loops: There is a single "default event loop" |
| 66 | that can handle everything including signals and child watchers, and any |
73 | that can handle everything including signals and child watchers, and any |
| 67 | number of "dynamic event loops" that can use different backends (with |
74 | number of "dynamic event loops" that can use different backends (with |
| … | |
… | |
| 89 | loop is protected by this module. |
96 | loop is protected by this module. |
| 90 | |
97 | |
| 91 | $loop->loop_fork |
98 | $loop->loop_fork |
| 92 | Must be called after a fork in the child, before entering or |
99 | Must be called after a fork in the child, before entering or |
| 93 | continuing the event loop. An alternative is to use |
100 | continuing the event loop. An alternative is to use |
| 94 | "EV::FLAG_FORKCHECK" which calls this fucntion automatically, at |
101 | "EV::FLAG_FORKCHECK" which calls this function automatically, at |
| 95 | some performance loss (refer to the libev documentation). |
102 | some performance loss (refer to the libev documentation). |
| 96 | |
103 | |
|
|
104 | $loop->loop_verify |
|
|
105 | Calls "ev_verify" to make internal consistency checks (for debugging |
|
|
106 | libev) and abort the program if any data structures wree found to be |
|
|
107 | corrupted. |
|
|
108 | |
| 97 | $loop = EV::default_loop [$flags] |
109 | $loop = EV::default_loop [$flags] |
| 98 | Return the default loop (which is a singleton object). |
110 | Return the default loop (which is a singleton object). Since this |
|
|
111 | module already creates the default loop with default flags, |
|
|
112 | specifying flags here will not have any effect unless you destroy |
|
|
113 | the default loop. |
| 99 | |
114 | |
| 100 | BASIC INTERFACE |
115 | BASIC INTERFACE |
| 101 | $EV::DIED |
116 | $EV::DIED |
| 102 | Must contain a reference to a function that is called when a |
117 | Must contain a reference to a function that is called when a |
| 103 | callback throws an exception (with $@ containing the error). The |
118 | callback throws an exception (with $@ containing the error). The |
| … | |
… | |
| 414 | changed by explicit date -s or other means such as ntpd). It is also |
429 | changed by explicit date -s or other means such as ntpd). It is also |
| 415 | the most complex watcher type in EV. |
430 | the most complex watcher type in EV. |
| 416 | |
431 | |
| 417 | It has three distinct "modes": |
432 | It has three distinct "modes": |
| 418 | |
433 | |
| 419 | * absolute timer ($interval = $reschedule_cb = 0) |
434 | * absolute timer ($interval = $reschedule_cb = 0) |
|
|
435 | |
| 420 | This time simply fires at the wallclock time $at and doesn't |
436 | This time simply fires at the wallclock time $at and doesn't |
| 421 | repeat. It will not adjust when a time jump occurs, that is, if |
437 | repeat. It will not adjust when a time jump occurs, that is, if |
| 422 | it is to be run at January 1st 2011 then it will run when the |
438 | it is to be run at January 1st 2011 then it will run when the |
| 423 | system time reaches or surpasses this time. |
439 | system time reaches or surpasses this time. |
| 424 | |
440 | |
| 425 | * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) |
441 | * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
|
|
442 | |
| 426 | In this mode the watcher will always be scheduled to time out at |
443 | In this mode the watcher will always be scheduled to time out at |
| 427 | the next "$at + N * $interval" time (for some integer N) and |
444 | the next "$at + N * $interval" time (for some integer N) and |
| 428 | then repeat, regardless of any time jumps. |
445 | then repeat, regardless of any time jumps. |
| 429 | |
446 | |
| 430 | This can be used to create timers that do not drift with respect |
447 | This can be used to create timers that do not drift with respect |
| … | |
… | |
| 439 | Another way to think about it (for the mathematically inclined) |
456 | Another way to think about it (for the mathematically inclined) |
| 440 | is that EV::periodic will try to run the callback in this mode |
457 | is that EV::periodic will try to run the callback in this mode |
| 441 | at the next possible time where "$time = $at (mod $interval)", |
458 | at the next possible time where "$time = $at (mod $interval)", |
| 442 | regardless of any time jumps. |
459 | regardless of any time jumps. |
| 443 | |
460 | |
| 444 | * manual reschedule mode ($reschedule_cb = coderef) |
461 | * manual reschedule mode ($reschedule_cb = coderef) |
|
|
462 | |
| 445 | In this mode $interval and $at are both being ignored. Instead, |
463 | In this mode $interval and $at are both being ignored. Instead, |
| 446 | each time the periodic watcher gets scheduled, the reschedule |
464 | each time the periodic watcher gets scheduled, the reschedule |
| 447 | callback ($reschedule_cb) will be called with the watcher as |
465 | callback ($reschedule_cb) will be called with the watcher as |
| 448 | first, and the current time as second argument. |
466 | first, and the current time as second argument. |
| 449 | |
467 | |
| 450 | *This callback MUST NOT stop or destroy this or any other |
468 | *This callback MUST NOT stop or destroy this or any other |
|
|
469 | periodic watcher, ever, and MUST NOT call any event loop |
| 451 | periodic watcher, ever*. If you need to stop it, return 1e30 and |
470 | functions or methods*. If you need to stop it, return 1e30 and |
| 452 | stop it afterwards. |
471 | stop it afterwards. You may create and start a "EV::prepare" |
|
|
472 | watcher for this task. |
| 453 | |
473 | |
| 454 | It must return the next time to trigger, based on the passed |
474 | It must return the next time to trigger, based on the passed |
| 455 | time value (that is, the lowest time value larger than to the |
475 | time value (that is, the lowest time value larger than or equal |
| 456 | second argument). It will usually be called just before the |
476 | to to the second argument). It will usually be called just |
| 457 | callback will be triggered, but might be called at other times, |
477 | before the callback will be triggered, but might be called at |
| 458 | too. |
478 | other times, too. |
| 459 | |
479 | |
| 460 | This can be used to create very complex timers, such as a timer |
480 | This can be used to create very complex timers, such as a timer |
| 461 | that triggers on each midnight, local time (actually 24 hours |
481 | that triggers on each midnight, local time (actually 24 hours |
| 462 | after the last midnight, to keep the example simple. If you know |
482 | after the last midnight, to keep the example simple. If you know |
| 463 | a way to do it correctly in about the same space (without |
483 | a way to do it correctly in about the same space (without |
| … | |
… | |
| 510 | $old_signum = $w->signal ($new_signal) |
530 | $old_signum = $w->signal ($new_signal) |
| 511 | Returns the previously set signal (always as a number not name) and |
531 | Returns the previously set signal (always as a number not name) and |
| 512 | optionally set a new one. |
532 | optionally set a new one. |
| 513 | |
533 | |
| 514 | CHILD WATCHERS - watch out for process status changes |
534 | CHILD WATCHERS - watch out for process status changes |
| 515 | $w = EV::child $pid, $callback |
535 | $w = EV::child $pid, $trace, $callback |
| 516 | $w = EV::child_ns $pid, $callback |
536 | $w = EV::child_ns $pid, $trace, $callback |
| 517 | $w = $loop->child ($pid, $callback) |
537 | $w = $loop->child ($pid, $trace, $callback) |
| 518 | $w = $loop->child_ns ($pid, $callback) |
538 | $w = $loop->child_ns ($pid, $trace, $callback) |
| 519 | Call the callback when a status change for pid $pid (or any pid if |
539 | Call the callback when a status change for pid $pid (or any pid if |
| 520 | $pid is 0) has been received. More precisely: when the process |
540 | $pid is 0) has been received (a status change happens when the |
|
|
541 | process terminates or is killed, or, when trace is true, |
|
|
542 | additionally when it is stopped or continued). More precisely: when |
| 521 | receives a "SIGCHLD", EV will fetch the outstanding exit/wait status |
543 | the process receives a "SIGCHLD", EV will fetch the outstanding |
| 522 | for all changed/zombie children and call the callback. |
544 | exit/wait status for all changed/zombie children and call the |
|
|
545 | callback. |
| 523 | |
546 | |
| 524 | It is valid (and fully supported) to install a child watcher after a |
547 | It is valid (and fully supported) to install a child watcher after a |
| 525 | child has exited but before the event loop has started its next |
548 | child has exited but before the event loop has started its next |
| 526 | iteration (for example, first you "fork", then the new child process |
549 | iteration (for example, first you "fork", then the new child process |
| 527 | might exit, and only then do you install a child watcher in the |
550 | might exit, and only then do you install a child watcher in the |
| … | |
… | |
| 534 | be called. |
557 | be called. |
| 535 | |
558 | |
| 536 | The "child_ns" variant doesn't start (activate) the newly created |
559 | The "child_ns" variant doesn't start (activate) the newly created |
| 537 | watcher. |
560 | watcher. |
| 538 | |
561 | |
| 539 | $w->set ($pid) |
562 | $w->set ($pid, $trace) |
| 540 | Reconfigures the watcher, see the constructor above for details. Can |
563 | Reconfigures the watcher, see the constructor above for details. Can |
| 541 | be called at any time. |
564 | be called at any time. |
| 542 | |
565 | |
| 543 | $current_pid = $w->pid |
566 | $current_pid = $w->pid |
| 544 | $old_pid = $w->pid ($new_pid) |
|
|
| 545 | Returns the previously set process id and optionally set a new one. |
567 | Returns the previously set process id and optionally set a new one. |
| 546 | |
568 | |
| 547 | $exit_status = $w->rstatus |
569 | $exit_status = $w->rstatus |
| 548 | Return the exit/wait status (as returned by waitpid, see the waitpid |
570 | Return the exit/wait status (as returned by waitpid, see the waitpid |
| 549 | entry in perlfunc). |
571 | entry in perlfunc). |
| … | |
… | |
| 771 | managed automatically. |
793 | managed automatically. |
| 772 | |
794 | |
| 773 | The "embed_ns" variant doesn't start (activate) the newly created |
795 | The "embed_ns" variant doesn't start (activate) the newly created |
| 774 | watcher. |
796 | watcher. |
| 775 | |
797 | |
|
|
798 | ASYNC WATCHERS - how to wake up another event loop |
|
|
799 | Async watchers are provided by EV, but have little use in perl directly, |
|
|
800 | as perl neither supports threads nor direct access to signal handlers or |
|
|
801 | other contexts where they could be of value. |
|
|
802 | |
|
|
803 | It is, however, possible to use them from the XS level. |
|
|
804 | |
|
|
805 | Please see the libev documentation for further details. |
|
|
806 | |
|
|
807 | $w = EV::async $callback |
|
|
808 | $w = EV::async_ns $callback |
|
|
809 | $w->send |
|
|
810 | $bool = $w->async_pending |
|
|
811 | |
| 776 | PERL SIGNALS |
812 | PERL SIGNALS |
| 777 | While Perl signal handling (%SIG) is not affected by EV, the behaviour |
813 | While Perl signal handling (%SIG) is not affected by EV, the behaviour |
| 778 | with EV is as the same as any other C library: Perl-signals will only be |
814 | with EV is as the same as any other C library: Perl-signals will only be |
| 779 | handled when Perl runs, which means your signal handler might be invoked |
815 | handled when Perl runs, which means your signal handler might be invoked |
| 780 | only the next time an event callback is invoked. |
816 | only the next time an event callback is invoked. |
| … | |
… | |
| 814 | course. |
850 | course. |
| 815 | |
851 | |
| 816 | SEE ALSO |
852 | SEE ALSO |
| 817 | EV::ADNS (asynchronous DNS), Glib::EV (makes Glib/Gtk2 use EV as event |
853 | EV::ADNS (asynchronous DNS), Glib::EV (makes Glib/Gtk2 use EV as event |
| 818 | loop), EV::Glib (embed Glib into EV), Coro::EV (efficient coroutines |
854 | loop), EV::Glib (embed Glib into EV), Coro::EV (efficient coroutines |
| 819 | with EV), Net::SNMP::EV (asynchronous SNMP). |
855 | with EV), Net::SNMP::EV (asynchronous SNMP), AnyEvent for event-loop |
|
|
856 | agnostic and portable event driven programming. |
| 820 | |
857 | |
| 821 | AUTHOR |
858 | AUTHOR |
| 822 | Marc Lehmann <schmorp@schmorp.de> |
859 | Marc Lehmann <schmorp@schmorp.de> |
| 823 | http://home.schmorp.de/ |
860 | http://home.schmorp.de/ |
| 824 | |
861 | |
