ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.248 by root, Sat Jul 18 22:27:10 2009 UTC vs.
Revision 1.312 by root, Mon Feb 15 18:02:35 2010 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6event loops. 6and 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
42This manpage is mainly a reference manual. If you are interested 42This manpage is mainly a reference manual. If you are interested
43in a tutorial or some gentle introduction, have a look at the 43in a tutorial or some gentle introduction, have a look at the
44L<AnyEvent::Intro> manpage. 44L<AnyEvent::Intro> manpage.
45
46=head1 SUPPORT
47
48There is a mailinglist for discussing all things AnyEvent, and an IRC
49channel, too.
50
51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52Repository>, 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
48Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49nowadays. So what is different about AnyEvent? 57nowadays. So what is different about AnyEvent?
173my variables are only visible after the statement in which they are 181my variables are only visible after the statement in which they are
174declared. 182declared.
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
178You can create an I/O watcher by calling the C<< AnyEvent->io >> method 192You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179with the following mandatory key-value pairs as arguments: 193with the following mandatory key-value pairs as arguments:
180 194
181C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch 195C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182for events (AnyEvent might or might not keep a reference to this file 196for 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
216You can create a time watcher by calling the C<< AnyEvent->timer >> 238You can create a time watcher by calling the C<< AnyEvent->timer >>
217method with the following mandatory arguments: 239method with the following mandatory arguments:
218 240
219C<after> specifies after how many seconds (fractional values are 241C<after> specifies after how many seconds (fractional values are
220supported) the callback should be invoked. C<cb> is the callback to invoke 242supported) the callback should be invoked. C<cb> is the callback to invoke
341might affect timers and time-outs. 363might affect timers and time-outs.
342 364
343When this is the case, you can call this method, which will update the 365When this is the case, you can call this method, which will update the
344event loop's idea of "current time". 366event loop's idea of "current time".
345 367
368A typical example would be a script in a web server (e.g. C<mod_perl>) -
369when mod_perl executes the script, then the event loop will have the wrong
370idea about the "current time" (being potentially far in the past, when the
371script ran the last time). In that case you should arrange a call to C<<
372AnyEvent->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
346Note that updating the time I<might> cause some events to be handled. 375Note that updating the time I<might> cause some events to be handled.
347 376
348=back 377=back
349 378
350=head2 SIGNAL WATCHERS 379=head2 SIGNAL WATCHERS
380
381 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
351 382
352You can watch for signals using a signal watcher, C<signal> is the signal 383You can watch for signals using a signal watcher, C<signal> is the signal
353I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl 384I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
354callback to be invoked whenever a signal occurs. 385callback to be invoked whenever a signal occurs.
355 386
372 403
373Example: exit on SIGINT 404Example: exit on SIGINT
374 405
375 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 406 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
376 407
408=head3 Restart Behaviour
409
410While restart behaviour is up to the event loop implementation, most will
411not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
412pure perl implementation).
413
414=head3 Safe/Unsafe Signals
415
416Perl signals can be either "safe" (synchronous to opcode handling) or
417"unsafe" (asynchronous) - the former might get delayed indefinitely, the
418latter might corrupt your memory.
419
420AnyEvent signal handlers are, in addition, synchronous to the event loop,
421i.e. they will not interrupt your running perl program but will only be
422called as part of the normal event handling (just like timer, I/O etc.
423callbacks, too).
424
377=head3 Signal Races, Delays and Workarounds 425=head3 Signal Races, Delays and Workarounds
378 426
379Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 427Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
380callbacks to signals in a generic way, which is a pity, as you cannot do 428callbacks to signals in a generic way, which is a pity, as you cannot
381race-free signal handling in perl. AnyEvent will try to do it's best, but 429do race-free signal handling in perl, requiring C libraries for
430this. AnyEvent will try to do it's best, which means in some cases,
382in some cases, signals will be delayed. The maximum time a signal might 431signals will be delayed. The maximum time a signal might be delayed is
383be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 432specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
384seconds). This variable can be changed only before the first signal 433variable can be changed only before the first signal watcher is created,
385watcher is created, and should be left alone otherwise. Higher values 434and should be left alone otherwise. This variable determines how often
435AnyEvent polls for signals (in case a wake-up was missed). Higher values
386will cause fewer spurious wake-ups, which is better for power and CPU 436will cause fewer spurious wake-ups, which is better for power and CPU
437saving.
438
387saving. All these problems can be avoided by installing the optional 439All these problems can be avoided by installing the optional
388L<Async::Interrupt> module. This will not work with inherently broken 440L<Async::Interrupt> module, which works with most event loops. It will not
389event loops such as L<Event> or L<Event::Lib> (and not with L<POE> 441work with inherently broken event loops such as L<Event> or L<Event::Lib>
390currently, 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
391those, you just have to suffer the delays. 443one-second latency). For those, you just have to suffer the delays.
392 444
393=head2 CHILD PROCESS WATCHERS 445=head2 CHILD PROCESS WATCHERS
394 446
447 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
448
395You can also watch on a child process exit and catch its exit status. 449You can also watch on a child process exit and catch its exit status.
396 450
397The child process is specified by the C<pid> argument (if set to C<0>, it 451The child process is specified by the C<pid> argument (one some backends,
398watches for any child process exit). The watcher will triggered only when 452using C<0> watches for any child process exit, on others this will
399the child process has finished and an exit status is available, not on 453croak). The watcher will be triggered only when the child process has
400any trace events (stopped/continued). 454finished and an exit status is available, not on any trace events
455(stopped/continued).
401 456
402The callback will be called with the pid and exit status (as returned by 457The callback will be called with the pid and exit status (as returned by
403waitpid), so unlike other watcher types, you I<can> rely on child watcher 458waitpid), so unlike other watcher types, you I<can> rely on child watcher
404callback arguments. 459callback arguments.
405 460
446 # do something else, then wait for process exit 501 # do something else, then wait for process exit
447 $done->recv; 502 $done->recv;
448 503
449=head2 IDLE WATCHERS 504=head2 IDLE WATCHERS
450 505
451Sometimes there is a need to do something, but it is not so important 506 $w = AnyEvent->idle (cb => <callback>);
452to 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
454attention by the event loop".
455 507
456Idle watchers ideally get invoked when the event loop has nothing 508Repeatedly invoke the callback after the process becomes idle, until
457better to do, just before it would block the process to wait for new 509either the watcher is destroyed or new events have been detected.
458events. Instead of blocking, the idle watcher is invoked.
459 510
460Most event loops unfortunately do not really support idle watchers (only 511Idle watchers are useful when there is a need to do something, but it
512is not so important (or wise) to do it instantly. The callback will be
513invoked only when there is "nothing better to do", which is usually
514defined as "all outstanding events have been handled and no new events
515have been detected". That means that idle watchers ideally get invoked
516when the event loop has just polled for new events but none have been
517detected. Instead of blocking to wait for more events, the idle watchers
518will be invoked.
519
520Unfortunately, most event loops do not really support idle watchers (only
461EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent 521EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
462will simply call the callback "from time to time". 522will simply call the callback "from time to time".
463 523
464Example: read lines from STDIN, but only process them when the 524Example: read lines from STDIN, but only process them when the
465program is otherwise idle: 525program is otherwise idle:
481 }); 541 });
482 }); 542 });
483 543
484=head2 CONDITION VARIABLES 544=head2 CONDITION VARIABLES
485 545
546 $cv = AnyEvent->condvar;
547
548 $cv->send (<list>);
549 my @res = $cv->recv;
550
486If you are familiar with some event loops you will know that all of them 551If you are familiar with some event loops you will know that all of them
487require you to run some blocking "loop", "run" or similar function that 552require you to run some blocking "loop", "run" or similar function that
488will actively watch for new events and call your callbacks. 553will actively watch for new events and call your callbacks.
489 554
490AnyEvent is slightly different: it expects somebody else to run the event 555AnyEvent is slightly different: it expects somebody else to run the event
509Condition variables are similar to callbacks, except that you can 574Condition variables are similar to callbacks, except that you can
510optionally wait for them. They can also be called merge points - points 575optionally wait for them. They can also be called merge points - points
511in time where multiple outstanding events have been processed. And yet 576in time where multiple outstanding events have been processed. And yet
512another way to call them is transactions - each condition variable can be 577another way to call them is transactions - each condition variable can be
513used to represent a transaction, which finishes at some point and delivers 578used to represent a transaction, which finishes at some point and delivers
514a result. 579a result. And yet some people know them as "futures" - a promise to
580compute/deliver something that you can wait for.
515 581
516Condition variables are very useful to signal that something has finished, 582Condition variables are very useful to signal that something has finished,
517for example, if you write a module that does asynchronous http requests, 583for example, if you write a module that does asynchronous http requests,
518then a condition variable would be the ideal candidate to signal the 584then a condition variable would be the ideal candidate to signal the
519availability of results. The user can either act when the callback is 585availability of results. The user can either act when the callback is
553 after => 1, 619 after => 1,
554 cb => sub { $result_ready->send }, 620 cb => sub { $result_ready->send },
555 ); 621 );
556 622
557 # this "blocks" (while handling events) till the callback 623 # this "blocks" (while handling events) till the callback
558 # calls -<send 624 # calls ->send
559 $result_ready->recv; 625 $result_ready->recv;
560 626
561Example: wait for a timer, but take advantage of the fact that condition 627Example: wait for a timer, but take advantage of the fact that condition
562variables are also callable directly. 628variables are also callable directly.
563 629
627one. For example, a function that pings many hosts in parallel might want 693one. For example, a function that pings many hosts in parallel might want
628to use a condition variable for the whole process. 694to use a condition variable for the whole process.
629 695
630Every call to C<< ->begin >> will increment a counter, and every call to 696Every call to C<< ->begin >> will increment a counter, and every call to
631C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 697C<< ->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 698>>, the (last) callback passed to C<begin> will be executed, passing the
633is I<supposed> to call C<< ->send >>, but that is not required. If no 699condvar as first argument. That callback is I<supposed> to call C<< ->send
634callback 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
701be called without any arguments.
635 702
636You can think of C<< $cv->send >> giving you an OR condition (one call 703You can think of C<< $cv->send >> giving you an OR condition (one call
637sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND 704sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
638condition (all C<begin> calls must be C<end>'ed before the condvar sends). 705condition (all C<begin> calls must be C<end>'ed before the condvar sends).
639 706
666begung can potentially be zero: 733begung can potentially be zero:
667 734
668 my $cv = AnyEvent->condvar; 735 my $cv = AnyEvent->condvar;
669 736
670 my %result; 737 my %result;
671 $cv->begin (sub { $cv->send (\%result) }); 738 $cv->begin (sub { shift->send (\%result) });
672 739
673 for my $host (@list_of_hosts) { 740 for my $host (@list_of_hosts) {
674 $cv->begin; 741 $cv->begin;
675 ping_host_then_call_callback $host, sub { 742 ping_host_then_call_callback $host, sub {
676 $result{$host} = ...; 743 $result{$host} = ...;
751=item $cb = $cv->cb ($cb->($cv)) 818=item $cb = $cv->cb ($cb->($cv))
752 819
753This is a mutator function that returns the callback set and optionally 820This is a mutator function that returns the callback set and optionally
754replaces it before doing so. 821replaces it before doing so.
755 822
756The callback will be called when the condition becomes "true", i.e. when 823The callback will be called when the condition becomes (or already was)
757C<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
758variable itself. Calling C<recv> inside the callback or at any later time 825the only argument being the condition variable itself. Calling C<recv>
759is guaranteed not to block. 826inside the callback or at any later time is guaranteed not to block.
760 827
761=back 828=back
762 829
763=head1 SUPPORTED EVENT LOOPS/BACKENDS 830=head1 SUPPORTED EVENT LOOPS/BACKENDS
764 831
767=over 4 834=over 4
768 835
769=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.
770 837
771EV is the preferred backend when no other event loop seems to be in 838EV is the preferred backend when no other event loop seems to be in
772use. If EV is not installed, then AnyEvent will try Event, and, failing 839use. If EV is not installed, then AnyEvent will fall back to its own
773that, will fall back to its own pure-perl implementation, which is 840pure-perl implementation, which is available everywhere as it comes with
774available everywhere as it comes with AnyEvent itself. 841AnyEvent itself.
775 842
776 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 843 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. 844 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
779 845
780=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.
781 847
782These will be used when they are currently loaded when the first watcher 848These will be used when they are currently loaded when the first watcher
783is created, in which case it is assumed that the application is using 849is created, in which case it is assumed that the application is using
784them. This means that AnyEvent will automatically pick the right backend 850them. This means that AnyEvent will automatically pick the right backend
785when the main program loads an event module before anything starts to 851when the main program loads an event module before anything starts to
786create watchers. Nothing special needs to be done by the main program. 852create watchers. Nothing special needs to be done by the main program.
787 853
854 AnyEvent::Impl::Event based on Event, very stable, few glitches.
788 AnyEvent::Impl::Glib based on Glib, slow but very stable. 855 AnyEvent::Impl::Glib based on Glib, slow but very stable.
789 AnyEvent::Impl::Tk based on Tk, very broken. 856 AnyEvent::Impl::Tk based on Tk, very broken.
790 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 857 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
791 AnyEvent::Impl::POE based on POE, very slow, some limitations. 858 AnyEvent::Impl::POE based on POE, very slow, some limitations.
859 AnyEvent::Impl::Irssi used when running within irssi.
792 860
793=item Backends with special needs. 861=item Backends with special needs.
794 862
795Qt requires the Qt::Application to be instantiated first, but will 863Qt requires the Qt::Application to be instantiated first, but will
796otherwise be picked up automatically. As long as the main program 864otherwise be picked up automatically. As long as the main program
870event module detection too early, for example, L<AnyEvent::AIO> creates 938event module detection too early, for example, L<AnyEvent::AIO> creates
871and installs the global L<IO::AIO> watcher in a C<post_detect> block to 939and installs the global L<IO::AIO> watcher in a C<post_detect> block to
872avoid autodetecting the event module at load time. 940avoid autodetecting the event module at load time.
873 941
874If called in scalar or list context, then it creates and returns an object 942If called in scalar or list context, then it creates and returns an object
875that automatically removes the callback again when it is destroyed. See 943that automatically removes the callback again when it is destroyed (or
944C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
876L<Coro::BDB> for a case where this is useful. 945a case where this is useful.
946
947Example: Create a watcher for the IO::AIO module and store it in
948C<$WATCHER>. Only do so after the event loop is initialised, though.
949
950 our WATCHER;
951
952 my $guard = AnyEvent::post_detect {
953 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
954 };
955
956 # the ||= is important in case post_detect immediately runs the block,
957 # as to not clobber the newly-created watcher. assigning both watcher and
958 # post_detect guard to the same variable has the advantage of users being
959 # able to just C<undef $WATCHER> if the watcher causes them grief.
960
961 $WATCHER ||= $guard;
877 962
878=item @AnyEvent::post_detect 963=item @AnyEvent::post_detect
879 964
880If there are any code references in this array (you can C<push> to it 965If there are any code references in this array (you can C<push> to it
881before or after loading AnyEvent), then they will called directly after 966before or after loading AnyEvent), then they will called directly after
884You should check C<$AnyEvent::MODEL> before adding to this array, though: 969You should check C<$AnyEvent::MODEL> before adding to this array, though:
885if it is defined then the event loop has already been detected, and the 970if it is defined then the event loop has already been detected, and the
886array will be ignored. 971array will be ignored.
887 972
888Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 973Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
889it,as it takes care of these details. 974it, as it takes care of these details.
890 975
891This variable is mainly useful for modules that can do something useful 976This variable is mainly useful for modules that can do something useful
892when AnyEvent is used and thus want to know when it is initialised, but do 977when AnyEvent is used and thus want to know when it is initialised, but do
893not need to even load it by default. This array provides the means to hook 978not need to even load it by default. This array provides the means to hook
894into AnyEvent passively, without loading it. 979into AnyEvent passively, without loading it.
980
981Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
982together, you could put this into Coro (this is the actual code used by
983Coro 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 }
895 993
896=back 994=back
897 995
898=head1 WHAT TO DO IN A MODULE 996=head1 WHAT TO DO IN A MODULE
899 997
1048 1146
1049package AnyEvent; 1147package AnyEvent;
1050 1148
1051# basically a tuned-down version of common::sense 1149# basically a tuned-down version of common::sense
1052sub common_sense { 1150sub common_sense {
1053 # no warnings 1151 # from common:.sense 1.0
1054 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1152 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1055 # use strict vars subs 1153 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1056 $^H |= 0x00000600; 1154 $^H |= 0x00000600;
1057} 1155}
1058 1156
1059BEGIN { AnyEvent::common_sense } 1157BEGIN { AnyEvent::common_sense }
1060 1158
1061use Carp (); 1159use Carp ();
1062 1160
1063our $VERSION = 4.85; 1161our $VERSION = '5.24';
1064our $MODEL; 1162our $MODEL;
1065 1163
1066our $AUTOLOAD; 1164our $AUTOLOAD;
1067our @ISA; 1165our @ISA;
1068 1166
1069our @REGISTRY; 1167our @REGISTRY;
1070 1168
1071our $WIN32;
1072
1073our $VERBOSE; 1169our $VERBOSE;
1074 1170
1075BEGIN { 1171BEGIN {
1172 eval "sub CYGWIN(){" . (($^O =~ /cygwin/i) *1) . "}";
1076 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1173 eval "sub WIN32 (){" . (($^O =~ /mswin32/i)*1) . "}";
1077 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1174 eval "sub TAINT (){" . (${^TAINT} *1) . "}";
1078 1175
1079 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1176 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1080 if ${^TAINT}; 1177 if ${^TAINT};
1081 1178
1082 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1179 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1093 for reverse split /\s*,\s*/, 1190 for reverse split /\s*,\s*/,
1094 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1191 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1095} 1192}
1096 1193
1097my @models = ( 1194my @models = (
1098 [EV:: => AnyEvent::Impl::EV::], 1195 [EV:: => AnyEvent::Impl::EV:: , 1],
1099 [Event:: => AnyEvent::Impl::Event::],
1100 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1196 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1101 # everything below here will not be autoprobed 1197 # everything below here will not (normally) be autoprobed
1102 # as the pureperl backend should work everywhere 1198 # as the pureperl backend should work everywhere
1103 # and is usually faster 1199 # and is usually faster
1200 [Event:: => AnyEvent::Impl::Event::, 1],
1104 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1201 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1105 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1202 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1203 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1106 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1204 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1107 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1205 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1108 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1206 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1109 [Wx:: => AnyEvent::Impl::POE::], 1207 [Wx:: => AnyEvent::Impl::POE::],
1110 [Prima:: => AnyEvent::Impl::POE::], 1208 [Prima:: => AnyEvent::Impl::POE::],
1111 # 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
1112 # byzantine signal and broken child handling, among others. 1210 # byzantine signal and broken child handling, among others.
1113 # 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
1114 # obvious default class. 1212 # obvious default class.
1115# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1213 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1116# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1214 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1117# [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
1118); 1217);
1119 1218
1120our %method = map +($_ => 1), 1219our %method = map +($_ => 1),
1121 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);
1122 1221
1126 my ($cb) = @_; 1225 my ($cb) = @_;
1127 1226
1128 if ($MODEL) { 1227 if ($MODEL) {
1129 $cb->(); 1228 $cb->();
1130 1229
1131 1 1230 undef
1132 } else { 1231 } else {
1133 push @post_detect, $cb; 1232 push @post_detect, $cb;
1134 1233
1135 defined wantarray 1234 defined wantarray
1136 ? bless \$cb, "AnyEvent::Util::postdetect" 1235 ? bless \$cb, "AnyEvent::Util::postdetect"
1141sub AnyEvent::Util::postdetect::DESTROY { 1240sub AnyEvent::Util::postdetect::DESTROY {
1142 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1241 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1143} 1242}
1144 1243
1145sub detect() { 1244sub detect() {
1245 # free some memory
1246 *detect = sub () { $MODEL };
1247
1248 local $!; # for good measure
1249 local $SIG{__DIE__};
1250
1251 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1252 my $model = "AnyEvent::Impl::$1";
1253 if (eval "require $model") {
1254 $MODEL = $model;
1255 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1256 } else {
1257 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1258 }
1259 }
1260
1261 # check for already loaded models
1146 unless ($MODEL) { 1262 unless ($MODEL) {
1147 local $SIG{__DIE__}; 1263 for (@REGISTRY, @models) {
1148 1264 my ($package, $model) = @$_;
1149 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1265 if (${"$package\::VERSION"} > 0) {
1150 my $model = "AnyEvent::Impl::$1";
1151 if (eval "require $model") { 1266 if (eval "require $model") {
1152 $MODEL = $model; 1267 $MODEL = $model;
1153 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1268 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1154 } else { 1269 last;
1155 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1270 }
1156 } 1271 }
1157 } 1272 }
1158 1273
1159 # check for already loaded models
1160 unless ($MODEL) { 1274 unless ($MODEL) {
1275 # try to autoload a model
1161 for (@REGISTRY, @models) { 1276 for (@REGISTRY, @models) {
1162 my ($package, $model) = @$_; 1277 my ($package, $model, $autoload) = @$_;
1278 if (
1279 $autoload
1280 and eval "require $package"
1163 if (${"$package\::VERSION"} > 0) { 1281 and ${"$package\::VERSION"} > 0
1164 if (eval "require $model") { 1282 and eval "require $model"
1283 ) {
1165 $MODEL = $model; 1284 $MODEL = $model;
1166 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1285 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1167 last; 1286 last;
1168 }
1169 } 1287 }
1170 } 1288 }
1171 1289
1172 unless ($MODEL) {
1173 # try to load a model
1174
1175 for (@REGISTRY, @models) {
1176 my ($package, $model) = @$_;
1177 if (eval "require $package"
1178 and ${"$package\::VERSION"} > 0
1179 and eval "require $model") {
1180 $MODEL = $model;
1181 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1182 last;
1183 }
1184 }
1185
1186 $MODEL 1290 $MODEL
1187 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1291 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1188 }
1189 } 1292 }
1190
1191 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1192
1193 unshift @ISA, $MODEL;
1194
1195 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1196
1197 (shift @post_detect)->() while @post_detect;
1198 } 1293 }
1294
1295 @models = (); # free probe data
1296
1297 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1298 unshift @ISA, $MODEL;
1299
1300 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1301
1302 (shift @post_detect)->() while @post_detect;
1199 1303
1200 $MODEL 1304 $MODEL
1201} 1305}
1202 1306
1203sub AUTOLOAD { 1307sub AUTOLOAD {
1204 (my $func = $AUTOLOAD) =~ s/.*://; 1308 (my $func = $AUTOLOAD) =~ s/.*://;
1205 1309
1206 $method{$func} 1310 $method{$func}
1207 or Carp::croak "$func: not a valid method for AnyEvent objects"; 1311 or Carp::croak "$func: not a valid AnyEvent class method";
1208 1312
1209 detect unless $MODEL; 1313 detect;
1210 1314
1211 my $class = shift; 1315 my $class = shift;
1212 $class->$func (@_); 1316 $class->$func (@_);
1213} 1317}
1214 1318
1227 # we assume CLOEXEC is already set by perl in all important cases 1331 # we assume CLOEXEC is already set by perl in all important cases
1228 1332
1229 ($fh2, $rw) 1333 ($fh2, $rw)
1230} 1334}
1231 1335
1336=head1 SIMPLIFIED AE API
1337
1338Starting with version 5.0, AnyEvent officially supports a second, much
1339simpler, API that is designed to reduce the calling, typing and memory
1340overhead.
1341
1342See the L<AE> manpage for details.
1343
1344=cut
1345
1346package AE;
1347
1348our $VERSION = $AnyEvent::VERSION;
1349
1350sub io($$$) {
1351 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1352}
1353
1354sub timer($$$) {
1355 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1356}
1357
1358sub signal($$) {
1359 AnyEvent->signal (signal => $_[0], cb => $_[1])
1360}
1361
1362sub child($$) {
1363 AnyEvent->child (pid => $_[0], cb => $_[1])
1364}
1365
1366sub idle($) {
1367 AnyEvent->idle (cb => $_[0])
1368}
1369
1370sub cv(;&) {
1371 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1372}
1373
1374sub now() {
1375 AnyEvent->now
1376}
1377
1378sub now_update() {
1379 AnyEvent->now_update
1380}
1381
1382sub time() {
1383 AnyEvent->time
1384}
1385
1232package AnyEvent::Base; 1386package AnyEvent::Base;
1233 1387
1234# default implementations for many methods 1388# default implementations for many methods
1235 1389
1236sub _time { 1390sub _time() {
1391 eval q{ # poor man's autoloading
1237 # probe for availability of Time::HiRes 1392 # probe for availability of Time::HiRes
1238 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1393 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1239 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1394 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1240 *_time = \&Time::HiRes::time; 1395 *_time = \&Time::HiRes::time;
1241 # if (eval "use POSIX (); (POSIX::times())... 1396 # if (eval "use POSIX (); (POSIX::times())...
1242 } else { 1397 } else {
1243 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1398 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1244 *_time = sub { time }; # epic fail 1399 *_time = sub (){ time }; # epic fail
1400 }
1245 } 1401 };
1402 die if $@;
1246 1403
1247 &_time 1404 &_time
1248} 1405}
1249 1406
1250sub time { _time } 1407sub time { _time }
1258} 1415}
1259 1416
1260# default implementation for ->signal 1417# default implementation for ->signal
1261 1418
1262our $HAVE_ASYNC_INTERRUPT; 1419our $HAVE_ASYNC_INTERRUPT;
1420
1421sub _have_async_interrupt() {
1422 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1423 && eval "use Async::Interrupt 1.02 (); 1")
1424 unless defined $HAVE_ASYNC_INTERRUPT;
1425
1426 $HAVE_ASYNC_INTERRUPT
1427}
1428
1263our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1429our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1264our (%SIG_ASY, %SIG_ASY_W); 1430our (%SIG_ASY, %SIG_ASY_W);
1265our ($SIG_COUNT, $SIG_TW); 1431our ($SIG_COUNT, $SIG_TW);
1266 1432
1267sub _signal_exec {
1268 $HAVE_ASYNC_INTERRUPT
1269 ? $SIGPIPE_R->drain
1270 : sysread $SIGPIPE_R, my $dummy, 9;
1271
1272 while (%SIG_EV) {
1273 for (keys %SIG_EV) {
1274 delete $SIG_EV{$_};
1275 $_->() for values %{ $SIG_CB{$_} || {} };
1276 }
1277 }
1278}
1279
1280# install a dumym wakeupw atcher to reduce signal catching latency 1433# install a dummy wakeup watcher to reduce signal catching latency
1434# used by Impls
1281sub _sig_add() { 1435sub _sig_add() {
1282 unless ($SIG_COUNT++) { 1436 unless ($SIG_COUNT++) {
1283 # try to align timer on a full-second boundary, if possible 1437 # try to align timer on a full-second boundary, if possible
1284 my $NOW = AnyEvent->now; 1438 my $NOW = AE::now;
1285 1439
1286 $SIG_TW = AnyEvent->timer ( 1440 $SIG_TW = AE::timer
1287 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1441 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1288 interval => $MAX_SIGNAL_LATENCY, 1442 $MAX_SIGNAL_LATENCY,
1289 cb => sub { }, # just for the PERL_ASYNC_CHECK 1443 sub { } # just for the PERL_ASYNC_CHECK
1290 ); 1444 ;
1291 } 1445 }
1292} 1446}
1293 1447
1294sub _sig_del { 1448sub _sig_del {
1295 undef $SIG_TW 1449 undef $SIG_TW
1296 unless --$SIG_COUNT; 1450 unless --$SIG_COUNT;
1297} 1451}
1298 1452
1453our $_sig_name_init; $_sig_name_init = sub {
1454 eval q{ # poor man's autoloading
1455 undef $_sig_name_init;
1456
1457 if (_have_async_interrupt) {
1458 *sig2num = \&Async::Interrupt::sig2num;
1459 *sig2name = \&Async::Interrupt::sig2name;
1460 } else {
1461 require Config;
1462
1463 my %signame2num;
1464 @signame2num{ split ' ', $Config::Config{sig_name} }
1465 = split ' ', $Config::Config{sig_num};
1466
1467 my @signum2name;
1468 @signum2name[values %signame2num] = keys %signame2num;
1469
1470 *sig2num = sub($) {
1471 $_[0] > 0 ? shift : $signame2num{+shift}
1472 };
1473 *sig2name = sub ($) {
1474 $_[0] > 0 ? $signum2name[+shift] : shift
1475 };
1476 }
1477 };
1478 die if $@;
1479};
1480
1481sub sig2num ($) { &$_sig_name_init; &sig2num }
1482sub sig2name($) { &$_sig_name_init; &sig2name }
1483
1299sub _signal { 1484sub signal {
1485 eval q{ # poor man's autoloading {}
1486 # probe for availability of Async::Interrupt
1487 if (_have_async_interrupt) {
1488 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1489
1490 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1491 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1492
1493 } else {
1494 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1495
1496 require Fcntl;
1497
1498 if (AnyEvent::WIN32) {
1499 require AnyEvent::Util;
1500
1501 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1502 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1503 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1504 } else {
1505 pipe $SIGPIPE_R, $SIGPIPE_W;
1506 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1507 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1508
1509 # not strictly required, as $^F is normally 2, but let's make sure...
1510 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1511 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1512 }
1513
1514 $SIGPIPE_R
1515 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1516
1517 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1518 }
1519
1520 *signal = sub {
1300 my (undef, %arg) = @_; 1521 my (undef, %arg) = @_;
1301 1522
1302 my $signal = uc $arg{signal} 1523 my $signal = uc $arg{signal}
1303 or Carp::croak "required option 'signal' is missing"; 1524 or Carp::croak "required option 'signal' is missing";
1304 1525
1305 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1306
1307 if ($HAVE_ASYNC_INTERRUPT) { 1526 if ($HAVE_ASYNC_INTERRUPT) {
1308 # async::interrupt 1527 # async::interrupt
1309 1528
1310 $SIG_ASY{$signal} ||= do { 1529 $signal = sig2num $signal;
1311 my $asy = new Async::Interrupt 1530 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1531
1532 $SIG_ASY{$signal} ||= new Async::Interrupt
1312 cb => sub { undef $SIG_EV{$signal} }, 1533 cb => sub { undef $SIG_EV{$signal} },
1313 signal => $signal, 1534 signal => $signal,
1314 pipe => [$SIGPIPE_R->filenos], 1535 pipe => [$SIGPIPE_R->filenos],
1536 pipe_autodrain => 0,
1537 ;
1538
1539 } else {
1540 # pure perl
1541
1542 # AE::Util has been loaded in signal
1543 $signal = sig2name $signal;
1544 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1545
1546 $SIG{$signal} ||= sub {
1547 local $!;
1548 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1549 undef $SIG_EV{$signal};
1550 };
1551
1552 # can't do signal processing without introducing races in pure perl,
1553 # so limit the signal latency.
1554 _sig_add;
1315 ; 1555 }
1316 $asy->pipe_autodrain (0);
1317 1556
1318 $asy 1557 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1319 }; 1558 };
1320 1559
1321 } else { 1560 *AnyEvent::Base::signal::DESTROY = sub {
1322 # pure perl 1561 my ($signal, $cb) = @{$_[0]};
1323 1562
1324 $SIG{$signal} ||= sub { 1563 _sig_del;
1325 local $!; 1564
1326 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1565 delete $SIG_CB{$signal}{$cb};
1566
1567 $HAVE_ASYNC_INTERRUPT
1568 ? delete $SIG_ASY{$signal}
1569 : # delete doesn't work with older perls - they then
1570 # print weird messages, or just unconditionally exit
1571 # instead of getting the default action.
1327 undef $SIG_EV{$signal}; 1572 undef $SIG{$signal}
1573 unless keys %{ $SIG_CB{$signal} };
1328 }; 1574 };
1329 1575
1330 # can't do signal processing without introducing races in pure perl, 1576 *_signal_exec = sub {
1331 # so limit the signal latency.
1332 _sig_add;
1333 }
1334
1335 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1336}
1337
1338sub 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; 1577 $HAVE_ASYNC_INTERRUPT
1344 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1578 ? $SIGPIPE_R->drain
1345 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1579 : sysread $SIGPIPE_R, (my $dummy), 9;
1346 1580
1347 } else { 1581 while (%SIG_EV) {
1348 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1582 for (keys %SIG_EV) {
1349 1583 delete $SIG_EV{$_};
1350 require Fcntl; 1584 $_->() for values %{ $SIG_CB{$_} || {} };
1351 1585 }
1352 if (AnyEvent::WIN32) { 1586 }
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 } 1587 };
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 } 1588 };
1589 die if $@;
1373 1590
1374 *signal = \&_signal;
1375 &signal 1591 &signal
1376}
1377
1378sub 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} 1592}
1393 1593
1394# default implementation for ->child 1594# default implementation for ->child
1395 1595
1396our %PID_CB; 1596our %PID_CB;
1397our $CHLD_W; 1597our $CHLD_W;
1398our $CHLD_DELAY_W; 1598our $CHLD_DELAY_W;
1399our $WNOHANG; 1599our $WNOHANG;
1400 1600
1401sub _sigchld { 1601# used by many Impl's
1402 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1602sub _emit_childstatus($$) {
1403 $_->($pid, $?) 1603 my (undef, $rpid, $rstatus) = @_;
1604
1605 $_->($rpid, $rstatus)
1404 for values %{ $PID_CB{$pid} || {} }, 1606 for values %{ $PID_CB{$rpid} || {} },
1405 values %{ $PID_CB{0} || {} }; 1607 values %{ $PID_CB{0} || {} };
1406 }
1407} 1608}
1408 1609
1409sub child { 1610sub child {
1611 eval q{ # poor man's autoloading {}
1612 *_sigchld = sub {
1613 my $pid;
1614
1615 AnyEvent->_emit_childstatus ($pid, $?)
1616 while ($pid = waitpid -1, $WNOHANG) > 0;
1617 };
1618
1619 *child = sub {
1410 my (undef, %arg) = @_; 1620 my (undef, %arg) = @_;
1411 1621
1412 defined (my $pid = $arg{pid} + 0) 1622 defined (my $pid = $arg{pid} + 0)
1413 or Carp::croak "required option 'pid' is missing"; 1623 or Carp::croak "required option 'pid' is missing";
1414 1624
1415 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1625 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1416 1626
1417 # WNOHANG is almost cetrainly 1 everywhere 1627 # WNOHANG is almost cetrainly 1 everywhere
1418 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1628 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1419 ? 1 1629 ? 1
1420 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1630 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1421 1631
1422 unless ($CHLD_W) { 1632 unless ($CHLD_W) {
1423 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1633 $CHLD_W = AE::signal CHLD => \&_sigchld;
1424 # child could be a zombie already, so make at least one round 1634 # child could be a zombie already, so make at least one round
1425 &_sigchld; 1635 &_sigchld;
1426 } 1636 }
1427 1637
1428 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1638 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1429} 1639 };
1430 1640
1431sub AnyEvent::Base::child::DESTROY { 1641 *AnyEvent::Base::child::DESTROY = sub {
1432 my ($pid, $cb) = @{$_[0]}; 1642 my ($pid, $cb) = @{$_[0]};
1433 1643
1434 delete $PID_CB{$pid}{$cb}; 1644 delete $PID_CB{$pid}{$cb};
1435 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1645 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1436 1646
1437 undef $CHLD_W unless keys %PID_CB; 1647 undef $CHLD_W unless keys %PID_CB;
1648 };
1649 };
1650 die if $@;
1651
1652 &child
1438} 1653}
1439 1654
1440# idle emulation is done by simply using a timer, regardless 1655# idle emulation is done by simply using a timer, regardless
1441# of whether the process is idle or not, and not letting 1656# of whether the process is idle or not, and not letting
1442# the callback use more than 50% of the time. 1657# the callback use more than 50% of the time.
1443sub idle { 1658sub idle {
1659 eval q{ # poor man's autoloading {}
1660 *idle = sub {
1444 my (undef, %arg) = @_; 1661 my (undef, %arg) = @_;
1445 1662
1446 my ($cb, $w, $rcb) = $arg{cb}; 1663 my ($cb, $w, $rcb) = $arg{cb};
1447 1664
1448 $rcb = sub { 1665 $rcb = sub {
1449 if ($cb) { 1666 if ($cb) {
1450 $w = _time; 1667 $w = _time;
1451 &$cb; 1668 &$cb;
1452 $w = _time - $w; 1669 $w = _time - $w;
1453 1670
1454 # never use more then 50% of the time for the idle watcher, 1671 # never use more then 50% of the time for the idle watcher,
1455 # within some limits 1672 # within some limits
1456 $w = 0.0001 if $w < 0.0001; 1673 $w = 0.0001 if $w < 0.0001;
1457 $w = 5 if $w > 5; 1674 $w = 5 if $w > 5;
1458 1675
1459 $w = AnyEvent->timer (after => $w, cb => $rcb); 1676 $w = AE::timer $w, 0, $rcb;
1460 } else { 1677 } else {
1461 # clean up... 1678 # clean up...
1462 undef $w; 1679 undef $w;
1463 undef $rcb; 1680 undef $rcb;
1681 }
1682 };
1683
1684 $w = AE::timer 0.05, 0, $rcb;
1685
1686 bless \\$cb, "AnyEvent::Base::idle"
1464 } 1687 };
1688
1689 *AnyEvent::Base::idle::DESTROY = sub {
1690 undef $${$_[0]};
1691 };
1465 }; 1692 };
1693 die if $@;
1466 1694
1467 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1695 &idle
1468
1469 bless \\$cb, "AnyEvent::Base::idle"
1470}
1471
1472sub AnyEvent::Base::idle::DESTROY {
1473 undef $${$_[0]};
1474} 1696}
1475 1697
1476package AnyEvent::CondVar; 1698package AnyEvent::CondVar;
1477 1699
1478our @ISA = AnyEvent::CondVar::Base::; 1700our @ISA = AnyEvent::CondVar::Base::;
1526 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1748 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1527 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1749 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1528} 1750}
1529 1751
1530sub cb { 1752sub cb {
1531 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1753 my $cv = shift;
1754
1755 @_
1756 and $cv->{_ae_cb} = shift
1757 and $cv->{_ae_sent}
1758 and (delete $cv->{_ae_cb})->($cv);
1759
1532 $_[0]{_ae_cb} 1760 $cv->{_ae_cb}
1533} 1761}
1534 1762
1535sub begin { 1763sub begin {
1536 ++$_[0]{_ae_counter}; 1764 ++$_[0]{_ae_counter};
1537 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1765 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1746 warn "read: $input\n"; # output what has been read 1974 warn "read: $input\n"; # output what has been read
1747 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1975 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1748 }, 1976 },
1749 ); 1977 );
1750 1978
1751 my $time_watcher; # can only be used once
1752
1753 sub new_timer {
1754 $timer = AnyEvent->timer (after => 1, cb => sub { 1979 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1755 warn "timeout\n"; # print 'timeout' about every second 1980 warn "timeout\n"; # print 'timeout' at most every second
1756 &new_timer; # and restart the time
1757 }); 1981 });
1758 }
1759
1760 new_timer; # create first timer
1761 1982
1762 $cv->recv; # wait until user enters /^q/i 1983 $cv->recv; # wait until user enters /^q/i
1763 1984
1764=head1 REAL-WORLD EXAMPLE 1985=head1 REAL-WORLD EXAMPLE
1765 1986
1896through AnyEvent. The benchmark creates a lot of timers (with a zero 2117through AnyEvent. The benchmark creates a lot of timers (with a zero
1897timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2118timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1898which it is), lets them fire exactly once and destroys them again. 2119which it is), lets them fire exactly once and destroys them again.
1899 2120
1900Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2121Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1901distribution. 2122distribution. It uses the L<AE> interface, which makes a real difference
2123for the EV and Perl backends only.
1902 2124
1903=head3 Explanation of the columns 2125=head3 Explanation of the columns
1904 2126
1905I<watcher> is the number of event watchers created/destroyed. Since 2127I<watcher> is the number of event watchers created/destroyed. Since
1906different event models feature vastly different performances, each event 2128different event models feature vastly different performances, each event
1927watcher. 2149watcher.
1928 2150
1929=head3 Results 2151=head3 Results
1930 2152
1931 name watchers bytes create invoke destroy comment 2153 name watchers bytes create invoke destroy comment
1932 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2154 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 2155 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 2156 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 2157 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 2158 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 2159 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 2160 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 2161 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 2162 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 2163 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 2164 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 2165 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1944 2166
1945=head3 Discussion 2167=head3 Discussion
1946 2168
1947The benchmark does I<not> measure scalability of the event loop very 2169The benchmark does I<not> measure scalability of the event loop very
1948well. For example, a select-based event loop (such as the pure perl one) 2170well. For example, a select-based event loop (such as the pure perl one)
1960benchmark machine, handling an event takes roughly 1600 CPU cycles with 2182benchmark machine, handling an event takes roughly 1600 CPU cycles with
1961EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2183EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1962cycles with POE. 2184cycles with POE.
1963 2185
1964C<EV> is the sole leader regarding speed and memory use, which are both 2186C<EV> is the sole leader regarding speed and memory use, which are both
1965maximal/minimal, respectively. Even when going through AnyEvent, it uses 2187maximal/minimal, respectively. When using the L<AE> API there is zero
2188overhead (when going through the AnyEvent API create is about 5-6 times
2189slower, with other times being equal, so still uses far less memory than
1966far less memory than any other event loop and is still faster than Event 2190any other event loop and is still faster than Event natively).
1967natively.
1968 2191
1969The pure perl implementation is hit in a few sweet spots (both the 2192The pure perl implementation is hit in a few sweet spots (both the
1970constant timeout and the use of a single fd hit optimisations in the perl 2193constant timeout and the use of a single fd hit optimisations in the perl
1971interpreter and the backend itself). Nevertheless this shows that it 2194interpreter and the backend itself). Nevertheless this shows that it
1972adds very little overhead in itself. Like any select-based backend its 2195adds very little overhead in itself. Like any select-based backend its
2046In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2269In 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 2270(1%) are active. This mirrors the activity of large servers with many
2048connections, most of which are idle at any one point in time. 2271connections, most of which are idle at any one point in time.
2049 2272
2050Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2273Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2051distribution. 2274distribution. It uses the L<AE> interface, which makes a real difference
2275for the EV and Perl backends only.
2052 2276
2053=head3 Explanation of the columns 2277=head3 Explanation of the columns
2054 2278
2055I<sockets> is the number of sockets, and twice the number of "servers" (as 2279I<sockets> is the number of sockets, and twice the number of "servers" (as
2056each server has a read and write socket end). 2280each server has a read and write socket end).
2064a new one that moves the timeout into the future. 2288a new one that moves the timeout into the future.
2065 2289
2066=head3 Results 2290=head3 Results
2067 2291
2068 name sockets create request 2292 name sockets create request
2069 EV 20000 69.01 11.16 2293 EV 20000 62.66 7.99
2070 Perl 20000 73.32 35.87 2294 Perl 20000 68.32 32.64
2071 IOAsync 20000 157.00 98.14 epoll 2295 IOAsync 20000 174.06 101.15 epoll
2072 IOAsync 20000 159.31 616.06 poll 2296 IOAsync 20000 174.67 610.84 poll
2073 Event 20000 212.62 257.32 2297 Event 20000 202.69 242.91
2074 Glib 20000 651.16 1896.30 2298 Glib 20000 557.01 1689.52
2075 POE 20000 349.67 12317.24 uses POE::Loop::Event 2299 POE 20000 341.54 12086.32 uses POE::Loop::Event
2076 2300
2077=head3 Discussion 2301=head3 Discussion
2078 2302
2079This benchmark I<does> measure scalability and overall performance of the 2303This benchmark I<does> measure scalability and overall performance of the
2080particular event loop. 2304particular event loop.
2206As you can see, the AnyEvent + EV combination even beats the 2430As you can see, the AnyEvent + EV combination even beats the
2207hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2431hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2208backend easily beats IO::Lambda and POE. 2432backend easily beats IO::Lambda and POE.
2209 2433
2210And even the 100% non-blocking version written using the high-level (and 2434And even the 100% non-blocking version written using the high-level (and
2211slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2435slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2212large margin, even though it does all of DNS, tcp-connect and socket I/O 2436higher level ("unoptimised") abstractions by a large margin, even though
2213in a non-blocking way. 2437it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2214 2438
2215The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2439The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2216F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2440F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2217part of the IO::lambda distribution and were used without any changes. 2441part of the IO::Lambda distribution and were used without any changes.
2218 2442
2219 2443
2220=head1 SIGNALS 2444=head1 SIGNALS
2221 2445
2222AnyEvent currently installs handlers for these signals: 2446AnyEvent currently installs handlers for these signals:
2264it's built-in modules) are required to use it. 2488it's built-in modules) are required to use it.
2265 2489
2266That does not mean that AnyEvent won't take advantage of some additional 2490That does not mean that AnyEvent won't take advantage of some additional
2267modules if they are installed. 2491modules if they are installed.
2268 2492
2269This section epxlains which additional modules will be used, and how they 2493This section explains which additional modules will be used, and how they
2270affect AnyEvent's operetion. 2494affect AnyEvent's operation.
2271 2495
2272=over 4 2496=over 4
2273 2497
2274=item L<Async::Interrupt> 2498=item L<Async::Interrupt>
2275 2499
2280catch the signals) with some delay (default is 10 seconds, look for 2504catch the signals) with some delay (default is 10 seconds, look for
2281C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2505C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2282 2506
2283If this module is available, then it will be used to implement signal 2507If this module is available, then it will be used to implement signal
2284catching, which means that signals will not be delayed, and the event loop 2508catching, which means that signals will not be delayed, and the event loop
2285will not be interrupted regularly, which is more efficient (And good for 2509will not be interrupted regularly, which is more efficient (and good for
2286battery life on laptops). 2510battery life on laptops).
2287 2511
2288This affects not just the pure-perl event loop, but also other event loops 2512This affects not just the pure-perl event loop, but also other event loops
2289that have no signal handling on their own (e.g. Glib, Tk, Qt). 2513that have no signal handling on their own (e.g. Glib, Tk, Qt).
2290 2514
2311lot less memory), but otherwise doesn't affect guard operation much. It is 2535lot less memory), but otherwise doesn't affect guard operation much. It is
2312purely used for performance. 2536purely used for performance.
2313 2537
2314=item L<JSON> and L<JSON::XS> 2538=item L<JSON> and L<JSON::XS>
2315 2539
2316This module is required when you want to read or write JSON data via 2540One of these modules is required when you want to read or write JSON data
2317L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2541via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2318advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2542advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2319 2543
2320In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2544In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2321installed. 2545installed.
2322 2546
2337 2561
2338 2562
2339=head1 FORK 2563=head1 FORK
2340 2564
2341Most event libraries are not fork-safe. The ones who are usually are 2565Most event libraries are not fork-safe. The ones who are usually are
2342because they rely on inefficient but fork-safe C<select> or C<poll> 2566because they rely on inefficient but fork-safe C<select> or C<poll> calls
2343calls. Only L<EV> is fully fork-aware. 2567- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2568are usually badly thought-out hacks that are incompatible with fork in
2569one way or another. Only L<EV> is fully fork-aware and ensures that you
2570continue event-processing in both parent and child (or both, if you know
2571what you are doing).
2572
2573This means that, in general, you cannot fork and do event processing in
2574the child if the event library was initialised before the fork (which
2575usually happens when the first AnyEvent watcher is created, or the library
2576is loaded).
2344 2577
2345If you have to fork, you must either do so I<before> creating your first 2578If you have to fork, you must either do so I<before> creating your first
2346watcher OR you must not use AnyEvent at all in the child OR you must do 2579watcher OR you must not use AnyEvent at all in the child OR you must do
2347something completely out of the scope of AnyEvent. 2580something completely out of the scope of AnyEvent.
2581
2582The problem of doing event processing in the parent I<and> the child
2583is much more complicated: even for backends that I<are> fork-aware or
2584fork-safe, their behaviour is not usually what you want: fork clones all
2585watchers, that means all timers, I/O watchers etc. are active in both
2586parent and child, which is almost never what you want. USing C<exec>
2587to start worker children from some kind of manage rprocess is usually
2588preferred, because it is much easier and cleaner, at the expense of having
2589to have another binary.
2348 2590
2349 2591
2350=head1 SECURITY CONSIDERATIONS 2592=head1 SECURITY CONSIDERATIONS
2351 2593
2352AnyEvent can be forced to load any event model via 2594AnyEvent can be forced to load any event model via
2390L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2632L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2391 2633
2392Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2634Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2393L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2635L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2394L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2636L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2395L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. 2637L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2396 2638
2397Non-blocking file handles, sockets, TCP clients and 2639Non-blocking file handles, sockets, TCP clients and
2398servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2640servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2399 2641
2400Asynchronous DNS: L<AnyEvent::DNS>. 2642Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines