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.199 by root, Fri Mar 27 10:49:50 2009 UTC vs.
Revision 1.229 by root, Wed Jul 8 02:01:12 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:
168=head2 I/O WATCHERS 176=head2 I/O WATCHERS
169 177
170You can create an I/O watcher by calling the C<< AnyEvent->io >> method 178You can create an I/O watcher by calling the C<< AnyEvent->io >> method
171with the following mandatory key-value pairs as arguments: 179with the following mandatory key-value pairs as arguments:
172 180
173C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch 181C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
174for events (AnyEvent might or might not keep a reference to this file 182for events (AnyEvent might or might not keep a reference to this file
175handle). Note that only file handles pointing to things for which 183handle). Note that only file handles pointing to things for which
176non-blocking operation makes sense are allowed. This includes sockets, 184non-blocking operation makes sense are allowed. This includes sockets,
177most character devices, pipes, fifos and so on, but not for example files 185most character devices, pipes, fifos and so on, but not for example files
178or block devices. 186or block devices.
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, "<") : ($w, ">");
1023 : $poll eq "w" ? ($w, ">")
1024 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1025 1129
1026 open my $fh2, "$mode&" . fileno $fh 1130 open my $fh2, "$mode&", $fh
1027 or die "cannot dup() filehandle: $!"; 1131 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1028 1132
1029 # we assume CLOEXEC is already set by perl in all important cases 1133 # we assume CLOEXEC is already set by perl in all important cases
1030 1134
1031 ($fh2, $rw) 1135 ($fh2, $rw)
1032} 1136}
1033 1137
1034package AnyEvent::Base; 1138package AnyEvent::Base;
1035 1139
1036# default implementation for now and time 1140# default implementations for many methods
1037 1141
1038BEGIN { 1142BEGIN {
1039 if (eval "use Time::HiRes (); time (); 1") { 1143 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1040 *_time = \&Time::HiRes::time; 1144 *_time = \&Time::HiRes::time;
1041 # if (eval "use POSIX (); (POSIX::times())... 1145 # if (eval "use POSIX (); (POSIX::times())...
1042 } else { 1146 } else {
1043 *_time = sub { time }; # epic fail 1147 *_time = sub { time }; # epic fail
1044 } 1148 }
1045} 1149}
1046 1150
1047sub time { _time } 1151sub time { _time }
1048sub now { _time } 1152sub now { _time }
1153sub now_update { }
1049 1154
1050# default implementation for ->condvar 1155# default implementation for ->condvar
1051 1156
1052sub condvar { 1157sub condvar {
1053 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1158 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1054} 1159}
1055 1160
1056# default implementation for ->signal 1161# default implementation for ->signal
1057 1162
1058our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1163our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1070 1175
1071sub signal { 1176sub signal {
1072 my (undef, %arg) = @_; 1177 my (undef, %arg) = @_;
1073 1178
1074 unless ($SIGPIPE_R) { 1179 unless ($SIGPIPE_R) {
1180 require Fcntl;
1181
1075 if (AnyEvent::WIN32) { 1182 if (AnyEvent::WIN32) {
1183 require AnyEvent::Util;
1184
1076 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1185 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1077 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; 1186 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1078 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case 1187 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1079 } else { 1188 } else {
1080 pipe $SIGPIPE_R, $SIGPIPE_W; 1189 pipe $SIGPIPE_R, $SIGPIPE_W;
1081 require Fcntl;
1082 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1190 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1083 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1191 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1192
1193 # not strictly required, as $^F is normally 2, but let's make sure...
1194 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1195 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1084 } 1196 }
1085 1197
1086 $SIGPIPE_R 1198 $SIGPIPE_R
1087 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1199 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1088 1200
1092 my $signal = uc $arg{signal} 1204 my $signal = uc $arg{signal}
1093 or Carp::croak "required option 'signal' is missing"; 1205 or Carp::croak "required option 'signal' is missing";
1094 1206
1095 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1207 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1096 $SIG{$signal} ||= sub { 1208 $SIG{$signal} ||= sub {
1209 local $!;
1097 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1210 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1098 undef $SIG_EV{$signal}; 1211 undef $SIG_EV{$signal};
1099 }; 1212 };
1100 1213
1101 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1214 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1102} 1215}
1103 1216
1104sub AnyEvent::Base::Signal::DESTROY { 1217sub AnyEvent::Base::signal::DESTROY {
1105 my ($signal, $cb) = @{$_[0]}; 1218 my ($signal, $cb) = @{$_[0]};
1106 1219
1107 delete $SIG_CB{$signal}{$cb}; 1220 delete $SIG_CB{$signal}{$cb};
1108 1221
1222 # delete doesn't work with older perls - they then
1223 # print weird messages, or just unconditionally exit
1224 # instead of getting the default action.
1109 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1225 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1110} 1226}
1111 1227
1112# default implementation for ->child 1228# default implementation for ->child
1113 1229
1114our %PID_CB; 1230our %PID_CB;
1115our $CHLD_W; 1231our $CHLD_W;
1116our $CHLD_DELAY_W; 1232our $CHLD_DELAY_W;
1117our $PID_IDLE;
1118our $WNOHANG; 1233our $WNOHANG;
1119 1234
1120sub _child_wait { 1235sub _sigchld {
1121 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1236 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1122 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1237 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1123 (values %{ $PID_CB{0} || {} }); 1238 (values %{ $PID_CB{0} || {} });
1124 } 1239 }
1125
1126 undef $PID_IDLE;
1127}
1128
1129sub _sigchld {
1130 # make sure we deliver these changes "synchronous" with the event loop.
1131 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1132 undef $CHLD_DELAY_W;
1133 &_child_wait;
1134 });
1135} 1240}
1136 1241
1137sub child { 1242sub child {
1138 my (undef, %arg) = @_; 1243 my (undef, %arg) = @_;
1139 1244
1140 defined (my $pid = $arg{pid} + 0) 1245 defined (my $pid = $arg{pid} + 0)
1141 or Carp::croak "required option 'pid' is missing"; 1246 or Carp::croak "required option 'pid' is missing";
1142 1247
1143 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1248 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1144 1249
1145 unless ($WNOHANG) {
1146 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1250 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1147 }
1148 1251
1149 unless ($CHLD_W) { 1252 unless ($CHLD_W) {
1150 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1253 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1151 # child could be a zombie already, so make at least one round 1254 # child could be a zombie already, so make at least one round
1152 &_sigchld; 1255 &_sigchld;
1153 } 1256 }
1154 1257
1155 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1258 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1156} 1259}
1157 1260
1158sub AnyEvent::Base::Child::DESTROY { 1261sub AnyEvent::Base::child::DESTROY {
1159 my ($pid, $cb) = @{$_[0]}; 1262 my ($pid, $cb) = @{$_[0]};
1160 1263
1161 delete $PID_CB{$pid}{$cb}; 1264 delete $PID_CB{$pid}{$cb};
1162 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1265 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1163 1266
1164 undef $CHLD_W unless keys %PID_CB; 1267 undef $CHLD_W unless keys %PID_CB;
1268}
1269
1270# idle emulation is done by simply using a timer, regardless
1271# of whether the process is idle or not, and not letting
1272# the callback use more than 50% of the time.
1273sub idle {
1274 my (undef, %arg) = @_;
1275
1276 my ($cb, $w, $rcb) = $arg{cb};
1277
1278 $rcb = sub {
1279 if ($cb) {
1280 $w = _time;
1281 &$cb;
1282 $w = _time - $w;
1283
1284 # never use more then 50% of the time for the idle watcher,
1285 # within some limits
1286 $w = 0.0001 if $w < 0.0001;
1287 $w = 5 if $w > 5;
1288
1289 $w = AnyEvent->timer (after => $w, cb => $rcb);
1290 } else {
1291 # clean up...
1292 undef $w;
1293 undef $rcb;
1294 }
1295 };
1296
1297 $w = AnyEvent->timer (after => 0.05, cb => $rcb);
1298
1299 bless \\$cb, "AnyEvent::Base::idle"
1300}
1301
1302sub AnyEvent::Base::idle::DESTROY {
1303 undef $${$_[0]};
1165} 1304}
1166 1305
1167package AnyEvent::CondVar; 1306package AnyEvent::CondVar;
1168 1307
1169our @ISA = AnyEvent::CondVar::Base::; 1308our @ISA = AnyEvent::CondVar::Base::;
1243so on. 1382so on.
1244 1383
1245=head1 ENVIRONMENT VARIABLES 1384=head1 ENVIRONMENT VARIABLES
1246 1385
1247The following environment variables are used by this module or its 1386The following environment variables are used by this module or its
1248submodules: 1387submodules.
1388
1389Note that AnyEvent will remove I<all> environment variables starting with
1390C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1391enabled.
1249 1392
1250=over 4 1393=over 4
1251 1394
1252=item C<PERL_ANYEVENT_VERBOSE> 1395=item C<PERL_ANYEVENT_VERBOSE>
1253 1396
1265=item C<PERL_ANYEVENT_STRICT> 1408=item C<PERL_ANYEVENT_STRICT>
1266 1409
1267AnyEvent does not do much argument checking by default, as thorough 1410AnyEvent does not do much argument checking by default, as thorough
1268argument checking is very costly. Setting this variable to a true value 1411argument checking is very costly. Setting this variable to a true value
1269will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1412will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1270check the arguments passed to most method calls. If it finds any problems 1413check the arguments passed to most method calls. If it finds any problems,
1271it will croak. 1414it will croak.
1272 1415
1273In other words, enables "strict" mode. 1416In other words, enables "strict" mode.
1274 1417
1275Unlike C<use strict>, it is definitely recommended ot keep it off in 1418Unlike C<use strict>, it is definitely recommended to keep it off in
1276production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1419production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1277developing programs can be very useful, however. 1420developing programs can be very useful, however.
1278 1421
1279=item C<PERL_ANYEVENT_MODEL> 1422=item C<PERL_ANYEVENT_MODEL>
1280 1423
1325 1468
1326=item C<PERL_ANYEVENT_MAX_FORKS> 1469=item C<PERL_ANYEVENT_MAX_FORKS>
1327 1470
1328The maximum number of child processes that C<AnyEvent::Util::fork_call> 1471The maximum number of child processes that C<AnyEvent::Util::fork_call>
1329will create in parallel. 1472will create in parallel.
1473
1474=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1475
1476The default value for the C<max_outstanding> parameter for the default DNS
1477resolver - this is the maximum number of parallel DNS requests that are
1478sent to the DNS server.
1479
1480=item C<PERL_ANYEVENT_RESOLV_CONF>
1481
1482The file to use instead of F</etc/resolv.conf> (or OS-specific
1483configuration) in the default resolver. When set to the empty string, no
1484default config will be used.
1485
1486=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1487
1488When neither C<ca_file> nor C<ca_path> was specified during
1489L<AnyEvent::TLS> context creation, and either of these environment
1490variables exist, they will be used to specify CA certificate locations
1491instead of a system-dependent default.
1330 1492
1331=back 1493=back
1332 1494
1333=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1495=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1334 1496
1579 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 1741 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1580 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 1742 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1581 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 1743 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1582 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 1744 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1583 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 1745 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1746 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
1747 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1584 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 1748 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1585 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 1749 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1586 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 1750 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1587 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 1751 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1588 1752
1617performance becomes really bad with lots of file descriptors (and few of 1781performance becomes really bad with lots of file descriptors (and few of
1618them active), of course, but this was not subject of this benchmark. 1782them active), of course, but this was not subject of this benchmark.
1619 1783
1620The C<Event> module has a relatively high setup and callback invocation 1784The C<Event> module has a relatively high setup and callback invocation
1621cost, but overall scores in on the third place. 1785cost, but overall scores in on the third place.
1786
1787C<IO::Async> performs admirably well, about on par with C<Event>, even
1788when using its pure perl backend.
1622 1789
1623C<Glib>'s memory usage is quite a bit higher, but it features a 1790C<Glib>'s memory usage is quite a bit higher, but it features a
1624faster callback invocation and overall ends up in the same class as 1791faster callback invocation and overall ends up in the same class as
1625C<Event>. However, Glib scales extremely badly, doubling the number of 1792C<Event>. However, Glib scales extremely badly, doubling the number of
1626watchers increases the processing time by more than a factor of four, 1793watchers increases the processing time by more than a factor of four,
1704it to another server. This includes deleting the old timeout and creating 1871it to another server. This includes deleting the old timeout and creating
1705a new one that moves the timeout into the future. 1872a new one that moves the timeout into the future.
1706 1873
1707=head3 Results 1874=head3 Results
1708 1875
1709 name sockets create request 1876 name sockets create request
1710 EV 20000 69.01 11.16 1877 EV 20000 69.01 11.16
1711 Perl 20000 73.32 35.87 1878 Perl 20000 73.32 35.87
1879 IOAsync 20000 157.00 98.14 epoll
1880 IOAsync 20000 159.31 616.06 poll
1712 Event 20000 212.62 257.32 1881 Event 20000 212.62 257.32
1713 Glib 20000 651.16 1896.30 1882 Glib 20000 651.16 1896.30
1714 POE 20000 349.67 12317.24 uses POE::Loop::Event 1883 POE 20000 349.67 12317.24 uses POE::Loop::Event
1715 1884
1716=head3 Discussion 1885=head3 Discussion
1717 1886
1718This benchmark I<does> measure scalability and overall performance of the 1887This benchmark I<does> measure scalability and overall performance of the
1719particular event loop. 1888particular event loop.
1721EV is again fastest. Since it is using epoll on my system, the setup time 1890EV is again fastest. Since it is using epoll on my system, the setup time
1722is relatively high, though. 1891is relatively high, though.
1723 1892
1724Perl surprisingly comes second. It is much faster than the C-based event 1893Perl surprisingly comes second. It is much faster than the C-based event
1725loops Event and Glib. 1894loops Event and Glib.
1895
1896IO::Async performs very well when using its epoll backend, and still quite
1897good compared to Glib when using its pure perl backend.
1726 1898
1727Event suffers from high setup time as well (look at its code and you will 1899Event suffers from high setup time as well (look at its code and you will
1728understand why). Callback invocation also has a high overhead compared to 1900understand why). Callback invocation also has a high overhead compared to
1729the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 1901the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1730uses select or poll in basically all documented configurations. 1902uses select or poll in basically all documented configurations.
1793=item * C-based event loops perform very well with small number of 1965=item * C-based event loops perform very well with small number of
1794watchers, as the management overhead dominates. 1966watchers, as the management overhead dominates.
1795 1967
1796=back 1968=back
1797 1969
1970=head2 THE IO::Lambda BENCHMARK
1971
1972Recently I was told about the benchmark in the IO::Lambda manpage, which
1973could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
1974simply compares IO::Lambda with POE, and IO::Lambda looks better (which
1975shouldn't come as a surprise to anybody). As such, the benchmark is
1976fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
1977very optimal. But how would AnyEvent compare when used without the extra
1978baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
1979
1980The benchmark itself creates an echo-server, and then, for 500 times,
1981connects to the echo server, sends a line, waits for the reply, and then
1982creates the next connection. This is a rather bad benchmark, as it doesn't
1983test the efficiency of the framework or much non-blocking I/O, but it is a
1984benchmark nevertheless.
1985
1986 name runtime
1987 Lambda/select 0.330 sec
1988 + optimized 0.122 sec
1989 Lambda/AnyEvent 0.327 sec
1990 + optimized 0.138 sec
1991 Raw sockets/select 0.077 sec
1992 POE/select, components 0.662 sec
1993 POE/select, raw sockets 0.226 sec
1994 POE/select, optimized 0.404 sec
1995
1996 AnyEvent/select/nb 0.085 sec
1997 AnyEvent/EV/nb 0.068 sec
1998 +state machine 0.134 sec
1999
2000The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2001benchmarks actually make blocking connects and use 100% blocking I/O,
2002defeating the purpose of an event-based solution. All of the newly
2003written AnyEvent benchmarks use 100% non-blocking connects (using
2004AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2005resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2006generally require a lot more bookkeeping and event handling than blocking
2007connects (which involve a single syscall only).
2008
2009The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2010offers similar expressive power as POE and IO::Lambda, using conventional
2011Perl syntax. This means that both the echo server and the client are 100%
2012non-blocking, further placing it at a disadvantage.
2013
2014As you can see, the AnyEvent + EV combination even beats the
2015hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2016backend easily beats IO::Lambda and POE.
2017
2018And even the 100% non-blocking version written using the high-level (and
2019slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2020large margin, even though it does all of DNS, tcp-connect and socket I/O
2021in a non-blocking way.
2022
2023The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2024F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2025part of the IO::lambda distribution and were used without any changes.
2026
1798 2027
1799=head1 SIGNALS 2028=head1 SIGNALS
1800 2029
1801AnyEvent currently installs handlers for these signals: 2030AnyEvent currently installs handlers for these signals:
1802 2031
1805=item SIGCHLD 2034=item SIGCHLD
1806 2035
1807A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2036A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1808emulation for event loops that do not support them natively. Also, some 2037emulation for event loops that do not support them natively. Also, some
1809event loops install a similar handler. 2038event loops install a similar handler.
2039
2040If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will
2041reset it to default, to avoid losing child exit statuses.
1810 2042
1811=item SIGPIPE 2043=item SIGPIPE
1812 2044
1813A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2045A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1814when AnyEvent gets loaded. 2046when AnyEvent gets loaded.
1826 2058
1827=back 2059=back
1828 2060
1829=cut 2061=cut
1830 2062
2063undef $SIG{CHLD}
2064 if $SIG{CHLD} eq 'IGNORE';
2065
1831$SIG{PIPE} = sub { } 2066$SIG{PIPE} = sub { }
1832 unless defined $SIG{PIPE}; 2067 unless defined $SIG{PIPE};
1833
1834 2068
1835=head1 FORK 2069=head1 FORK
1836 2070
1837Most event libraries are not fork-safe. The ones who are usually are 2071Most event libraries are not fork-safe. The ones who are usually are
1838because they rely on inefficient but fork-safe C<select> or C<poll> 2072because they rely on inefficient but fork-safe C<select> or C<poll>
1859 use AnyEvent; 2093 use AnyEvent;
1860 2094
1861Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2095Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1862be used to probe what backend is used and gain other information (which is 2096be used to probe what backend is used and gain other information (which is
1863probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2097probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1864$ENV{PERL_ANYEGENT_STRICT}. 2098$ENV{PERL_ANYEVENT_STRICT}.
2099
2100Note that AnyEvent will remove I<all> environment variables starting with
2101C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2102enabled.
1865 2103
1866 2104
1867=head1 BUGS 2105=head1 BUGS
1868 2106
1869Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2107Perl 5.8 has numerous memleaks that sometimes hit this module and are hard

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines