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.343 by root, Wed Dec 29 04:27:53 2010 UTC vs.
Revision 1.396 by root, Sat Mar 10 17:36:24 2012 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - the DBI of event loop programming 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6and POE are various supported event loops/environments. 6FLTK and POE are various supported event loops/environments.
7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
121The interface itself is vaguely similar, but not identical to the L<Event> 121The interface itself is vaguely similar, but not identical to the L<Event>
122module. 122module.
123 123
124During the first call of any watcher-creation method, the module tries 124During the first call of any watcher-creation method, the module tries
125to detect the currently loaded event loop by probing whether one of the 125to detect the currently loaded event loop by probing whether one of the
126following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>, 126following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one 127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
128found is used. If none are detected, the module tries to load the first 128found is used. If none are detected, the module tries to load the first
129four modules in the order given; but note that if L<EV> is not 129four modules in the order given; but note that if L<EV> is not
130available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so 130available, the pure-perl L<AnyEvent::Loop> should always work, so
131the other two are not normally tried. 131the other two are not normally tried.
132 132
133Because AnyEvent first checks for modules that are already loaded, loading 133Because AnyEvent first checks for modules that are already loaded, loading
134an event model explicitly before first using AnyEvent will likely make 134an event model explicitly before first using AnyEvent will likely make
135that model the default. For example: 135that model the default. For example:
142The I<likely> means that, if any module loads another event model and 142The I<likely> means that, if any module loads another event model and
143starts using it, all bets are off - this case should be very rare though, 143starts using it, all bets are off - this case should be very rare though,
144as very few modules hardcode event loops without announcing this very 144as very few modules hardcode event loops without announcing this very
145loudly. 145loudly.
146 146
147The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
148C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148other event modules you can load it explicitly and enjoy the high
149explicitly and enjoy the high availability of that event loop :) 149availability of that event loop :)
150 150
151=head1 WATCHERS 151=head1 WATCHERS
152 152
153AnyEvent has the central concept of a I<watcher>, which is an object that 153AnyEvent has the central concept of a I<watcher>, which is an object that
154stores relevant data for each kind of event you are waiting for, such as 154stores relevant data for each kind of event you are waiting for, such as
356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
357account. 357account.
358 358
359=item AnyEvent->now_update 359=item AnyEvent->now_update
360 360
361Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache 361Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
362the current time for each loop iteration (see the discussion of L<< 362time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
363AnyEvent->now >>, above). 363above).
364 364
365When a callback runs for a long time (or when the process sleeps), then 365When a callback runs for a long time (or when the process sleeps), then
366this "current" time will differ substantially from the real time, which 366this "current" time will differ substantially from the real time, which
367might affect timers and time-outs. 367might affect timers and time-outs.
368 368
415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's 415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416pure perl implementation). 416pure perl implementation).
417 417
418=head3 Safe/Unsafe Signals 418=head3 Safe/Unsafe Signals
419 419
420Perl signals can be either "safe" (synchronous to opcode handling) or 420Perl signals can be either "safe" (synchronous to opcode handling)
421"unsafe" (asynchronous) - the former might get delayed indefinitely, the 421or "unsafe" (asynchronous) - the former might delay signal delivery
422latter might corrupt your memory. 422indefinitely, the latter might corrupt your memory.
423 423
424AnyEvent signal handlers are, in addition, synchronous to the event loop, 424AnyEvent signal handlers are, in addition, synchronous to the event loop,
425i.e. they will not interrupt your running perl program but will only be 425i.e. they will not interrupt your running perl program but will only be
426called as part of the normal event handling (just like timer, I/O etc. 426called as part of the normal event handling (just like timer, I/O etc.
427callbacks, too). 427callbacks, too).
428 428
429=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
430 430
431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support
432callbacks to signals in a generic way, which is a pity, as you cannot 432attaching callbacks to signals in a generic way, which is a pity,
433do race-free signal handling in perl, requiring C libraries for 433as you cannot do race-free signal handling in perl, requiring
434this. AnyEvent will try to do its best, which means in some cases, 434C libraries for this. AnyEvent will try to do its best, which
435signals will be delayed. The maximum time a signal might be delayed is 435means in some cases, signals will be delayed. The maximum time
436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 436a signal might be delayed is 10 seconds by default, but can
437variable can be changed only before the first signal watcher is created, 437be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or
438and should be left alone otherwise. This variable determines how often 438C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES>
439AnyEvent polls for signals (in case a wake-up was missed). Higher values 439section for details.
440will cause fewer spurious wake-ups, which is better for power and CPU
441saving.
442 440
443All these problems can be avoided by installing the optional 441All these problems can be avoided by installing the optional
444L<Async::Interrupt> module, which works with most event loops. It will not 442L<Async::Interrupt> module, which works with most event loops. It will not
445work with inherently broken event loops such as L<Event> or L<Event::Lib> 443work with inherently broken event loops such as L<Event> or L<Event::Lib>
446(and not with L<POE> currently, as POE does its own workaround with 444(and not with L<POE> currently). For those, you just have to suffer the
447one-second latency). For those, you just have to suffer the delays. 445delays.
448 446
449=head2 CHILD PROCESS WATCHERS 447=head2 CHILD PROCESS WATCHERS
450 448
451 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 449 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
452 450
482thing in an AnyEvent program, you I<have> to create at least one 480thing in an AnyEvent program, you I<have> to create at least one
483watcher before you C<fork> the child (alternatively, you can call 481watcher before you C<fork> the child (alternatively, you can call
484C<AnyEvent::detect>). 482C<AnyEvent::detect>).
485 483
486As most event loops do not support waiting for child events, they will be 484As most event loops do not support waiting for child events, they will be
487emulated by AnyEvent in most cases, in which the latency and race problems 485emulated by AnyEvent in most cases, in which case the latency and race
488mentioned in the description of signal watchers apply. 486problems mentioned in the description of signal watchers apply.
489 487
490Example: fork a process and wait for it 488Example: fork a process and wait for it
491 489
492 my $done = AnyEvent->condvar; 490 my $done = AnyEvent->condvar;
493 491
860use. If EV is not installed, then AnyEvent will fall back to its own 858use. If EV is not installed, then AnyEvent will fall back to its own
861pure-perl implementation, which is available everywhere as it comes with 859pure-perl implementation, which is available everywhere as it comes with
862AnyEvent itself. 860AnyEvent itself.
863 861
864 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 862 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 863 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866 864
867=item Backends that are transparently being picked up when they are used. 865=item Backends that are transparently being picked up when they are used.
868 866
869These will be used if they are already loaded when the first watcher 867These will be used if they are already loaded when the first watcher
870is created, in which case it is assumed that the application is using 868is created, in which case it is assumed that the application is using
877 AnyEvent::Impl::Tk based on Tk, very broken. 875 AnyEvent::Impl::Tk based on Tk, very broken.
878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 876 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879 AnyEvent::Impl::POE based on POE, very slow, some limitations. 877 AnyEvent::Impl::POE based on POE, very slow, some limitations.
880 AnyEvent::Impl::Irssi used when running within irssi. 878 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async. 879 AnyEvent::Impl::IOAsync based on IO::Async.
880 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
881 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
882 882
883=item Backends with special needs. 883=item Backends with special needs.
884 884
885Qt requires the Qt::Application to be instantiated first, but will 885Qt requires the Qt::Application to be instantiated first, but will
886otherwise be picked up automatically. As long as the main program 886otherwise be picked up automatically. As long as the main program
931 931
932Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 932Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
933if necessary. You should only call this function right before you would 933if necessary. You should only call this function right before you would
934have created an AnyEvent watcher anyway, that is, as late as possible at 934have created an AnyEvent watcher anyway, that is, as late as possible at
935runtime, and not e.g. during initialisation of your module. 935runtime, and not e.g. during initialisation of your module.
936
937The effect of calling this function is as if a watcher had been created
938(specifically, actions that happen "when the first watcher is created"
939happen when calling detetc as well).
936 940
937If you need to do some initialisation before AnyEvent watchers are 941If you need to do some initialisation before AnyEvent watchers are
938created, use C<post_detect>. 942created, use C<post_detect>.
939 943
940=item $guard = AnyEvent::post_detect { BLOCK } 944=item $guard = AnyEvent::post_detect { BLOCK }
1003 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1007 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1004 # as soon as it is 1008 # as soon as it is
1005 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1009 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1006 } 1010 }
1007 1011
1012=item AnyEvent::postpone { BLOCK }
1013
1014Arranges for the block to be executed as soon as possible, but not before
1015the call itself returns. In practise, the block will be executed just
1016before the event loop polls for new events, or shortly afterwards.
1017
1018This function never returns anything (to make the C<return postpone { ...
1019}> idiom more useful.
1020
1021To understand the usefulness of this function, consider a function that
1022asynchronously does something for you and returns some transaction
1023object or guard to let you cancel the operation. For example,
1024C<AnyEvent::Socket::tcp_connect>:
1025
1026 # start a conenction attempt unless one is active
1027 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
1028 delete $self->{connect_guard};
1029 ...
1030 };
1031
1032Imagine that this function could instantly call the callback, for
1033example, because it detects an obvious error such as a negative port
1034number. Invoking the callback before the function returns causes problems
1035however: the callback will be called and will try to delete the guard
1036object. But since the function hasn't returned yet, there is nothing to
1037delete. When the function eventually returns it will assign the guard
1038object to C<< $self->{connect_guard} >>, where it will likely never be
1039deleted, so the program thinks it is still trying to connect.
1040
1041This is where C<AnyEvent::postpone> should be used. Instead of calling the
1042callback directly on error:
1043
1044 $cb->(undef), return # signal error to callback, BAD!
1045 if $some_error_condition;
1046
1047It should use C<postpone>:
1048
1049 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1050 if $some_error_condition;
1051
1052=item AnyEvent::log $level, $msg[, @args]
1053
1054Log the given C<$msg> at the given C<$level>.
1055
1056If L<AnyEvent::Log> is not loaded then this function makes a simple test
1057to see whether the message will be logged. If the test succeeds it will
1058load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1059the L<AnyEvent::Log> documentation for details.
1060
1061If the test fails it will simply return. Right now this happens when a
1062numerical loglevel is used and it is larger than the level specified via
1063C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1064
1065If you want to sprinkle loads of logging calls around your code, consider
1066creating a logger callback with the C<AnyEvent::Log::logger> function,
1067which can reduce typing, codesize and can reduce the logging overhead
1068enourmously.
1069
1008=back 1070=back
1009 1071
1010=head1 WHAT TO DO IN A MODULE 1072=head1 WHAT TO DO IN A MODULE
1011 1073
1012As a module author, you should C<use AnyEvent> and call AnyEvent methods 1074As a module author, you should C<use AnyEvent> and call AnyEvent methods
1045modules might create watchers when they are loaded, and AnyEvent will 1107modules might create watchers when they are loaded, and AnyEvent will
1046decide on the event model to use as soon as it creates watchers, and it 1108decide on the event model to use as soon as it creates watchers, and it
1047might choose the wrong one unless you load the correct one yourself. 1109might choose the wrong one unless you load the correct one yourself.
1048 1110
1049You can chose to use a pure-perl implementation by loading the 1111You can chose to use a pure-perl implementation by loading the
1050C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1112C<AnyEvent::Loop> module, which gives you similar behaviour
1051everywhere, but letting AnyEvent chose the model is generally better. 1113everywhere, but letting AnyEvent chose the model is generally better.
1052 1114
1053=head2 MAINLOOP EMULATION 1115=head2 MAINLOOP EMULATION
1054 1116
1055Sometimes (often for short test scripts, or even standalone programs who 1117Sometimes (often for short test scripts, or even standalone programs who
1068 1130
1069 1131
1070=head1 OTHER MODULES 1132=head1 OTHER MODULES
1071 1133
1072The following is a non-exhaustive list of additional modules that use 1134The following is a non-exhaustive list of additional modules that use
1073AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1135AnyEvent as a client and can therefore be mixed easily with other
1074modules and other event loops in the same program. Some of the modules 1136AnyEvent modules and other event loops in the same program. Some of the
1075come as part of AnyEvent, the others are available via CPAN. 1137modules come as part of AnyEvent, the others are available via CPAN (see
1138L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
1139a longer non-exhaustive list), and the list is heavily biased towards
1140modules of the AnyEvent author himself :)
1076 1141
1077=over 4 1142=over 4
1078 1143
1079=item L<AnyEvent::Util> 1144=item L<AnyEvent::Util>
1080 1145
1100=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> 1165=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1101 1166
1102Implement event-based interfaces to the protocols of the same name (for 1167Implement event-based interfaces to the protocols of the same name (for
1103the curious, IGS is the International Go Server and FCP is the Freenet 1168the curious, IGS is the International Go Server and FCP is the Freenet
1104Client Protocol). 1169Client Protocol).
1105
1106=item L<AnyEvent::Handle::UDP>
1107
1108Here be danger!
1109
1110As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1111there are so many things wrong with AnyEvent::Handle::UDP, most notably
1112its use of a stream-based API with a protocol that isn't streamable, that
1113the only way to improve it is to delete it.
1114
1115It features data corruption (but typically only under load) and general
1116confusion. On top, the author is not only clueless about UDP but also
1117fact-resistant - some gems of his understanding: "connect doesn't work
1118with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1119packets", "I don't need to implement proper error checking as UDP doesn't
1120support error checking" and so on - he doesn't even understand what's
1121wrong with his module when it is explained to him.
1122
1123=item L<AnyEvent::DBI>
1124
1125Executes L<DBI> requests asynchronously in a proxy process for you,
1126notifying you in an event-based way when the operation is finished.
1127 1170
1128=item L<AnyEvent::AIO> 1171=item L<AnyEvent::AIO>
1129 1172
1130Truly asynchronous (as opposed to non-blocking) I/O, should be in the 1173Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1131toolbox of every event programmer. AnyEvent::AIO transparently fuses 1174toolbox of every event programmer. AnyEvent::AIO transparently fuses
1132L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1175L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1133file I/O, and much more. 1176file I/O, and much more.
1134 1177
1178=item L<AnyEvent::Filesys::Notify>
1179
1180AnyEvent is good for non-blocking stuff, but it can't detect file or
1181path changes (e.g. "watch this directory for new files", "watch this
1182file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
1183do just that in a portbale fashion, supporting inotify on GNU/Linux and
1184some weird, without doubt broken, stuff on OS X to monitor files. It can
1185fall back to blocking scans at regular intervals transparently on other
1186platforms, so it's about as portable as it gets.
1187
1188(I haven't used it myself, but I haven't heard anybody complaining about
1189it yet).
1190
1191=item L<AnyEvent::DBI>
1192
1193Executes L<DBI> requests asynchronously in a proxy process for you,
1194notifying you in an event-based way when the operation is finished.
1195
1135=item L<AnyEvent::HTTPD> 1196=item L<AnyEvent::HTTPD>
1136 1197
1137A simple embedded webserver. 1198A simple embedded webserver.
1138 1199
1139=item L<AnyEvent::FastPing> 1200=item L<AnyEvent::FastPing>
1140 1201
1141The fastest ping in the west. 1202The fastest ping in the west.
1142 1203
1143=item L<Coro> 1204=item L<Coro>
1144 1205
1145Has special support for AnyEvent via L<Coro::AnyEvent>. 1206Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
1207to simply invert the flow control - don't call us, we will call you:
1208
1209 async {
1210 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
1211 print "5 seconds later!\n";
1212
1213 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1214 my $line = <STDIN>; # works for ttys
1215
1216 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1217 my ($body, $hdr) = Coro::rouse_wait;
1218 };
1146 1219
1147=back 1220=back
1148 1221
1149=cut 1222=cut
1150 1223
1151package AnyEvent; 1224package AnyEvent;
1152 1225
1153# basically a tuned-down version of common::sense 1226# basically a tuned-down version of common::sense
1154sub common_sense { 1227sub common_sense {
1155 # from common:.sense 3.3 1228 # from common:.sense 3.4
1156 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00"; 1229 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1157 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) 1230 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1158 $^H |= 0x00000600; 1231 $^H |= 0x00000600;
1159} 1232}
1160 1233
1161BEGIN { AnyEvent::common_sense } 1234BEGIN { AnyEvent::common_sense }
1162 1235
1163use Carp (); 1236use Carp ();
1164 1237
1165our $VERSION = '5.29'; 1238our $VERSION = '6.14';
1166our $MODEL; 1239our $MODEL;
1167
1168our $AUTOLOAD;
1169our @ISA; 1240our @ISA;
1170
1171our @REGISTRY; 1241our @REGISTRY;
1172
1173our $VERBOSE; 1242our $VERBOSE;
1243our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1244our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!)
1174 1245
1175BEGIN { 1246BEGIN {
1176 require "AnyEvent/constants.pl"; 1247 require "AnyEvent/constants.pl";
1177 1248
1178 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1249 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1179 1250
1180 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1251 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1181 if ${^TAINT}; 1252 if ${^TAINT};
1182 1253
1183 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1254 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1255 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1184 1256
1185} 1257 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1258 if ${^TAINT};
1186 1259
1187our $MAX_SIGNAL_LATENCY = 10; 1260 # $ENV{PERL_ANYEVENT_xxx} now valid
1188 1261
1189our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1262 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1190 1263
1191{
1192 my $idx; 1264 my $idx;
1193 $PROTOCOL{$_} = ++$idx 1265 $PROTOCOL{$_} = ++$idx
1194 for reverse split /\s*,\s*/, 1266 for reverse split /\s*,\s*/,
1195 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1267 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1196} 1268}
1197 1269
1270our @post_detect;
1271
1272sub post_detect(&) {
1273 my ($cb) = @_;
1274
1275 push @post_detect, $cb;
1276
1277 defined wantarray
1278 ? bless \$cb, "AnyEvent::Util::postdetect"
1279 : ()
1280}
1281
1282sub AnyEvent::Util::postdetect::DESTROY {
1283 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1284}
1285
1286our $POSTPONE_W;
1287our @POSTPONE;
1288
1289sub _postpone_exec {
1290 undef $POSTPONE_W;
1291
1292 &{ shift @POSTPONE }
1293 while @POSTPONE;
1294}
1295
1296sub postpone(&) {
1297 push @POSTPONE, shift;
1298
1299 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1300
1301 ()
1302}
1303
1304sub log($$;@) {
1305 # only load the big bloated module when we actually are about to log something
1306 if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
1307 local ($!, $@);
1308 require AnyEvent::Log; # among other things, sets $VERBOSE to 9
1309 # AnyEvent::Log overwrites this function
1310 goto &log;
1311 }
1312
1313 0 # not logged
1314}
1315
1316sub _logger($;$) {
1317 my ($level, $renabled) = @_;
1318
1319 $$renabled = $level <= $VERBOSE;
1320
1321 my $logger = [(caller)[0], $level, $renabled];
1322
1323 $AnyEvent::Log::LOGGER{$logger+0} = $logger;
1324
1325# return unless defined wantarray;
1326#
1327# require AnyEvent::Util;
1328# my $guard = AnyEvent::Util::guard (sub {
1329# # "clean up"
1330# delete $LOGGER{$logger+0};
1331# });
1332#
1333# sub {
1334# return 0 unless $$renabled;
1335#
1336# $guard if 0; # keep guard alive, but don't cause runtime overhead
1337# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
1338# package AnyEvent::Log;
1339# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
1340# }
1341}
1342
1343if (length $ENV{PERL_ANYEVENT_LOG}) {
1344 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1345}
1346
1198my @models = ( 1347our @models = (
1199 [EV:: => AnyEvent::Impl::EV:: , 1], 1348 [EV:: => AnyEvent::Impl::EV::],
1200 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1349 [AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1201 # everything below here will not (normally) be autoprobed 1350 # everything below here will not (normally) be autoprobed
1202 # as the pureperl backend should work everywhere 1351 # as the pure perl backend should work everywhere
1203 # and is usually faster 1352 # and is usually faster
1353 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1204 [Event:: => AnyEvent::Impl::Event::, 1], 1354 [Event:: => AnyEvent::Impl::Event::], # slow, stable
1205 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1355 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1356 # everything below here should not be autoloaded
1206 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1357 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1207 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1208 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1358 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1209 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1359 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1210 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1360 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1211 [Wx:: => AnyEvent::Impl::POE::], 1361 [Wx:: => AnyEvent::Impl::POE::],
1212 [Prima:: => AnyEvent::Impl::POE::], 1362 [Prima:: => AnyEvent::Impl::POE::],
1213 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1363 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1364 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1365 [FLTK:: => AnyEvent::Impl::FLTK::],
1214); 1366);
1215 1367
1216our %method = map +($_ => 1), 1368our @isa_hook;
1369
1370sub _isa_set {
1371 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1372
1373 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1374 for 1 .. $#pkg;
1375
1376 grep $_ && $_->[1], @isa_hook
1377 and AE::_reset ();
1378}
1379
1380# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1381sub _isa_hook($$;$) {
1382 my ($i, $pkg, $reset_ae) = @_;
1383
1384 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1385
1386 _isa_set;
1387}
1388
1389# all autoloaded methods reserve the complete glob, not just the method slot.
1390# due to bugs in perls method cache implementation.
1217 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1391our @methods = qw(io timer time now now_update signal child idle condvar);
1218
1219our @post_detect;
1220
1221sub post_detect(&) {
1222 my ($cb) = @_;
1223
1224 push @post_detect, $cb;
1225
1226 defined wantarray
1227 ? bless \$cb, "AnyEvent::Util::postdetect"
1228 : ()
1229}
1230
1231sub AnyEvent::Util::postdetect::DESTROY {
1232 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1233}
1234 1392
1235sub detect() { 1393sub detect() {
1394 return $MODEL if $MODEL; # some programs keep references to detect
1395
1396 # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1397 # the author knows about the problems and what it does to AnyEvent as a whole
1398 # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
1399 # anyway.
1400 AnyEvent::log fatal => "AnyEvent: IO::Async::Loop::AnyEvent detected - that module is broken by\n"
1401 . "design, abuses internals and breaks AnyEvent - will not continue."
1402 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1403
1404 local $!; # for good measure
1405 local $SIG{__DIE__}; # we use eval
1406
1236 # free some memory 1407 # free some memory
1237 *detect = sub () { $MODEL }; 1408 *detect = sub () { $MODEL };
1409 # undef &func doesn't correctly update the method cache. grmbl.
1410 # so we delete the whole glob. grmbl.
1411 # otoh, perl doesn't let me undef an active usb, but it lets me free
1412 # a glob with an active sub. hrm. i hope it works, but perl is
1413 # usually buggy in this department. sigh.
1414 delete @{"AnyEvent::"}{@methods};
1415 undef @methods;
1238 1416
1239 local $!; # for good measure
1240 local $SIG{__DIE__};
1241
1242 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1417 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1243 my $model = "AnyEvent::Impl::$1"; 1418 my $model = $1;
1419 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1244 if (eval "require $model") { 1420 if (eval "require $model") {
1421 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1245 $MODEL = $model; 1422 $MODEL = $model;
1246 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1247 } else { 1423 } else {
1248 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1424 AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1249 } 1425 }
1250 } 1426 }
1251 1427
1252 # check for already loaded models 1428 # check for already loaded models
1253 unless ($MODEL) { 1429 unless ($MODEL) {
1254 for (@REGISTRY, @models) { 1430 for (@REGISTRY, @models) {
1255 my ($package, $model) = @$_; 1431 my ($package, $model) = @$_;
1256 if (${"$package\::VERSION"} > 0) { 1432 if (${"$package\::VERSION"} > 0) {
1257 if (eval "require $model") { 1433 if (eval "require $model") {
1434 AnyEvent::log 7 => "autodetected model '$model', using it.";
1258 $MODEL = $model; 1435 $MODEL = $model;
1259 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1436 last;
1437 } else {
1438 AnyEvent::log 8 => "detected event loop $package, but cannot load '$model', skipping: $@";
1439 }
1440 }
1441 }
1442
1443 unless ($MODEL) {
1444 # try to autoload a model
1445 for (@REGISTRY, @models) {
1446 my ($package, $model) = @$_;
1447 if (
1448 eval "require $package"
1449 and ${"$package\::VERSION"} > 0
1450 and eval "require $model"
1451 ) {
1452 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1453 $MODEL = $model;
1260 last; 1454 last;
1261 } 1455 }
1262 } 1456 }
1263 }
1264
1265 unless ($MODEL) {
1266 # try to autoload a model
1267 for (@REGISTRY, @models) {
1268 my ($package, $model, $autoload) = @$_;
1269 if (
1270 $autoload
1271 and eval "require $package"
1272 and ${"$package\::VERSION"} > 0
1273 and eval "require $model"
1274 ) {
1275 $MODEL = $model;
1276 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1277 last;
1278 }
1279 }
1280 1457
1281 $MODEL 1458 $MODEL
1282 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1459 or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1283 } 1460 }
1284 } 1461 }
1285 1462
1286 @models = (); # free probe data 1463 # free memory only needed for probing
1464 undef @models;
1465 undef @REGISTRY;
1287 1466
1288 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1467 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1289 unshift @ISA, $MODEL;
1290 1468
1291 # now nuke some methods that are overridden by the backend. 1469 # now nuke some methods that are overridden by the backend.
1292 # SUPER is not allowed. 1470 # SUPER usage is not allowed in these.
1293 for (qw(time signal child idle)) { 1471 for (qw(time signal child idle)) {
1294 undef &{"AnyEvent::Base::$_"} 1472 undef &{"AnyEvent::Base::$_"}
1295 if defined &{"$MODEL\::$_"}; 1473 if defined &{"$MODEL\::$_"};
1296 } 1474 }
1297 1475
1476 _isa_set;
1477
1478 # we're officially open!
1479
1298 if ($ENV{PERL_ANYEVENT_STRICT}) { 1480 if ($ENV{PERL_ANYEVENT_STRICT}) {
1299 eval { require AnyEvent::Strict }; 1481 require AnyEvent::Strict;
1300 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1301 if $@ && $VERBOSE;
1302 } 1482 }
1303 1483
1484 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1485 require AnyEvent::Debug;
1486 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1487 }
1488
1489 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1490 require AnyEvent::Socket;
1491 require AnyEvent::Debug;
1492
1493 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1494 $shell =~ s/\$\$/$$/g;
1495
1496 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1497 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1498 }
1499
1500 # now the anyevent environment is set up as the user told us to, so
1501 # call the actual user code - post detects
1502
1304 (shift @post_detect)->() while @post_detect; 1503 (shift @post_detect)->() while @post_detect;
1504 undef @post_detect;
1305 1505
1306 *post_detect = sub(&) { 1506 *post_detect = sub(&) {
1307 shift->(); 1507 shift->();
1308 1508
1309 undef 1509 undef
1310 }; 1510 };
1311 1511
1312 $MODEL 1512 $MODEL
1313} 1513}
1314 1514
1315sub AUTOLOAD { 1515for my $name (@methods) {
1316 (my $func = $AUTOLOAD) =~ s/.*://; 1516 *$name = sub {
1317
1318 $method{$func}
1319 or Carp::croak "$func: not a valid AnyEvent class method";
1320
1321 detect; 1517 detect;
1322 1518 # we use goto because
1323 my $class = shift; 1519 # a) it makes the thunk more transparent
1324 $class->$func (@_); 1520 # b) it allows us to delete the thunk later
1521 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1522 };
1325} 1523}
1326 1524
1327# utility function to dup a filehandle. this is used by many backends 1525# utility function to dup a filehandle. this is used by many backends
1328# to support binding more than one watcher per filehandle (they usually 1526# to support binding more than one watcher per filehandle (they usually
1329# allow only one watcher per fd, so we dup it to get a different one). 1527# allow only one watcher per fd, so we dup it to get a different one).
1353 1551
1354package AE; 1552package AE;
1355 1553
1356our $VERSION = $AnyEvent::VERSION; 1554our $VERSION = $AnyEvent::VERSION;
1357 1555
1556sub _reset() {
1557 eval q{
1358# fall back to the main API by default - backends and AnyEvent::Base 1558 # fall back to the main API by default - backends and AnyEvent::Base
1359# implementations can overwrite these. 1559 # implementations can overwrite these.
1360 1560
1361sub io($$$) { 1561 sub io($$$) {
1362 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1562 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1363} 1563 }
1364 1564
1365sub timer($$$) { 1565 sub timer($$$) {
1366 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1566 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1367} 1567 }
1368 1568
1369sub signal($$) { 1569 sub signal($$) {
1370 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1570 AnyEvent->signal (signal => $_[0], cb => $_[1])
1371} 1571 }
1372 1572
1373sub child($$) { 1573 sub child($$) {
1374 AnyEvent->child (pid => $_[0], cb => $_[1]) 1574 AnyEvent->child (pid => $_[0], cb => $_[1])
1375} 1575 }
1376 1576
1377sub idle($) { 1577 sub idle($) {
1378 AnyEvent->idle (cb => $_[0]) 1578 AnyEvent->idle (cb => $_[0]);
1379} 1579 }
1380 1580
1381sub cv(;&) { 1581 sub cv(;&) {
1382 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1582 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1383} 1583 }
1384 1584
1385sub now() { 1585 sub now() {
1386 AnyEvent->now 1586 AnyEvent->now
1387} 1587 }
1388 1588
1389sub now_update() { 1589 sub now_update() {
1390 AnyEvent->now_update 1590 AnyEvent->now_update
1391} 1591 }
1392 1592
1393sub time() { 1593 sub time() {
1394 AnyEvent->time 1594 AnyEvent->time
1595 }
1596
1597 *postpone = \&AnyEvent::postpone;
1598 *log = \&AnyEvent::log;
1599 };
1600 die if $@;
1395} 1601}
1602
1603BEGIN { _reset }
1396 1604
1397package AnyEvent::Base; 1605package AnyEvent::Base;
1398 1606
1399# default implementations for many methods 1607# default implementations for many methods
1400 1608
1401sub time { 1609sub time {
1402 eval q{ # poor man's autoloading {} 1610 eval q{ # poor man's autoloading {}
1403 # probe for availability of Time::HiRes 1611 # probe for availability of Time::HiRes
1404 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1612 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1405 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1613 *time = sub { Time::HiRes::time () };
1406 *AE::time = \&Time::HiRes::time; 1614 *AE::time = \& Time::HiRes::time ;
1615 *now = \&time;
1616 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1407 # if (eval "use POSIX (); (POSIX::times())... 1617 # if (eval "use POSIX (); (POSIX::times())...
1408 } else { 1618 } else {
1619 *time = sub { CORE::time };
1620 *AE::time = sub (){ CORE::time };
1621 *now = \&time;
1409 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1622 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1410 *AE::time = sub (){ time }; # epic fail
1411 } 1623 }
1412
1413 *time = sub { AE::time }; # different prototypes
1414 }; 1624 };
1415 die if $@; 1625 die if $@;
1416 1626
1417 &time 1627 &time
1418} 1628}
1419 1629
1420*now = \&time; 1630*now = \&time;
1421
1422sub now_update { } 1631sub now_update { }
1423 1632
1633sub _poll {
1634 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1635}
1636
1424# default implementation for ->condvar 1637# default implementation for ->condvar
1638# in fact, the default should not be overwritten
1425 1639
1426sub condvar { 1640sub condvar {
1427 eval q{ # poor man's autoloading {} 1641 eval q{ # poor man's autoloading {}
1428 *condvar = sub { 1642 *condvar = sub {
1429 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1643 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1507 1721
1508sub signal { 1722sub signal {
1509 eval q{ # poor man's autoloading {} 1723 eval q{ # poor man's autoloading {}
1510 # probe for availability of Async::Interrupt 1724 # probe for availability of Async::Interrupt
1511 if (_have_async_interrupt) { 1725 if (_have_async_interrupt) {
1512 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1726 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1513 1727
1514 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1728 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1515 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1729 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1516 1730
1517 } else { 1731 } else {
1518 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1732 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1519 1733
1520 if (AnyEvent::WIN32) { 1734 if (AnyEvent::WIN32) {
1521 require AnyEvent::Util; 1735 require AnyEvent::Util;
1522 1736
1523 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1737 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1599 : sysread $SIGPIPE_R, (my $dummy), 9; 1813 : sysread $SIGPIPE_R, (my $dummy), 9;
1600 1814
1601 while (%SIG_EV) { 1815 while (%SIG_EV) {
1602 for (keys %SIG_EV) { 1816 for (keys %SIG_EV) {
1603 delete $SIG_EV{$_}; 1817 delete $SIG_EV{$_};
1604 $_->() for values %{ $SIG_CB{$_} || {} }; 1818 &$_ for values %{ $SIG_CB{$_} || {} };
1605 } 1819 }
1606 } 1820 }
1607 }; 1821 };
1608 }; 1822 };
1609 die if $@; 1823 die if $@;
1636 }; 1850 };
1637 1851
1638 *child = sub { 1852 *child = sub {
1639 my (undef, %arg) = @_; 1853 my (undef, %arg) = @_;
1640 1854
1641 defined (my $pid = $arg{pid} + 0) 1855 my $pid = $arg{pid};
1642 or Carp::croak "required option 'pid' is missing"; 1856 my $cb = $arg{cb};
1643 1857
1644 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1858 $PID_CB{$pid}{$cb+0} = $cb;
1645 1859
1646 unless ($CHLD_W) { 1860 unless ($CHLD_W) {
1647 $CHLD_W = AE::signal CHLD => \&_sigchld; 1861 $CHLD_W = AE::signal CHLD => \&_sigchld;
1648 # child could be a zombie already, so make at least one round 1862 # child could be a zombie already, so make at least one round
1649 &_sigchld; 1863 &_sigchld;
1650 } 1864 }
1651 1865
1652 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1866 bless [$pid, $cb+0], "AnyEvent::Base::child"
1653 }; 1867 };
1654 1868
1655 *AnyEvent::Base::child::DESTROY = sub { 1869 *AnyEvent::Base::child::DESTROY = sub {
1656 my ($pid, $cb) = @{$_[0]}; 1870 my ($pid, $icb) = @{$_[0]};
1657 1871
1658 delete $PID_CB{$pid}{$cb}; 1872 delete $PID_CB{$pid}{$icb};
1659 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1873 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1660 1874
1661 undef $CHLD_W unless keys %PID_CB; 1875 undef $CHLD_W unless keys %PID_CB;
1662 }; 1876 };
1663 }; 1877 };
1676 1890
1677 my ($cb, $w, $rcb) = $arg{cb}; 1891 my ($cb, $w, $rcb) = $arg{cb};
1678 1892
1679 $rcb = sub { 1893 $rcb = sub {
1680 if ($cb) { 1894 if ($cb) {
1681 $w = _time; 1895 $w = AE::time;
1682 &$cb; 1896 &$cb;
1683 $w = _time - $w; 1897 $w = AE::time - $w;
1684 1898
1685 # never use more then 50% of the time for the idle watcher, 1899 # never use more then 50% of the time for the idle watcher,
1686 # within some limits 1900 # within some limits
1687 $w = 0.0001 if $w < 0.0001; 1901 $w = 0.0001 if $w < 0.0001;
1688 $w = 5 if $w > 5; 1902 $w = 5 if $w > 5;
1735 1949
1736sub _send { 1950sub _send {
1737 # nop 1951 # nop
1738} 1952}
1739 1953
1954sub _wait {
1955 AnyEvent->_poll until $_[0]{_ae_sent};
1956}
1957
1740sub send { 1958sub send {
1741 my $cv = shift; 1959 my $cv = shift;
1742 $cv->{_ae_sent} = [@_]; 1960 $cv->{_ae_sent} = [@_];
1743 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1961 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1744 $cv->_send; 1962 $cv->_send;
1751 1969
1752sub ready { 1970sub ready {
1753 $_[0]{_ae_sent} 1971 $_[0]{_ae_sent}
1754} 1972}
1755 1973
1756sub _wait {
1757 $WAITING
1758 and !$_[0]{_ae_sent}
1759 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1760
1761 local $WAITING = 1;
1762 AnyEvent->one_event while !$_[0]{_ae_sent};
1763}
1764
1765sub recv { 1974sub recv {
1975 unless ($_[0]{_ae_sent}) {
1976 $WAITING
1977 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1978
1979 local $WAITING = 1;
1766 $_[0]->_wait; 1980 $_[0]->_wait;
1981 }
1767 1982
1768 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1983 $_[0]{_ae_croak}
1769 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1984 and Carp::croak $_[0]{_ae_croak};
1985
1986 wantarray
1987 ? @{ $_[0]{_ae_sent} }
1988 : $_[0]{_ae_sent}[0]
1770} 1989}
1771 1990
1772sub cb { 1991sub cb {
1773 my $cv = shift; 1992 my $cv = shift;
1774 1993
1790 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 2009 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1791} 2010}
1792 2011
1793# undocumented/compatibility with pre-3.4 2012# undocumented/compatibility with pre-3.4
1794*broadcast = \&send; 2013*broadcast = \&send;
1795*wait = \&_wait; 2014*wait = \&recv;
1796 2015
1797=head1 ERROR AND EXCEPTION HANDLING 2016=head1 ERROR AND EXCEPTION HANDLING
1798 2017
1799In general, AnyEvent does not do any error handling - it relies on the 2018In general, AnyEvent does not do any error handling - it relies on the
1800caller to do that if required. The L<AnyEvent::Strict> module (see also 2019caller to do that if required. The L<AnyEvent::Strict> module (see also
1812$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2031$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1813so on. 2032so on.
1814 2033
1815=head1 ENVIRONMENT VARIABLES 2034=head1 ENVIRONMENT VARIABLES
1816 2035
1817The following environment variables are used by this module or its 2036AnyEvent supports a number of environment variables that tune the
1818submodules. 2037runtime behaviour. They are usually evaluated when AnyEvent is
2038loaded, initialised, or a submodule that uses them is loaded. Many of
2039them also cause AnyEvent to load additional modules - for example,
2040C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2041loaded.
1819 2042
1820Note that AnyEvent will remove I<all> environment variables starting with 2043All the environment variables documented here start with
1821C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2044C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1822enabled. 2045namespace. Other modules are encouraged (but by no means required) to use
2046C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2047namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2048be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2049variables starting with C<AE_>, see below).
2050
2051All variables can also be set via the C<AE_> prefix, that is, instead
2052of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2053case there is a clash btween anyevent and another program that uses
2054C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2055variable to the empty string, as those variables take precedence.
2056
2057When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2058to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2059exists. If taint mode is on, then AnyEvent will remove I<all> environment
2060variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2061with C<undef> or the empty string, if the corresaponding C<AE_> variable
2062is set).
2063
2064The exact algorithm is currently:
2065
2066 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2067 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2068 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2069
2070This ensures that child processes will not see the C<AE_> variables.
2071
2072The following environment variables are currently known to AnyEvent:
1823 2073
1824=over 4 2074=over 4
1825 2075
1826=item C<PERL_ANYEVENT_VERBOSE> 2076=item C<PERL_ANYEVENT_VERBOSE>
1827 2077
1828By default, AnyEvent will be completely silent except in fatal 2078By default, AnyEvent will only log messages with loglevel C<3>
1829conditions. You can set this environment variable to make AnyEvent more 2079(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
2080environment variable to a numerical loglevel to make AnyEvent more (or
1830talkative. 2081less) talkative.
1831 2082
2083If you want to do more than just set the global logging level
2084you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2085complex specifications.
2086
2087When set to C<0> (C<off>), then no messages whatsoever will be logged with
2088the default logging settings.
2089
1832When set to C<1> or higher, causes AnyEvent to warn about unexpected 2090When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1833conditions, such as not being able to load the event model specified by 2091unexpected conditions, such as not being able to load the event model
1834C<PERL_ANYEVENT_MODEL>. 2092specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2093exception - this is the minimum recommended level.
1835 2094
1836When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2095When set to C<7> or higher (info), cause AnyEvent to report which event model it
1837model it chooses. 2096chooses.
1838 2097
1839When set to C<8> or higher, then AnyEvent will report extra information on 2098When set to C<8> or higher (debug), then AnyEvent will report extra information on
1840which optional modules it loads and how it implements certain features. 2099which optional modules it loads and how it implements certain features.
2100
2101=item C<PERL_ANYEVENT_LOG>
2102
2103Accepts rather complex logging specifications. For example, you could log
2104all C<debug> messages of some module to stderr, warnings and above to
2105stderr, and errors and above to syslog, with:
2106
2107 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2108
2109For the rather extensive details, see L<AnyEvent::Log>.
2110
2111This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2112so will take effect even before AnyEvent has initialised itself.
2113
2114Note that specifying this environment variable causes the L<AnyEvent::Log>
2115module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2116using the latter saves a few hundred kB of memory until the first message
2117is being logged.
1841 2118
1842=item C<PERL_ANYEVENT_STRICT> 2119=item C<PERL_ANYEVENT_STRICT>
1843 2120
1844AnyEvent does not do much argument checking by default, as thorough 2121AnyEvent does not do much argument checking by default, as thorough
1845argument checking is very costly. Setting this variable to a true value 2122argument checking is very costly. Setting this variable to a true value
1852Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2129Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1853>>, it is definitely recommended to keep it off in production. Keeping 2130>>, it is definitely recommended to keep it off in production. Keeping
1854C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2131C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1855can be very useful, however. 2132can be very useful, however.
1856 2133
2134=item C<PERL_ANYEVENT_DEBUG_SHELL>
2135
2136If this env variable is nonempty, then its contents will be interpreted by
2137C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2138replacing every occurance of C<$$> by the process pid). The shell object
2139is saved in C<$AnyEvent::Debug::SHELL>.
2140
2141This happens when the first watcher is created.
2142
2143For example, to bind a debug shell on a unix domain socket in
2144F<< /tmp/debug<pid>.sock >>, you could use this:
2145
2146 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2147 # connect with e.g.: socat readline /tmp/debug123.sock
2148
2149Or to bind to tcp port 4545 on localhost:
2150
2151 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2152 # connect with e.g.: telnet localhost 4545
2153
2154Note that creating sockets in F</tmp> or on localhost is very unsafe on
2155multiuser systems.
2156
2157=item C<PERL_ANYEVENT_DEBUG_WRAP>
2158
2159Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2160debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2161
1857=item C<PERL_ANYEVENT_MODEL> 2162=item C<PERL_ANYEVENT_MODEL>
1858 2163
1859This can be used to specify the event model to be used by AnyEvent, before 2164This can be used to specify the event model to be used by AnyEvent, before
1860auto detection and -probing kicks in. It must be a string consisting 2165auto detection and -probing kicks in.
1861entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2166
2167It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2168or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1862and the resulting module name is loaded and if the load was successful, 2169resulting module name is loaded and - if the load was successful - used as
1863used as event model. If it fails to load AnyEvent will proceed with 2170event model backend. If it fails to load then AnyEvent will proceed with
1864auto detection and -probing. 2171auto detection and -probing.
1865 2172
1866This functionality might change in future versions. 2173If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2174nothing gets prepended and the module name is used as-is (hint: C<::> at
2175the end of a string designates a module name and quotes it appropriately).
1867 2176
1868For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2177For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1869could start your program like this: 2178could start your program like this:
1870 2179
1871 PERL_ANYEVENT_MODEL=Perl perl ... 2180 PERL_ANYEVENT_MODEL=Perl perl ...
1872 2181
1873=item C<PERL_ANYEVENT_PROTOCOLS> 2182=item C<PERL_ANYEVENT_PROTOCOLS>
1889but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2198but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1890- only support IPv4, never try to resolve or contact IPv6 2199- only support IPv4, never try to resolve or contact IPv6
1891addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2200addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1892IPv6, but prefer IPv6 over IPv4. 2201IPv6, but prefer IPv6 over IPv4.
1893 2202
2203=item C<PERL_ANYEVENT_HOSTS>
2204
2205This variable, if specified, overrides the F</etc/hosts> file used by
2206L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2207from that file instead.
2208
1894=item C<PERL_ANYEVENT_EDNS0> 2209=item C<PERL_ANYEVENT_EDNS0>
1895 2210
1896Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2211Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1897for DNS. This extension is generally useful to reduce DNS traffic, but 2212DNS. This extension is generally useful to reduce DNS traffic, especially
1898some (broken) firewalls drop such DNS packets, which is why it is off by 2213when DNSSEC is involved, but some (broken) firewalls drop such DNS
1899default. 2214packets, which is why it is off by default.
1900 2215
1901Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2216Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1902EDNS0 in its DNS requests. 2217EDNS0 in its DNS requests.
1903 2218
1904=item C<PERL_ANYEVENT_MAX_FORKS> 2219=item C<PERL_ANYEVENT_MAX_FORKS>
1910 2225
1911The default value for the C<max_outstanding> parameter for the default DNS 2226The default value for the C<max_outstanding> parameter for the default DNS
1912resolver - this is the maximum number of parallel DNS requests that are 2227resolver - this is the maximum number of parallel DNS requests that are
1913sent to the DNS server. 2228sent to the DNS server.
1914 2229
2230=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
2231
2232Perl has inherently racy signal handling (you can basically choose between
2233losing signals and memory corruption) - pure perl event loops (including
2234C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
2235have to poll regularly to avoid losing signals.
2236
2237Some event loops are racy, but don't poll regularly, and some event loops
2238are written in C but are still racy. For those event loops, AnyEvent
2239installs a timer that regularly wakes up the event loop.
2240
2241By default, the interval for this timer is C<10> seconds, but you can
2242override this delay with this environment variable (or by setting
2243the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
2244watchers).
2245
2246Lower values increase CPU (and energy) usage, higher values can introduce
2247long delays when reaping children or waiting for signals.
2248
2249The L<AnyEvent::Async> module, if available, will be used to avoid this
2250polling (with most event loops).
2251
1915=item C<PERL_ANYEVENT_RESOLV_CONF> 2252=item C<PERL_ANYEVENT_RESOLV_CONF>
1916 2253
1917The file to use instead of F</etc/resolv.conf> (or OS-specific 2254The absolute path to a F<resolv.conf>-style file to use instead of
1918configuration) in the default resolver. When set to the empty string, no 2255F</etc/resolv.conf> (or the OS-specific configuration) in the default
1919default config will be used. 2256resolver, or the empty string to select the default configuration.
1920 2257
1921=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2258=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1922 2259
1923When neither C<ca_file> nor C<ca_path> was specified during 2260When neither C<ca_file> nor C<ca_path> was specified during
1924L<AnyEvent::TLS> context creation, and either of these environment 2261L<AnyEvent::TLS> context creation, and either of these environment
1925variables exist, they will be used to specify CA certificate locations 2262variables are nonempty, they will be used to specify CA certificate
1926instead of a system-dependent default. 2263locations instead of a system-dependent default.
1927 2264
1928=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2265=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1929 2266
1930When these are set to C<1>, then the respective modules are not 2267When these are set to C<1>, then the respective modules are not
1931loaded. Mostly good for testing AnyEvent itself. 2268loaded. Mostly good for testing AnyEvent itself.
2263(even when used without AnyEvent), but most event loops have acceptable 2600(even when used without AnyEvent), but most event loops have acceptable
2264performance with or without AnyEvent. 2601performance with or without AnyEvent.
2265 2602
2266=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2603=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2267the actual event loop, only with extremely fast event loops such as EV 2604the actual event loop, only with extremely fast event loops such as EV
2268adds AnyEvent significant overhead. 2605does AnyEvent add significant overhead.
2269 2606
2270=item * You should avoid POE like the plague if you want performance or 2607=item * You should avoid POE like the plague if you want performance or
2271reasonable memory usage. 2608reasonable memory usage.
2272 2609
2273=back 2610=back
2572 2909
2573=item L<Time::HiRes> 2910=item L<Time::HiRes>
2574 2911
2575This module is part of perl since release 5.008. It will be used when the 2912This module is part of perl since release 5.008. It will be used when the
2576chosen event library does not come with a timing source of its own. The 2913chosen event library does not come with a timing source of its own. The
2577pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2914pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2578try to use a monotonic clock for timing stability. 2915try to use a monotonic clock for timing stability.
2579 2916
2580=back 2917=back
2581 2918
2582 2919
2648 2985
2649Tutorial/Introduction: L<AnyEvent::Intro>. 2986Tutorial/Introduction: L<AnyEvent::Intro>.
2650 2987
2651FAQ: L<AnyEvent::FAQ>. 2988FAQ: L<AnyEvent::FAQ>.
2652 2989
2653Utility functions: L<AnyEvent::Util>. 2990Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2991(simply logging).
2654 2992
2655Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2993Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2656L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2994L<AnyEvent::Debug> (interactive shell, watcher tracing).
2995
2996Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2997L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2998L<Qt>, L<POE>, L<FLTK>.
2657 2999
2658Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 3000Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2659L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 3001L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2660L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 3002L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2661L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 3003L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
3004L<AnyEvent::Impl::FLTK>.
2662 3005
2663Non-blocking file handles, sockets, TCP clients and 3006Non-blocking handles, pipes, stream sockets, TCP clients and
2664servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 3007servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2665 3008
2666Asynchronous DNS: L<AnyEvent::DNS>. 3009Asynchronous DNS: L<AnyEvent::DNS>.
2667 3010
2668Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 3011Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines