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.251 by root, Mon Jul 20 22:39:57 2009 UTC vs.
Revision 1.317 by root, Wed Mar 24 21:22:57 2010 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - events independent of event loop implementation 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
47 47
48There is a mailinglist for discussing all things AnyEvent, and an IRC 48There is a mailinglist for discussing all things AnyEvent, and an IRC
49channel, too. 49channel, too.
50 50
51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software 51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52Respository>, at L<http://anyevent.schmorp.de>, for more info. 52Repository>, at L<http://anyevent.schmorp.de>, for more info.
53 53
54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
55 55
56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
57nowadays. So what is different about AnyEvent? 57nowadays. So what is different about AnyEvent?
181my variables are only visible after the statement in which they are 181my variables are only visible after the statement in which they are
182declared. 182declared.
183 183
184=head2 I/O WATCHERS 184=head2 I/O WATCHERS
185 185
186 $w = AnyEvent->io (
187 fh => <filehandle_or_fileno>,
188 poll => <"r" or "w">,
189 cb => <callback>,
190 );
191
186You 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
187with the following mandatory key-value pairs as arguments: 193with the following mandatory key-value pairs as arguments:
188 194
189C<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
190for 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
219 undef $w; 225 undef $w;
220 }); 226 });
221 227
222=head2 TIME WATCHERS 228=head2 TIME WATCHERS
223 229
230 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
231
232 $w = AnyEvent->timer (
233 after => <fractional_seconds>,
234 interval => <fractional_seconds>,
235 cb => <callback>,
236 );
237
224You can create a time watcher by calling the C<< AnyEvent->timer >> 238You can create a time watcher by calling the C<< AnyEvent->timer >>
225method with the following mandatory arguments: 239method with the following mandatory arguments:
226 240
227C<after> specifies after how many seconds (fractional values are 241C<after> specifies after how many seconds (fractional values are
228supported) 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
349might affect timers and time-outs. 363might affect timers and time-outs.
350 364
351When 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
352event loop's idea of "current time". 366event loop's idea of "current time".
353 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
354Note 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.
355 376
356=back 377=back
357 378
358=head2 SIGNAL WATCHERS 379=head2 SIGNAL WATCHERS
380
381 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
359 382
360You 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
361I<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
362callback to be invoked whenever a signal occurs. 385callback to be invoked whenever a signal occurs.
363 386
380 403
381Example: exit on SIGINT 404Example: exit on SIGINT
382 405
383 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 406 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384 407
408=head3 Restart Behaviour
409
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
385=head3 Signal Races, Delays and Workarounds 425=head3 Signal Races, Delays and Workarounds
386 426
387Many 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
388callbacks 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
389race-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,
390in 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
391be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 432specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392seconds). This variable can be changed only before the first signal 433variable can be changed only before the first signal watcher is created,
393watcher 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
394will 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
395saving. All these problems can be avoided by installing the optional 439All these problems can be avoided by installing the optional
396L<Async::Interrupt> module. This will not work with inherently broken 440L<Async::Interrupt> module, which works with most event loops. It will not
397event 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>
398currently, 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
399those, you just have to suffer the delays. 443one-second latency). For those, you just have to suffer the delays.
400 444
401=head2 CHILD PROCESS WATCHERS 445=head2 CHILD PROCESS WATCHERS
402 446
447 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
448
403You 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.
404 450
405The 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,
406watches for any child process exit). The watcher will triggered only when 452using C<0> watches for any child process exit, on others this will
407the child process has finished and an exit status is available, not on 453croak). The watcher will be triggered only when the child process has
408any trace events (stopped/continued). 454finished and an exit status is available, not on any trace events
455(stopped/continued).
409 456
410The 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
411waitpid), 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
412callback arguments. 459callback arguments.
413 460
454 # do something else, then wait for process exit 501 # do something else, then wait for process exit
455 $done->recv; 502 $done->recv;
456 503
457=head2 IDLE WATCHERS 504=head2 IDLE WATCHERS
458 505
459Sometimes there is a need to do something, but it is not so important 506 $w = AnyEvent->idle (cb => <callback>);
460to do it instantly, but only when there is nothing better to do. This
461"nothing better to do" is usually defined to be "no other events need
462attention by the event loop".
463 507
464Idle watchers ideally get invoked when the event loop has nothing 508Repeatedly invoke the callback after the process becomes idle, until
465better to do, just before it would block the process to wait for new 509either the watcher is destroyed or new events have been detected.
466events. Instead of blocking, the idle watcher is invoked.
467 510
468Most 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
469EV, 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
470will simply call the callback "from time to time". 522will simply call the callback "from time to time".
471 523
472Example: read lines from STDIN, but only process them when the 524Example: read lines from STDIN, but only process them when the
473program is otherwise idle: 525program is otherwise idle:
489 }); 541 });
490 }); 542 });
491 543
492=head2 CONDITION VARIABLES 544=head2 CONDITION VARIABLES
493 545
546 $cv = AnyEvent->condvar;
547
548 $cv->send (<list>);
549 my @res = $cv->recv;
550
494If 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
495require you to run some blocking "loop", "run" or similar function that 552require you to run some blocking "loop", "run" or similar function that
496will actively watch for new events and call your callbacks. 553will actively watch for new events and call your callbacks.
497 554
498AnyEvent is slightly different: it expects somebody else to run the event 555AnyEvent is slightly different: it expects somebody else to run the event
562 after => 1, 619 after => 1,
563 cb => sub { $result_ready->send }, 620 cb => sub { $result_ready->send },
564 ); 621 );
565 622
566 # this "blocks" (while handling events) till the callback 623 # this "blocks" (while handling events) till the callback
567 # calls -<send 624 # calls ->send
568 $result_ready->recv; 625 $result_ready->recv;
569 626
570Example: 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
571variables are also callable directly. 628variables are also callable directly.
572 629
636one. 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
637to use a condition variable for the whole process. 694to use a condition variable for the whole process.
638 695
639Every 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
640C<< ->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
641>>, 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
642is 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
643callback 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.
644 702
645You 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
646sends), 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
647condition (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).
648 706
675begung can potentially be zero: 733begung can potentially be zero:
676 734
677 my $cv = AnyEvent->condvar; 735 my $cv = AnyEvent->condvar;
678 736
679 my %result; 737 my %result;
680 $cv->begin (sub { $cv->send (\%result) }); 738 $cv->begin (sub { shift->send (\%result) });
681 739
682 for my $host (@list_of_hosts) { 740 for my $host (@list_of_hosts) {
683 $cv->begin; 741 $cv->begin;
684 ping_host_then_call_callback $host, sub { 742 ping_host_then_call_callback $host, sub {
685 $result{$host} = ...; 743 $result{$host} = ...;
760=item $cb = $cv->cb ($cb->($cv)) 818=item $cb = $cv->cb ($cb->($cv))
761 819
762This is a mutator function that returns the callback set and optionally 820This is a mutator function that returns the callback set and optionally
763replaces it before doing so. 821replaces it before doing so.
764 822
765The callback will be called when the condition becomes "true", i.e. when 823The callback will be called when the condition becomes (or already was)
766C<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
767variable itself. Calling C<recv> inside the callback or at any later time 825the only argument being the condition variable itself. Calling C<recv>
768is guaranteed not to block. 826inside the callback or at any later time is guaranteed not to block.
769 827
770=back 828=back
771 829
772=head1 SUPPORTED EVENT LOOPS/BACKENDS 830=head1 SUPPORTED EVENT LOOPS/BACKENDS
773 831
776=over 4 834=over 4
777 835
778=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.
779 837
780EV 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
781use. 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
782that, will fall back to its own pure-perl implementation, which is 840pure-perl implementation, which is available everywhere as it comes with
783available everywhere as it comes with AnyEvent itself. 841AnyEvent itself.
784 842
785 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 843 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
786 AnyEvent::Impl::Event based on Event, very stable, few glitches.
787 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 844 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
788 845
789=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.
790 847
791These 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
792is 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
793them. This means that AnyEvent will automatically pick the right backend 850them. This means that AnyEvent will automatically pick the right backend
794when the main program loads an event module before anything starts to 851when the main program loads an event module before anything starts to
795create watchers. Nothing special needs to be done by the main program. 852create watchers. Nothing special needs to be done by the main program.
796 853
854 AnyEvent::Impl::Event based on Event, very stable, few glitches.
797 AnyEvent::Impl::Glib based on Glib, slow but very stable. 855 AnyEvent::Impl::Glib based on Glib, slow but very stable.
798 AnyEvent::Impl::Tk based on Tk, very broken. 856 AnyEvent::Impl::Tk based on Tk, very broken.
799 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 857 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
800 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.
801 860
802=item Backends with special needs. 861=item Backends with special needs.
803 862
804Qt requires the Qt::Application to be instantiated first, but will 863Qt requires the Qt::Application to be instantiated first, but will
805otherwise be picked up automatically. As long as the main program 864otherwise be picked up automatically. As long as the main program
879event module detection too early, for example, L<AnyEvent::AIO> creates 938event module detection too early, for example, L<AnyEvent::AIO> creates
880and 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
881avoid autodetecting the event module at load time. 940avoid autodetecting the event module at load time.
882 941
883If 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
884that 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
885L<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;
886 962
887=item @AnyEvent::post_detect 963=item @AnyEvent::post_detect
888 964
889If 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
890before or after loading AnyEvent), then they will called directly after 966before or after loading AnyEvent), then they will called directly after
893You should check C<$AnyEvent::MODEL> before adding to this array, though: 969You should check C<$AnyEvent::MODEL> before adding to this array, though:
894if 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
895array will be ignored. 971array will be ignored.
896 972
897Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 973Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
898it,as it takes care of these details. 974it, as it takes care of these details.
899 975
900This variable is mainly useful for modules that can do something useful 976This variable is mainly useful for modules that can do something useful
901when 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
902not 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
903into 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 }
904 993
905=back 994=back
906 995
907=head1 WHAT TO DO IN A MODULE 996=head1 WHAT TO DO IN A MODULE
908 997
1057 1146
1058package AnyEvent; 1147package AnyEvent;
1059 1148
1060# basically a tuned-down version of common::sense 1149# basically a tuned-down version of common::sense
1061sub common_sense { 1150sub common_sense {
1062 # no warnings 1151 # from common:.sense 1.0
1063 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1152 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1064 # use strict vars subs 1153 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1065 $^H |= 0x00000600; 1154 $^H |= 0x00000600;
1066} 1155}
1067 1156
1068BEGIN { AnyEvent::common_sense } 1157BEGIN { AnyEvent::common_sense }
1069 1158
1070use Carp (); 1159use Carp ();
1071 1160
1072our $VERSION = 4.86; 1161our $VERSION = '5.251';
1073our $MODEL; 1162our $MODEL;
1074 1163
1075our $AUTOLOAD; 1164our $AUTOLOAD;
1076our @ISA; 1165our @ISA;
1077 1166
1078our @REGISTRY; 1167our @REGISTRY;
1079 1168
1080our $WIN32;
1081
1082our $VERBOSE; 1169our $VERBOSE;
1083 1170
1084BEGIN { 1171BEGIN {
1085 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1172 require "AnyEvent/constants.pl";
1173
1086 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1174 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1087 1175
1088 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1176 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1089 if ${^TAINT}; 1177 if ${^TAINT};
1090 1178
1091 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1179 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1102 for reverse split /\s*,\s*/, 1190 for reverse split /\s*,\s*/,
1103 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1191 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1104} 1192}
1105 1193
1106my @models = ( 1194my @models = (
1107 [EV:: => AnyEvent::Impl::EV::], 1195 [EV:: => AnyEvent::Impl::EV:: , 1],
1108 [Event:: => AnyEvent::Impl::Event::],
1109 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1196 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1110 # everything below here will not be autoprobed 1197 # everything below here will not (normally) be autoprobed
1111 # as the pureperl backend should work everywhere 1198 # as the pureperl backend should work everywhere
1112 # and is usually faster 1199 # and is usually faster
1200 [Event:: => AnyEvent::Impl::Event::, 1],
1113 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1201 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1114 [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
1115 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1204 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1116 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1205 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1117 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1206 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1118 [Wx:: => AnyEvent::Impl::POE::], 1207 [Wx:: => AnyEvent::Impl::POE::],
1119 [Prima:: => AnyEvent::Impl::POE::], 1208 [Prima:: => AnyEvent::Impl::POE::],
1120 # 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
1121 # byzantine signal and broken child handling, among others. 1210 # byzantine signal and broken child handling, among others.
1122 # 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
1123 # obvious default class. 1212 # obvious default class.
1124# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1213 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1125# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1214 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1126# [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
1127); 1217);
1128 1218
1129our %method = map +($_ => 1), 1219our %method = map +($_ => 1),
1130 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);
1131 1221
1132our @post_detect; 1222our @post_detect;
1133 1223
1134sub post_detect(&) { 1224sub post_detect(&) {
1135 my ($cb) = @_; 1225 my ($cb) = @_;
1136 1226
1137 if ($MODEL) {
1138 $cb->();
1139
1140 1
1141 } else {
1142 push @post_detect, $cb; 1227 push @post_detect, $cb;
1143 1228
1144 defined wantarray 1229 defined wantarray
1145 ? bless \$cb, "AnyEvent::Util::postdetect" 1230 ? bless \$cb, "AnyEvent::Util::postdetect"
1146 : () 1231 : ()
1147 }
1148} 1232}
1149 1233
1150sub AnyEvent::Util::postdetect::DESTROY { 1234sub AnyEvent::Util::postdetect::DESTROY {
1151 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1235 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1152} 1236}
1153 1237
1154sub detect() { 1238sub detect() {
1239 # free some memory
1240 *detect = sub () { $MODEL };
1241
1242 local $!; # for good measure
1243 local $SIG{__DIE__};
1244
1245 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1246 my $model = "AnyEvent::Impl::$1";
1247 if (eval "require $model") {
1248 $MODEL = $model;
1249 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1250 } else {
1251 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1252 }
1253 }
1254
1255 # check for already loaded models
1155 unless ($MODEL) { 1256 unless ($MODEL) {
1156 local $SIG{__DIE__}; 1257 for (@REGISTRY, @models) {
1157 1258 my ($package, $model) = @$_;
1158 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1259 if (${"$package\::VERSION"} > 0) {
1159 my $model = "AnyEvent::Impl::$1";
1160 if (eval "require $model") { 1260 if (eval "require $model") {
1161 $MODEL = $model; 1261 $MODEL = $model;
1162 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1262 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1163 } else { 1263 last;
1164 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1264 }
1165 } 1265 }
1166 } 1266 }
1167 1267
1168 # check for already loaded models
1169 unless ($MODEL) { 1268 unless ($MODEL) {
1269 # try to autoload a model
1170 for (@REGISTRY, @models) { 1270 for (@REGISTRY, @models) {
1171 my ($package, $model) = @$_; 1271 my ($package, $model, $autoload) = @$_;
1272 if (
1273 $autoload
1274 and eval "require $package"
1172 if (${"$package\::VERSION"} > 0) { 1275 and ${"$package\::VERSION"} > 0
1173 if (eval "require $model") { 1276 and eval "require $model"
1277 ) {
1174 $MODEL = $model; 1278 $MODEL = $model;
1175 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1279 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1176 last; 1280 last;
1177 }
1178 } 1281 }
1179 } 1282 }
1180 1283
1181 unless ($MODEL) {
1182 # try to load a model
1183
1184 for (@REGISTRY, @models) {
1185 my ($package, $model) = @$_;
1186 if (eval "require $package"
1187 and ${"$package\::VERSION"} > 0
1188 and eval "require $model") {
1189 $MODEL = $model;
1190 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1191 last;
1192 }
1193 }
1194
1195 $MODEL 1284 $MODEL
1196 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1285 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1197 }
1198 } 1286 }
1199
1200 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1201
1202 unshift @ISA, $MODEL;
1203
1204 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1205
1206 (shift @post_detect)->() while @post_detect;
1207 } 1287 }
1288
1289 @models = (); # free probe data
1290
1291 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1292 unshift @ISA, $MODEL;
1293
1294 # now nuke some methods that are overriden by the backend.
1295 # SUPER is not allowed.
1296 for (qw(time signal child idle)) {
1297 undef &{"AnyEvent::Base::$_"}
1298 if defined &{"$MODEL\::$_"};
1299 }
1300
1301 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1302
1303 (shift @post_detect)->() while @post_detect;
1304
1305 *post_detect = sub(&) {
1306 shift->();
1307
1308 undef
1309 };
1208 1310
1209 $MODEL 1311 $MODEL
1210} 1312}
1211 1313
1212sub AUTOLOAD { 1314sub AUTOLOAD {
1213 (my $func = $AUTOLOAD) =~ s/.*://; 1315 (my $func = $AUTOLOAD) =~ s/.*://;
1214 1316
1215 $method{$func} 1317 $method{$func}
1216 or Carp::croak "$func: not a valid method for AnyEvent objects"; 1318 or Carp::croak "$func: not a valid AnyEvent class method";
1217 1319
1218 detect unless $MODEL; 1320 detect;
1219 1321
1220 my $class = shift; 1322 my $class = shift;
1221 $class->$func (@_); 1323 $class->$func (@_);
1222} 1324}
1223 1325
1236 # we assume CLOEXEC is already set by perl in all important cases 1338 # we assume CLOEXEC is already set by perl in all important cases
1237 1339
1238 ($fh2, $rw) 1340 ($fh2, $rw)
1239} 1341}
1240 1342
1343=head1 SIMPLIFIED AE API
1344
1345Starting with version 5.0, AnyEvent officially supports a second, much
1346simpler, API that is designed to reduce the calling, typing and memory
1347overhead.
1348
1349See the L<AE> manpage for details.
1350
1351=cut
1352
1353package AE;
1354
1355our $VERSION = $AnyEvent::VERSION;
1356
1357sub io($$$) {
1358 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1359}
1360
1361sub timer($$$) {
1362 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1363}
1364
1365sub signal($$) {
1366 AnyEvent->signal (signal => $_[0], cb => $_[1])
1367}
1368
1369sub child($$) {
1370 AnyEvent->child (pid => $_[0], cb => $_[1])
1371}
1372
1373sub idle($) {
1374 AnyEvent->idle (cb => $_[0])
1375}
1376
1377sub cv(;&) {
1378 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1379}
1380
1381sub now() {
1382 AnyEvent->now
1383}
1384
1385sub now_update() {
1386 AnyEvent->now_update
1387}
1388
1389sub time() {
1390 AnyEvent->time
1391}
1392
1241package AnyEvent::Base; 1393package AnyEvent::Base;
1242 1394
1243# default implementations for many methods 1395# default implementations for many methods
1244 1396
1245sub _time { 1397sub time {
1398 eval q{ # poor man's autoloading {}
1246 # probe for availability of Time::HiRes 1399 # probe for availability of Time::HiRes
1247 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1400 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1248 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1401 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1249 *_time = \&Time::HiRes::time; 1402 *AE::time = \&Time::HiRes::time;
1250 # if (eval "use POSIX (); (POSIX::times())... 1403 # if (eval "use POSIX (); (POSIX::times())...
1251 } else { 1404 } else {
1252 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1405 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1253 *_time = sub { time }; # epic fail 1406 *AE::time = sub (){ time }; # epic fail
1407 }
1408
1409 *time = sub { AE::time }; # different prototypes
1254 } 1410 };
1411 die if $@;
1255 1412
1256 &_time 1413 &time
1257} 1414}
1258 1415
1259sub time { _time } 1416*now = \&time;
1260sub now { _time } 1417
1261sub now_update { } 1418sub now_update { }
1262 1419
1263# default implementation for ->condvar 1420# default implementation for ->condvar
1264 1421
1265sub condvar { 1422sub condvar {
1423 eval q{ # poor man's autoloading {}
1424 *condvar = sub {
1266 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1425 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1426 };
1427
1428 *AE::cv = sub (;&) {
1429 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1430 };
1431 };
1432 die if $@;
1433
1434 &condvar
1267} 1435}
1268 1436
1269# default implementation for ->signal 1437# default implementation for ->signal
1270 1438
1271our $HAVE_ASYNC_INTERRUPT; 1439our $HAVE_ASYNC_INTERRUPT;
1440
1441sub _have_async_interrupt() {
1442 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1443 && eval "use Async::Interrupt 1.02 (); 1")
1444 unless defined $HAVE_ASYNC_INTERRUPT;
1445
1446 $HAVE_ASYNC_INTERRUPT
1447}
1448
1272our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1449our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1273our (%SIG_ASY, %SIG_ASY_W); 1450our (%SIG_ASY, %SIG_ASY_W);
1274our ($SIG_COUNT, $SIG_TW); 1451our ($SIG_COUNT, $SIG_TW);
1275 1452
1276sub _signal_exec {
1277 $HAVE_ASYNC_INTERRUPT
1278 ? $SIGPIPE_R->drain
1279 : sysread $SIGPIPE_R, my $dummy, 9;
1280
1281 while (%SIG_EV) {
1282 for (keys %SIG_EV) {
1283 delete $SIG_EV{$_};
1284 $_->() for values %{ $SIG_CB{$_} || {} };
1285 }
1286 }
1287}
1288
1289# install a dumym wakeupw atcher to reduce signal catching latency 1453# install a dummy wakeup watcher to reduce signal catching latency
1454# used by Impls
1290sub _sig_add() { 1455sub _sig_add() {
1291 unless ($SIG_COUNT++) { 1456 unless ($SIG_COUNT++) {
1292 # try to align timer on a full-second boundary, if possible 1457 # try to align timer on a full-second boundary, if possible
1293 my $NOW = AnyEvent->now; 1458 my $NOW = AE::now;
1294 1459
1295 $SIG_TW = AnyEvent->timer ( 1460 $SIG_TW = AE::timer
1296 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1461 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1297 interval => $MAX_SIGNAL_LATENCY, 1462 $MAX_SIGNAL_LATENCY,
1298 cb => sub { }, # just for the PERL_ASYNC_CHECK 1463 sub { } # just for the PERL_ASYNC_CHECK
1299 ); 1464 ;
1300 } 1465 }
1301} 1466}
1302 1467
1303sub _sig_del { 1468sub _sig_del {
1304 undef $SIG_TW 1469 undef $SIG_TW
1305 unless --$SIG_COUNT; 1470 unless --$SIG_COUNT;
1306} 1471}
1307 1472
1473our $_sig_name_init; $_sig_name_init = sub {
1474 eval q{ # poor man's autoloading {}
1475 undef $_sig_name_init;
1476
1477 if (_have_async_interrupt) {
1478 *sig2num = \&Async::Interrupt::sig2num;
1479 *sig2name = \&Async::Interrupt::sig2name;
1480 } else {
1481 require Config;
1482
1483 my %signame2num;
1484 @signame2num{ split ' ', $Config::Config{sig_name} }
1485 = split ' ', $Config::Config{sig_num};
1486
1487 my @signum2name;
1488 @signum2name[values %signame2num] = keys %signame2num;
1489
1490 *sig2num = sub($) {
1491 $_[0] > 0 ? shift : $signame2num{+shift}
1492 };
1493 *sig2name = sub ($) {
1494 $_[0] > 0 ? $signum2name[+shift] : shift
1495 };
1496 }
1497 };
1498 die if $@;
1499};
1500
1501sub sig2num ($) { &$_sig_name_init; &sig2num }
1502sub sig2name($) { &$_sig_name_init; &sig2name }
1503
1308sub _signal { 1504sub signal {
1309 my (undef, %arg) = @_; 1505 eval q{ # poor man's autoloading {}
1506 # probe for availability of Async::Interrupt
1507 if (_have_async_interrupt) {
1508 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1310 1509
1311 my $signal = uc $arg{signal} 1510 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1312 or Carp::croak "required option 'signal' is missing"; 1511 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1313 1512
1314 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1513 } else {
1514 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1315 1515
1316 if ($HAVE_ASYNC_INTERRUPT) { 1516 if (AnyEvent::WIN32) {
1317 # async::interrupt 1517 require AnyEvent::Util;
1318 1518
1319 $SIG_ASY{$signal} ||= do { 1519 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1320 my $asy = new Async::Interrupt 1520 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1321 cb => sub { undef $SIG_EV{$signal} }, 1521 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1322 signal => $signal, 1522 } else {
1323 pipe => [$SIGPIPE_R->filenos], 1523 pipe $SIGPIPE_R, $SIGPIPE_W;
1524 fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1525 fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1526
1527 # not strictly required, as $^F is normally 2, but let's make sure...
1528 fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1529 fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1324 ; 1530 }
1325 $asy->pipe_autodrain (0);
1326 1531
1327 $asy 1532 $SIGPIPE_R
1533 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1534
1535 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1536 }
1537
1538 *signal = $HAVE_ASYNC_INTERRUPT
1539 ? sub {
1540 my (undef, %arg) = @_;
1541
1542 # async::interrupt
1543 my $signal = sig2num $arg{signal};
1544 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1545
1546 $SIG_ASY{$signal} ||= new Async::Interrupt
1547 cb => sub { undef $SIG_EV{$signal} },
1548 signal => $signal,
1549 pipe => [$SIGPIPE_R->filenos],
1550 pipe_autodrain => 0,
1551 ;
1552
1553 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1554 }
1555 : sub {
1556 my (undef, %arg) = @_;
1557
1558 # pure perl
1559 my $signal = sig2name $arg{signal};
1560 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1561
1562 $SIG{$signal} ||= sub {
1563 local $!;
1564 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1565 undef $SIG_EV{$signal};
1566 };
1567
1568 # can't do signal processing without introducing races in pure perl,
1569 # so limit the signal latency.
1570 _sig_add;
1571
1572 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1573 }
1574 ;
1575
1576 *AnyEvent::Base::signal::DESTROY = sub {
1577 my ($signal, $cb) = @{$_[0]};
1578
1579 _sig_del;
1580
1581 delete $SIG_CB{$signal}{$cb};
1582
1583 $HAVE_ASYNC_INTERRUPT
1584 ? delete $SIG_ASY{$signal}
1585 : # delete doesn't work with older perls - they then
1586 # print weird messages, or just unconditionally exit
1587 # instead of getting the default action.
1588 undef $SIG{$signal}
1589 unless keys %{ $SIG_CB{$signal} };
1328 }; 1590 };
1329 1591
1330 } else { 1592 *_signal_exec = sub {
1331 # pure perl 1593 $HAVE_ASYNC_INTERRUPT
1594 ? $SIGPIPE_R->drain
1595 : sysread $SIGPIPE_R, (my $dummy), 9;
1332 1596
1333 $SIG{$signal} ||= sub { 1597 while (%SIG_EV) {
1334 local $!; 1598 for (keys %SIG_EV) {
1335 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1599 delete $SIG_EV{$_};
1336 undef $SIG_EV{$signal}; 1600 $_->() for values %{ $SIG_CB{$_} || {} };
1601 }
1602 }
1337 }; 1603 };
1338
1339 # can't do signal processing without introducing races in pure perl,
1340 # so limit the signal latency.
1341 _sig_add;
1342 } 1604 };
1605 die if $@;
1343 1606
1344 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1345}
1346
1347sub signal {
1348 # probe for availability of Async::Interrupt
1349 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1350 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1351
1352 $HAVE_ASYNC_INTERRUPT = 1;
1353 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1354 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1355
1356 } else {
1357 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1358
1359 require Fcntl;
1360
1361 if (AnyEvent::WIN32) {
1362 require AnyEvent::Util;
1363
1364 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1365 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1366 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1367 } else {
1368 pipe $SIGPIPE_R, $SIGPIPE_W;
1369 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1370 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1371
1372 # not strictly required, as $^F is normally 2, but let's make sure...
1373 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1374 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1375 }
1376
1377 $SIGPIPE_R
1378 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1379
1380 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1381 }
1382
1383 *signal = \&_signal;
1384 &signal 1607 &signal
1385}
1386
1387sub AnyEvent::Base::signal::DESTROY {
1388 my ($signal, $cb) = @{$_[0]};
1389
1390 _sig_del;
1391
1392 delete $SIG_CB{$signal}{$cb};
1393
1394 $HAVE_ASYNC_INTERRUPT
1395 ? delete $SIG_ASY{$signal}
1396 : # delete doesn't work with older perls - they then
1397 # print weird messages, or just unconditionally exit
1398 # instead of getting the default action.
1399 undef $SIG{$signal}
1400 unless keys %{ $SIG_CB{$signal} };
1401} 1608}
1402 1609
1403# default implementation for ->child 1610# default implementation for ->child
1404 1611
1405our %PID_CB; 1612our %PID_CB;
1406our $CHLD_W; 1613our $CHLD_W;
1407our $CHLD_DELAY_W; 1614our $CHLD_DELAY_W;
1408our $WNOHANG; 1615our $WNOHANG;
1409 1616
1410sub _sigchld { 1617# used by many Impl's
1411 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1618sub _emit_childstatus($$) {
1412 $_->($pid, $?) 1619 my (undef, $rpid, $rstatus) = @_;
1620
1621 $_->($rpid, $rstatus)
1413 for values %{ $PID_CB{$pid} || {} }, 1622 for values %{ $PID_CB{$rpid} || {} },
1414 values %{ $PID_CB{0} || {} }; 1623 values %{ $PID_CB{0} || {} };
1415 }
1416} 1624}
1417 1625
1418sub child { 1626sub child {
1627 eval q{ # poor man's autoloading {}
1628 *_sigchld = sub {
1629 my $pid;
1630
1631 AnyEvent->_emit_childstatus ($pid, $?)
1632 while ($pid = waitpid -1, $WNOHANG) > 0;
1633 };
1634
1635 *child = sub {
1419 my (undef, %arg) = @_; 1636 my (undef, %arg) = @_;
1420 1637
1421 defined (my $pid = $arg{pid} + 0) 1638 defined (my $pid = $arg{pid} + 0)
1422 or Carp::croak "required option 'pid' is missing"; 1639 or Carp::croak "required option 'pid' is missing";
1423 1640
1424 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1641 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1425 1642
1426 # WNOHANG is almost cetrainly 1 everywhere 1643 # WNOHANG is almost cetrainly 1 everywhere
1427 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1644 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1428 ? 1 1645 ? 1
1429 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1646 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1430 1647
1431 unless ($CHLD_W) { 1648 unless ($CHLD_W) {
1432 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1649 $CHLD_W = AE::signal CHLD => \&_sigchld;
1433 # child could be a zombie already, so make at least one round 1650 # child could be a zombie already, so make at least one round
1434 &_sigchld; 1651 &_sigchld;
1435 } 1652 }
1436 1653
1437 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1654 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1438} 1655 };
1439 1656
1440sub AnyEvent::Base::child::DESTROY { 1657 *AnyEvent::Base::child::DESTROY = sub {
1441 my ($pid, $cb) = @{$_[0]}; 1658 my ($pid, $cb) = @{$_[0]};
1442 1659
1443 delete $PID_CB{$pid}{$cb}; 1660 delete $PID_CB{$pid}{$cb};
1444 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1661 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1445 1662
1446 undef $CHLD_W unless keys %PID_CB; 1663 undef $CHLD_W unless keys %PID_CB;
1664 };
1665 };
1666 die if $@;
1667
1668 &child
1447} 1669}
1448 1670
1449# idle emulation is done by simply using a timer, regardless 1671# idle emulation is done by simply using a timer, regardless
1450# of whether the process is idle or not, and not letting 1672# of whether the process is idle or not, and not letting
1451# the callback use more than 50% of the time. 1673# the callback use more than 50% of the time.
1452sub idle { 1674sub idle {
1675 eval q{ # poor man's autoloading {}
1676 *idle = sub {
1453 my (undef, %arg) = @_; 1677 my (undef, %arg) = @_;
1454 1678
1455 my ($cb, $w, $rcb) = $arg{cb}; 1679 my ($cb, $w, $rcb) = $arg{cb};
1456 1680
1457 $rcb = sub { 1681 $rcb = sub {
1458 if ($cb) { 1682 if ($cb) {
1459 $w = _time; 1683 $w = _time;
1460 &$cb; 1684 &$cb;
1461 $w = _time - $w; 1685 $w = _time - $w;
1462 1686
1463 # never use more then 50% of the time for the idle watcher, 1687 # never use more then 50% of the time for the idle watcher,
1464 # within some limits 1688 # within some limits
1465 $w = 0.0001 if $w < 0.0001; 1689 $w = 0.0001 if $w < 0.0001;
1466 $w = 5 if $w > 5; 1690 $w = 5 if $w > 5;
1467 1691
1468 $w = AnyEvent->timer (after => $w, cb => $rcb); 1692 $w = AE::timer $w, 0, $rcb;
1469 } else { 1693 } else {
1470 # clean up... 1694 # clean up...
1471 undef $w; 1695 undef $w;
1472 undef $rcb; 1696 undef $rcb;
1697 }
1698 };
1699
1700 $w = AE::timer 0.05, 0, $rcb;
1701
1702 bless \\$cb, "AnyEvent::Base::idle"
1473 } 1703 };
1704
1705 *AnyEvent::Base::idle::DESTROY = sub {
1706 undef $${$_[0]};
1707 };
1474 }; 1708 };
1709 die if $@;
1475 1710
1476 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1711 &idle
1477
1478 bless \\$cb, "AnyEvent::Base::idle"
1479}
1480
1481sub AnyEvent::Base::idle::DESTROY {
1482 undef $${$_[0]};
1483} 1712}
1484 1713
1485package AnyEvent::CondVar; 1714package AnyEvent::CondVar;
1486 1715
1487our @ISA = AnyEvent::CondVar::Base::; 1716our @ISA = AnyEvent::CondVar::Base::;
1535 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1764 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1536 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1765 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1537} 1766}
1538 1767
1539sub cb { 1768sub cb {
1540 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1769 my $cv = shift;
1770
1771 @_
1772 and $cv->{_ae_cb} = shift
1773 and $cv->{_ae_sent}
1774 and (delete $cv->{_ae_cb})->($cv);
1775
1541 $_[0]{_ae_cb} 1776 $cv->{_ae_cb}
1542} 1777}
1543 1778
1544sub begin { 1779sub begin {
1545 ++$_[0]{_ae_counter}; 1780 ++$_[0]{_ae_counter};
1546 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1781 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1755 warn "read: $input\n"; # output what has been read 1990 warn "read: $input\n"; # output what has been read
1756 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1991 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1757 }, 1992 },
1758 ); 1993 );
1759 1994
1760 my $time_watcher; # can only be used once
1761
1762 sub new_timer {
1763 $timer = AnyEvent->timer (after => 1, cb => sub { 1995 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1764 warn "timeout\n"; # print 'timeout' about every second 1996 warn "timeout\n"; # print 'timeout' at most every second
1765 &new_timer; # and restart the time
1766 }); 1997 });
1767 }
1768
1769 new_timer; # create first timer
1770 1998
1771 $cv->recv; # wait until user enters /^q/i 1999 $cv->recv; # wait until user enters /^q/i
1772 2000
1773=head1 REAL-WORLD EXAMPLE 2001=head1 REAL-WORLD EXAMPLE
1774 2002
1905through AnyEvent. The benchmark creates a lot of timers (with a zero 2133through AnyEvent. The benchmark creates a lot of timers (with a zero
1906timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2134timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1907which it is), lets them fire exactly once and destroys them again. 2135which it is), lets them fire exactly once and destroys them again.
1908 2136
1909Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2137Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1910distribution. 2138distribution. It uses the L<AE> interface, which makes a real difference
2139for the EV and Perl backends only.
1911 2140
1912=head3 Explanation of the columns 2141=head3 Explanation of the columns
1913 2142
1914I<watcher> is the number of event watchers created/destroyed. Since 2143I<watcher> is the number of event watchers created/destroyed. Since
1915different event models feature vastly different performances, each event 2144different event models feature vastly different performances, each event
1936watcher. 2165watcher.
1937 2166
1938=head3 Results 2167=head3 Results
1939 2168
1940 name watchers bytes create invoke destroy comment 2169 name watchers bytes create invoke destroy comment
1941 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2170 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1942 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2171 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1943 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2172 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1944 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2173 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1945 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2174 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1946 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2175 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1947 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2176 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1948 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2177 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1949 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2178 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1950 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2179 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1951 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2180 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1952 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2181 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1953 2182
1954=head3 Discussion 2183=head3 Discussion
1955 2184
1956The benchmark does I<not> measure scalability of the event loop very 2185The benchmark does I<not> measure scalability of the event loop very
1957well. For example, a select-based event loop (such as the pure perl one) 2186well. For example, a select-based event loop (such as the pure perl one)
1969benchmark machine, handling an event takes roughly 1600 CPU cycles with 2198benchmark machine, handling an event takes roughly 1600 CPU cycles with
1970EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2199EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1971cycles with POE. 2200cycles with POE.
1972 2201
1973C<EV> is the sole leader regarding speed and memory use, which are both 2202C<EV> is the sole leader regarding speed and memory use, which are both
1974maximal/minimal, respectively. Even when going through AnyEvent, it uses 2203maximal/minimal, respectively. When using the L<AE> API there is zero
2204overhead (when going through the AnyEvent API create is about 5-6 times
2205slower, with other times being equal, so still uses far less memory than
1975far less memory than any other event loop and is still faster than Event 2206any other event loop and is still faster than Event natively).
1976natively.
1977 2207
1978The pure perl implementation is hit in a few sweet spots (both the 2208The pure perl implementation is hit in a few sweet spots (both the
1979constant timeout and the use of a single fd hit optimisations in the perl 2209constant timeout and the use of a single fd hit optimisations in the perl
1980interpreter and the backend itself). Nevertheless this shows that it 2210interpreter and the backend itself). Nevertheless this shows that it
1981adds very little overhead in itself. Like any select-based backend its 2211adds very little overhead in itself. Like any select-based backend its
2055In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2285In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2056(1%) are active. This mirrors the activity of large servers with many 2286(1%) are active. This mirrors the activity of large servers with many
2057connections, most of which are idle at any one point in time. 2287connections, most of which are idle at any one point in time.
2058 2288
2059Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2289Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2060distribution. 2290distribution. It uses the L<AE> interface, which makes a real difference
2291for the EV and Perl backends only.
2061 2292
2062=head3 Explanation of the columns 2293=head3 Explanation of the columns
2063 2294
2064I<sockets> is the number of sockets, and twice the number of "servers" (as 2295I<sockets> is the number of sockets, and twice the number of "servers" (as
2065each server has a read and write socket end). 2296each server has a read and write socket end).
2073a new one that moves the timeout into the future. 2304a new one that moves the timeout into the future.
2074 2305
2075=head3 Results 2306=head3 Results
2076 2307
2077 name sockets create request 2308 name sockets create request
2078 EV 20000 69.01 11.16 2309 EV 20000 62.66 7.99
2079 Perl 20000 73.32 35.87 2310 Perl 20000 68.32 32.64
2080 IOAsync 20000 157.00 98.14 epoll 2311 IOAsync 20000 174.06 101.15 epoll
2081 IOAsync 20000 159.31 616.06 poll 2312 IOAsync 20000 174.67 610.84 poll
2082 Event 20000 212.62 257.32 2313 Event 20000 202.69 242.91
2083 Glib 20000 651.16 1896.30 2314 Glib 20000 557.01 1689.52
2084 POE 20000 349.67 12317.24 uses POE::Loop::Event 2315 POE 20000 341.54 12086.32 uses POE::Loop::Event
2085 2316
2086=head3 Discussion 2317=head3 Discussion
2087 2318
2088This benchmark I<does> measure scalability and overall performance of the 2319This benchmark I<does> measure scalability and overall performance of the
2089particular event loop. 2320particular event loop.
2215As you can see, the AnyEvent + EV combination even beats the 2446As you can see, the AnyEvent + EV combination even beats the
2216hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2447hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2217backend easily beats IO::Lambda and POE. 2448backend easily beats IO::Lambda and POE.
2218 2449
2219And even the 100% non-blocking version written using the high-level (and 2450And even the 100% non-blocking version written using the high-level (and
2220slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2451slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2221large margin, even though it does all of DNS, tcp-connect and socket I/O 2452higher level ("unoptimised") abstractions by a large margin, even though
2222in a non-blocking way. 2453it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2223 2454
2224The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2455The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2225F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2456F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2226part of the IO::lambda distribution and were used without any changes. 2457part of the IO::Lambda distribution and were used without any changes.
2227 2458
2228 2459
2229=head1 SIGNALS 2460=head1 SIGNALS
2230 2461
2231AnyEvent currently installs handlers for these signals: 2462AnyEvent currently installs handlers for these signals:
2273it's built-in modules) are required to use it. 2504it's built-in modules) are required to use it.
2274 2505
2275That does not mean that AnyEvent won't take advantage of some additional 2506That does not mean that AnyEvent won't take advantage of some additional
2276modules if they are installed. 2507modules if they are installed.
2277 2508
2278This section epxlains which additional modules will be used, and how they 2509This section explains which additional modules will be used, and how they
2279affect AnyEvent's operetion. 2510affect AnyEvent's operation.
2280 2511
2281=over 4 2512=over 4
2282 2513
2283=item L<Async::Interrupt> 2514=item L<Async::Interrupt>
2284 2515
2289catch the signals) with some delay (default is 10 seconds, look for 2520catch the signals) with some delay (default is 10 seconds, look for
2290C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2521C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2291 2522
2292If this module is available, then it will be used to implement signal 2523If this module is available, then it will be used to implement signal
2293catching, which means that signals will not be delayed, and the event loop 2524catching, which means that signals will not be delayed, and the event loop
2294will not be interrupted regularly, which is more efficient (And good for 2525will not be interrupted regularly, which is more efficient (and good for
2295battery life on laptops). 2526battery life on laptops).
2296 2527
2297This affects not just the pure-perl event loop, but also other event loops 2528This affects not just the pure-perl event loop, but also other event loops
2298that have no signal handling on their own (e.g. Glib, Tk, Qt). 2529that have no signal handling on their own (e.g. Glib, Tk, Qt).
2299 2530
2311automatic timer adjustments even when no monotonic clock is available, 2542automatic timer adjustments even when no monotonic clock is available,
2312can take avdantage of advanced kernel interfaces such as C<epoll> and 2543can take avdantage of advanced kernel interfaces such as C<epoll> and
2313C<kqueue>, and is the fastest backend I<by far>. You can even embed 2544C<kqueue>, and is the fastest backend I<by far>. You can even embed
2314L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). 2545L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2315 2546
2547If you only use backends that rely on another event loop (e.g. C<Tk>),
2548then this module will do nothing for you.
2549
2316=item L<Guard> 2550=item L<Guard>
2317 2551
2318The guard module, when used, will be used to implement 2552The guard module, when used, will be used to implement
2319C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a 2553C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2320lot less memory), but otherwise doesn't affect guard operation much. It is 2554lot less memory), but otherwise doesn't affect guard operation much. It is
2321purely used for performance. 2555purely used for performance.
2322 2556
2323=item L<JSON> and L<JSON::XS> 2557=item L<JSON> and L<JSON::XS>
2324 2558
2325This module is required when you want to read or write JSON data via 2559One of these modules is required when you want to read or write JSON data
2326L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2560via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2327advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2561advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2328
2329In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2330installed.
2331 2562
2332=item L<Net::SSLeay> 2563=item L<Net::SSLeay>
2333 2564
2334Implementing TLS/SSL in Perl is certainly interesting, but not very 2565Implementing TLS/SSL in Perl is certainly interesting, but not very
2335worthwhile: If this module is installed, then L<AnyEvent::Handle> (with 2566worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2346 2577
2347 2578
2348=head1 FORK 2579=head1 FORK
2349 2580
2350Most event libraries are not fork-safe. The ones who are usually are 2581Most event libraries are not fork-safe. The ones who are usually are
2351because they rely on inefficient but fork-safe C<select> or C<poll> 2582because they rely on inefficient but fork-safe C<select> or C<poll> calls
2352calls. Only L<EV> is fully fork-aware. 2583- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2584are usually badly thought-out hacks that are incompatible with fork in
2585one way or another. Only L<EV> is fully fork-aware and ensures that you
2586continue event-processing in both parent and child (or both, if you know
2587what you are doing).
2588
2589This means that, in general, you cannot fork and do event processing in
2590the child if the event library was initialised before the fork (which
2591usually happens when the first AnyEvent watcher is created, or the library
2592is loaded).
2353 2593
2354If you have to fork, you must either do so I<before> creating your first 2594If you have to fork, you must either do so I<before> creating your first
2355watcher OR you must not use AnyEvent at all in the child OR you must do 2595watcher OR you must not use AnyEvent at all in the child OR you must do
2356something completely out of the scope of AnyEvent. 2596something completely out of the scope of AnyEvent.
2597
2598The problem of doing event processing in the parent I<and> the child
2599is much more complicated: even for backends that I<are> fork-aware or
2600fork-safe, their behaviour is not usually what you want: fork clones all
2601watchers, that means all timers, I/O watchers etc. are active in both
2602parent and child, which is almost never what you want. USing C<exec>
2603to start worker children from some kind of manage rprocess is usually
2604preferred, because it is much easier and cleaner, at the expense of having
2605to have another binary.
2357 2606
2358 2607
2359=head1 SECURITY CONSIDERATIONS 2608=head1 SECURITY CONSIDERATIONS
2360 2609
2361AnyEvent can be forced to load any event model via 2610AnyEvent can be forced to load any event model via
2399L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2648L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2400 2649
2401Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2650Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2402L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2651L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2403L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2652L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2404L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. 2653L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2405 2654
2406Non-blocking file handles, sockets, TCP clients and 2655Non-blocking file handles, sockets, TCP clients and
2407servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2656servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2408 2657
2409Asynchronous DNS: L<AnyEvent::DNS>. 2658Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines