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.167 by root, Tue Jul 8 23:44:51 2008 UTC vs.
Revision 1.212 by root, Sun Jun 7 16:48:38 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 { ... });
14
15 # one-shot or repeating timers
16 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
18
19 print AnyEvent->now; # prints current event loop time
20 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21
22 # POSIX signal
23 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
24
25 # child process exit
26 my $w = AnyEvent->child (pid => $pid, cb => sub {
27 my ($pid, $status) = @_;
12 ... 28 ...
13 }); 29 });
14 30
15 my $w = AnyEvent->timer (after => $seconds, cb => sub { 31 # called when event loop idle (if applicable)
16 ... 32 my $w = AnyEvent->idle (cb => sub { ... });
17 });
18 33
19 my $w = AnyEvent->condvar; # stores whether a condition was flagged 34 my $w = AnyEvent->condvar; # stores whether a condition was flagged
20 $w->send; # wake up current and all future recv's 35 $w->send; # wake up current and all future recv's
21 $w->recv; # enters "main loop" till $condvar gets ->send 36 $w->recv; # enters "main loop" till $condvar gets ->send
37 # use a condvar in callback mode:
38 $w->cb (sub { $_[0]->recv });
22 39
23=head1 INTRODUCTION/TUTORIAL 40=head1 INTRODUCTION/TUTORIAL
24 41
25This manpage is mainly a reference manual. If you are interested 42This manpage is mainly a reference manual. If you are interested
26in a tutorial or some gentle introduction, have a look at the 43in a tutorial or some gentle introduction, have a look at the
33 50
34Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of 51Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
35policy> and AnyEvent is I<small and efficient>. 52policy> and AnyEvent is I<small and efficient>.
36 53
37First and foremost, I<AnyEvent is not an event model> itself, it only 54First and foremost, I<AnyEvent is not an event model> itself, it only
38interfaces to whatever event model the main program happens to use in a 55interfaces to whatever event model the main program happens to use, in a
39pragmatic way. For event models and certain classes of immortals alike, 56pragmatic way. For event models and certain classes of immortals alike,
40the statement "there can only be one" is a bitter reality: In general, 57the statement "there can only be one" is a bitter reality: In general,
41only one event loop can be active at the same time in a process. AnyEvent 58only one event loop can be active at the same time in a process. AnyEvent
42helps hiding the differences between those event loops. 59cannot change this, but it can hide the differences between those event
60loops.
43 61
44The goal of AnyEvent is to offer module authors the ability to do event 62The goal of AnyEvent is to offer module authors the ability to do event
45programming (waiting for I/O or timer events) without subscribing to a 63programming (waiting for I/O or timer events) without subscribing to a
46religion, a way of living, and most importantly: without forcing your 64religion, a way of living, and most importantly: without forcing your
47module users into the same thing by forcing them to use the same event 65module users into the same thing by forcing them to use the same event
48model you use. 66model you use.
49 67
50For modules like POE or IO::Async (which is a total misnomer as it is 68For modules like POE or IO::Async (which is a total misnomer as it is
51actually doing all I/O I<synchronously>...), using them in your module is 69actually doing all I/O I<synchronously>...), using them in your module is
52like joining a cult: After you joined, you are dependent on them and you 70like joining a cult: After you joined, you are dependent on them and you
53cannot use anything else, as it is simply incompatible to everything that 71cannot use anything else, as they are simply incompatible to everything
54isn't itself. What's worse, all the potential users of your module are 72that isn't them. What's worse, all the potential users of your
55I<also> forced to use the same event loop you use. 73module are I<also> forced to use the same event loop you use.
56 74
57AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 75AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
58fine. AnyEvent + Tk works fine etc. etc. but none of these work together 76fine. AnyEvent + Tk works fine etc. etc. but none of these work together
59with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if 77with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
60your module uses one of those, every user of your module has to use it, 78your module uses one of those, every user of your module has to use it,
61too. But if your module uses AnyEvent, it works transparently with all 79too. But if your module uses AnyEvent, it works transparently with all
62event models it supports (including stuff like POE and IO::Async, as long 80event models it supports (including stuff like IO::Async, as long as those
63as those use one of the supported event loops. It is trivial to add new 81use one of the supported event loops. It is trivial to add new event loops
64event loops to AnyEvent, too, so it is future-proof). 82to AnyEvent, too, so it is future-proof).
65 83
66In addition to being free of having to use I<the one and only true event 84In addition to being free of having to use I<the one and only true event
67model>, AnyEvent also is free of bloat and policy: with POE or similar 85model>, AnyEvent also is free of bloat and policy: with POE or similar
68modules, you get an enormous amount of code and strict rules you have to 86modules, you get an enormous amount of code and strict rules you have to
69follow. AnyEvent, on the other hand, is lean and up to the point, by only 87follow. AnyEvent, on the other hand, is lean and up to the point, by only
127These watchers are normal Perl objects with normal Perl lifetime. After 145These watchers are normal Perl objects with normal Perl lifetime. After
128creating a watcher it will immediately "watch" for events and invoke the 146creating a watcher it will immediately "watch" for events and invoke the
129callback when the event occurs (of course, only when the event model 147callback when the event occurs (of course, only when the event model
130is in control). 148is in control).
131 149
150Note that B<callbacks must not permanently change global variables>
151potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
152callbacks must not C<die> >>. The former is good programming practise in
153Perl and the latter stems from the fact that exception handling differs
154widely between event loops.
155
132To disable the watcher you have to destroy it (e.g. by setting the 156To disable the watcher you have to destroy it (e.g. by setting the
133variable you store it in to C<undef> or otherwise deleting all references 157variable you store it in to C<undef> or otherwise deleting all references
134to it). 158to it).
135 159
136All watchers are created by calling a method on the C<AnyEvent> class. 160All watchers are created by calling a method on the C<AnyEvent> class.
152=head2 I/O WATCHERS 176=head2 I/O WATCHERS
153 177
154You 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
155with the following mandatory key-value pairs as arguments: 179with the following mandatory key-value pairs as arguments:
156 180
157C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events 181C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch
158(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
159must 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
160waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the 189watcher waiting for "r"eadable or "w"ritable events, respectively.
190
161callback to invoke each time the file handle becomes ready. 191C<cb> is the callback to invoke each time the file handle becomes ready.
162 192
163Although the callback might get passed parameters, their value and 193Although the callback might get passed parameters, their value and
164presence is undefined and you cannot rely on them. Portable AnyEvent 194presence is undefined and you cannot rely on them. Portable AnyEvent
165callbacks cannot use arguments passed to I/O watcher callbacks. 195callbacks cannot use arguments passed to I/O watcher callbacks.
166 196
298In 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
299can 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
300difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 330difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
301account. 331account.
302 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
303=back 348=back
304 349
305=head2 SIGNAL WATCHERS 350=head2 SIGNAL WATCHERS
306 351
307You 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
330=head2 CHILD PROCESS WATCHERS 375=head2 CHILD PROCESS WATCHERS
331 376
332You can also watch on a child process exit and catch its exit status. 377You can also watch on a child process exit and catch its exit status.
333 378
334The child process is specified by the C<pid> argument (if set to C<0>, it 379The child process is specified by the C<pid> argument (if set to C<0>, it
335watches for any child process exit). The watcher will trigger as often 380watches for any child process exit). The watcher will triggered only when
336as status change for the child are received. This works by installing a 381the child process has finished and an exit status is available, not on
337signal handler for C<SIGCHLD>. The callback will be called with the pid 382any trace events (stopped/continued).
338and exit status (as returned by waitpid), so unlike other watcher types, 383
339you I<can> rely on child watcher callback arguments. 384The callback will be called with the pid and exit status (as returned by
385waitpid), so unlike other watcher types, you I<can> rely on child watcher
386callback arguments.
387
388This watcher type works by installing a signal handler for C<SIGCHLD>,
389and since it cannot be shared, nothing else should use SIGCHLD or reap
390random child processes (waiting for specific child processes, e.g. inside
391C<system>, is just fine).
340 392
341There 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
342I<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
343have exited already (and no SIGCHLD will be sent anymore). 395have exited already (and no SIGCHLD will be sent anymore).
344 396
366 ); 418 );
367 419
368 # do something else, then wait for process exit 420 # do something else, then wait for process exit
369 $done->recv; 421 $done->recv;
370 422
423=head2 IDLE WATCHERS
424
425Sometimes there is a need to do something, but it is not so important
426to do it instantly, but only when there is nothing better to do. This
427"nothing better to do" is usually defined to be "no other events need
428attention by the event loop".
429
430Idle watchers ideally get invoked when the event loop has nothing
431better to do, just before it would block the process to wait for new
432events. Instead of blocking, the idle watcher is invoked.
433
434Most event loops unfortunately do not really support idle watchers (only
435EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
436will simply call the callback "from time to time".
437
438Example: read lines from STDIN, but only process them when the
439program is otherwise idle:
440
441 my @lines; # read data
442 my $idle_w;
443 my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
444 push @lines, scalar <STDIN>;
445
446 # start an idle watcher, if not already done
447 $idle_w ||= AnyEvent->idle (cb => sub {
448 # handle only one line, when there are lines left
449 if (my $line = shift @lines) {
450 print "handled when idle: $line";
451 } else {
452 # otherwise disable the idle watcher again
453 undef $idle_w;
454 }
455 });
456 });
457
371=head2 CONDITION VARIABLES 458=head2 CONDITION VARIABLES
372 459
373If you are familiar with some event loops you will know that all of them 460If you are familiar with some event loops you will know that all of them
374require you to run some blocking "loop", "run" or similar function that 461require you to run some blocking "loop", "run" or similar function that
375will actively watch for new events and call your callbacks. 462will actively watch for new events and call your callbacks.
380The instrument to do that is called a "condition variable", so called 467The instrument to do that is called a "condition variable", so called
381because they represent a condition that must become true. 468because they represent a condition that must become true.
382 469
383Condition variables can be created by calling the C<< AnyEvent->condvar 470Condition variables can be created by calling the C<< AnyEvent->condvar
384>> method, usually without arguments. The only argument pair allowed is 471>> method, usually without arguments. The only argument pair allowed is
472
385C<cb>, which specifies a callback to be called when the condition variable 473C<cb>, which specifies a callback to be called when the condition variable
386becomes true. 474becomes true, with the condition variable as the first argument (but not
475the results).
387 476
388After creation, the condition variable is "false" until it becomes "true" 477After creation, the condition variable is "false" until it becomes "true"
389by calling the C<send> method (or calling the condition variable as if it 478by calling the C<send> method (or calling the condition variable as if it
390were a callback, read about the caveats in the description for the C<< 479were a callback, read about the caveats in the description for the C<<
391->send >> method). 480->send >> method).
447 536
448 my $done = AnyEvent->condvar; 537 my $done = AnyEvent->condvar;
449 my $delay = AnyEvent->timer (after => 5, cb => $done); 538 my $delay = AnyEvent->timer (after => 5, cb => $done);
450 $done->recv; 539 $done->recv;
451 540
541Example: Imagine an API that returns a condvar and doesn't support
542callbacks. This is how you make a synchronous call, for example from
543the main program:
544
545 use AnyEvent::CouchDB;
546
547 ...
548
549 my @info = $couchdb->info->recv;
550
551And this is how you would just ste a callback to be called whenever the
552results are available:
553
554 $couchdb->info->cb (sub {
555 my @info = $_[0]->recv;
556 });
557
452=head3 METHODS FOR PRODUCERS 558=head3 METHODS FOR PRODUCERS
453 559
454These methods should only be used by the producing side, i.e. the 560These methods should only be used by the producing side, i.e. the
455code/module that eventually sends the signal. Note that it is also 561code/module that eventually sends the signal. Note that it is also
456the producer side which creates the condvar in most cases, but it isn't 562the producer side which creates the condvar in most cases, but it isn't
589=item $bool = $cv->ready 695=item $bool = $cv->ready
590 696
591Returns true when the condition is "true", i.e. whether C<send> or 697Returns true when the condition is "true", i.e. whether C<send> or
592C<croak> have been called. 698C<croak> have been called.
593 699
594=item $cb = $cv->cb ([new callback]) 700=item $cb = $cv->cb ($cb->($cv))
595 701
596This is a mutator function that returns the callback set and optionally 702This is a mutator function that returns the callback set and optionally
597replaces it before doing so. 703replaces it before doing so.
598 704
599The callback will be called when the condition becomes "true", i.e. when 705The callback will be called when the condition becomes "true", i.e. when
789=item L<AnyEvent::IGS> 895=item L<AnyEvent::IGS>
790 896
791A non-blocking interface to the Internet Go Server protocol (used by 897A non-blocking interface to the Internet Go Server protocol (used by
792L<App::IGS>). 898L<App::IGS>).
793 899
794=item L<Net::IRC3> 900=item L<AnyEvent::IRC>
795 901
796AnyEvent based IRC client module family. 902AnyEvent based IRC client module family (replacing the older Net::IRC3).
797 903
798=item L<Net::XMPP2> 904=item L<Net::XMPP2>
799 905
800AnyEvent based XMPP (Jabber protocol) module family. 906AnyEvent based XMPP (Jabber protocol) module family.
801 907
821=cut 927=cut
822 928
823package AnyEvent; 929package AnyEvent;
824 930
825no warnings; 931no warnings;
826use strict; 932use strict qw(vars subs);
827 933
828use Carp; 934use Carp;
829 935
830our $VERSION = 4.2; 936our $VERSION = 4.411;
831our $MODEL; 937our $MODEL;
832 938
833our $AUTOLOAD; 939our $AUTOLOAD;
834our @ISA; 940our @ISA;
835 941
867 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 973 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
868 [Wx:: => AnyEvent::Impl::POE::], 974 [Wx:: => AnyEvent::Impl::POE::],
869 [Prima:: => AnyEvent::Impl::POE::], 975 [Prima:: => AnyEvent::Impl::POE::],
870); 976);
871 977
872our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 978our %method = map +($_ => 1),
979 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
873 980
874our @post_detect; 981our @post_detect;
875 982
876sub post_detect(&) { 983sub post_detect(&) {
877 my ($cb) = @_; 984 my ($cb) = @_;
882 1 989 1
883 } else { 990 } else {
884 push @post_detect, $cb; 991 push @post_detect, $cb;
885 992
886 defined wantarray 993 defined wantarray
887 ? bless \$cb, "AnyEvent::Util::PostDetect" 994 ? bless \$cb, "AnyEvent::Util::postdetect"
888 : () 995 : ()
889 } 996 }
890} 997}
891 998
892sub AnyEvent::Util::PostDetect::DESTROY { 999sub AnyEvent::Util::postdetect::DESTROY {
893 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1000 @post_detect = grep $_ != ${$_[0]}, @post_detect;
894} 1001}
895 1002
896sub detect() { 1003sub detect() {
897 unless ($MODEL) { 1004 unless ($MODEL) {
934 last; 1041 last;
935 } 1042 }
936 } 1043 }
937 1044
938 $MODEL 1045 $MODEL
939 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1046 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
940 } 1047 }
941 } 1048 }
942 1049
943 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1050 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
944 1051
945 if ($ENV{PERL_ANYEVENT_STRICT}) {
946 unshift @AnyEvent::Base::Strict::ISA, $MODEL;
947 unshift @ISA, AnyEvent::Base::Strict::
948 } else {
949 unshift @ISA, $MODEL; 1052 unshift @ISA, $MODEL;
950 } 1053
1054 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
951 1055
952 (shift @post_detect)->() while @post_detect; 1056 (shift @post_detect)->() while @post_detect;
953 } 1057 }
954 1058
955 $MODEL 1059 $MODEL
965 1069
966 my $class = shift; 1070 my $class = shift;
967 $class->$func (@_); 1071 $class->$func (@_);
968} 1072}
969 1073
1074# utility function to dup a filehandle. this is used by many backends
1075# to support binding more than one watcher per filehandle (they usually
1076# allow only one watcher per fd, so we dup it to get a different one).
1077sub _dupfh($$$$) {
1078 my ($poll, $fh, $r, $w) = @_;
1079
1080 # cygwin requires the fh mode to be matching, unix doesn't
1081 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1082 : $poll eq "w" ? ($w, ">")
1083 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1084
1085 open my $fh2, "$mode&" . fileno $fh
1086 or die "cannot dup() filehandle: $!,";
1087
1088 # we assume CLOEXEC is already set by perl in all important cases
1089
1090 ($fh2, $rw)
1091}
1092
970package AnyEvent::Base; 1093package AnyEvent::Base;
971 1094
972# default implementation for now and time 1095# default implementations for many methods
973 1096
974use Time::HiRes (); 1097BEGIN {
1098 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1099 *_time = \&Time::HiRes::time;
1100 # if (eval "use POSIX (); (POSIX::times())...
1101 } else {
1102 *_time = sub { time }; # epic fail
1103 }
1104}
975 1105
976sub time { Time::HiRes::time } 1106sub time { _time }
977sub now { Time::HiRes::time } 1107sub now { _time }
1108sub now_update { }
978 1109
979# default implementation for ->condvar 1110# default implementation for ->condvar
980 1111
981sub condvar { 1112sub condvar {
982 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1113 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
983} 1114}
984 1115
985# default implementation for ->signal 1116# default implementation for ->signal
986 1117
987our %SIG_CB; 1118our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1119
1120sub _signal_exec {
1121 sysread $SIGPIPE_R, my $dummy, 4;
1122
1123 while (%SIG_EV) {
1124 for (keys %SIG_EV) {
1125 delete $SIG_EV{$_};
1126 $_->() for values %{ $SIG_CB{$_} || {} };
1127 }
1128 }
1129}
988 1130
989sub signal { 1131sub signal {
990 my (undef, %arg) = @_; 1132 my (undef, %arg) = @_;
991 1133
1134 unless ($SIGPIPE_R) {
1135 require Fcntl;
1136
1137 if (AnyEvent::WIN32) {
1138 require AnyEvent::Util;
1139
1140 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1141 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1142 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1143 } else {
1144 pipe $SIGPIPE_R, $SIGPIPE_W;
1145 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1146 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1147
1148 # not strictly required, as $^F is normally 2, but let's make sure...
1149 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1150 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1151 }
1152
1153 $SIGPIPE_R
1154 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1155
1156 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1157 }
1158
992 my $signal = uc $arg{signal} 1159 my $signal = uc $arg{signal}
993 or Carp::croak "required option 'signal' is missing"; 1160 or Carp::croak "required option 'signal' is missing";
994 1161
995 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1162 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
996 $SIG{$signal} ||= sub { 1163 $SIG{$signal} ||= sub {
997 $_->() for values %{ $SIG_CB{$signal} || {} }; 1164 local $!;
1165 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1166 undef $SIG_EV{$signal};
998 }; 1167 };
999 1168
1000 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1169 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1001} 1170}
1002 1171
1003sub AnyEvent::Base::Signal::DESTROY { 1172sub AnyEvent::Base::signal::DESTROY {
1004 my ($signal, $cb) = @{$_[0]}; 1173 my ($signal, $cb) = @{$_[0]};
1005 1174
1006 delete $SIG_CB{$signal}{$cb}; 1175 delete $SIG_CB{$signal}{$cb};
1007 1176
1177 # delete doesn't work with older perls - they then
1178 # print weird messages, or just unconditionally exit
1179 # instead of getting the default action.
1008 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1180 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1009} 1181}
1010 1182
1011# default implementation for ->child 1183# default implementation for ->child
1012 1184
1013our %PID_CB; 1185our %PID_CB;
1014our $CHLD_W; 1186our $CHLD_W;
1015our $CHLD_DELAY_W; 1187our $CHLD_DELAY_W;
1016our $PID_IDLE;
1017our $WNOHANG; 1188our $WNOHANG;
1018 1189
1019sub _child_wait { 1190sub _sigchld {
1020 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1191 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1021 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1192 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1022 (values %{ $PID_CB{0} || {} }); 1193 (values %{ $PID_CB{0} || {} });
1023 } 1194 }
1024
1025 undef $PID_IDLE;
1026}
1027
1028sub _sigchld {
1029 # make sure we deliver these changes "synchronous" with the event loop.
1030 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1031 undef $CHLD_DELAY_W;
1032 &_child_wait;
1033 });
1034} 1195}
1035 1196
1036sub child { 1197sub child {
1037 my (undef, %arg) = @_; 1198 my (undef, %arg) = @_;
1038 1199
1039 defined (my $pid = $arg{pid} + 0) 1200 defined (my $pid = $arg{pid} + 0)
1040 or Carp::croak "required option 'pid' is missing"; 1201 or Carp::croak "required option 'pid' is missing";
1041 1202
1042 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1203 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1043 1204
1044 unless ($WNOHANG) {
1045 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1205 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1046 }
1047 1206
1048 unless ($CHLD_W) { 1207 unless ($CHLD_W) {
1049 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1208 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1050 # child could be a zombie already, so make at least one round 1209 # child could be a zombie already, so make at least one round
1051 &_sigchld; 1210 &_sigchld;
1052 } 1211 }
1053 1212
1054 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1213 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1055} 1214}
1056 1215
1057sub AnyEvent::Base::Child::DESTROY { 1216sub AnyEvent::Base::child::DESTROY {
1058 my ($pid, $cb) = @{$_[0]}; 1217 my ($pid, $cb) = @{$_[0]};
1059 1218
1060 delete $PID_CB{$pid}{$cb}; 1219 delete $PID_CB{$pid}{$cb};
1061 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1220 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1062 1221
1063 undef $CHLD_W unless keys %PID_CB; 1222 undef $CHLD_W unless keys %PID_CB;
1223}
1224
1225# idle emulation is done by simply using a timer, regardless
1226# of whether the process is idle or not, and not letting
1227# the callback use more than 50% of the time.
1228sub idle {
1229 my (undef, %arg) = @_;
1230
1231 my ($cb, $w, $rcb) = $arg{cb};
1232
1233 $rcb = sub {
1234 if ($cb) {
1235 $w = _time;
1236 &$cb;
1237 $w = _time - $w;
1238
1239 # never use more then 50% of the time for the idle watcher,
1240 # within some limits
1241 $w = 0.0001 if $w < 0.0001;
1242 $w = 5 if $w > 5;
1243
1244 $w = AnyEvent->timer (after => $w, cb => $rcb);
1245 } else {
1246 # clean up...
1247 undef $w;
1248 undef $rcb;
1249 }
1250 };
1251
1252 $w = AnyEvent->timer (after => 0.05, cb => $rcb);
1253
1254 bless \\$cb, "AnyEvent::Base::idle"
1255}
1256
1257sub AnyEvent::Base::idle::DESTROY {
1258 undef $${$_[0]};
1064} 1259}
1065 1260
1066package AnyEvent::CondVar; 1261package AnyEvent::CondVar;
1067 1262
1068our @ISA = AnyEvent::CondVar::Base::; 1263our @ISA = AnyEvent::CondVar::Base::;
1121 1316
1122# undocumented/compatibility with pre-3.4 1317# undocumented/compatibility with pre-3.4
1123*broadcast = \&send; 1318*broadcast = \&send;
1124*wait = \&_wait; 1319*wait = \&_wait;
1125 1320
1126package AnyEvent::Base::Strict; 1321=head1 ERROR AND EXCEPTION HANDLING
1127 1322
1128use Carp qw(croak); 1323In general, AnyEvent does not do any error handling - it relies on the
1324caller to do that if required. The L<AnyEvent::Strict> module (see also
1325the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1326checking of all AnyEvent methods, however, which is highly useful during
1327development.
1129 1328
1130# supply checks for argument validity for many functions 1329As for exception handling (i.e. runtime errors and exceptions thrown while
1330executing a callback), this is not only highly event-loop specific, but
1331also not in any way wrapped by this module, as this is the job of the main
1332program.
1131 1333
1132sub io { 1334The pure perl event loop simply re-throws the exception (usually
1133 my $class = shift; 1335within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1134 my %arg = @_; 1336$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1337so on.
1135 1338
1136 ref $arg{cb} 1339=head1 ENVIRONMENT VARIABLES
1137 or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'";
1138 delete $arg{cb};
1139
1140 fileno $arg{fh}
1141 or croak "AnyEvent->io called with illegal fh argument '$arg{fh}'";
1142 delete $arg{fh};
1143
1144 $arg{poll} =~ /^[rw]$/
1145 or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'";
1146 delete $arg{poll};
1147
1148 croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg
1149 if keys %arg;
1150 1340
1151 $class->SUPER::io (@_) 1341The following environment variables are used by this module or its
1152} 1342submodules:
1153 1343
1154sub timer { 1344=over 4
1155 my $class = shift;
1156 my %arg = @_;
1157 1345
1158 ref $arg{cb} 1346=item C<PERL_ANYEVENT_VERBOSE>
1159 or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'";
1160 delete $arg{cb};
1161
1162 exists $arg{after}
1163 or croak "AnyEvent->timer called without mandatory 'after' parameter";
1164 delete $arg{after};
1165
1166 $arg{interval} > 0 || !$arg{interval}
1167 or croak "AnyEvent->timer called with illegal interval argument '$arg{interval}'";
1168 delete $arg{interval};
1169
1170 croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg
1171 if keys %arg;
1172 1347
1173 $class->SUPER::timer (@_) 1348By default, AnyEvent will be completely silent except in fatal
1174} 1349conditions. You can set this environment variable to make AnyEvent more
1350talkative.
1175 1351
1176sub signal { 1352When set to C<1> or higher, causes AnyEvent to warn about unexpected
1177 my $class = shift; 1353conditions, such as not being able to load the event model specified by
1178 my %arg = @_; 1354C<PERL_ANYEVENT_MODEL>.
1179 1355
1180 ref $arg{cb} 1356When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1181 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'"; 1357model it chooses.
1182 delete $arg{cb};
1183
1184 eval "require POSIX; defined &POSIX::SIG$arg{signal}"
1185 or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'";
1186 delete $arg{signal};
1187
1188 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
1189 if keys %arg;
1190 1358
1191 $class->SUPER::signal (@_) 1359=item C<PERL_ANYEVENT_STRICT>
1192}
1193 1360
1194sub child { 1361AnyEvent does not do much argument checking by default, as thorough
1195 my $class = shift; 1362argument checking is very costly. Setting this variable to a true value
1196 my %arg = @_; 1363will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1364check the arguments passed to most method calls. If it finds any problems
1365it will croak.
1197 1366
1198 ref $arg{cb} 1367In other words, enables "strict" mode.
1199 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
1200 delete $arg{cb};
1201
1202 $arg{pid} =~ /^-?\d+$/
1203 or croak "AnyEvent->signal called with illegal pid value '$arg{pid}'";
1204 delete $arg{pid};
1205
1206 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
1207 if keys %arg;
1208 1368
1209 $class->SUPER::child (@_) 1369Unlike C<use strict>, it is definitely recommended ot keep it off in
1210} 1370production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1371developing programs can be very useful, however.
1211 1372
1212sub condvar { 1373=item C<PERL_ANYEVENT_MODEL>
1213 my $class = shift;
1214 my %arg = @_;
1215 1374
1216 !exists $arg{cb} or ref $arg{cb} 1375This can be used to specify the event model to be used by AnyEvent, before
1217 or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'"; 1376auto detection and -probing kicks in. It must be a string consisting
1218 delete $arg{cb}; 1377entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1219 1378and the resulting module name is loaded and if the load was successful,
1220 croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg 1379used as event model. If it fails to load AnyEvent will proceed with
1221 if keys %arg; 1380auto detection and -probing.
1222 1381
1223 $class->SUPER::condvar (@_) 1382This functionality might change in future versions.
1224}
1225 1383
1226sub time { 1384For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1227 my $class = shift; 1385could start your program like this:
1228 1386
1229 @_ 1387 PERL_ANYEVENT_MODEL=Perl perl ...
1230 and croak "AnyEvent->time wrongly called with paramaters";
1231 1388
1232 $class->SUPER::time (@_) 1389=item C<PERL_ANYEVENT_PROTOCOLS>
1233}
1234 1390
1235sub now { 1391Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1236 my $class = shift; 1392for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1393of auto probing).
1237 1394
1238 @_ 1395Must be set to a comma-separated list of protocols or address families,
1239 and croak "AnyEvent->now wrongly called with paramaters"; 1396current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1397used, and preference will be given to protocols mentioned earlier in the
1398list.
1240 1399
1241 $class->SUPER::now (@_) 1400This variable can effectively be used for denial-of-service attacks
1242} 1401against local programs (e.g. when setuid), although the impact is likely
1402small, as the program has to handle conenction and other failures anyways.
1403
1404Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1405but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1406- only support IPv4, never try to resolve or contact IPv6
1407addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1408IPv6, but prefer IPv6 over IPv4.
1409
1410=item C<PERL_ANYEVENT_EDNS0>
1411
1412Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1413for DNS. This extension is generally useful to reduce DNS traffic, but
1414some (broken) firewalls drop such DNS packets, which is why it is off by
1415default.
1416
1417Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1418EDNS0 in its DNS requests.
1419
1420=item C<PERL_ANYEVENT_MAX_FORKS>
1421
1422The maximum number of child processes that C<AnyEvent::Util::fork_call>
1423will create in parallel.
1424
1425=back
1243 1426
1244=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1427=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1245 1428
1246This is an advanced topic that you do not normally need to use AnyEvent in 1429This is an advanced topic that you do not normally need to use AnyEvent in
1247a module. This section is only of use to event loop authors who want to 1430a module. This section is only of use to event loop authors who want to
1281 1464
1282I<rxvt-unicode> also cheats a bit by not providing blocking access to 1465I<rxvt-unicode> also cheats a bit by not providing blocking access to
1283condition variables: code blocking while waiting for a condition will 1466condition variables: code blocking while waiting for a condition will
1284C<die>. This still works with most modules/usages, and blocking calls must 1467C<die>. This still works with most modules/usages, and blocking calls must
1285not be done in an interactive application, so it makes sense. 1468not be done in an interactive application, so it makes sense.
1286
1287=head1 ENVIRONMENT VARIABLES
1288
1289The following environment variables are used by this module:
1290
1291=over 4
1292
1293=item C<PERL_ANYEVENT_VERBOSE>
1294
1295By default, AnyEvent will be completely silent except in fatal
1296conditions. You can set this environment variable to make AnyEvent more
1297talkative.
1298
1299When set to C<1> or higher, causes AnyEvent to warn about unexpected
1300conditions, such as not being able to load the event model specified by
1301C<PERL_ANYEVENT_MODEL>.
1302
1303When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1304model it chooses.
1305
1306=item C<PERL_ANYEVENT_STRICT>
1307
1308AnyEvent does not do much argument checking by default, as thorough
1309argument checking is very costly. Setting this variable to a true value
1310will cause AnyEvent to thoroughly check the arguments passed to most
1311method calls and croaks if it finds any problems. In other words, enables
1312"strict" mode. Unlike C<use strict> it is definitely recommended ot keep
1313it off in production.
1314
1315=item C<PERL_ANYEVENT_MODEL>
1316
1317This can be used to specify the event model to be used by AnyEvent, before
1318auto detection and -probing kicks in. It must be a string consisting
1319entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1320and the resulting module name is loaded and if the load was successful,
1321used as event model. If it fails to load AnyEvent will proceed with
1322auto detection and -probing.
1323
1324This functionality might change in future versions.
1325
1326For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1327could start your program like this:
1328
1329 PERL_ANYEVENT_MODEL=Perl perl ...
1330
1331=item C<PERL_ANYEVENT_PROTOCOLS>
1332
1333Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1334for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1335of auto probing).
1336
1337Must be set to a comma-separated list of protocols or address families,
1338current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1339used, and preference will be given to protocols mentioned earlier in the
1340list.
1341
1342This variable can effectively be used for denial-of-service attacks
1343against local programs (e.g. when setuid), although the impact is likely
1344small, as the program has to handle connection errors already-
1345
1346Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1347but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1348- only support IPv4, never try to resolve or contact IPv6
1349addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1350IPv6, but prefer IPv6 over IPv4.
1351
1352=item C<PERL_ANYEVENT_EDNS0>
1353
1354Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1355for DNS. This extension is generally useful to reduce DNS traffic, but
1356some (broken) firewalls drop such DNS packets, which is why it is off by
1357default.
1358
1359Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1360EDNS0 in its DNS requests.
1361
1362=item C<PERL_ANYEVENT_MAX_FORKS>
1363
1364The maximum number of child processes that C<AnyEvent::Util::fork_call>
1365will create in parallel.
1366
1367=back
1368 1469
1369=head1 EXAMPLE PROGRAM 1470=head1 EXAMPLE PROGRAM
1370 1471
1371The following program uses an I/O watcher to read data from STDIN, a timer 1472The following program uses an I/O watcher to read data from STDIN, a timer
1372to display a message once per second, and a condition variable to quit the 1473to display a message once per second, and a condition variable to quit the
1566watcher. 1667watcher.
1567 1668
1568=head3 Results 1669=head3 Results
1569 1670
1570 name watchers bytes create invoke destroy comment 1671 name watchers bytes create invoke destroy comment
1571 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 1672 EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1572 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 1673 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1573 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 1674 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1574 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 1675 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1575 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 1676 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1576 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 1677 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1577 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 1678 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1578 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 1679 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1579 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 1680 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1580 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 1681 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1581 1682
1582=head3 Discussion 1683=head3 Discussion
1583 1684
1584The benchmark does I<not> measure scalability of the event loop very 1685The benchmark does I<not> measure scalability of the event loop very
1585well. For example, a select-based event loop (such as the pure perl one) 1686well. For example, a select-based event loop (such as the pure perl one)
1787watchers, as the management overhead dominates. 1888watchers, as the management overhead dominates.
1788 1889
1789=back 1890=back
1790 1891
1791 1892
1893=head1 SIGNALS
1894
1895AnyEvent currently installs handlers for these signals:
1896
1897=over 4
1898
1899=item SIGCHLD
1900
1901A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1902emulation for event loops that do not support them natively. Also, some
1903event loops install a similar handler.
1904
1905=item SIGPIPE
1906
1907A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1908when AnyEvent gets loaded.
1909
1910The rationale for this is that AnyEvent users usually do not really depend
1911on SIGPIPE delivery (which is purely an optimisation for shell use, or
1912badly-written programs), but C<SIGPIPE> can cause spurious and rare
1913program exits as a lot of people do not expect C<SIGPIPE> when writing to
1914some random socket.
1915
1916The rationale for installing a no-op handler as opposed to ignoring it is
1917that this way, the handler will be restored to defaults on exec.
1918
1919Feel free to install your own handler, or reset it to defaults.
1920
1921=back
1922
1923=cut
1924
1925$SIG{PIPE} = sub { }
1926 unless defined $SIG{PIPE};
1927
1928
1792=head1 FORK 1929=head1 FORK
1793 1930
1794Most event libraries are not fork-safe. The ones who are usually are 1931Most event libraries are not fork-safe. The ones who are usually are
1795because they rely on inefficient but fork-safe C<select> or C<poll> 1932because they rely on inefficient but fork-safe C<select> or C<poll>
1796calls. Only L<EV> is fully fork-aware. 1933calls. Only L<EV> is fully fork-aware.
1824=head1 BUGS 1961=head1 BUGS
1825 1962
1826Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 1963Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1827to work around. If you suffer from memleaks, first upgrade to Perl 5.10 1964to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1828and check wether the leaks still show up. (Perl 5.10.0 has other annoying 1965and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1829mamleaks, such as leaking on C<map> and C<grep> but it is usually not as 1966memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1830pronounced). 1967pronounced).
1831 1968
1832 1969
1833=head1 SEE ALSO 1970=head1 SEE ALSO
1834 1971

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines