1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - events independent of event loop implementation |
3 | AnyEvent - the DBI of event loop programming |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, IO::Async, Qt and POE are |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt |
6 | various supported event loops/environments. |
6 | and POE are various supported event loops/environments. |
7 | |
7 | |
8 | =head1 SYNOPSIS |
8 | =head1 SYNOPSIS |
9 | |
9 | |
10 | use AnyEvent; |
10 | use AnyEvent; |
11 | |
11 | |
… | |
… | |
181 | my variables are only visible after the statement in which they are |
181 | my variables are only visible after the statement in which they are |
182 | declared. |
182 | declared. |
183 | |
183 | |
184 | =head2 I/O WATCHERS |
184 | =head2 I/O WATCHERS |
185 | |
185 | |
|
|
186 | $w = AnyEvent->io ( |
|
|
187 | fh => <filehandle_or_fileno>, |
|
|
188 | poll => <"r" or "w">, |
|
|
189 | cb => <callback>, |
|
|
190 | ); |
|
|
191 | |
186 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
192 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
187 | with the following mandatory key-value pairs as arguments: |
193 | with the following mandatory key-value pairs as arguments: |
188 | |
194 | |
189 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
195 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
190 | for events (AnyEvent might or might not keep a reference to this file |
196 | for events (AnyEvent might or might not keep a reference to this file |
… | |
… | |
219 | undef $w; |
225 | undef $w; |
220 | }); |
226 | }); |
221 | |
227 | |
222 | =head2 TIME WATCHERS |
228 | =head2 TIME WATCHERS |
223 | |
229 | |
|
|
230 | $w = AnyEvent->timer (after => <seconds>, cb => <callback>); |
|
|
231 | |
|
|
232 | $w = AnyEvent->timer ( |
|
|
233 | after => <fractional_seconds>, |
|
|
234 | interval => <fractional_seconds>, |
|
|
235 | cb => <callback>, |
|
|
236 | ); |
|
|
237 | |
224 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
238 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
225 | method with the following mandatory arguments: |
239 | method with the following mandatory arguments: |
226 | |
240 | |
227 | C<after> specifies after how many seconds (fractional values are |
241 | C<after> specifies after how many seconds (fractional values are |
228 | supported) the callback should be invoked. C<cb> is the callback to invoke |
242 | supported) the callback should be invoked. C<cb> is the callback to invoke |
… | |
… | |
349 | might affect timers and time-outs. |
363 | might affect timers and time-outs. |
350 | |
364 | |
351 | When this is the case, you can call this method, which will update the |
365 | When this is the case, you can call this method, which will update the |
352 | event loop's idea of "current time". |
366 | event loop's idea of "current time". |
353 | |
367 | |
|
|
368 | A typical example would be a script in a web server (e.g. C<mod_perl>) - |
|
|
369 | when mod_perl executes the script, then the event loop will have the wrong |
|
|
370 | idea about the "current time" (being potentially far in the past, when the |
|
|
371 | script ran the last time). In that case you should arrange a call to C<< |
|
|
372 | AnyEvent->now_update >> each time the web server process wakes up again |
|
|
373 | (e.g. at the start of your script, or in a handler). |
|
|
374 | |
354 | Note that updating the time I<might> cause some events to be handled. |
375 | Note that updating the time I<might> cause some events to be handled. |
355 | |
376 | |
356 | =back |
377 | =back |
357 | |
378 | |
358 | =head2 SIGNAL WATCHERS |
379 | =head2 SIGNAL WATCHERS |
|
|
380 | |
|
|
381 | $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>); |
359 | |
382 | |
360 | You can watch for signals using a signal watcher, C<signal> is the signal |
383 | You can watch for signals using a signal watcher, C<signal> is the signal |
361 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
384 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
362 | callback to be invoked whenever a signal occurs. |
385 | callback to be invoked whenever a signal occurs. |
363 | |
386 | |
… | |
… | |
380 | |
403 | |
381 | Example: exit on SIGINT |
404 | Example: exit on SIGINT |
382 | |
405 | |
383 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
406 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
384 | |
407 | |
|
|
408 | =head3 Restart Behaviour |
|
|
409 | |
|
|
410 | While restart behaviour is up to the event loop implementation, most will |
|
|
411 | not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's |
|
|
412 | pure perl implementation). |
|
|
413 | |
|
|
414 | =head3 Safe/Unsafe Signals |
|
|
415 | |
|
|
416 | Perl signals can be either "safe" (synchronous to opcode handling) or |
|
|
417 | "unsafe" (asynchronous) - the former might get delayed indefinitely, the |
|
|
418 | latter might corrupt your memory. |
|
|
419 | |
|
|
420 | AnyEvent signal handlers are, in addition, synchronous to the event loop, |
|
|
421 | i.e. they will not interrupt your running perl program but will only be |
|
|
422 | called as part of the normal event handling (just like timer, I/O etc. |
|
|
423 | callbacks, too). |
|
|
424 | |
385 | =head3 Signal Races, Delays and Workarounds |
425 | =head3 Signal Races, Delays and Workarounds |
386 | |
426 | |
387 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
427 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
388 | callbacks to signals in a generic way, which is a pity, as you cannot do |
428 | callbacks to signals in a generic way, which is a pity, as you cannot |
389 | race-free signal handling in perl. AnyEvent will try to do it's best, but |
429 | do race-free signal handling in perl, requiring C libraries for |
|
|
430 | this. AnyEvent will try to do it's best, which means in some cases, |
390 | in some cases, signals will be delayed. The maximum time a signal might |
431 | signals will be delayed. The maximum time a signal might be delayed is |
391 | be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 |
432 | specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This |
392 | seconds). This variable can be changed only before the first signal |
433 | variable can be changed only before the first signal watcher is created, |
393 | watcher is created, and should be left alone otherwise. Higher values |
434 | and should be left alone otherwise. This variable determines how often |
|
|
435 | AnyEvent polls for signals (in case a wake-up was missed). Higher values |
394 | will cause fewer spurious wake-ups, which is better for power and CPU |
436 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
437 | saving. |
|
|
438 | |
395 | saving. All these problems can be avoided by installing the optional |
439 | All these problems can be avoided by installing the optional |
396 | L<Async::Interrupt> module. This will not work with inherently broken |
440 | L<Async::Interrupt> module, which works with most event loops. It will not |
397 | event loops such as L<Event> or L<Event::Lib> (and not with L<POE> |
441 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
398 | currently, as POE does it's own workaround with one-second latency). With |
442 | (and not with L<POE> currently, as POE does it's own workaround with |
399 | those, you just have to suffer the delays. |
443 | one-second latency). For those, you just have to suffer the delays. |
400 | |
444 | |
401 | =head2 CHILD PROCESS WATCHERS |
445 | =head2 CHILD PROCESS WATCHERS |
|
|
446 | |
|
|
447 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
402 | |
448 | |
403 | You can also watch on a child process exit and catch its exit status. |
449 | You can also watch on a child process exit and catch its exit status. |
404 | |
450 | |
405 | The child process is specified by the C<pid> argument (one some backends, |
451 | The child process is specified by the C<pid> argument (one some backends, |
406 | using C<0> watches for any child process exit, on others this will |
452 | using C<0> watches for any child process exit, on others this will |
… | |
… | |
455 | # do something else, then wait for process exit |
501 | # do something else, then wait for process exit |
456 | $done->recv; |
502 | $done->recv; |
457 | |
503 | |
458 | =head2 IDLE WATCHERS |
504 | =head2 IDLE WATCHERS |
459 | |
505 | |
460 | Sometimes there is a need to do something, but it is not so important |
506 | $w = AnyEvent->idle (cb => <callback>); |
461 | to do it instantly, but only when there is nothing better to do. This |
|
|
462 | "nothing better to do" is usually defined to be "no other events need |
|
|
463 | attention by the event loop". |
|
|
464 | |
507 | |
465 | Idle watchers ideally get invoked when the event loop has nothing |
508 | Repeatedly invoke the callback after the process becomes idle, until |
466 | better to do, just before it would block the process to wait for new |
509 | either the watcher is destroyed or new events have been detected. |
467 | events. Instead of blocking, the idle watcher is invoked. |
|
|
468 | |
510 | |
469 | Most event loops unfortunately do not really support idle watchers (only |
511 | Idle watchers are useful when there is a need to do something, but it |
|
|
512 | is not so important (or wise) to do it instantly. The callback will be |
|
|
513 | invoked only when there is "nothing better to do", which is usually |
|
|
514 | defined as "all outstanding events have been handled and no new events |
|
|
515 | have been detected". That means that idle watchers ideally get invoked |
|
|
516 | when the event loop has just polled for new events but none have been |
|
|
517 | detected. Instead of blocking to wait for more events, the idle watchers |
|
|
518 | will be invoked. |
|
|
519 | |
|
|
520 | Unfortunately, most event loops do not really support idle watchers (only |
470 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
521 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
471 | will simply call the callback "from time to time". |
522 | will simply call the callback "from time to time". |
472 | |
523 | |
473 | Example: read lines from STDIN, but only process them when the |
524 | Example: read lines from STDIN, but only process them when the |
474 | program is otherwise idle: |
525 | program is otherwise idle: |
… | |
… | |
490 | }); |
541 | }); |
491 | }); |
542 | }); |
492 | |
543 | |
493 | =head2 CONDITION VARIABLES |
544 | =head2 CONDITION VARIABLES |
494 | |
545 | |
|
|
546 | $cv = AnyEvent->condvar; |
|
|
547 | |
|
|
548 | $cv->send (<list>); |
|
|
549 | my @res = $cv->recv; |
|
|
550 | |
495 | If you are familiar with some event loops you will know that all of them |
551 | If you are familiar with some event loops you will know that all of them |
496 | require you to run some blocking "loop", "run" or similar function that |
552 | require you to run some blocking "loop", "run" or similar function that |
497 | will actively watch for new events and call your callbacks. |
553 | will actively watch for new events and call your callbacks. |
498 | |
554 | |
499 | AnyEvent is slightly different: it expects somebody else to run the event |
555 | AnyEvent is slightly different: it expects somebody else to run the event |
… | |
… | |
563 | after => 1, |
619 | after => 1, |
564 | cb => sub { $result_ready->send }, |
620 | cb => sub { $result_ready->send }, |
565 | ); |
621 | ); |
566 | |
622 | |
567 | # this "blocks" (while handling events) till the callback |
623 | # this "blocks" (while handling events) till the callback |
568 | # calls -<send |
624 | # calls ->send |
569 | $result_ready->recv; |
625 | $result_ready->recv; |
570 | |
626 | |
571 | Example: wait for a timer, but take advantage of the fact that condition |
627 | Example: wait for a timer, but take advantage of the fact that condition |
572 | variables are also callable directly. |
628 | variables are also callable directly. |
573 | |
629 | |
… | |
… | |
637 | one. For example, a function that pings many hosts in parallel might want |
693 | one. For example, a function that pings many hosts in parallel might want |
638 | to use a condition variable for the whole process. |
694 | to use a condition variable for the whole process. |
639 | |
695 | |
640 | Every call to C<< ->begin >> will increment a counter, and every call to |
696 | Every call to C<< ->begin >> will increment a counter, and every call to |
641 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
697 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
642 | >>, the (last) callback passed to C<begin> will be executed. That callback |
698 | >>, the (last) callback passed to C<begin> will be executed, passing the |
643 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
699 | condvar as first argument. That callback is I<supposed> to call C<< ->send |
644 | callback was set, C<send> will be called without any arguments. |
700 | >>, but that is not required. If no group callback was set, C<send> will |
|
|
701 | be called without any arguments. |
645 | |
702 | |
646 | You can think of C<< $cv->send >> giving you an OR condition (one call |
703 | You can think of C<< $cv->send >> giving you an OR condition (one call |
647 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
704 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
648 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
705 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
649 | |
706 | |
… | |
… | |
676 | begung can potentially be zero: |
733 | begung can potentially be zero: |
677 | |
734 | |
678 | my $cv = AnyEvent->condvar; |
735 | my $cv = AnyEvent->condvar; |
679 | |
736 | |
680 | my %result; |
737 | my %result; |
681 | $cv->begin (sub { $cv->send (\%result) }); |
738 | $cv->begin (sub { shift->send (\%result) }); |
682 | |
739 | |
683 | for my $host (@list_of_hosts) { |
740 | for my $host (@list_of_hosts) { |
684 | $cv->begin; |
741 | $cv->begin; |
685 | ping_host_then_call_callback $host, sub { |
742 | ping_host_then_call_callback $host, sub { |
686 | $result{$host} = ...; |
743 | $result{$host} = ...; |
… | |
… | |
761 | =item $cb = $cv->cb ($cb->($cv)) |
818 | =item $cb = $cv->cb ($cb->($cv)) |
762 | |
819 | |
763 | This is a mutator function that returns the callback set and optionally |
820 | This is a mutator function that returns the callback set and optionally |
764 | replaces it before doing so. |
821 | replaces it before doing so. |
765 | |
822 | |
766 | The callback will be called when the condition becomes "true", i.e. when |
823 | The callback will be called when the condition becomes (or already was) |
767 | C<send> or C<croak> are called, with the only argument being the condition |
824 | "true", i.e. when C<send> or C<croak> are called (or were called), with |
768 | variable itself. Calling C<recv> inside the callback or at any later time |
825 | the only argument being the condition variable itself. Calling C<recv> |
769 | is guaranteed not to block. |
826 | inside the callback or at any later time is guaranteed not to block. |
770 | |
827 | |
771 | =back |
828 | =back |
772 | |
829 | |
773 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
830 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
774 | |
831 | |
… | |
… | |
777 | =over 4 |
834 | =over 4 |
778 | |
835 | |
779 | =item Backends that are autoprobed when no other event loop can be found. |
836 | =item Backends that are autoprobed when no other event loop can be found. |
780 | |
837 | |
781 | EV is the preferred backend when no other event loop seems to be in |
838 | EV is the preferred backend when no other event loop seems to be in |
782 | use. If EV is not installed, then AnyEvent will try Event, and, failing |
839 | use. If EV is not installed, then AnyEvent will fall back to its own |
783 | that, will fall back to its own pure-perl implementation, which is |
840 | pure-perl implementation, which is available everywhere as it comes with |
784 | available everywhere as it comes with AnyEvent itself. |
841 | AnyEvent itself. |
785 | |
842 | |
786 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
843 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
787 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
788 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
844 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
789 | |
845 | |
790 | =item Backends that are transparently being picked up when they are used. |
846 | =item Backends that are transparently being picked up when they are used. |
791 | |
847 | |
792 | These will be used when they are currently loaded when the first watcher |
848 | These will be used when they are currently loaded when the first watcher |
793 | is created, in which case it is assumed that the application is using |
849 | is created, in which case it is assumed that the application is using |
794 | them. This means that AnyEvent will automatically pick the right backend |
850 | them. This means that AnyEvent will automatically pick the right backend |
795 | when the main program loads an event module before anything starts to |
851 | when the main program loads an event module before anything starts to |
796 | create watchers. Nothing special needs to be done by the main program. |
852 | create watchers. Nothing special needs to be done by the main program. |
797 | |
853 | |
|
|
854 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
798 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
855 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
799 | AnyEvent::Impl::Tk based on Tk, very broken. |
856 | AnyEvent::Impl::Tk based on Tk, very broken. |
800 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
857 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
801 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
858 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
802 | AnyEvent::Impl::Irssi used when running within irssi. |
859 | AnyEvent::Impl::Irssi used when running within irssi. |
… | |
… | |
912 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
969 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
913 | if it is defined then the event loop has already been detected, and the |
970 | if it is defined then the event loop has already been detected, and the |
914 | array will be ignored. |
971 | array will be ignored. |
915 | |
972 | |
916 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
973 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
917 | it,as it takes care of these details. |
974 | it, as it takes care of these details. |
918 | |
975 | |
919 | This variable is mainly useful for modules that can do something useful |
976 | This variable is mainly useful for modules that can do something useful |
920 | when AnyEvent is used and thus want to know when it is initialised, but do |
977 | when AnyEvent is used and thus want to know when it is initialised, but do |
921 | not need to even load it by default. This array provides the means to hook |
978 | not need to even load it by default. This array provides the means to hook |
922 | into AnyEvent passively, without loading it. |
979 | into AnyEvent passively, without loading it. |
|
|
980 | |
|
|
981 | Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used |
|
|
982 | together, you could put this into Coro (this is the actual code used by |
|
|
983 | Coro to accomplish this): |
|
|
984 | |
|
|
985 | if (defined $AnyEvent::MODEL) { |
|
|
986 | # AnyEvent already initialised, so load Coro::AnyEvent |
|
|
987 | require Coro::AnyEvent; |
|
|
988 | } else { |
|
|
989 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
|
|
990 | # as soon as it is |
|
|
991 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
|
|
992 | } |
923 | |
993 | |
924 | =back |
994 | =back |
925 | |
995 | |
926 | =head1 WHAT TO DO IN A MODULE |
996 | =head1 WHAT TO DO IN A MODULE |
927 | |
997 | |
… | |
… | |
1076 | |
1146 | |
1077 | package AnyEvent; |
1147 | package AnyEvent; |
1078 | |
1148 | |
1079 | # basically a tuned-down version of common::sense |
1149 | # basically a tuned-down version of common::sense |
1080 | sub common_sense { |
1150 | sub common_sense { |
1081 | # no warnings |
1151 | # from common:.sense 1.0 |
1082 | ${^WARNING_BITS} ^= ${^WARNING_BITS}; |
1152 | ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00"; |
1083 | # use strict vars subs |
1153 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1084 | $^H |= 0x00000600; |
1154 | $^H |= 0x00000600; |
1085 | } |
1155 | } |
1086 | |
1156 | |
1087 | BEGIN { AnyEvent::common_sense } |
1157 | BEGIN { AnyEvent::common_sense } |
1088 | |
1158 | |
1089 | use Carp (); |
1159 | use Carp (); |
1090 | |
1160 | |
1091 | our $VERSION = 4.86; |
1161 | our $VERSION = '5.24'; |
1092 | our $MODEL; |
1162 | our $MODEL; |
1093 | |
1163 | |
1094 | our $AUTOLOAD; |
1164 | our $AUTOLOAD; |
1095 | our @ISA; |
1165 | our @ISA; |
1096 | |
1166 | |
1097 | our @REGISTRY; |
1167 | our @REGISTRY; |
1098 | |
1168 | |
1099 | our $WIN32; |
|
|
1100 | |
|
|
1101 | our $VERBOSE; |
1169 | our $VERBOSE; |
1102 | |
1170 | |
1103 | BEGIN { |
1171 | BEGIN { |
|
|
1172 | eval "sub CYGWIN(){" . (($^O =~ /cygwin/i) *1) . "}"; |
1104 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1173 | eval "sub WIN32 (){" . (($^O =~ /mswin32/i)*1) . "}"; |
1105 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1174 | eval "sub TAINT (){" . (${^TAINT} *1) . "}"; |
1106 | |
1175 | |
1107 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1176 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1108 | if ${^TAINT}; |
1177 | if ${^TAINT}; |
1109 | |
1178 | |
1110 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1179 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
… | |
… | |
1122 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1191 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1123 | } |
1192 | } |
1124 | |
1193 | |
1125 | my @models = ( |
1194 | my @models = ( |
1126 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1195 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1127 | [Event:: => AnyEvent::Impl::Event::, 1], |
|
|
1128 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1196 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1129 | # everything below here will not (normally) be autoprobed |
1197 | # everything below here will not (normally) be autoprobed |
1130 | # as the pureperl backend should work everywhere |
1198 | # as the pureperl backend should work everywhere |
1131 | # and is usually faster |
1199 | # and is usually faster |
|
|
1200 | [Event:: => AnyEvent::Impl::Event::, 1], |
1132 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1201 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1133 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1202 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1134 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1203 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1135 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1204 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1136 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1205 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
… | |
… | |
1139 | [Prima:: => AnyEvent::Impl::POE::], |
1208 | [Prima:: => AnyEvent::Impl::POE::], |
1140 | # IO::Async is just too broken - we would need workarounds for its |
1209 | # IO::Async is just too broken - we would need workarounds for its |
1141 | # byzantine signal and broken child handling, among others. |
1210 | # byzantine signal and broken child handling, among others. |
1142 | # IO::Async is rather hard to detect, as it doesn't have any |
1211 | # IO::Async is rather hard to detect, as it doesn't have any |
1143 | # obvious default class. |
1212 | # obvious default class. |
1144 | # [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1213 | [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1145 | # [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1214 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1146 | # [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1215 | [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1216 | [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1147 | ); |
1217 | ); |
1148 | |
1218 | |
1149 | our %method = map +($_ => 1), |
1219 | our %method = map +($_ => 1), |
1150 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1220 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1151 | |
1221 | |
… | |
… | |
1258 | # we assume CLOEXEC is already set by perl in all important cases |
1328 | # we assume CLOEXEC is already set by perl in all important cases |
1259 | |
1329 | |
1260 | ($fh2, $rw) |
1330 | ($fh2, $rw) |
1261 | } |
1331 | } |
1262 | |
1332 | |
|
|
1333 | =head1 SIMPLIFIED AE API |
|
|
1334 | |
|
|
1335 | Starting with version 5.0, AnyEvent officially supports a second, much |
|
|
1336 | simpler, API that is designed to reduce the calling, typing and memory |
|
|
1337 | overhead. |
|
|
1338 | |
|
|
1339 | See the L<AE> manpage for details. |
|
|
1340 | |
|
|
1341 | =cut |
|
|
1342 | |
|
|
1343 | package AE; |
|
|
1344 | |
|
|
1345 | our $VERSION = $AnyEvent::VERSION; |
|
|
1346 | |
|
|
1347 | sub io($$$) { |
|
|
1348 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
|
|
1349 | } |
|
|
1350 | |
|
|
1351 | sub timer($$$) { |
|
|
1352 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
|
|
1353 | } |
|
|
1354 | |
|
|
1355 | sub signal($$) { |
|
|
1356 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
|
|
1357 | } |
|
|
1358 | |
|
|
1359 | sub child($$) { |
|
|
1360 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
|
|
1361 | } |
|
|
1362 | |
|
|
1363 | sub idle($) { |
|
|
1364 | AnyEvent->idle (cb => $_[0]) |
|
|
1365 | } |
|
|
1366 | |
|
|
1367 | sub cv(;&) { |
|
|
1368 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
|
|
1369 | } |
|
|
1370 | |
|
|
1371 | sub now() { |
|
|
1372 | AnyEvent->now |
|
|
1373 | } |
|
|
1374 | |
|
|
1375 | sub now_update() { |
|
|
1376 | AnyEvent->now_update |
|
|
1377 | } |
|
|
1378 | |
|
|
1379 | sub time() { |
|
|
1380 | AnyEvent->time |
|
|
1381 | } |
|
|
1382 | |
1263 | package AnyEvent::Base; |
1383 | package AnyEvent::Base; |
1264 | |
1384 | |
1265 | # default implementations for many methods |
1385 | # default implementations for many methods |
1266 | |
1386 | |
1267 | sub _time { |
1387 | sub _time() { |
1268 | # probe for availability of Time::HiRes |
1388 | # probe for availability of Time::HiRes |
1269 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1389 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1270 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1390 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1271 | *_time = \&Time::HiRes::time; |
1391 | *_time = \&Time::HiRes::time; |
1272 | # if (eval "use POSIX (); (POSIX::times())... |
1392 | # if (eval "use POSIX (); (POSIX::times())... |
… | |
… | |
1289 | } |
1409 | } |
1290 | |
1410 | |
1291 | # default implementation for ->signal |
1411 | # default implementation for ->signal |
1292 | |
1412 | |
1293 | our $HAVE_ASYNC_INTERRUPT; |
1413 | our $HAVE_ASYNC_INTERRUPT; |
|
|
1414 | |
|
|
1415 | sub _have_async_interrupt() { |
|
|
1416 | $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} |
|
|
1417 | && eval "use Async::Interrupt 1.02 (); 1") |
|
|
1418 | unless defined $HAVE_ASYNC_INTERRUPT; |
|
|
1419 | |
|
|
1420 | $HAVE_ASYNC_INTERRUPT |
|
|
1421 | } |
|
|
1422 | |
1294 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1423 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1295 | our (%SIG_ASY, %SIG_ASY_W); |
1424 | our (%SIG_ASY, %SIG_ASY_W); |
1296 | our ($SIG_COUNT, $SIG_TW); |
1425 | our ($SIG_COUNT, $SIG_TW); |
1297 | |
1426 | |
1298 | sub _signal_exec { |
1427 | sub _signal_exec { |
1299 | $HAVE_ASYNC_INTERRUPT |
1428 | $HAVE_ASYNC_INTERRUPT |
1300 | ? $SIGPIPE_R->drain |
1429 | ? $SIGPIPE_R->drain |
1301 | : sysread $SIGPIPE_R, my $dummy, 9; |
1430 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1302 | |
1431 | |
1303 | while (%SIG_EV) { |
1432 | while (%SIG_EV) { |
1304 | for (keys %SIG_EV) { |
1433 | for (keys %SIG_EV) { |
1305 | delete $SIG_EV{$_}; |
1434 | delete $SIG_EV{$_}; |
1306 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1435 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1307 | } |
1436 | } |
1308 | } |
1437 | } |
1309 | } |
1438 | } |
1310 | |
1439 | |
1311 | # install a dumym wakeupw atcher to reduce signal catching latency |
1440 | # install a dummy wakeup watcher to reduce signal catching latency |
1312 | sub _sig_add() { |
1441 | sub _sig_add() { |
1313 | unless ($SIG_COUNT++) { |
1442 | unless ($SIG_COUNT++) { |
1314 | # try to align timer on a full-second boundary, if possible |
1443 | # try to align timer on a full-second boundary, if possible |
1315 | my $NOW = AnyEvent->now; |
1444 | my $NOW = AE::now; |
1316 | |
1445 | |
1317 | $SIG_TW = AnyEvent->timer ( |
1446 | $SIG_TW = AE::timer |
1318 | after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), |
1447 | $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), |
1319 | interval => $MAX_SIGNAL_LATENCY, |
1448 | $MAX_SIGNAL_LATENCY, |
1320 | cb => sub { }, # just for the PERL_ASYNC_CHECK |
1449 | sub { } # just for the PERL_ASYNC_CHECK |
1321 | ); |
1450 | ; |
1322 | } |
1451 | } |
1323 | } |
1452 | } |
1324 | |
1453 | |
1325 | sub _sig_del { |
1454 | sub _sig_del { |
1326 | undef $SIG_TW |
1455 | undef $SIG_TW |
1327 | unless --$SIG_COUNT; |
1456 | unless --$SIG_COUNT; |
1328 | } |
1457 | } |
1329 | |
1458 | |
|
|
1459 | our $_sig_name_init; $_sig_name_init = sub { |
|
|
1460 | eval q{ # poor man's autoloading |
|
|
1461 | undef $_sig_name_init; |
|
|
1462 | |
|
|
1463 | if (_have_async_interrupt) { |
|
|
1464 | *sig2num = \&Async::Interrupt::sig2num; |
|
|
1465 | *sig2name = \&Async::Interrupt::sig2name; |
|
|
1466 | } else { |
|
|
1467 | require Config; |
|
|
1468 | |
|
|
1469 | my %signame2num; |
|
|
1470 | @signame2num{ split ' ', $Config::Config{sig_name} } |
|
|
1471 | = split ' ', $Config::Config{sig_num}; |
|
|
1472 | |
|
|
1473 | my @signum2name; |
|
|
1474 | @signum2name[values %signame2num] = keys %signame2num; |
|
|
1475 | |
|
|
1476 | *sig2num = sub($) { |
|
|
1477 | $_[0] > 0 ? shift : $signame2num{+shift} |
|
|
1478 | }; |
|
|
1479 | *sig2name = sub ($) { |
|
|
1480 | $_[0] > 0 ? $signum2name[+shift] : shift |
|
|
1481 | }; |
|
|
1482 | } |
|
|
1483 | }; |
|
|
1484 | die if $@; |
|
|
1485 | }; |
|
|
1486 | |
|
|
1487 | sub sig2num ($) { &$_sig_name_init; &sig2num } |
|
|
1488 | sub sig2name($) { &$_sig_name_init; &sig2name } |
|
|
1489 | |
1330 | sub _signal { |
1490 | sub signal { |
|
|
1491 | eval q{ # poor man's autoloading {} |
|
|
1492 | # probe for availability of Async::Interrupt |
|
|
1493 | if (_have_async_interrupt) { |
|
|
1494 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
|
|
1495 | |
|
|
1496 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1497 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
|
|
1498 | |
|
|
1499 | } else { |
|
|
1500 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1501 | |
|
|
1502 | require Fcntl; |
|
|
1503 | |
|
|
1504 | if (AnyEvent::WIN32) { |
|
|
1505 | require AnyEvent::Util; |
|
|
1506 | |
|
|
1507 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1508 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; |
|
|
1509 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case |
|
|
1510 | } else { |
|
|
1511 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1512 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1513 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1514 | |
|
|
1515 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1516 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1517 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1518 | } |
|
|
1519 | |
|
|
1520 | $SIGPIPE_R |
|
|
1521 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1522 | |
|
|
1523 | $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec; |
|
|
1524 | } |
|
|
1525 | |
|
|
1526 | *signal = sub { |
1331 | my (undef, %arg) = @_; |
1527 | my (undef, %arg) = @_; |
1332 | |
1528 | |
1333 | my $signal = uc $arg{signal} |
1529 | my $signal = uc $arg{signal} |
1334 | or Carp::croak "required option 'signal' is missing"; |
1530 | or Carp::croak "required option 'signal' is missing"; |
1335 | |
1531 | |
1336 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1337 | |
|
|
1338 | if ($HAVE_ASYNC_INTERRUPT) { |
1532 | if ($HAVE_ASYNC_INTERRUPT) { |
1339 | # async::interrupt |
1533 | # async::interrupt |
1340 | |
1534 | |
1341 | $SIG_ASY{$signal} ||= do { |
1535 | $signal = sig2num $signal; |
1342 | my $asy = new Async::Interrupt |
1536 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1537 | |
|
|
1538 | $SIG_ASY{$signal} ||= new Async::Interrupt |
1343 | cb => sub { undef $SIG_EV{$signal} }, |
1539 | cb => sub { undef $SIG_EV{$signal} }, |
1344 | signal => $signal, |
1540 | signal => $signal, |
1345 | pipe => [$SIGPIPE_R->filenos], |
1541 | pipe => [$SIGPIPE_R->filenos], |
|
|
1542 | pipe_autodrain => 0, |
|
|
1543 | ; |
|
|
1544 | |
|
|
1545 | } else { |
|
|
1546 | # pure perl |
|
|
1547 | |
|
|
1548 | # AE::Util has been loaded in signal |
|
|
1549 | $signal = sig2name $signal; |
|
|
1550 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1551 | |
|
|
1552 | $SIG{$signal} ||= sub { |
|
|
1553 | local $!; |
|
|
1554 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1555 | undef $SIG_EV{$signal}; |
|
|
1556 | }; |
|
|
1557 | |
|
|
1558 | # can't do signal processing without introducing races in pure perl, |
|
|
1559 | # so limit the signal latency. |
|
|
1560 | _sig_add; |
1346 | ; |
1561 | } |
1347 | $asy->pipe_autodrain (0); |
|
|
1348 | |
1562 | |
1349 | $asy |
1563 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1350 | }; |
1564 | }; |
1351 | |
1565 | |
1352 | } else { |
1566 | *AnyEvent::Base::signal::DESTROY = sub { |
1353 | # pure perl |
1567 | my ($signal, $cb) = @{$_[0]}; |
1354 | |
1568 | |
1355 | $SIG{$signal} ||= sub { |
1569 | _sig_del; |
1356 | local $!; |
1570 | |
1357 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1571 | delete $SIG_CB{$signal}{$cb}; |
|
|
1572 | |
|
|
1573 | $HAVE_ASYNC_INTERRUPT |
|
|
1574 | ? delete $SIG_ASY{$signal} |
|
|
1575 | : # delete doesn't work with older perls - they then |
|
|
1576 | # print weird messages, or just unconditionally exit |
|
|
1577 | # instead of getting the default action. |
1358 | undef $SIG_EV{$signal}; |
1578 | undef $SIG{$signal} |
|
|
1579 | unless keys %{ $SIG_CB{$signal} }; |
1359 | }; |
1580 | }; |
1360 | |
|
|
1361 | # can't do signal processing without introducing races in pure perl, |
|
|
1362 | # so limit the signal latency. |
|
|
1363 | _sig_add; |
|
|
1364 | } |
1581 | }; |
1365 | |
1582 | die if $@; |
1366 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1367 | } |
|
|
1368 | |
|
|
1369 | sub signal { |
|
|
1370 | # probe for availability of Async::Interrupt |
|
|
1371 | if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") { |
|
|
1372 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
|
|
1373 | |
|
|
1374 | $HAVE_ASYNC_INTERRUPT = 1; |
|
|
1375 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1376 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
|
|
1377 | |
|
|
1378 | } else { |
|
|
1379 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1380 | |
|
|
1381 | require Fcntl; |
|
|
1382 | |
|
|
1383 | if (AnyEvent::WIN32) { |
|
|
1384 | require AnyEvent::Util; |
|
|
1385 | |
|
|
1386 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1387 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1388 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1389 | } else { |
|
|
1390 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1391 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1392 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1393 | |
|
|
1394 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1395 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1396 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1397 | } |
|
|
1398 | |
|
|
1399 | $SIGPIPE_R |
|
|
1400 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1401 | |
|
|
1402 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1403 | } |
|
|
1404 | |
|
|
1405 | *signal = \&_signal; |
|
|
1406 | &signal |
1583 | &signal |
1407 | } |
|
|
1408 | |
|
|
1409 | sub AnyEvent::Base::signal::DESTROY { |
|
|
1410 | my ($signal, $cb) = @{$_[0]}; |
|
|
1411 | |
|
|
1412 | _sig_del; |
|
|
1413 | |
|
|
1414 | delete $SIG_CB{$signal}{$cb}; |
|
|
1415 | |
|
|
1416 | $HAVE_ASYNC_INTERRUPT |
|
|
1417 | ? delete $SIG_ASY{$signal} |
|
|
1418 | : # delete doesn't work with older perls - they then |
|
|
1419 | # print weird messages, or just unconditionally exit |
|
|
1420 | # instead of getting the default action. |
|
|
1421 | undef $SIG{$signal} |
|
|
1422 | unless keys %{ $SIG_CB{$signal} }; |
|
|
1423 | } |
1584 | } |
1424 | |
1585 | |
1425 | # default implementation for ->child |
1586 | # default implementation for ->child |
1426 | |
1587 | |
1427 | our %PID_CB; |
1588 | our %PID_CB; |
… | |
… | |
1456 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
1617 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
1457 | ? 1 |
1618 | ? 1 |
1458 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1619 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1459 | |
1620 | |
1460 | unless ($CHLD_W) { |
1621 | unless ($CHLD_W) { |
1461 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1622 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1462 | # child could be a zombie already, so make at least one round |
1623 | # child could be a zombie already, so make at least one round |
1463 | &_sigchld; |
1624 | &_sigchld; |
1464 | } |
1625 | } |
1465 | |
1626 | |
1466 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1627 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
… | |
… | |
1492 | # never use more then 50% of the time for the idle watcher, |
1653 | # never use more then 50% of the time for the idle watcher, |
1493 | # within some limits |
1654 | # within some limits |
1494 | $w = 0.0001 if $w < 0.0001; |
1655 | $w = 0.0001 if $w < 0.0001; |
1495 | $w = 5 if $w > 5; |
1656 | $w = 5 if $w > 5; |
1496 | |
1657 | |
1497 | $w = AnyEvent->timer (after => $w, cb => $rcb); |
1658 | $w = AE::timer $w, 0, $rcb; |
1498 | } else { |
1659 | } else { |
1499 | # clean up... |
1660 | # clean up... |
1500 | undef $w; |
1661 | undef $w; |
1501 | undef $rcb; |
1662 | undef $rcb; |
1502 | } |
1663 | } |
1503 | }; |
1664 | }; |
1504 | |
1665 | |
1505 | $w = AnyEvent->timer (after => 0.05, cb => $rcb); |
1666 | $w = AE::timer 0.05, 0, $rcb; |
1506 | |
1667 | |
1507 | bless \\$cb, "AnyEvent::Base::idle" |
1668 | bless \\$cb, "AnyEvent::Base::idle" |
1508 | } |
1669 | } |
1509 | |
1670 | |
1510 | sub AnyEvent::Base::idle::DESTROY { |
1671 | sub AnyEvent::Base::idle::DESTROY { |
… | |
… | |
1564 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1725 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1565 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1726 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1566 | } |
1727 | } |
1567 | |
1728 | |
1568 | sub cb { |
1729 | sub cb { |
1569 | $_[0]{_ae_cb} = $_[1] if @_ > 1; |
1730 | my $cv = shift; |
|
|
1731 | |
|
|
1732 | @_ |
|
|
1733 | and $cv->{_ae_cb} = shift |
|
|
1734 | and $cv->{_ae_sent} |
|
|
1735 | and (delete $cv->{_ae_cb})->($cv); |
|
|
1736 | |
1570 | $_[0]{_ae_cb} |
1737 | $cv->{_ae_cb} |
1571 | } |
1738 | } |
1572 | |
1739 | |
1573 | sub begin { |
1740 | sub begin { |
1574 | ++$_[0]{_ae_counter}; |
1741 | ++$_[0]{_ae_counter}; |
1575 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
1742 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
… | |
… | |
1784 | warn "read: $input\n"; # output what has been read |
1951 | warn "read: $input\n"; # output what has been read |
1785 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1952 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1786 | }, |
1953 | }, |
1787 | ); |
1954 | ); |
1788 | |
1955 | |
1789 | my $time_watcher; # can only be used once |
|
|
1790 | |
|
|
1791 | sub new_timer { |
|
|
1792 | $timer = AnyEvent->timer (after => 1, cb => sub { |
1956 | my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub { |
1793 | warn "timeout\n"; # print 'timeout' about every second |
1957 | warn "timeout\n"; # print 'timeout' at most every second |
1794 | &new_timer; # and restart the time |
|
|
1795 | }); |
1958 | }); |
1796 | } |
|
|
1797 | |
|
|
1798 | new_timer; # create first timer |
|
|
1799 | |
1959 | |
1800 | $cv->recv; # wait until user enters /^q/i |
1960 | $cv->recv; # wait until user enters /^q/i |
1801 | |
1961 | |
1802 | =head1 REAL-WORLD EXAMPLE |
1962 | =head1 REAL-WORLD EXAMPLE |
1803 | |
1963 | |
… | |
… | |
1934 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
2094 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1935 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
2095 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1936 | which it is), lets them fire exactly once and destroys them again. |
2096 | which it is), lets them fire exactly once and destroys them again. |
1937 | |
2097 | |
1938 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
2098 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1939 | distribution. |
2099 | distribution. It uses the L<AE> interface, which makes a real difference |
|
|
2100 | for the EV and Perl backends only. |
1940 | |
2101 | |
1941 | =head3 Explanation of the columns |
2102 | =head3 Explanation of the columns |
1942 | |
2103 | |
1943 | I<watcher> is the number of event watchers created/destroyed. Since |
2104 | I<watcher> is the number of event watchers created/destroyed. Since |
1944 | different event models feature vastly different performances, each event |
2105 | different event models feature vastly different performances, each event |
… | |
… | |
1965 | watcher. |
2126 | watcher. |
1966 | |
2127 | |
1967 | =head3 Results |
2128 | =head3 Results |
1968 | |
2129 | |
1969 | name watchers bytes create invoke destroy comment |
2130 | name watchers bytes create invoke destroy comment |
1970 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
2131 | EV/EV 100000 223 0.47 0.43 0.27 EV native interface |
1971 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
2132 | EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers |
1972 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
2133 | Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal |
1973 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
2134 | Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation |
1974 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
2135 | Event/Event 16000 516 31.16 31.84 0.82 Event native interface |
1975 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
2136 | Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers |
1976 | IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll |
2137 | IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll |
1977 | IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll |
2138 | IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll |
1978 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
2139 | Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour |
1979 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
2140 | Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers |
1980 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
2141 | POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event |
1981 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
2142 | POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select |
1982 | |
2143 | |
1983 | =head3 Discussion |
2144 | =head3 Discussion |
1984 | |
2145 | |
1985 | The benchmark does I<not> measure scalability of the event loop very |
2146 | The benchmark does I<not> measure scalability of the event loop very |
1986 | well. For example, a select-based event loop (such as the pure perl one) |
2147 | well. For example, a select-based event loop (such as the pure perl one) |
… | |
… | |
1998 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
2159 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
1999 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU |
2160 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU |
2000 | cycles with POE. |
2161 | cycles with POE. |
2001 | |
2162 | |
2002 | C<EV> is the sole leader regarding speed and memory use, which are both |
2163 | C<EV> is the sole leader regarding speed and memory use, which are both |
2003 | maximal/minimal, respectively. Even when going through AnyEvent, it uses |
2164 | maximal/minimal, respectively. When using the L<AE> API there is zero |
|
|
2165 | overhead (when going through the AnyEvent API create is about 5-6 times |
|
|
2166 | slower, with other times being equal, so still uses far less memory than |
2004 | far less memory than any other event loop and is still faster than Event |
2167 | any other event loop and is still faster than Event natively). |
2005 | natively. |
|
|
2006 | |
2168 | |
2007 | The pure perl implementation is hit in a few sweet spots (both the |
2169 | The pure perl implementation is hit in a few sweet spots (both the |
2008 | constant timeout and the use of a single fd hit optimisations in the perl |
2170 | constant timeout and the use of a single fd hit optimisations in the perl |
2009 | interpreter and the backend itself). Nevertheless this shows that it |
2171 | interpreter and the backend itself). Nevertheless this shows that it |
2010 | adds very little overhead in itself. Like any select-based backend its |
2172 | adds very little overhead in itself. Like any select-based backend its |
… | |
… | |
2084 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
2246 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
2085 | (1%) are active. This mirrors the activity of large servers with many |
2247 | (1%) are active. This mirrors the activity of large servers with many |
2086 | connections, most of which are idle at any one point in time. |
2248 | connections, most of which are idle at any one point in time. |
2087 | |
2249 | |
2088 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
2250 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
2089 | distribution. |
2251 | distribution. It uses the L<AE> interface, which makes a real difference |
|
|
2252 | for the EV and Perl backends only. |
2090 | |
2253 | |
2091 | =head3 Explanation of the columns |
2254 | =head3 Explanation of the columns |
2092 | |
2255 | |
2093 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
2256 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
2094 | each server has a read and write socket end). |
2257 | each server has a read and write socket end). |
… | |
… | |
2102 | a new one that moves the timeout into the future. |
2265 | a new one that moves the timeout into the future. |
2103 | |
2266 | |
2104 | =head3 Results |
2267 | =head3 Results |
2105 | |
2268 | |
2106 | name sockets create request |
2269 | name sockets create request |
2107 | EV 20000 69.01 11.16 |
2270 | EV 20000 62.66 7.99 |
2108 | Perl 20000 73.32 35.87 |
2271 | Perl 20000 68.32 32.64 |
2109 | IOAsync 20000 157.00 98.14 epoll |
2272 | IOAsync 20000 174.06 101.15 epoll |
2110 | IOAsync 20000 159.31 616.06 poll |
2273 | IOAsync 20000 174.67 610.84 poll |
2111 | Event 20000 212.62 257.32 |
2274 | Event 20000 202.69 242.91 |
2112 | Glib 20000 651.16 1896.30 |
2275 | Glib 20000 557.01 1689.52 |
2113 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
2276 | POE 20000 341.54 12086.32 uses POE::Loop::Event |
2114 | |
2277 | |
2115 | =head3 Discussion |
2278 | =head3 Discussion |
2116 | |
2279 | |
2117 | This benchmark I<does> measure scalability and overall performance of the |
2280 | This benchmark I<does> measure scalability and overall performance of the |
2118 | particular event loop. |
2281 | particular event loop. |
… | |
… | |
2244 | As you can see, the AnyEvent + EV combination even beats the |
2407 | As you can see, the AnyEvent + EV combination even beats the |
2245 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
2408 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
2246 | backend easily beats IO::Lambda and POE. |
2409 | backend easily beats IO::Lambda and POE. |
2247 | |
2410 | |
2248 | And even the 100% non-blocking version written using the high-level (and |
2411 | And even the 100% non-blocking version written using the high-level (and |
2249 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a |
2412 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda |
2250 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
2413 | higher level ("unoptimised") abstractions by a large margin, even though |
2251 | in a non-blocking way. |
2414 | it does all of DNS, tcp-connect and socket I/O in a non-blocking way. |
2252 | |
2415 | |
2253 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
2416 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
2254 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
2417 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
2255 | part of the IO::lambda distribution and were used without any changes. |
2418 | part of the IO::Lambda distribution and were used without any changes. |
2256 | |
2419 | |
2257 | |
2420 | |
2258 | =head1 SIGNALS |
2421 | =head1 SIGNALS |
2259 | |
2422 | |
2260 | AnyEvent currently installs handlers for these signals: |
2423 | AnyEvent currently installs handlers for these signals: |
… | |
… | |
2302 | it's built-in modules) are required to use it. |
2465 | it's built-in modules) are required to use it. |
2303 | |
2466 | |
2304 | That does not mean that AnyEvent won't take advantage of some additional |
2467 | That does not mean that AnyEvent won't take advantage of some additional |
2305 | modules if they are installed. |
2468 | modules if they are installed. |
2306 | |
2469 | |
2307 | This section epxlains which additional modules will be used, and how they |
2470 | This section explains which additional modules will be used, and how they |
2308 | affect AnyEvent's operetion. |
2471 | affect AnyEvent's operation. |
2309 | |
2472 | |
2310 | =over 4 |
2473 | =over 4 |
2311 | |
2474 | |
2312 | =item L<Async::Interrupt> |
2475 | =item L<Async::Interrupt> |
2313 | |
2476 | |
… | |
… | |
2318 | catch the signals) with some delay (default is 10 seconds, look for |
2481 | catch the signals) with some delay (default is 10 seconds, look for |
2319 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
2482 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
2320 | |
2483 | |
2321 | If this module is available, then it will be used to implement signal |
2484 | If this module is available, then it will be used to implement signal |
2322 | catching, which means that signals will not be delayed, and the event loop |
2485 | catching, which means that signals will not be delayed, and the event loop |
2323 | will not be interrupted regularly, which is more efficient (And good for |
2486 | will not be interrupted regularly, which is more efficient (and good for |
2324 | battery life on laptops). |
2487 | battery life on laptops). |
2325 | |
2488 | |
2326 | This affects not just the pure-perl event loop, but also other event loops |
2489 | This affects not just the pure-perl event loop, but also other event loops |
2327 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
2490 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
2328 | |
2491 | |
… | |
… | |
2349 | lot less memory), but otherwise doesn't affect guard operation much. It is |
2512 | lot less memory), but otherwise doesn't affect guard operation much. It is |
2350 | purely used for performance. |
2513 | purely used for performance. |
2351 | |
2514 | |
2352 | =item L<JSON> and L<JSON::XS> |
2515 | =item L<JSON> and L<JSON::XS> |
2353 | |
2516 | |
2354 | This module is required when you want to read or write JSON data via |
2517 | One of these modules is required when you want to read or write JSON data |
2355 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
2518 | via L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
2356 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
2519 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
2357 | |
2520 | |
2358 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
2521 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
2359 | installed. |
2522 | installed. |
2360 | |
2523 | |
… | |
… | |
2375 | |
2538 | |
2376 | |
2539 | |
2377 | =head1 FORK |
2540 | =head1 FORK |
2378 | |
2541 | |
2379 | Most event libraries are not fork-safe. The ones who are usually are |
2542 | Most event libraries are not fork-safe. The ones who are usually are |
2380 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2543 | because they rely on inefficient but fork-safe C<select> or C<poll> calls |
2381 | calls. Only L<EV> is fully fork-aware. |
2544 | - higher performance APIs such as BSD's kqueue or the dreaded Linux epoll |
|
|
2545 | are usually badly thought-out hacks that are incompatible with fork in |
|
|
2546 | one way or another. Only L<EV> is fully fork-aware and ensures that you |
|
|
2547 | continue event-processing in both parent and child (or both, if you know |
|
|
2548 | what you are doing). |
|
|
2549 | |
|
|
2550 | This means that, in general, you cannot fork and do event processing in |
|
|
2551 | the child if the event library was initialised before the fork (which |
|
|
2552 | usually happens when the first AnyEvent watcher is created, or the library |
|
|
2553 | is loaded). |
2382 | |
2554 | |
2383 | If you have to fork, you must either do so I<before> creating your first |
2555 | If you have to fork, you must either do so I<before> creating your first |
2384 | watcher OR you must not use AnyEvent at all in the child OR you must do |
2556 | watcher OR you must not use AnyEvent at all in the child OR you must do |
2385 | something completely out of the scope of AnyEvent. |
2557 | something completely out of the scope of AnyEvent. |
|
|
2558 | |
|
|
2559 | The problem of doing event processing in the parent I<and> the child |
|
|
2560 | is much more complicated: even for backends that I<are> fork-aware or |
|
|
2561 | fork-safe, their behaviour is not usually what you want: fork clones all |
|
|
2562 | watchers, that means all timers, I/O watchers etc. are active in both |
|
|
2563 | parent and child, which is almost never what you want. USing C<exec> |
|
|
2564 | to start worker children from some kind of manage rprocess is usually |
|
|
2565 | preferred, because it is much easier and cleaner, at the expense of having |
|
|
2566 | to have another binary. |
2386 | |
2567 | |
2387 | |
2568 | |
2388 | =head1 SECURITY CONSIDERATIONS |
2569 | =head1 SECURITY CONSIDERATIONS |
2389 | |
2570 | |
2390 | AnyEvent can be forced to load any event model via |
2571 | AnyEvent can be forced to load any event model via |