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.202 by root, Wed Apr 1 15:29:00 2009 UTC vs.
Revision 1.227 by root, Mon Jul 6 23:42:24 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - provide framework for multiple event loops
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported
6event loops.
6 7
7=head1 SYNOPSIS 8=head1 SYNOPSIS
8 9
9 use AnyEvent; 10 use AnyEvent;
10 11
12 # file descriptor readable
11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... }); 13 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
12 14
15 # one-shot or repeating timers
13 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); 16 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
14 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... 17 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
15 18
16 print AnyEvent->now; # prints current event loop time 19 print AnyEvent->now; # prints current event loop time
17 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. 20 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
18 21
22 # POSIX signal
19 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... }); 23 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
20 24
25 # child process exit
21 my $w = AnyEvent->child (pid => $pid, cb => sub { 26 my $w = AnyEvent->child (pid => $pid, cb => sub {
22 my ($pid, $status) = @_; 27 my ($pid, $status) = @_;
23 ... 28 ...
24 }); 29 });
30
31 # called when event loop idle (if applicable)
32 my $w = AnyEvent->idle (cb => sub { ... });
25 33
26 my $w = AnyEvent->condvar; # stores whether a condition was flagged 34 my $w = AnyEvent->condvar; # stores whether a condition was flagged
27 $w->send; # wake up current and all future recv's 35 $w->send; # wake up current and all future recv's
28 $w->recv; # enters "main loop" till $condvar gets ->send 36 $w->recv; # enters "main loop" till $condvar gets ->send
29 # use a condvar in callback mode: 37 # use a condvar in callback mode:
320In either case, if you care (and in most cases, you don't), then you 328In either case, if you care (and in most cases, you don't), then you
321can get whatever behaviour you want with any event loop, by taking the 329can get whatever behaviour you want with any event loop, by taking the
322difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 330difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
323account. 331account.
324 332
333=item AnyEvent->now_update
334
335Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
336the current time for each loop iteration (see the discussion of L<<
337AnyEvent->now >>, above).
338
339When a callback runs for a long time (or when the process sleeps), then
340this "current" time will differ substantially from the real time, which
341might affect timers and time-outs.
342
343When this is the case, you can call this method, which will update the
344event loop's idea of "current time".
345
346Note that updating the time I<might> cause some events to be handled.
347
325=back 348=back
326 349
327=head2 SIGNAL WATCHERS 350=head2 SIGNAL WATCHERS
328 351
329You can watch for signals using a signal watcher, C<signal> is the signal 352You can watch for signals using a signal watcher, C<signal> is the signal
369 392
370There is a slight catch to child watchers, however: you usually start them 393There is a slight catch to child watchers, however: you usually start them
371I<after> the child process was created, and this means the process could 394I<after> the child process was created, and this means the process could
372have exited already (and no SIGCHLD will be sent anymore). 395have exited already (and no SIGCHLD will be sent anymore).
373 396
374Not all event models handle this correctly (POE doesn't), but even for 397Not all event models handle this correctly (neither POE nor IO::Async do,
398see their AnyEvent::Impl manpages for details), but even for event models
375event models that I<do> handle this correctly, they usually need to be 399that I<do> handle this correctly, they usually need to be loaded before
376loaded before the process exits (i.e. before you fork in the first place). 400the process exits (i.e. before you fork in the first place). AnyEvent's
401pure perl event loop handles all cases correctly regardless of when you
402start the watcher.
377 403
378This means you cannot create a child watcher as the very first thing in an 404This means you cannot create a child watcher as the very first
379AnyEvent program, you I<have> to create at least one watcher before you 405thing in an AnyEvent program, you I<have> to create at least one
380C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 406watcher before you C<fork> the child (alternatively, you can call
407C<AnyEvent::detect>).
381 408
382Example: fork a process and wait for it 409Example: fork a process and wait for it
383 410
384 my $done = AnyEvent->condvar; 411 my $done = AnyEvent->condvar;
385 412
395 ); 422 );
396 423
397 # do something else, then wait for process exit 424 # do something else, then wait for process exit
398 $done->recv; 425 $done->recv;
399 426
427=head2 IDLE WATCHERS
428
429Sometimes there is a need to do something, but it is not so important
430to do it instantly, but only when there is nothing better to do. This
431"nothing better to do" is usually defined to be "no other events need
432attention by the event loop".
433
434Idle watchers ideally get invoked when the event loop has nothing
435better to do, just before it would block the process to wait for new
436events. Instead of blocking, the idle watcher is invoked.
437
438Most event loops unfortunately do not really support idle watchers (only
439EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
440will simply call the callback "from time to time".
441
442Example: read lines from STDIN, but only process them when the
443program is otherwise idle:
444
445 my @lines; # read data
446 my $idle_w;
447 my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
448 push @lines, scalar <STDIN>;
449
450 # start an idle watcher, if not already done
451 $idle_w ||= AnyEvent->idle (cb => sub {
452 # handle only one line, when there are lines left
453 if (my $line = shift @lines) {
454 print "handled when idle: $line";
455 } else {
456 # otherwise disable the idle watcher again
457 undef $idle_w;
458 }
459 });
460 });
461
400=head2 CONDITION VARIABLES 462=head2 CONDITION VARIABLES
401 463
402If you are familiar with some event loops you will know that all of them 464If you are familiar with some event loops you will know that all of them
403require you to run some blocking "loop", "run" or similar function that 465require you to run some blocking "loop", "run" or similar function that
404will actively watch for new events and call your callbacks. 466will actively watch for new events and call your callbacks.
537 599
538=item $cv->begin ([group callback]) 600=item $cv->begin ([group callback])
539 601
540=item $cv->end 602=item $cv->end
541 603
542These two methods are EXPERIMENTAL and MIGHT CHANGE.
543
544These two methods can be used to combine many transactions/events into 604These two methods can be used to combine many transactions/events into
545one. For example, a function that pings many hosts in parallel might want 605one. For example, a function that pings many hosts in parallel might want
546to use a condition variable for the whole process. 606to use a condition variable for the whole process.
547 607
548Every call to C<< ->begin >> will increment a counter, and every call to 608Every call to C<< ->begin >> will increment a counter, and every call to
549C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 609C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
550>>, the (last) callback passed to C<begin> will be executed. That callback 610>>, the (last) callback passed to C<begin> will be executed. That callback
551is I<supposed> to call C<< ->send >>, but that is not required. If no 611is I<supposed> to call C<< ->send >>, but that is not required. If no
552callback was set, C<send> will be called without any arguments. 612callback was set, C<send> will be called without any arguments.
553 613
554Let's clarify this with the ping example: 614You can think of C<< $cv->send >> giving you an OR condition (one call
615sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
616condition (all C<begin> calls must be C<end>'ed before the condvar sends).
617
618Let's start with a simple example: you have two I/O watchers (for example,
619STDOUT and STDERR for a program), and you want to wait for both streams to
620close before activating a condvar:
621
622 my $cv = AnyEvent->condvar;
623
624 $cv->begin; # first watcher
625 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
626 defined sysread $fh1, my $buf, 4096
627 or $cv->end;
628 });
629
630 $cv->begin; # second watcher
631 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
632 defined sysread $fh2, my $buf, 4096
633 or $cv->end;
634 });
635
636 $cv->recv;
637
638This works because for every event source (EOF on file handle), there is
639one call to C<begin>, so the condvar waits for all calls to C<end> before
640sending.
641
642The ping example mentioned above is slightly more complicated, as the
643there are results to be passwd back, and the number of tasks that are
644begung can potentially be zero:
555 645
556 my $cv = AnyEvent->condvar; 646 my $cv = AnyEvent->condvar;
557 647
558 my %result; 648 my %result;
559 $cv->begin (sub { $cv->send (\%result) }); 649 $cv->begin (sub { $cv->send (\%result) });
579loop, which serves two important purposes: first, it sets the callback 669loop, which serves two important purposes: first, it sets the callback
580to be called once the counter reaches C<0>, and second, it ensures that 670to be called once the counter reaches C<0>, and second, it ensures that
581C<send> is called even when C<no> hosts are being pinged (the loop 671C<send> is called even when C<no> hosts are being pinged (the loop
582doesn't execute once). 672doesn't execute once).
583 673
584This is the general pattern when you "fan out" into multiple subrequests: 674This is the general pattern when you "fan out" into multiple (but
585use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 675potentially none) subrequests: use an outer C<begin>/C<end> pair to set
586is called at least once, and then, for each subrequest you start, call 676the callback and ensure C<end> is called at least once, and then, for each
587C<begin> and for each subrequest you finish, call C<end>. 677subrequest you start, call C<begin> and for each subrequest you finish,
678call C<end>.
588 679
589=back 680=back
590 681
591=head3 METHODS FOR CONSUMERS 682=head3 METHODS FOR CONSUMERS
592 683
672 AnyEvent::Impl::Tk based on Tk, very bad choice. 763 AnyEvent::Impl::Tk based on Tk, very bad choice.
673 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). 764 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
674 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 765 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
675 AnyEvent::Impl::POE based on POE, not generic enough for full support. 766 AnyEvent::Impl::POE based on POE, not generic enough for full support.
676 767
768 # warning, support for IO::Async is only partial, as it is too broken
769 # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
770 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
771
677There is no support for WxWidgets, as WxWidgets has no support for 772There is no support for WxWidgets, as WxWidgets has no support for
678watching file handles. However, you can use WxWidgets through the 773watching file handles. However, you can use WxWidgets through the
679POE Adaptor, as POE has a Wx backend that simply polls 20 times per 774POE Adaptor, as POE has a Wx backend that simply polls 20 times per
680second, which was considered to be too horrible to even consider for 775second, which was considered to be too horrible to even consider for
681AnyEvent. Likewise, other POE backends can be used by AnyEvent by using 776AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
873no warnings; 968no warnings;
874use strict qw(vars subs); 969use strict qw(vars subs);
875 970
876use Carp; 971use Carp;
877 972
878our $VERSION = 4.35; 973our $VERSION = 4.8;
879our $MODEL; 974our $MODEL;
880 975
881our $AUTOLOAD; 976our $AUTOLOAD;
882our @ISA; 977our @ISA;
883 978
884our @REGISTRY; 979our @REGISTRY;
885 980
886our $WIN32; 981our $WIN32;
887 982
888BEGIN { 983BEGIN {
889 my $win32 = ! ! ($^O =~ /mswin32/i); 984 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
890 eval "sub WIN32(){ $win32 }"; 985 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
986
987 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
988 if ${^TAINT};
891} 989}
892 990
893our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 991our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
894 992
895our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 993our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
913 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1011 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
914 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1012 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
915 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1013 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
916 [Wx:: => AnyEvent::Impl::POE::], 1014 [Wx:: => AnyEvent::Impl::POE::],
917 [Prima:: => AnyEvent::Impl::POE::], 1015 [Prima:: => AnyEvent::Impl::POE::],
1016 # IO::Async is just too broken - we would need workaorunds for its
1017 # byzantine signal and broken child handling, among others.
1018 # IO::Async is rather hard to detect, as it doesn't have any
1019 # obvious default class.
1020# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1021# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1022# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
918); 1023);
919 1024
920our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 1025our %method = map +($_ => 1),
1026 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
921 1027
922our @post_detect; 1028our @post_detect;
923 1029
924sub post_detect(&) { 1030sub post_detect(&) {
925 my ($cb) = @_; 1031 my ($cb) = @_;
930 1 1036 1
931 } else { 1037 } else {
932 push @post_detect, $cb; 1038 push @post_detect, $cb;
933 1039
934 defined wantarray 1040 defined wantarray
935 ? bless \$cb, "AnyEvent::Util::PostDetect" 1041 ? bless \$cb, "AnyEvent::Util::postdetect"
936 : () 1042 : ()
937 } 1043 }
938} 1044}
939 1045
940sub AnyEvent::Util::PostDetect::DESTROY { 1046sub AnyEvent::Util::postdetect::DESTROY {
941 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1047 @post_detect = grep $_ != ${$_[0]}, @post_detect;
942} 1048}
943 1049
944sub detect() { 1050sub detect() {
945 unless ($MODEL) { 1051 unless ($MODEL) {
982 last; 1088 last;
983 } 1089 }
984 } 1090 }
985 1091
986 $MODEL 1092 $MODEL
987 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1093 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
988 } 1094 }
989 } 1095 }
990 1096
991 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1097 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
992 1098
1013} 1119}
1014 1120
1015# utility function to dup a filehandle. this is used by many backends 1121# utility function to dup a filehandle. this is used by many backends
1016# to support binding more than one watcher per filehandle (they usually 1122# to support binding more than one watcher per filehandle (they usually
1017# allow only one watcher per fd, so we dup it to get a different one). 1123# allow only one watcher per fd, so we dup it to get a different one).
1018sub _dupfh($$$$) { 1124sub _dupfh($$;$$) {
1019 my ($poll, $fh, $r, $w) = @_; 1125 my ($poll, $fh, $r, $w) = @_;
1020 1126
1021 # cygwin requires the fh mode to be matching, unix doesn't 1127 # cygwin requires the fh mode to be matching, unix doesn't
1022 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1128 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1023 : $poll eq "w" ? ($w, ">") 1129 : $poll eq "w" ? ($w, ">")
1024 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; 1130 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1025 1131
1026 open my $fh2, "$mode&" . fileno $fh 1132 open my $fh2, "$mode&" . fileno $fh
1027 or die "cannot dup() filehandle: $!"; 1133 or die "cannot dup() filehandle: $!,";
1028 1134
1029 # we assume CLOEXEC is already set by perl in all important cases 1135 # we assume CLOEXEC is already set by perl in all important cases
1030 1136
1031 ($fh2, $rw) 1137 ($fh2, $rw)
1032} 1138}
1033 1139
1034package AnyEvent::Base; 1140package AnyEvent::Base;
1035 1141
1036# default implementation for now and time 1142# default implementations for many methods
1037 1143
1038BEGIN { 1144BEGIN {
1039 if (eval "use Time::HiRes (); time (); 1") { 1145 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1040 *_time = \&Time::HiRes::time; 1146 *_time = \&Time::HiRes::time;
1041 # if (eval "use POSIX (); (POSIX::times())... 1147 # if (eval "use POSIX (); (POSIX::times())...
1042 } else { 1148 } else {
1043 *_time = sub { time }; # epic fail 1149 *_time = sub { time }; # epic fail
1044 } 1150 }
1045} 1151}
1046 1152
1047sub time { _time } 1153sub time { _time }
1048sub now { _time } 1154sub now { _time }
1155sub now_update { }
1049 1156
1050# default implementation for ->condvar 1157# default implementation for ->condvar
1051 1158
1052sub condvar { 1159sub condvar {
1053 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1160 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1054} 1161}
1055 1162
1056# default implementation for ->signal 1163# default implementation for ->signal
1057 1164
1058our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1165our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1082 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case 1189 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1083 } else { 1190 } else {
1084 pipe $SIGPIPE_R, $SIGPIPE_W; 1191 pipe $SIGPIPE_R, $SIGPIPE_W;
1085 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1192 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1086 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1193 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1194
1195 # not strictly required, as $^F is normally 2, but let's make sure...
1196 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1197 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1087 } 1198 }
1088 1199
1089 $SIGPIPE_R 1200 $SIGPIPE_R
1090 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1201 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1091
1092 # not strictly required, as $^F is normally 2, but let's make sure...
1093 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1094 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1095 1202
1096 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1203 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1097 } 1204 }
1098 1205
1099 my $signal = uc $arg{signal} 1206 my $signal = uc $arg{signal}
1104 local $!; 1211 local $!;
1105 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1212 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1106 undef $SIG_EV{$signal}; 1213 undef $SIG_EV{$signal};
1107 }; 1214 };
1108 1215
1109 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1216 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1110} 1217}
1111 1218
1112sub AnyEvent::Base::Signal::DESTROY { 1219sub AnyEvent::Base::signal::DESTROY {
1113 my ($signal, $cb) = @{$_[0]}; 1220 my ($signal, $cb) = @{$_[0]};
1114 1221
1115 delete $SIG_CB{$signal}{$cb}; 1222 delete $SIG_CB{$signal}{$cb};
1116 1223
1224 # delete doesn't work with older perls - they then
1225 # print weird messages, or just unconditionally exit
1226 # instead of getting the default action.
1117 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1227 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1118} 1228}
1119 1229
1120# default implementation for ->child 1230# default implementation for ->child
1121 1231
1122our %PID_CB; 1232our %PID_CB;
1123our $CHLD_W; 1233our $CHLD_W;
1124our $CHLD_DELAY_W; 1234our $CHLD_DELAY_W;
1125our $PID_IDLE;
1126our $WNOHANG; 1235our $WNOHANG;
1127 1236
1128sub _child_wait { 1237sub _sigchld {
1129 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1238 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1130 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1239 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1131 (values %{ $PID_CB{0} || {} }); 1240 (values %{ $PID_CB{0} || {} });
1132 } 1241 }
1133
1134 undef $PID_IDLE;
1135}
1136
1137sub _sigchld {
1138 # make sure we deliver these changes "synchronous" with the event loop.
1139 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1140 undef $CHLD_DELAY_W;
1141 &_child_wait;
1142 });
1143} 1242}
1144 1243
1145sub child { 1244sub child {
1146 my (undef, %arg) = @_; 1245 my (undef, %arg) = @_;
1147 1246
1148 defined (my $pid = $arg{pid} + 0) 1247 defined (my $pid = $arg{pid} + 0)
1149 or Carp::croak "required option 'pid' is missing"; 1248 or Carp::croak "required option 'pid' is missing";
1150 1249
1151 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1250 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1152 1251
1153 unless ($WNOHANG) {
1154 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1252 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1155 }
1156 1253
1157 unless ($CHLD_W) { 1254 unless ($CHLD_W) {
1158 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1255 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1159 # child could be a zombie already, so make at least one round 1256 # child could be a zombie already, so make at least one round
1160 &_sigchld; 1257 &_sigchld;
1161 } 1258 }
1162 1259
1163 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1260 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1164} 1261}
1165 1262
1166sub AnyEvent::Base::Child::DESTROY { 1263sub AnyEvent::Base::child::DESTROY {
1167 my ($pid, $cb) = @{$_[0]}; 1264 my ($pid, $cb) = @{$_[0]};
1168 1265
1169 delete $PID_CB{$pid}{$cb}; 1266 delete $PID_CB{$pid}{$cb};
1170 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1267 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1171 1268
1172 undef $CHLD_W unless keys %PID_CB; 1269 undef $CHLD_W unless keys %PID_CB;
1270}
1271
1272# idle emulation is done by simply using a timer, regardless
1273# of whether the process is idle or not, and not letting
1274# the callback use more than 50% of the time.
1275sub idle {
1276 my (undef, %arg) = @_;
1277
1278 my ($cb, $w, $rcb) = $arg{cb};
1279
1280 $rcb = sub {
1281 if ($cb) {
1282 $w = _time;
1283 &$cb;
1284 $w = _time - $w;
1285
1286 # never use more then 50% of the time for the idle watcher,
1287 # within some limits
1288 $w = 0.0001 if $w < 0.0001;
1289 $w = 5 if $w > 5;
1290
1291 $w = AnyEvent->timer (after => $w, cb => $rcb);
1292 } else {
1293 # clean up...
1294 undef $w;
1295 undef $rcb;
1296 }
1297 };
1298
1299 $w = AnyEvent->timer (after => 0.05, cb => $rcb);
1300
1301 bless \\$cb, "AnyEvent::Base::idle"
1302}
1303
1304sub AnyEvent::Base::idle::DESTROY {
1305 undef $${$_[0]};
1173} 1306}
1174 1307
1175package AnyEvent::CondVar; 1308package AnyEvent::CondVar;
1176 1309
1177our @ISA = AnyEvent::CondVar::Base::; 1310our @ISA = AnyEvent::CondVar::Base::;
1251so on. 1384so on.
1252 1385
1253=head1 ENVIRONMENT VARIABLES 1386=head1 ENVIRONMENT VARIABLES
1254 1387
1255The following environment variables are used by this module or its 1388The following environment variables are used by this module or its
1256submodules: 1389submodules.
1390
1391Note that AnyEvent will remove I<all> environment variables starting with
1392C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1393enabled.
1257 1394
1258=over 4 1395=over 4
1259 1396
1260=item C<PERL_ANYEVENT_VERBOSE> 1397=item C<PERL_ANYEVENT_VERBOSE>
1261 1398
1273=item C<PERL_ANYEVENT_STRICT> 1410=item C<PERL_ANYEVENT_STRICT>
1274 1411
1275AnyEvent does not do much argument checking by default, as thorough 1412AnyEvent does not do much argument checking by default, as thorough
1276argument checking is very costly. Setting this variable to a true value 1413argument checking is very costly. Setting this variable to a true value
1277will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1414will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1278check the arguments passed to most method calls. If it finds any problems 1415check the arguments passed to most method calls. If it finds any problems,
1279it will croak. 1416it will croak.
1280 1417
1281In other words, enables "strict" mode. 1418In other words, enables "strict" mode.
1282 1419
1283Unlike C<use strict>, it is definitely recommended ot keep it off in 1420Unlike C<use strict>, it is definitely recommended to keep it off in
1284production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1421production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1285developing programs can be very useful, however. 1422developing programs can be very useful, however.
1286 1423
1287=item C<PERL_ANYEVENT_MODEL> 1424=item C<PERL_ANYEVENT_MODEL>
1288 1425
1333 1470
1334=item C<PERL_ANYEVENT_MAX_FORKS> 1471=item C<PERL_ANYEVENT_MAX_FORKS>
1335 1472
1336The maximum number of child processes that C<AnyEvent::Util::fork_call> 1473The maximum number of child processes that C<AnyEvent::Util::fork_call>
1337will create in parallel. 1474will create in parallel.
1475
1476=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1477
1478The default value for the C<max_outstanding> parameter for the default DNS
1479resolver - this is the maximum number of parallel DNS requests that are
1480sent to the DNS server.
1481
1482=item C<PERL_ANYEVENT_RESOLV_CONF>
1483
1484The file to use instead of F</etc/resolv.conf> (or OS-specific
1485configuration) in the default resolver. When set to the empty string, no
1486default config will be used.
1487
1488=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1489
1490When neither C<ca_file> nor C<ca_path> was specified during
1491L<AnyEvent::TLS> context creation, and either of these environment
1492variables exist, they will be used to specify CA certificate locations
1493instead of a system-dependent default.
1338 1494
1339=back 1495=back
1340 1496
1341=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1497=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1342 1498
1587 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 1743 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1588 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 1744 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1589 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 1745 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1590 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 1746 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1591 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 1747 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1748 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
1749 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1592 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 1750 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1593 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 1751 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1594 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 1752 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1595 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 1753 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1596 1754
1625performance becomes really bad with lots of file descriptors (and few of 1783performance becomes really bad with lots of file descriptors (and few of
1626them active), of course, but this was not subject of this benchmark. 1784them active), of course, but this was not subject of this benchmark.
1627 1785
1628The C<Event> module has a relatively high setup and callback invocation 1786The C<Event> module has a relatively high setup and callback invocation
1629cost, but overall scores in on the third place. 1787cost, but overall scores in on the third place.
1788
1789C<IO::Async> performs admirably well, about on par with C<Event>, even
1790when using its pure perl backend.
1630 1791
1631C<Glib>'s memory usage is quite a bit higher, but it features a 1792C<Glib>'s memory usage is quite a bit higher, but it features a
1632faster callback invocation and overall ends up in the same class as 1793faster callback invocation and overall ends up in the same class as
1633C<Event>. However, Glib scales extremely badly, doubling the number of 1794C<Event>. However, Glib scales extremely badly, doubling the number of
1634watchers increases the processing time by more than a factor of four, 1795watchers increases the processing time by more than a factor of four,
1712it to another server. This includes deleting the old timeout and creating 1873it to another server. This includes deleting the old timeout and creating
1713a new one that moves the timeout into the future. 1874a new one that moves the timeout into the future.
1714 1875
1715=head3 Results 1876=head3 Results
1716 1877
1717 name sockets create request 1878 name sockets create request
1718 EV 20000 69.01 11.16 1879 EV 20000 69.01 11.16
1719 Perl 20000 73.32 35.87 1880 Perl 20000 73.32 35.87
1881 IOAsync 20000 157.00 98.14 epoll
1882 IOAsync 20000 159.31 616.06 poll
1720 Event 20000 212.62 257.32 1883 Event 20000 212.62 257.32
1721 Glib 20000 651.16 1896.30 1884 Glib 20000 651.16 1896.30
1722 POE 20000 349.67 12317.24 uses POE::Loop::Event 1885 POE 20000 349.67 12317.24 uses POE::Loop::Event
1723 1886
1724=head3 Discussion 1887=head3 Discussion
1725 1888
1726This benchmark I<does> measure scalability and overall performance of the 1889This benchmark I<does> measure scalability and overall performance of the
1727particular event loop. 1890particular event loop.
1729EV is again fastest. Since it is using epoll on my system, the setup time 1892EV is again fastest. Since it is using epoll on my system, the setup time
1730is relatively high, though. 1893is relatively high, though.
1731 1894
1732Perl surprisingly comes second. It is much faster than the C-based event 1895Perl surprisingly comes second. It is much faster than the C-based event
1733loops Event and Glib. 1896loops Event and Glib.
1897
1898IO::Async performs very well when using its epoll backend, and still quite
1899good compared to Glib when using its pure perl backend.
1734 1900
1735Event suffers from high setup time as well (look at its code and you will 1901Event suffers from high setup time as well (look at its code and you will
1736understand why). Callback invocation also has a high overhead compared to 1902understand why). Callback invocation also has a high overhead compared to
1737the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 1903the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1738uses select or poll in basically all documented configurations. 1904uses select or poll in basically all documented configurations.
1801=item * C-based event loops perform very well with small number of 1967=item * C-based event loops perform very well with small number of
1802watchers, as the management overhead dominates. 1968watchers, as the management overhead dominates.
1803 1969
1804=back 1970=back
1805 1971
1972=head2 THE IO::Lambda BENCHMARK
1973
1974Recently I was told about the benchmark in the IO::Lambda manpage, which
1975could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
1976simply compares IO::Lambda with POE, and IO::Lambda looks better (which
1977shouldn't come as a surprise to anybody). As such, the benchmark is
1978fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
1979very optimal. But how would AnyEvent compare when used without the extra
1980baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
1981
1982The benchmark itself creates an echo-server, and then, for 500 times,
1983connects to the echo server, sends a line, waits for the reply, and then
1984creates the next connection. This is a rather bad benchmark, as it doesn't
1985test the efficiency of the framework or much non-blocking I/O, but it is a
1986benchmark nevertheless.
1987
1988 name runtime
1989 Lambda/select 0.330 sec
1990 + optimized 0.122 sec
1991 Lambda/AnyEvent 0.327 sec
1992 + optimized 0.138 sec
1993 Raw sockets/select 0.077 sec
1994 POE/select, components 0.662 sec
1995 POE/select, raw sockets 0.226 sec
1996 POE/select, optimized 0.404 sec
1997
1998 AnyEvent/select/nb 0.085 sec
1999 AnyEvent/EV/nb 0.068 sec
2000 +state machine 0.134 sec
2001
2002The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2003benchmarks actually make blocking connects and use 100% blocking I/O,
2004defeating the purpose of an event-based solution. All of the newly
2005written AnyEvent benchmarks use 100% non-blocking connects (using
2006AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2007resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2008generally require a lot more bookkeeping and event handling than blocking
2009connects (which involve a single syscall only).
2010
2011The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2012offers similar expressive power as POE and IO::Lambda, using conventional
2013Perl syntax. This means that both the echo server and the client are 100%
2014non-blocking, further placing it at a disadvantage.
2015
2016As you can see, the AnyEvent + EV combination even beats the
2017hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2018backend easily beats IO::Lambda and POE.
2019
2020And even the 100% non-blocking version written using the high-level (and
2021slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2022large margin, even though it does all of DNS, tcp-connect and socket I/O
2023in a non-blocking way.
2024
2025The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2026F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2027part of the IO::lambda distribution and were used without any changes.
2028
1806 2029
1807=head1 SIGNALS 2030=head1 SIGNALS
1808 2031
1809AnyEvent currently installs handlers for these signals: 2032AnyEvent currently installs handlers for these signals:
1810 2033
1813=item SIGCHLD 2036=item SIGCHLD
1814 2037
1815A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2038A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1816emulation for event loops that do not support them natively. Also, some 2039emulation for event loops that do not support them natively. Also, some
1817event loops install a similar handler. 2040event loops install a similar handler.
2041
2042If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will
2043reset it to default, to avoid losing child exit statuses.
1818 2044
1819=item SIGPIPE 2045=item SIGPIPE
1820 2046
1821A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2047A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1822when AnyEvent gets loaded. 2048when AnyEvent gets loaded.
1834 2060
1835=back 2061=back
1836 2062
1837=cut 2063=cut
1838 2064
2065undef $SIG{CHLD}
2066 if $SIG{CHLD} eq 'IGNORE';
2067
1839$SIG{PIPE} = sub { } 2068$SIG{PIPE} = sub { }
1840 unless defined $SIG{PIPE}; 2069 unless defined $SIG{PIPE};
1841
1842 2070
1843=head1 FORK 2071=head1 FORK
1844 2072
1845Most event libraries are not fork-safe. The ones who are usually are 2073Most event libraries are not fork-safe. The ones who are usually are
1846because they rely on inefficient but fork-safe C<select> or C<poll> 2074because they rely on inefficient but fork-safe C<select> or C<poll>
1867 use AnyEvent; 2095 use AnyEvent;
1868 2096
1869Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2097Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1870be used to probe what backend is used and gain other information (which is 2098be used to probe what backend is used and gain other information (which is
1871probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2099probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1872$ENV{PERL_ANYEGENT_STRICT}. 2100$ENV{PERL_ANYEVENT_STRICT}.
2101
2102Note that AnyEvent will remove I<all> environment variables starting with
2103C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2104enabled.
1873 2105
1874 2106
1875=head1 BUGS 2107=head1 BUGS
1876 2108
1877Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2109Perl 5.8 has numerous memleaks that sometimes hit this module and are hard

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines