1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
3 | AnyEvent - the DBI of event loop programming |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt |
6 | event loops. |
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 | |
… | |
… | |
40 | =head1 INTRODUCTION/TUTORIAL |
40 | =head1 INTRODUCTION/TUTORIAL |
41 | |
41 | |
42 | This manpage is mainly a reference manual. If you are interested |
42 | This manpage is mainly a reference manual. If you are interested |
43 | in a tutorial or some gentle introduction, have a look at the |
43 | in a tutorial or some gentle introduction, have a look at the |
44 | L<AnyEvent::Intro> manpage. |
44 | L<AnyEvent::Intro> manpage. |
|
|
45 | |
|
|
46 | =head1 SUPPORT |
|
|
47 | |
|
|
48 | There is a mailinglist for discussing all things AnyEvent, and an IRC |
|
|
49 | channel, too. |
|
|
50 | |
|
|
51 | See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software |
|
|
52 | Repository>, at L<http://anyevent.schmorp.de>, for more info. |
45 | |
53 | |
46 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
54 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
47 | |
55 | |
48 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
56 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
49 | nowadays. So what is different about AnyEvent? |
57 | nowadays. So what is different about AnyEvent? |
… | |
… | |
173 | 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 |
174 | declared. |
182 | declared. |
175 | |
183 | |
176 | =head2 I/O WATCHERS |
184 | =head2 I/O WATCHERS |
177 | |
185 | |
|
|
186 | $w = AnyEvent->io ( |
|
|
187 | fh => <filehandle_or_fileno>, |
|
|
188 | poll => <"r" or "w">, |
|
|
189 | cb => <callback>, |
|
|
190 | ); |
|
|
191 | |
178 | 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 |
179 | with the following mandatory key-value pairs as arguments: |
193 | with the following mandatory key-value pairs as arguments: |
180 | |
194 | |
181 | 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 |
182 | 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 |
… | |
… | |
211 | undef $w; |
225 | undef $w; |
212 | }); |
226 | }); |
213 | |
227 | |
214 | =head2 TIME WATCHERS |
228 | =head2 TIME WATCHERS |
215 | |
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 | |
216 | 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 >> |
217 | method with the following mandatory arguments: |
239 | method with the following mandatory arguments: |
218 | |
240 | |
219 | C<after> specifies after how many seconds (fractional values are |
241 | C<after> specifies after how many seconds (fractional values are |
220 | 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 |
… | |
… | |
347 | |
369 | |
348 | =back |
370 | =back |
349 | |
371 | |
350 | =head2 SIGNAL WATCHERS |
372 | =head2 SIGNAL WATCHERS |
351 | |
373 | |
|
|
374 | $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>); |
|
|
375 | |
352 | You can watch for signals using a signal watcher, C<signal> is the signal |
376 | You can watch for signals using a signal watcher, C<signal> is the signal |
353 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
377 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
354 | callback to be invoked whenever a signal occurs. |
378 | callback to be invoked whenever a signal occurs. |
355 | |
379 | |
356 | Although the callback might get passed parameters, their value and |
380 | Although the callback might get passed parameters, their value and |
… | |
… | |
375 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
399 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
376 | |
400 | |
377 | =head3 Signal Races, Delays and Workarounds |
401 | =head3 Signal Races, Delays and Workarounds |
378 | |
402 | |
379 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
403 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
380 | callbacks to signals in a generic way, which is a pity, as you cannot do |
404 | callbacks to signals in a generic way, which is a pity, as you cannot |
381 | race-free signal handling in perl. AnyEvent will try to do it's best, but |
405 | do race-free signal handling in perl, requiring C libraries for |
|
|
406 | this. AnyEvent will try to do it's best, which means in some cases, |
382 | in some cases, signals will be delayed. The maximum time a signal might |
407 | signals will be delayed. The maximum time a signal might be delayed is |
383 | be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 |
408 | specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This |
384 | seconds). This variable can be changed only before the first signal |
409 | variable can be changed only before the first signal watcher is created, |
385 | watcher is created, and should be left alone otherwise. Higher values |
410 | and should be left alone otherwise. This variable determines how often |
|
|
411 | AnyEvent polls for signals (in case a wake-up was missed). Higher values |
386 | will cause fewer spurious wake-ups, which is better for power and CPU |
412 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
413 | saving. |
|
|
414 | |
387 | saving. All these problems can be avoided by installing the optional |
415 | All these problems can be avoided by installing the optional |
388 | L<Async::Interrupt> module. This will not work with inherently broken |
416 | L<Async::Interrupt> module, which works with most event loops. It will not |
389 | event loops such as L<Event> or L<Event::Lib> (and not with L<POE> |
417 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
390 | currently, as POE does it's own workaround with one-second latency). With |
418 | (and not with L<POE> currently, as POE does it's own workaround with |
391 | those, you just have to suffer the delays. |
419 | one-second latency). For those, you just have to suffer the delays. |
392 | |
420 | |
393 | =head2 CHILD PROCESS WATCHERS |
421 | =head2 CHILD PROCESS WATCHERS |
394 | |
422 | |
|
|
423 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
|
|
424 | |
395 | You can also watch on a child process exit and catch its exit status. |
425 | You can also watch on a child process exit and catch its exit status. |
396 | |
426 | |
397 | The child process is specified by the C<pid> argument (if set to C<0>, it |
427 | The child process is specified by the C<pid> argument (one some backends, |
398 | watches for any child process exit). The watcher will triggered only when |
428 | using C<0> watches for any child process exit, on others this will |
399 | the child process has finished and an exit status is available, not on |
429 | croak). The watcher will be triggered only when the child process has |
400 | any trace events (stopped/continued). |
430 | finished and an exit status is available, not on any trace events |
|
|
431 | (stopped/continued). |
401 | |
432 | |
402 | The callback will be called with the pid and exit status (as returned by |
433 | The callback will be called with the pid and exit status (as returned by |
403 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
434 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
404 | callback arguments. |
435 | callback arguments. |
405 | |
436 | |
… | |
… | |
446 | # do something else, then wait for process exit |
477 | # do something else, then wait for process exit |
447 | $done->recv; |
478 | $done->recv; |
448 | |
479 | |
449 | =head2 IDLE WATCHERS |
480 | =head2 IDLE WATCHERS |
450 | |
481 | |
|
|
482 | $w = AnyEvent->idle (cb => <callback>); |
|
|
483 | |
451 | Sometimes there is a need to do something, but it is not so important |
484 | Sometimes there is a need to do something, but it is not so important |
452 | to do it instantly, but only when there is nothing better to do. This |
485 | to do it instantly, but only when there is nothing better to do. This |
453 | "nothing better to do" is usually defined to be "no other events need |
486 | "nothing better to do" is usually defined to be "no other events need |
454 | attention by the event loop". |
487 | attention by the event loop". |
455 | |
488 | |
… | |
… | |
481 | }); |
514 | }); |
482 | }); |
515 | }); |
483 | |
516 | |
484 | =head2 CONDITION VARIABLES |
517 | =head2 CONDITION VARIABLES |
485 | |
518 | |
|
|
519 | $cv = AnyEvent->condvar; |
|
|
520 | |
|
|
521 | $cv->send (<list>); |
|
|
522 | my @res = $cv->recv; |
|
|
523 | |
486 | If you are familiar with some event loops you will know that all of them |
524 | If you are familiar with some event loops you will know that all of them |
487 | require you to run some blocking "loop", "run" or similar function that |
525 | require you to run some blocking "loop", "run" or similar function that |
488 | will actively watch for new events and call your callbacks. |
526 | will actively watch for new events and call your callbacks. |
489 | |
527 | |
490 | AnyEvent is slightly different: it expects somebody else to run the event |
528 | AnyEvent is slightly different: it expects somebody else to run the event |
… | |
… | |
509 | Condition variables are similar to callbacks, except that you can |
547 | Condition variables are similar to callbacks, except that you can |
510 | optionally wait for them. They can also be called merge points - points |
548 | optionally wait for them. They can also be called merge points - points |
511 | in time where multiple outstanding events have been processed. And yet |
549 | in time where multiple outstanding events have been processed. And yet |
512 | another way to call them is transactions - each condition variable can be |
550 | another way to call them is transactions - each condition variable can be |
513 | used to represent a transaction, which finishes at some point and delivers |
551 | used to represent a transaction, which finishes at some point and delivers |
514 | a result. |
552 | a result. And yet some people know them as "futures" - a promise to |
|
|
553 | compute/deliver something that you can wait for. |
515 | |
554 | |
516 | Condition variables are very useful to signal that something has finished, |
555 | Condition variables are very useful to signal that something has finished, |
517 | for example, if you write a module that does asynchronous http requests, |
556 | for example, if you write a module that does asynchronous http requests, |
518 | then a condition variable would be the ideal candidate to signal the |
557 | then a condition variable would be the ideal candidate to signal the |
519 | availability of results. The user can either act when the callback is |
558 | availability of results. The user can either act when the callback is |
… | |
… | |
553 | after => 1, |
592 | after => 1, |
554 | cb => sub { $result_ready->send }, |
593 | cb => sub { $result_ready->send }, |
555 | ); |
594 | ); |
556 | |
595 | |
557 | # this "blocks" (while handling events) till the callback |
596 | # this "blocks" (while handling events) till the callback |
558 | # calls -<send |
597 | # calls ->send |
559 | $result_ready->recv; |
598 | $result_ready->recv; |
560 | |
599 | |
561 | Example: wait for a timer, but take advantage of the fact that condition |
600 | Example: wait for a timer, but take advantage of the fact that condition |
562 | variables are also callable directly. |
601 | variables are also callable directly. |
563 | |
602 | |
… | |
… | |
627 | one. For example, a function that pings many hosts in parallel might want |
666 | one. For example, a function that pings many hosts in parallel might want |
628 | to use a condition variable for the whole process. |
667 | to use a condition variable for the whole process. |
629 | |
668 | |
630 | Every call to C<< ->begin >> will increment a counter, and every call to |
669 | Every call to C<< ->begin >> will increment a counter, and every call to |
631 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
670 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
632 | >>, the (last) callback passed to C<begin> will be executed. That callback |
671 | >>, the (last) callback passed to C<begin> will be executed, passing the |
633 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
672 | condvar as first argument. That callback is I<supposed> to call C<< ->send |
634 | callback was set, C<send> will be called without any arguments. |
673 | >>, but that is not required. If no group callback was set, C<send> will |
|
|
674 | be called without any arguments. |
635 | |
675 | |
636 | You can think of C<< $cv->send >> giving you an OR condition (one call |
676 | You can think of C<< $cv->send >> giving you an OR condition (one call |
637 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
677 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
638 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
678 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
639 | |
679 | |
… | |
… | |
666 | begung can potentially be zero: |
706 | begung can potentially be zero: |
667 | |
707 | |
668 | my $cv = AnyEvent->condvar; |
708 | my $cv = AnyEvent->condvar; |
669 | |
709 | |
670 | my %result; |
710 | my %result; |
671 | $cv->begin (sub { $cv->send (\%result) }); |
711 | $cv->begin (sub { shift->send (\%result) }); |
672 | |
712 | |
673 | for my $host (@list_of_hosts) { |
713 | for my $host (@list_of_hosts) { |
674 | $cv->begin; |
714 | $cv->begin; |
675 | ping_host_then_call_callback $host, sub { |
715 | ping_host_then_call_callback $host, sub { |
676 | $result{$host} = ...; |
716 | $result{$host} = ...; |
… | |
… | |
751 | =item $cb = $cv->cb ($cb->($cv)) |
791 | =item $cb = $cv->cb ($cb->($cv)) |
752 | |
792 | |
753 | This is a mutator function that returns the callback set and optionally |
793 | This is a mutator function that returns the callback set and optionally |
754 | replaces it before doing so. |
794 | replaces it before doing so. |
755 | |
795 | |
756 | The callback will be called when the condition becomes "true", i.e. when |
796 | The callback will be called when the condition becomes (or already was) |
757 | C<send> or C<croak> are called, with the only argument being the condition |
797 | "true", i.e. when C<send> or C<croak> are called (or were called), with |
758 | variable itself. Calling C<recv> inside the callback or at any later time |
798 | the only argument being the condition variable itself. Calling C<recv> |
759 | is guaranteed not to block. |
799 | inside the callback or at any later time is guaranteed not to block. |
760 | |
800 | |
761 | =back |
801 | =back |
762 | |
802 | |
763 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
803 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
764 | |
804 | |
… | |
… | |
767 | =over 4 |
807 | =over 4 |
768 | |
808 | |
769 | =item Backends that are autoprobed when no other event loop can be found. |
809 | =item Backends that are autoprobed when no other event loop can be found. |
770 | |
810 | |
771 | EV is the preferred backend when no other event loop seems to be in |
811 | EV is the preferred backend when no other event loop seems to be in |
772 | use. If EV is not installed, then AnyEvent will try Event, and, failing |
812 | use. If EV is not installed, then AnyEvent will fall back to its own |
773 | that, will fall back to its own pure-perl implementation, which is |
813 | pure-perl implementation, which is available everywhere as it comes with |
774 | available everywhere as it comes with AnyEvent itself. |
814 | AnyEvent itself. |
775 | |
815 | |
776 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
816 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
777 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
778 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
817 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
779 | |
818 | |
780 | =item Backends that are transparently being picked up when they are used. |
819 | =item Backends that are transparently being picked up when they are used. |
781 | |
820 | |
782 | These will be used when they are currently loaded when the first watcher |
821 | These will be used when they are currently loaded when the first watcher |
783 | is created, in which case it is assumed that the application is using |
822 | is created, in which case it is assumed that the application is using |
784 | them. This means that AnyEvent will automatically pick the right backend |
823 | them. This means that AnyEvent will automatically pick the right backend |
785 | when the main program loads an event module before anything starts to |
824 | when the main program loads an event module before anything starts to |
786 | create watchers. Nothing special needs to be done by the main program. |
825 | create watchers. Nothing special needs to be done by the main program. |
787 | |
826 | |
|
|
827 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
788 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
828 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
789 | AnyEvent::Impl::Tk based on Tk, very broken. |
829 | AnyEvent::Impl::Tk based on Tk, very broken. |
790 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
830 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
791 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
831 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
832 | AnyEvent::Impl::Irssi used when running within irssi. |
792 | |
833 | |
793 | =item Backends with special needs. |
834 | =item Backends with special needs. |
794 | |
835 | |
795 | Qt requires the Qt::Application to be instantiated first, but will |
836 | Qt requires the Qt::Application to be instantiated first, but will |
796 | otherwise be picked up automatically. As long as the main program |
837 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
870 | event module detection too early, for example, L<AnyEvent::AIO> creates |
911 | event module detection too early, for example, L<AnyEvent::AIO> creates |
871 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
912 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
872 | avoid autodetecting the event module at load time. |
913 | avoid autodetecting the event module at load time. |
873 | |
914 | |
874 | If called in scalar or list context, then it creates and returns an object |
915 | If called in scalar or list context, then it creates and returns an object |
875 | that automatically removes the callback again when it is destroyed. See |
916 | that automatically removes the callback again when it is destroyed (or |
|
|
917 | C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for |
876 | L<Coro::BDB> for a case where this is useful. |
918 | a case where this is useful. |
|
|
919 | |
|
|
920 | Example: Create a watcher for the IO::AIO module and store it in |
|
|
921 | C<$WATCHER>. Only do so after the event loop is initialised, though. |
|
|
922 | |
|
|
923 | our WATCHER; |
|
|
924 | |
|
|
925 | my $guard = AnyEvent::post_detect { |
|
|
926 | $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); |
|
|
927 | }; |
|
|
928 | |
|
|
929 | # the ||= is important in case post_detect immediately runs the block, |
|
|
930 | # as to not clobber the newly-created watcher. assigning both watcher and |
|
|
931 | # post_detect guard to the same variable has the advantage of users being |
|
|
932 | # able to just C<undef $WATCHER> if the watcher causes them grief. |
|
|
933 | |
|
|
934 | $WATCHER ||= $guard; |
877 | |
935 | |
878 | =item @AnyEvent::post_detect |
936 | =item @AnyEvent::post_detect |
879 | |
937 | |
880 | If there are any code references in this array (you can C<push> to it |
938 | If there are any code references in this array (you can C<push> to it |
881 | before or after loading AnyEvent), then they will called directly after |
939 | before or after loading AnyEvent), then they will called directly after |
… | |
… | |
1048 | |
1106 | |
1049 | package AnyEvent; |
1107 | package AnyEvent; |
1050 | |
1108 | |
1051 | # basically a tuned-down version of common::sense |
1109 | # basically a tuned-down version of common::sense |
1052 | sub common_sense { |
1110 | sub common_sense { |
1053 | # no warnings |
1111 | # from common:.sense 1.0 |
1054 | ${^WARNING_BITS} ^= ${^WARNING_BITS}; |
1112 | ${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03"; |
1055 | # use strict vars subs |
1113 | # use strict vars subs |
1056 | $^H |= 0x00000600; |
1114 | $^H |= 0x00000600; |
1057 | } |
1115 | } |
1058 | |
1116 | |
1059 | BEGIN { AnyEvent::common_sense } |
1117 | BEGIN { AnyEvent::common_sense } |
1060 | |
1118 | |
1061 | use Carp (); |
1119 | use Carp (); |
1062 | |
1120 | |
1063 | our $VERSION = 4.85; |
1121 | our $VERSION = '5.12'; |
1064 | our $MODEL; |
1122 | our $MODEL; |
1065 | |
1123 | |
1066 | our $AUTOLOAD; |
1124 | our $AUTOLOAD; |
1067 | our @ISA; |
1125 | our @ISA; |
1068 | |
1126 | |
… | |
… | |
1093 | for reverse split /\s*,\s*/, |
1151 | for reverse split /\s*,\s*/, |
1094 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1152 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1095 | } |
1153 | } |
1096 | |
1154 | |
1097 | my @models = ( |
1155 | my @models = ( |
1098 | [EV:: => AnyEvent::Impl::EV::], |
1156 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1099 | [Event:: => AnyEvent::Impl::Event::], |
|
|
1100 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1157 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1101 | # everything below here will not be autoprobed |
1158 | # everything below here will not (normally) be autoprobed |
1102 | # as the pureperl backend should work everywhere |
1159 | # as the pureperl backend should work everywhere |
1103 | # and is usually faster |
1160 | # and is usually faster |
|
|
1161 | [Event:: => AnyEvent::Impl::Event::, 1], |
1104 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1162 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1105 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1163 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
1164 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1106 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1165 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1107 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1166 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1108 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1167 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1109 | [Wx:: => AnyEvent::Impl::POE::], |
1168 | [Wx:: => AnyEvent::Impl::POE::], |
1110 | [Prima:: => AnyEvent::Impl::POE::], |
1169 | [Prima:: => AnyEvent::Impl::POE::], |
1111 | # IO::Async is just too broken - we would need workarounds for its |
1170 | # IO::Async is just too broken - we would need workarounds for its |
1112 | # byzantine signal and broken child handling, among others. |
1171 | # byzantine signal and broken child handling, among others. |
1113 | # IO::Async is rather hard to detect, as it doesn't have any |
1172 | # IO::Async is rather hard to detect, as it doesn't have any |
1114 | # obvious default class. |
1173 | # obvious default class. |
1115 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1174 | [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1116 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1175 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1117 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1176 | [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1177 | [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1118 | ); |
1178 | ); |
1119 | |
1179 | |
1120 | our %method = map +($_ => 1), |
1180 | our %method = map +($_ => 1), |
1121 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1181 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1122 | |
1182 | |
… | |
… | |
1126 | my ($cb) = @_; |
1186 | my ($cb) = @_; |
1127 | |
1187 | |
1128 | if ($MODEL) { |
1188 | if ($MODEL) { |
1129 | $cb->(); |
1189 | $cb->(); |
1130 | |
1190 | |
1131 | 1 |
1191 | undef |
1132 | } else { |
1192 | } else { |
1133 | push @post_detect, $cb; |
1193 | push @post_detect, $cb; |
1134 | |
1194 | |
1135 | defined wantarray |
1195 | defined wantarray |
1136 | ? bless \$cb, "AnyEvent::Util::postdetect" |
1196 | ? bless \$cb, "AnyEvent::Util::postdetect" |
… | |
… | |
1168 | } |
1228 | } |
1169 | } |
1229 | } |
1170 | } |
1230 | } |
1171 | |
1231 | |
1172 | unless ($MODEL) { |
1232 | unless ($MODEL) { |
1173 | # try to load a model |
1233 | # try to autoload a model |
1174 | |
|
|
1175 | for (@REGISTRY, @models) { |
1234 | for (@REGISTRY, @models) { |
1176 | my ($package, $model) = @$_; |
1235 | my ($package, $model, $autoload) = @$_; |
|
|
1236 | if ( |
|
|
1237 | $autoload |
1177 | if (eval "require $package" |
1238 | and eval "require $package" |
1178 | and ${"$package\::VERSION"} > 0 |
1239 | and ${"$package\::VERSION"} > 0 |
1179 | and eval "require $model") { |
1240 | and eval "require $model" |
|
|
1241 | ) { |
1180 | $MODEL = $model; |
1242 | $MODEL = $model; |
1181 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; |
1243 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1182 | last; |
1244 | last; |
1183 | } |
1245 | } |
1184 | } |
1246 | } |
1185 | |
1247 | |
1186 | $MODEL |
1248 | $MODEL |
… | |
… | |
1227 | # we assume CLOEXEC is already set by perl in all important cases |
1289 | # we assume CLOEXEC is already set by perl in all important cases |
1228 | |
1290 | |
1229 | ($fh2, $rw) |
1291 | ($fh2, $rw) |
1230 | } |
1292 | } |
1231 | |
1293 | |
|
|
1294 | =head1 SIMPLIFIED AE API |
|
|
1295 | |
|
|
1296 | Starting with version 5.0, AnyEvent officially supports a second, much |
|
|
1297 | simpler, API that is designed to reduce the calling, typing and memory |
|
|
1298 | overhead. |
|
|
1299 | |
|
|
1300 | See the L<AE> manpage for details. |
|
|
1301 | |
|
|
1302 | =cut |
|
|
1303 | |
|
|
1304 | package AE; |
|
|
1305 | |
|
|
1306 | our $VERSION = $AnyEvent::VERSION; |
|
|
1307 | |
|
|
1308 | sub io($$$) { |
|
|
1309 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
|
|
1310 | } |
|
|
1311 | |
|
|
1312 | sub timer($$$) { |
|
|
1313 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
|
|
1314 | } |
|
|
1315 | |
|
|
1316 | sub signal($$) { |
|
|
1317 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
|
|
1318 | } |
|
|
1319 | |
|
|
1320 | sub child($$) { |
|
|
1321 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
|
|
1322 | } |
|
|
1323 | |
|
|
1324 | sub idle($) { |
|
|
1325 | AnyEvent->idle (cb => $_[0]) |
|
|
1326 | } |
|
|
1327 | |
|
|
1328 | sub cv(;&) { |
|
|
1329 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
|
|
1330 | } |
|
|
1331 | |
|
|
1332 | sub now() { |
|
|
1333 | AnyEvent->now |
|
|
1334 | } |
|
|
1335 | |
|
|
1336 | sub now_update() { |
|
|
1337 | AnyEvent->now_update |
|
|
1338 | } |
|
|
1339 | |
|
|
1340 | sub time() { |
|
|
1341 | AnyEvent->time |
|
|
1342 | } |
|
|
1343 | |
1232 | package AnyEvent::Base; |
1344 | package AnyEvent::Base; |
1233 | |
1345 | |
1234 | # default implementations for many methods |
1346 | # default implementations for many methods |
1235 | |
1347 | |
1236 | sub _time { |
1348 | sub _time() { |
1237 | # probe for availability of Time::HiRes |
1349 | # probe for availability of Time::HiRes |
1238 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1350 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1239 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1351 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1240 | *_time = \&Time::HiRes::time; |
1352 | *_time = \&Time::HiRes::time; |
1241 | # if (eval "use POSIX (); (POSIX::times())... |
1353 | # if (eval "use POSIX (); (POSIX::times())... |
… | |
… | |
1258 | } |
1370 | } |
1259 | |
1371 | |
1260 | # default implementation for ->signal |
1372 | # default implementation for ->signal |
1261 | |
1373 | |
1262 | our $HAVE_ASYNC_INTERRUPT; |
1374 | our $HAVE_ASYNC_INTERRUPT; |
|
|
1375 | |
|
|
1376 | sub _have_async_interrupt() { |
|
|
1377 | $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} |
|
|
1378 | && eval "use Async::Interrupt 1.02 (); 1") |
|
|
1379 | unless defined $HAVE_ASYNC_INTERRUPT; |
|
|
1380 | |
|
|
1381 | $HAVE_ASYNC_INTERRUPT |
|
|
1382 | } |
|
|
1383 | |
1263 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1384 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1264 | our (%SIG_ASY, %SIG_ASY_W); |
1385 | our (%SIG_ASY, %SIG_ASY_W); |
1265 | our ($SIG_COUNT, $SIG_TW); |
1386 | our ($SIG_COUNT, $SIG_TW); |
1266 | |
1387 | |
1267 | sub _signal_exec { |
1388 | sub _signal_exec { |
… | |
… | |
1275 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1396 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1276 | } |
1397 | } |
1277 | } |
1398 | } |
1278 | } |
1399 | } |
1279 | |
1400 | |
1280 | # install a dumym wakeupw atcher to reduce signal catching latency |
1401 | # install a dummy wakeup watcher to reduce signal catching latency |
1281 | sub _sig_add() { |
1402 | sub _sig_add() { |
1282 | unless ($SIG_COUNT++) { |
1403 | unless ($SIG_COUNT++) { |
1283 | # try to align timer on a full-second boundary, if possible |
1404 | # try to align timer on a full-second boundary, if possible |
1284 | my $NOW = AnyEvent->now; |
1405 | my $NOW = AE::now; |
1285 | |
1406 | |
1286 | $SIG_TW = AnyEvent->timer ( |
1407 | $SIG_TW = AE::timer |
1287 | after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), |
1408 | $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), |
1288 | interval => $MAX_SIGNAL_LATENCY, |
1409 | $MAX_SIGNAL_LATENCY, |
1289 | cb => sub { }, # just for the PERL_ASYNC_CHECK |
1410 | sub { } # just for the PERL_ASYNC_CHECK |
1290 | ); |
1411 | ; |
1291 | } |
1412 | } |
1292 | } |
1413 | } |
1293 | |
1414 | |
1294 | sub _sig_del { |
1415 | sub _sig_del { |
1295 | undef $SIG_TW |
1416 | undef $SIG_TW |
1296 | unless --$SIG_COUNT; |
1417 | unless --$SIG_COUNT; |
1297 | } |
1418 | } |
1298 | |
1419 | |
|
|
1420 | our $_sig_name_init; $_sig_name_init = sub { |
|
|
1421 | eval q{ # poor man's autoloading |
|
|
1422 | undef $_sig_name_init; |
|
|
1423 | |
|
|
1424 | if (_have_async_interrupt) { |
|
|
1425 | *sig2num = \&Async::Interrupt::sig2num; |
|
|
1426 | *sig2name = \&Async::Interrupt::sig2name; |
|
|
1427 | } else { |
|
|
1428 | require Config; |
|
|
1429 | |
|
|
1430 | my %signame2num; |
|
|
1431 | @signame2num{ split ' ', $Config::Config{sig_name} } |
|
|
1432 | = split ' ', $Config::Config{sig_num}; |
|
|
1433 | |
|
|
1434 | my @signum2name; |
|
|
1435 | @signum2name[values %signame2num] = keys %signame2num; |
|
|
1436 | |
|
|
1437 | *sig2num = sub($) { |
|
|
1438 | $_[0] > 0 ? shift : $signame2num{+shift} |
|
|
1439 | }; |
|
|
1440 | *sig2name = sub ($) { |
|
|
1441 | $_[0] > 0 ? $signum2name[+shift] : shift |
|
|
1442 | }; |
|
|
1443 | } |
|
|
1444 | }; |
|
|
1445 | die if $@; |
|
|
1446 | }; |
|
|
1447 | |
|
|
1448 | sub sig2num ($) { &$_sig_name_init; &sig2num } |
|
|
1449 | sub sig2name($) { &$_sig_name_init; &sig2name } |
|
|
1450 | |
1299 | sub _signal { |
1451 | sub signal { |
|
|
1452 | eval q{ # poor man's autoloading {} |
|
|
1453 | # probe for availability of Async::Interrupt |
|
|
1454 | if (_have_async_interrupt) { |
|
|
1455 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
|
|
1456 | |
|
|
1457 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1458 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
|
|
1459 | |
|
|
1460 | } else { |
|
|
1461 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1462 | |
|
|
1463 | require Fcntl; |
|
|
1464 | |
|
|
1465 | if (AnyEvent::WIN32) { |
|
|
1466 | require AnyEvent::Util; |
|
|
1467 | |
|
|
1468 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1469 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; |
|
|
1470 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case |
|
|
1471 | } else { |
|
|
1472 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1473 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1474 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1475 | |
|
|
1476 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1477 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1478 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1479 | } |
|
|
1480 | |
|
|
1481 | $SIGPIPE_R |
|
|
1482 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1483 | |
|
|
1484 | $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec; |
|
|
1485 | } |
|
|
1486 | |
|
|
1487 | *signal = sub { |
1300 | my (undef, %arg) = @_; |
1488 | my (undef, %arg) = @_; |
1301 | |
1489 | |
1302 | my $signal = uc $arg{signal} |
1490 | my $signal = uc $arg{signal} |
1303 | or Carp::croak "required option 'signal' is missing"; |
1491 | or Carp::croak "required option 'signal' is missing"; |
1304 | |
1492 | |
1305 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1306 | |
|
|
1307 | if ($HAVE_ASYNC_INTERRUPT) { |
1493 | if ($HAVE_ASYNC_INTERRUPT) { |
1308 | # async::interrupt |
1494 | # async::interrupt |
1309 | |
1495 | |
1310 | $SIG_ASY{$signal} ||= do { |
1496 | $signal = sig2num $signal; |
1311 | my $asy = new Async::Interrupt |
1497 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1498 | |
|
|
1499 | $SIG_ASY{$signal} ||= new Async::Interrupt |
1312 | cb => sub { undef $SIG_EV{$signal} }, |
1500 | cb => sub { undef $SIG_EV{$signal} }, |
1313 | signal => $signal, |
1501 | signal => $signal, |
1314 | pipe => [$SIGPIPE_R->filenos], |
1502 | pipe => [$SIGPIPE_R->filenos], |
|
|
1503 | pipe_autodrain => 0, |
|
|
1504 | ; |
|
|
1505 | |
|
|
1506 | } else { |
|
|
1507 | # pure perl |
|
|
1508 | |
|
|
1509 | # AE::Util has been loaded in signal |
|
|
1510 | $signal = sig2name $signal; |
|
|
1511 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1512 | |
|
|
1513 | $SIG{$signal} ||= sub { |
|
|
1514 | local $!; |
|
|
1515 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1516 | undef $SIG_EV{$signal}; |
|
|
1517 | }; |
|
|
1518 | |
|
|
1519 | # can't do signal processing without introducing races in pure perl, |
|
|
1520 | # so limit the signal latency. |
|
|
1521 | _sig_add; |
1315 | ; |
1522 | } |
1316 | $asy->pipe_autodrain (0); |
|
|
1317 | |
1523 | |
1318 | $asy |
1524 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1319 | }; |
1525 | }; |
1320 | |
1526 | |
1321 | } else { |
1527 | *AnyEvent::Base::signal::DESTROY = sub { |
1322 | # pure perl |
1528 | my ($signal, $cb) = @{$_[0]}; |
1323 | |
1529 | |
1324 | $SIG{$signal} ||= sub { |
1530 | _sig_del; |
1325 | local $!; |
1531 | |
1326 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1532 | delete $SIG_CB{$signal}{$cb}; |
|
|
1533 | |
|
|
1534 | $HAVE_ASYNC_INTERRUPT |
|
|
1535 | ? delete $SIG_ASY{$signal} |
|
|
1536 | : # delete doesn't work with older perls - they then |
|
|
1537 | # print weird messages, or just unconditionally exit |
|
|
1538 | # instead of getting the default action. |
1327 | undef $SIG_EV{$signal}; |
1539 | undef $SIG{$signal} |
|
|
1540 | unless keys %{ $SIG_CB{$signal} }; |
1328 | }; |
1541 | }; |
1329 | |
|
|
1330 | # can't do signal processing without introducing races in pure perl, |
|
|
1331 | # so limit the signal latency. |
|
|
1332 | _sig_add; |
|
|
1333 | } |
1542 | }; |
1334 | |
1543 | die if $@; |
1335 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1336 | } |
|
|
1337 | |
|
|
1338 | sub signal { |
|
|
1339 | # probe for availability of Async::Interrupt |
|
|
1340 | if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") { |
|
|
1341 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
|
|
1342 | |
|
|
1343 | $HAVE_ASYNC_INTERRUPT = 1; |
|
|
1344 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1345 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
|
|
1346 | |
|
|
1347 | } else { |
|
|
1348 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1349 | |
|
|
1350 | require Fcntl; |
|
|
1351 | |
|
|
1352 | if (AnyEvent::WIN32) { |
|
|
1353 | require AnyEvent::Util; |
|
|
1354 | |
|
|
1355 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1356 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1357 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1358 | } else { |
|
|
1359 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1360 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1361 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1362 | |
|
|
1363 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1364 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1365 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1366 | } |
|
|
1367 | |
|
|
1368 | $SIGPIPE_R |
|
|
1369 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1370 | |
|
|
1371 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1372 | } |
|
|
1373 | |
|
|
1374 | *signal = \&_signal; |
|
|
1375 | &signal |
1544 | &signal |
1376 | } |
|
|
1377 | |
|
|
1378 | sub AnyEvent::Base::signal::DESTROY { |
|
|
1379 | my ($signal, $cb) = @{$_[0]}; |
|
|
1380 | |
|
|
1381 | _sig_del; |
|
|
1382 | |
|
|
1383 | delete $SIG_CB{$signal}{$cb}; |
|
|
1384 | |
|
|
1385 | $HAVE_ASYNC_INTERRUPT |
|
|
1386 | ? delete $SIG_ASY{$signal} |
|
|
1387 | : # delete doesn't work with older perls - they then |
|
|
1388 | # print weird messages, or just unconditionally exit |
|
|
1389 | # instead of getting the default action. |
|
|
1390 | undef $SIG{$signal} |
|
|
1391 | unless keys %{ $SIG_CB{$signal} }; |
|
|
1392 | } |
1545 | } |
1393 | |
1546 | |
1394 | # default implementation for ->child |
1547 | # default implementation for ->child |
1395 | |
1548 | |
1396 | our %PID_CB; |
1549 | our %PID_CB; |
1397 | our $CHLD_W; |
1550 | our $CHLD_W; |
1398 | our $CHLD_DELAY_W; |
1551 | our $CHLD_DELAY_W; |
1399 | our $WNOHANG; |
1552 | our $WNOHANG; |
1400 | |
1553 | |
|
|
1554 | sub _emit_childstatus($$) { |
|
|
1555 | my (undef, $rpid, $rstatus) = @_; |
|
|
1556 | |
|
|
1557 | $_->($rpid, $rstatus) |
|
|
1558 | for values %{ $PID_CB{$rpid} || {} }, |
|
|
1559 | values %{ $PID_CB{0} || {} }; |
|
|
1560 | } |
|
|
1561 | |
1401 | sub _sigchld { |
1562 | sub _sigchld { |
|
|
1563 | my $pid; |
|
|
1564 | |
|
|
1565 | AnyEvent->_emit_childstatus ($pid, $?) |
1402 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1566 | while ($pid = waitpid -1, $WNOHANG) > 0; |
1403 | $_->($pid, $?) |
|
|
1404 | for values %{ $PID_CB{$pid} || {} }, |
|
|
1405 | values %{ $PID_CB{0} || {} }; |
|
|
1406 | } |
|
|
1407 | } |
1567 | } |
1408 | |
1568 | |
1409 | sub child { |
1569 | sub child { |
1410 | my (undef, %arg) = @_; |
1570 | my (undef, %arg) = @_; |
1411 | |
1571 | |
… | |
… | |
1418 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
1578 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
1419 | ? 1 |
1579 | ? 1 |
1420 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1580 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1421 | |
1581 | |
1422 | unless ($CHLD_W) { |
1582 | unless ($CHLD_W) { |
1423 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1583 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1424 | # child could be a zombie already, so make at least one round |
1584 | # child could be a zombie already, so make at least one round |
1425 | &_sigchld; |
1585 | &_sigchld; |
1426 | } |
1586 | } |
1427 | |
1587 | |
1428 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1588 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
… | |
… | |
1454 | # never use more then 50% of the time for the idle watcher, |
1614 | # never use more then 50% of the time for the idle watcher, |
1455 | # within some limits |
1615 | # within some limits |
1456 | $w = 0.0001 if $w < 0.0001; |
1616 | $w = 0.0001 if $w < 0.0001; |
1457 | $w = 5 if $w > 5; |
1617 | $w = 5 if $w > 5; |
1458 | |
1618 | |
1459 | $w = AnyEvent->timer (after => $w, cb => $rcb); |
1619 | $w = AE::timer $w, 0, $rcb; |
1460 | } else { |
1620 | } else { |
1461 | # clean up... |
1621 | # clean up... |
1462 | undef $w; |
1622 | undef $w; |
1463 | undef $rcb; |
1623 | undef $rcb; |
1464 | } |
1624 | } |
1465 | }; |
1625 | }; |
1466 | |
1626 | |
1467 | $w = AnyEvent->timer (after => 0.05, cb => $rcb); |
1627 | $w = AE::timer 0.05, 0, $rcb; |
1468 | |
1628 | |
1469 | bless \\$cb, "AnyEvent::Base::idle" |
1629 | bless \\$cb, "AnyEvent::Base::idle" |
1470 | } |
1630 | } |
1471 | |
1631 | |
1472 | sub AnyEvent::Base::idle::DESTROY { |
1632 | sub AnyEvent::Base::idle::DESTROY { |
… | |
… | |
1526 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1686 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1527 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1687 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1528 | } |
1688 | } |
1529 | |
1689 | |
1530 | sub cb { |
1690 | sub cb { |
1531 | $_[0]{_ae_cb} = $_[1] if @_ > 1; |
1691 | my $cv = shift; |
|
|
1692 | |
|
|
1693 | @_ |
|
|
1694 | and $cv->{_ae_cb} = shift |
|
|
1695 | and $cv->{_ae_sent} |
|
|
1696 | and (delete $cv->{_ae_cb})->($cv); |
|
|
1697 | |
1532 | $_[0]{_ae_cb} |
1698 | $cv->{_ae_cb} |
1533 | } |
1699 | } |
1534 | |
1700 | |
1535 | sub begin { |
1701 | sub begin { |
1536 | ++$_[0]{_ae_counter}; |
1702 | ++$_[0]{_ae_counter}; |
1537 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
1703 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
… | |
… | |
1746 | warn "read: $input\n"; # output what has been read |
1912 | warn "read: $input\n"; # output what has been read |
1747 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1913 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1748 | }, |
1914 | }, |
1749 | ); |
1915 | ); |
1750 | |
1916 | |
1751 | my $time_watcher; # can only be used once |
|
|
1752 | |
|
|
1753 | sub new_timer { |
|
|
1754 | $timer = AnyEvent->timer (after => 1, cb => sub { |
1917 | my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub { |
1755 | warn "timeout\n"; # print 'timeout' about every second |
1918 | warn "timeout\n"; # print 'timeout' at most every second |
1756 | &new_timer; # and restart the time |
|
|
1757 | }); |
1919 | }); |
1758 | } |
|
|
1759 | |
|
|
1760 | new_timer; # create first timer |
|
|
1761 | |
1920 | |
1762 | $cv->recv; # wait until user enters /^q/i |
1921 | $cv->recv; # wait until user enters /^q/i |
1763 | |
1922 | |
1764 | =head1 REAL-WORLD EXAMPLE |
1923 | =head1 REAL-WORLD EXAMPLE |
1765 | |
1924 | |
… | |
… | |
1896 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
2055 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1897 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
2056 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1898 | which it is), lets them fire exactly once and destroys them again. |
2057 | which it is), lets them fire exactly once and destroys them again. |
1899 | |
2058 | |
1900 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
2059 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1901 | distribution. |
2060 | distribution. It uses the L<AE> interface, which makes a real difference |
|
|
2061 | for the EV and Perl backends only. |
1902 | |
2062 | |
1903 | =head3 Explanation of the columns |
2063 | =head3 Explanation of the columns |
1904 | |
2064 | |
1905 | I<watcher> is the number of event watchers created/destroyed. Since |
2065 | I<watcher> is the number of event watchers created/destroyed. Since |
1906 | different event models feature vastly different performances, each event |
2066 | different event models feature vastly different performances, each event |
… | |
… | |
1927 | watcher. |
2087 | watcher. |
1928 | |
2088 | |
1929 | =head3 Results |
2089 | =head3 Results |
1930 | |
2090 | |
1931 | name watchers bytes create invoke destroy comment |
2091 | name watchers bytes create invoke destroy comment |
1932 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
2092 | EV/EV 100000 223 0.47 0.43 0.27 EV native interface |
1933 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
2093 | EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers |
1934 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
2094 | Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal |
1935 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
2095 | Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation |
1936 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
2096 | Event/Event 16000 516 31.16 31.84 0.82 Event native interface |
1937 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
2097 | Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers |
1938 | IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll |
2098 | IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll |
1939 | IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll |
2099 | IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll |
1940 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
2100 | Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour |
1941 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
2101 | Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers |
1942 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
2102 | POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event |
1943 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
2103 | POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select |
1944 | |
2104 | |
1945 | =head3 Discussion |
2105 | =head3 Discussion |
1946 | |
2106 | |
1947 | The benchmark does I<not> measure scalability of the event loop very |
2107 | The benchmark does I<not> measure scalability of the event loop very |
1948 | well. For example, a select-based event loop (such as the pure perl one) |
2108 | well. For example, a select-based event loop (such as the pure perl one) |
… | |
… | |
1960 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
2120 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
1961 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU |
2121 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU |
1962 | cycles with POE. |
2122 | cycles with POE. |
1963 | |
2123 | |
1964 | C<EV> is the sole leader regarding speed and memory use, which are both |
2124 | C<EV> is the sole leader regarding speed and memory use, which are both |
1965 | maximal/minimal, respectively. Even when going through AnyEvent, it uses |
2125 | maximal/minimal, respectively. When using the L<AE> API there is zero |
|
|
2126 | overhead (when going through the AnyEvent API create is about 5-6 times |
|
|
2127 | slower, with other times being equal, so still uses far less memory than |
1966 | far less memory than any other event loop and is still faster than Event |
2128 | any other event loop and is still faster than Event natively). |
1967 | natively. |
|
|
1968 | |
2129 | |
1969 | The pure perl implementation is hit in a few sweet spots (both the |
2130 | The pure perl implementation is hit in a few sweet spots (both the |
1970 | constant timeout and the use of a single fd hit optimisations in the perl |
2131 | constant timeout and the use of a single fd hit optimisations in the perl |
1971 | interpreter and the backend itself). Nevertheless this shows that it |
2132 | interpreter and the backend itself). Nevertheless this shows that it |
1972 | adds very little overhead in itself. Like any select-based backend its |
2133 | adds very little overhead in itself. Like any select-based backend its |
… | |
… | |
2046 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
2207 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
2047 | (1%) are active. This mirrors the activity of large servers with many |
2208 | (1%) are active. This mirrors the activity of large servers with many |
2048 | connections, most of which are idle at any one point in time. |
2209 | connections, most of which are idle at any one point in time. |
2049 | |
2210 | |
2050 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
2211 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
2051 | distribution. |
2212 | distribution. It uses the L<AE> interface, which makes a real difference |
|
|
2213 | for the EV and Perl backends only. |
2052 | |
2214 | |
2053 | =head3 Explanation of the columns |
2215 | =head3 Explanation of the columns |
2054 | |
2216 | |
2055 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
2217 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
2056 | each server has a read and write socket end). |
2218 | each server has a read and write socket end). |
… | |
… | |
2064 | a new one that moves the timeout into the future. |
2226 | a new one that moves the timeout into the future. |
2065 | |
2227 | |
2066 | =head3 Results |
2228 | =head3 Results |
2067 | |
2229 | |
2068 | name sockets create request |
2230 | name sockets create request |
2069 | EV 20000 69.01 11.16 |
2231 | EV 20000 62.66 7.99 |
2070 | Perl 20000 73.32 35.87 |
2232 | Perl 20000 68.32 32.64 |
2071 | IOAsync 20000 157.00 98.14 epoll |
2233 | IOAsync 20000 174.06 101.15 epoll |
2072 | IOAsync 20000 159.31 616.06 poll |
2234 | IOAsync 20000 174.67 610.84 poll |
2073 | Event 20000 212.62 257.32 |
2235 | Event 20000 202.69 242.91 |
2074 | Glib 20000 651.16 1896.30 |
2236 | Glib 20000 557.01 1689.52 |
2075 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
2237 | POE 20000 341.54 12086.32 uses POE::Loop::Event |
2076 | |
2238 | |
2077 | =head3 Discussion |
2239 | =head3 Discussion |
2078 | |
2240 | |
2079 | This benchmark I<does> measure scalability and overall performance of the |
2241 | This benchmark I<does> measure scalability and overall performance of the |
2080 | particular event loop. |
2242 | particular event loop. |
… | |
… | |
2206 | As you can see, the AnyEvent + EV combination even beats the |
2368 | As you can see, the AnyEvent + EV combination even beats the |
2207 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
2369 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
2208 | backend easily beats IO::Lambda and POE. |
2370 | backend easily beats IO::Lambda and POE. |
2209 | |
2371 | |
2210 | And even the 100% non-blocking version written using the high-level (and |
2372 | And even the 100% non-blocking version written using the high-level (and |
2211 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a |
2373 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda |
2212 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
2374 | higher level ("unoptimised") abstractions by a large margin, even though |
2213 | in a non-blocking way. |
2375 | it does all of DNS, tcp-connect and socket I/O in a non-blocking way. |
2214 | |
2376 | |
2215 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
2377 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
2216 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
2378 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
2217 | part of the IO::lambda distribution and were used without any changes. |
2379 | part of the IO::Lambda distribution and were used without any changes. |
2218 | |
2380 | |
2219 | |
2381 | |
2220 | =head1 SIGNALS |
2382 | =head1 SIGNALS |
2221 | |
2383 | |
2222 | AnyEvent currently installs handlers for these signals: |
2384 | AnyEvent currently installs handlers for these signals: |
… | |
… | |
2311 | lot less memory), but otherwise doesn't affect guard operation much. It is |
2473 | lot less memory), but otherwise doesn't affect guard operation much. It is |
2312 | purely used for performance. |
2474 | purely used for performance. |
2313 | |
2475 | |
2314 | =item L<JSON> and L<JSON::XS> |
2476 | =item L<JSON> and L<JSON::XS> |
2315 | |
2477 | |
2316 | This module is required when you want to read or write JSON data via |
2478 | One of these modules is required when you want to read or write JSON data |
2317 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
2479 | via L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
2318 | advantage of the ulta-high-speed L<JSON::XS> module when it is installed. |
2480 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
2319 | |
2481 | |
2320 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
2482 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
2321 | installed. |
2483 | installed. |
2322 | |
2484 | |
2323 | =item L<Net::SSLeay> |
2485 | =item L<Net::SSLeay> |
… | |
… | |
2390 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2552 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2391 | |
2553 | |
2392 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2554 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2393 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2555 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2394 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2556 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2395 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
2557 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2396 | |
2558 | |
2397 | Non-blocking file handles, sockets, TCP clients and |
2559 | Non-blocking file handles, sockets, TCP clients and |
2398 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2560 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2399 | |
2561 | |
2400 | Asynchronous DNS: L<AnyEvent::DNS>. |
2562 | Asynchronous DNS: L<AnyEvent::DNS>. |