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.197 by root, Thu Mar 26 15:51:44 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> the Perl I<file handle> (I<not> file descriptor) to watch for events 181C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
174(AnyEvent might or might not keep a reference to this file handle). C<poll> 182for events (AnyEvent might or might not keep a reference to this file
183handle). Note that only file handles pointing to things for which
184non-blocking operation makes sense are allowed. This includes sockets,
185most character devices, pipes, fifos and so on, but not for example files
186or block devices.
187
175must be a string that is either C<r> or C<w>, which creates a watcher 188C<poll> must be a string that is either C<r> or C<w>, which creates a
176waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the 189watcher waiting for "r"eadable or "w"ritable events, respectively.
190
177callback to invoke each time the file handle becomes ready. 191C<cb> is the callback to invoke each time the file handle becomes ready.
178 192
179Although the callback might get passed parameters, their value and 193Although the callback might get passed parameters, their value and
180presence is undefined and you cannot rely on them. Portable AnyEvent 194presence is undefined and you cannot rely on them. Portable AnyEvent
181callbacks cannot use arguments passed to I/O watcher callbacks. 195callbacks cannot use arguments passed to I/O watcher callbacks.
182 196
314In 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
315can 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
316difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 330difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
317account. 331account.
318 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
319=back 348=back
320 349
321=head2 SIGNAL WATCHERS 350=head2 SIGNAL WATCHERS
322 351
323You 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
363 392
364There 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
365I<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
366have exited already (and no SIGCHLD will be sent anymore). 395have exited already (and no SIGCHLD will be sent anymore).
367 396
368Not 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
369event 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
370loaded 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.
371 403
372This 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
373AnyEvent 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
374C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 406watcher before you C<fork> the child (alternatively, you can call
407C<AnyEvent::detect>).
375 408
376Example: fork a process and wait for it 409Example: fork a process and wait for it
377 410
378 my $done = AnyEvent->condvar; 411 my $done = AnyEvent->condvar;
379 412
389 ); 422 );
390 423
391 # do something else, then wait for process exit 424 # do something else, then wait for process exit
392 $done->recv; 425 $done->recv;
393 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
394=head2 CONDITION VARIABLES 462=head2 CONDITION VARIABLES
395 463
396If 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
397require you to run some blocking "loop", "run" or similar function that 465require you to run some blocking "loop", "run" or similar function that
398will actively watch for new events and call your callbacks. 466will actively watch for new events and call your callbacks.
531 599
532=item $cv->begin ([group callback]) 600=item $cv->begin ([group callback])
533 601
534=item $cv->end 602=item $cv->end
535 603
536These two methods are EXPERIMENTAL and MIGHT CHANGE.
537
538These two methods can be used to combine many transactions/events into 604These two methods can be used to combine many transactions/events into
539one. 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
540to use a condition variable for the whole process. 606to use a condition variable for the whole process.
541 607
542Every 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
543C<< ->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
544>>, 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
545is 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
546callback was set, C<send> will be called without any arguments. 612callback was set, C<send> will be called without any arguments.
547 613
548Let'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:
549 645
550 my $cv = AnyEvent->condvar; 646 my $cv = AnyEvent->condvar;
551 647
552 my %result; 648 my %result;
553 $cv->begin (sub { $cv->send (\%result) }); 649 $cv->begin (sub { $cv->send (\%result) });
573loop, which serves two important purposes: first, it sets the callback 669loop, which serves two important purposes: first, it sets the callback
574to 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
575C<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
576doesn't execute once). 672doesn't execute once).
577 673
578This is the general pattern when you "fan out" into multiple subrequests: 674This is the general pattern when you "fan out" into multiple (but
579use 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
580is 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
581C<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>.
582 679
583=back 680=back
584 681
585=head3 METHODS FOR CONSUMERS 682=head3 METHODS FOR CONSUMERS
586 683
666 AnyEvent::Impl::Tk based on Tk, very bad choice. 763 AnyEvent::Impl::Tk based on Tk, very bad choice.
667 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).
668 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 765 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
669 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.
670 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
671There is no support for WxWidgets, as WxWidgets has no support for 772There is no support for WxWidgets, as WxWidgets has no support for
672watching file handles. However, you can use WxWidgets through the 773watching file handles. However, you can use WxWidgets through the
673POE 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
674second, which was considered to be too horrible to even consider for 775second, which was considered to be too horrible to even consider for
675AnyEvent. Likewise, other POE backends can be used by AnyEvent by using 776AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
867no warnings; 968no warnings;
868use strict qw(vars subs); 969use strict qw(vars subs);
869 970
870use Carp; 971use Carp;
871 972
872our $VERSION = 4.341; 973our $VERSION = 4.8;
873our $MODEL; 974our $MODEL;
874 975
875our $AUTOLOAD; 976our $AUTOLOAD;
876our @ISA; 977our @ISA;
877 978
878our @REGISTRY; 979our @REGISTRY;
879 980
880our $WIN32; 981our $WIN32;
881 982
882BEGIN { 983BEGIN {
883 my $win32 = ! ! ($^O =~ /mswin32/i); 984 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
884 eval "sub WIN32(){ $win32 }"; 985 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
986
987 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
988 if ${^TAINT};
885} 989}
886 990
887our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 991our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
888 992
889our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 993our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
907 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1011 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
908 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1012 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
909 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1013 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
910 [Wx:: => AnyEvent::Impl::POE::], 1014 [Wx:: => AnyEvent::Impl::POE::],
911 [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
912); 1023);
913 1024
914our %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);
915 1027
916our @post_detect; 1028our @post_detect;
917 1029
918sub post_detect(&) { 1030sub post_detect(&) {
919 my ($cb) = @_; 1031 my ($cb) = @_;
924 1 1036 1
925 } else { 1037 } else {
926 push @post_detect, $cb; 1038 push @post_detect, $cb;
927 1039
928 defined wantarray 1040 defined wantarray
929 ? bless \$cb, "AnyEvent::Util::PostDetect" 1041 ? bless \$cb, "AnyEvent::Util::postdetect"
930 : () 1042 : ()
931 } 1043 }
932} 1044}
933 1045
934sub AnyEvent::Util::PostDetect::DESTROY { 1046sub AnyEvent::Util::postdetect::DESTROY {
935 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1047 @post_detect = grep $_ != ${$_[0]}, @post_detect;
936} 1048}
937 1049
938sub detect() { 1050sub detect() {
939 unless ($MODEL) { 1051 unless ($MODEL) {
976 last; 1088 last;
977 } 1089 }
978 } 1090 }
979 1091
980 $MODEL 1092 $MODEL
981 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";
982 } 1094 }
983 } 1095 }
984 1096
985 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1097 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
986 1098
1007} 1119}
1008 1120
1009# 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
1010# to support binding more than one watcher per filehandle (they usually 1122# to support binding more than one watcher per filehandle (they usually
1011# 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).
1012sub _dupfh($$$$) { 1124sub _dupfh($$;$$) {
1013 my ($poll, $fh, $r, $w) = @_; 1125 my ($poll, $fh, $r, $w) = @_;
1014 1126
1015 # cygwin requires the fh mode to be matching, unix doesn't 1127 # cygwin requires the fh mode to be matching, unix doesn't
1016 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1128 my ($rw, $mode) = $poll eq "r" ? ($r, "<") : ($w, ">");
1017 : $poll eq "w" ? ($w, ">")
1018 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1019 1129
1020 open my $fh2, "$mode&" . fileno $fh 1130 open my $fh2, "$mode&", $fh
1021 or die "cannot dup() filehandle: $!"; 1131 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1022 1132
1023 # 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
1024 1134
1025 ($fh2, $rw) 1135 ($fh2, $rw)
1026} 1136}
1027 1137
1028package AnyEvent::Base; 1138package AnyEvent::Base;
1029 1139
1030# default implementation for now and time 1140# default implementations for many methods
1031 1141
1032BEGIN { 1142BEGIN {
1033 if (eval "use Time::HiRes (); time (); 1") { 1143 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1034 *_time = \&Time::HiRes::time; 1144 *_time = \&Time::HiRes::time;
1035 # if (eval "use POSIX (); (POSIX::times())... 1145 # if (eval "use POSIX (); (POSIX::times())...
1036 } else { 1146 } else {
1037 *_time = sub { time }; # epic fail 1147 *_time = sub { time }; # epic fail
1038 } 1148 }
1039} 1149}
1040 1150
1041sub time { _time } 1151sub time { _time }
1042sub now { _time } 1152sub now { _time }
1153sub now_update { }
1043 1154
1044# default implementation for ->condvar 1155# default implementation for ->condvar
1045 1156
1046sub condvar { 1157sub condvar {
1047 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1158 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1048} 1159}
1049 1160
1050# default implementation for ->signal 1161# default implementation for ->signal
1051 1162
1052our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1163our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1053 1164
1054sub _signal_exec { 1165sub _signal_exec {
1166 sysread $SIGPIPE_R, my $dummy, 4;
1167
1055 while (%SIG_EV) { 1168 while (%SIG_EV) {
1056 sysread $SIGPIPE_R, my $dummy, 4;
1057 for (keys %SIG_EV) { 1169 for (keys %SIG_EV) {
1058 delete $SIG_EV{$_}; 1170 delete $SIG_EV{$_};
1059 $_->() for values %{ $SIG_CB{$_} || {} }; 1171 $_->() for values %{ $SIG_CB{$_} || {} };
1060 } 1172 }
1061 } 1173 }
1063 1175
1064sub signal { 1176sub signal {
1065 my (undef, %arg) = @_; 1177 my (undef, %arg) = @_;
1066 1178
1067 unless ($SIGPIPE_R) { 1179 unless ($SIGPIPE_R) {
1180 require Fcntl;
1181
1068 if (AnyEvent::WIN32) { 1182 if (AnyEvent::WIN32) {
1183 require AnyEvent::Util;
1184
1069 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1185 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1070 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; 1186 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1071 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
1072 } else { 1188 } else {
1073 pipe $SIGPIPE_R, $SIGPIPE_W; 1189 pipe $SIGPIPE_R, $SIGPIPE_W;
1074 require Fcntl;
1075 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;
1076 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;
1077 } 1196 }
1078 1197
1079 $SIGPIPE_R 1198 $SIGPIPE_R
1080 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";
1081 1200
1085 my $signal = uc $arg{signal} 1204 my $signal = uc $arg{signal}
1086 or Carp::croak "required option 'signal' is missing"; 1205 or Carp::croak "required option 'signal' is missing";
1087 1206
1088 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1207 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1089 $SIG{$signal} ||= sub { 1208 $SIG{$signal} ||= sub {
1209 local $!;
1090 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1210 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1091 undef $SIG_EV{$signal}; 1211 undef $SIG_EV{$signal};
1092 }; 1212 };
1093 1213
1094 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1214 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1095} 1215}
1096 1216
1097sub AnyEvent::Base::Signal::DESTROY { 1217sub AnyEvent::Base::signal::DESTROY {
1098 my ($signal, $cb) = @{$_[0]}; 1218 my ($signal, $cb) = @{$_[0]};
1099 1219
1100 delete $SIG_CB{$signal}{$cb}; 1220 delete $SIG_CB{$signal}{$cb};
1101 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.
1102 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1225 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1103} 1226}
1104 1227
1105# default implementation for ->child 1228# default implementation for ->child
1106 1229
1107our %PID_CB; 1230our %PID_CB;
1108our $CHLD_W; 1231our $CHLD_W;
1109our $CHLD_DELAY_W; 1232our $CHLD_DELAY_W;
1110our $PID_IDLE;
1111our $WNOHANG; 1233our $WNOHANG;
1112 1234
1113sub _child_wait { 1235sub _sigchld {
1114 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1236 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1115 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1237 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1116 (values %{ $PID_CB{0} || {} }); 1238 (values %{ $PID_CB{0} || {} });
1117 } 1239 }
1118
1119 undef $PID_IDLE;
1120}
1121
1122sub _sigchld {
1123 # make sure we deliver these changes "synchronous" with the event loop.
1124 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1125 undef $CHLD_DELAY_W;
1126 &_child_wait;
1127 });
1128} 1240}
1129 1241
1130sub child { 1242sub child {
1131 my (undef, %arg) = @_; 1243 my (undef, %arg) = @_;
1132 1244
1133 defined (my $pid = $arg{pid} + 0) 1245 defined (my $pid = $arg{pid} + 0)
1134 or Carp::croak "required option 'pid' is missing"; 1246 or Carp::croak "required option 'pid' is missing";
1135 1247
1136 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1248 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1137 1249
1138 unless ($WNOHANG) {
1139 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1250 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1140 }
1141 1251
1142 unless ($CHLD_W) { 1252 unless ($CHLD_W) {
1143 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1253 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1144 # 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
1145 &_sigchld; 1255 &_sigchld;
1146 } 1256 }
1147 1257
1148 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1258 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1149} 1259}
1150 1260
1151sub AnyEvent::Base::Child::DESTROY { 1261sub AnyEvent::Base::child::DESTROY {
1152 my ($pid, $cb) = @{$_[0]}; 1262 my ($pid, $cb) = @{$_[0]};
1153 1263
1154 delete $PID_CB{$pid}{$cb}; 1264 delete $PID_CB{$pid}{$cb};
1155 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1265 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1156 1266
1157 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]};
1158} 1304}
1159 1305
1160package AnyEvent::CondVar; 1306package AnyEvent::CondVar;
1161 1307
1162our @ISA = AnyEvent::CondVar::Base::; 1308our @ISA = AnyEvent::CondVar::Base::;
1236so on. 1382so on.
1237 1383
1238=head1 ENVIRONMENT VARIABLES 1384=head1 ENVIRONMENT VARIABLES
1239 1385
1240The following environment variables are used by this module or its 1386The following environment variables are used by this module or its
1241submodules: 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.
1242 1392
1243=over 4 1393=over 4
1244 1394
1245=item C<PERL_ANYEVENT_VERBOSE> 1395=item C<PERL_ANYEVENT_VERBOSE>
1246 1396
1258=item C<PERL_ANYEVENT_STRICT> 1408=item C<PERL_ANYEVENT_STRICT>
1259 1409
1260AnyEvent does not do much argument checking by default, as thorough 1410AnyEvent does not do much argument checking by default, as thorough
1261argument checking is very costly. Setting this variable to a true value 1411argument checking is very costly. Setting this variable to a true value
1262will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1412will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1263check 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,
1264it will croak. 1414it will croak.
1265 1415
1266In other words, enables "strict" mode. 1416In other words, enables "strict" mode.
1267 1417
1268Unlike 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
1269production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1419production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1270developing programs can be very useful, however. 1420developing programs can be very useful, however.
1271 1421
1272=item C<PERL_ANYEVENT_MODEL> 1422=item C<PERL_ANYEVENT_MODEL>
1273 1423
1318 1468
1319=item C<PERL_ANYEVENT_MAX_FORKS> 1469=item C<PERL_ANYEVENT_MAX_FORKS>
1320 1470
1321The maximum number of child processes that C<AnyEvent::Util::fork_call> 1471The maximum number of child processes that C<AnyEvent::Util::fork_call>
1322will 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.
1323 1492
1324=back 1493=back
1325 1494
1326=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1495=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1327 1496
1572 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
1573 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
1574 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
1575 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
1576 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
1577 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
1578 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
1579 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
1580 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
1581 1752
1610performance becomes really bad with lots of file descriptors (and few of 1781performance becomes really bad with lots of file descriptors (and few of
1611them active), of course, but this was not subject of this benchmark. 1782them active), of course, but this was not subject of this benchmark.
1612 1783
1613The C<Event> module has a relatively high setup and callback invocation 1784The C<Event> module has a relatively high setup and callback invocation
1614cost, 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.
1615 1789
1616C<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
1617faster callback invocation and overall ends up in the same class as 1791faster callback invocation and overall ends up in the same class as
1618C<Event>. However, Glib scales extremely badly, doubling the number of 1792C<Event>. However, Glib scales extremely badly, doubling the number of
1619watchers increases the processing time by more than a factor of four, 1793watchers increases the processing time by more than a factor of four,
1697it to another server. This includes deleting the old timeout and creating 1871it to another server. This includes deleting the old timeout and creating
1698a new one that moves the timeout into the future. 1872a new one that moves the timeout into the future.
1699 1873
1700=head3 Results 1874=head3 Results
1701 1875
1702 name sockets create request 1876 name sockets create request
1703 EV 20000 69.01 11.16 1877 EV 20000 69.01 11.16
1704 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
1705 Event 20000 212.62 257.32 1881 Event 20000 212.62 257.32
1706 Glib 20000 651.16 1896.30 1882 Glib 20000 651.16 1896.30
1707 POE 20000 349.67 12317.24 uses POE::Loop::Event 1883 POE 20000 349.67 12317.24 uses POE::Loop::Event
1708 1884
1709=head3 Discussion 1885=head3 Discussion
1710 1886
1711This benchmark I<does> measure scalability and overall performance of the 1887This benchmark I<does> measure scalability and overall performance of the
1712particular event loop. 1888particular event loop.
1714EV 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
1715is relatively high, though. 1891is relatively high, though.
1716 1892
1717Perl 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
1718loops 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.
1719 1898
1720Event 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
1721understand why). Callback invocation also has a high overhead compared to 1900understand why). Callback invocation also has a high overhead compared to
1722the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 1901the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1723uses select or poll in basically all documented configurations. 1902uses select or poll in basically all documented configurations.
1786=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
1787watchers, as the management overhead dominates. 1966watchers, as the management overhead dominates.
1788 1967
1789=back 1968=back
1790 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
1791 2027
1792=head1 SIGNALS 2028=head1 SIGNALS
1793 2029
1794AnyEvent currently installs handlers for these signals: 2030AnyEvent currently installs handlers for these signals:
1795 2031
1798=item SIGCHLD 2034=item SIGCHLD
1799 2035
1800A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2036A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1801emulation for event loops that do not support them natively. Also, some 2037emulation for event loops that do not support them natively. Also, some
1802event 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.
1803 2042
1804=item SIGPIPE 2043=item SIGPIPE
1805 2044
1806A 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>
1807when AnyEvent gets loaded. 2046when AnyEvent gets loaded.
1819 2058
1820=back 2059=back
1821 2060
1822=cut 2061=cut
1823 2062
2063undef $SIG{CHLD}
2064 if $SIG{CHLD} eq 'IGNORE';
2065
1824$SIG{PIPE} = sub { } 2066$SIG{PIPE} = sub { }
1825 unless defined $SIG{PIPE}; 2067 unless defined $SIG{PIPE};
1826
1827 2068
1828=head1 FORK 2069=head1 FORK
1829 2070
1830Most 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
1831because 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>
1852 use AnyEvent; 2093 use AnyEvent;
1853 2094
1854Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2095Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1855be 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
1856probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2097probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1857$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.
1858 2103
1859 2104
1860=head1 BUGS 2105=head1 BUGS
1861 2106
1862Perl 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