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.347 by root, Sun Jan 23 11:15:09 2011 UTC vs.
Revision 1.404 by root, Sat May 12 23:14:29 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
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.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. 880 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
881 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
883 882
884=item Backends with special needs. 883=item Backends with special needs.
885 884
886Qt requires the Qt::Application to be instantiated first, but will 885Qt requires the Qt::Application to be instantiated first, but will
887otherwise be picked up automatically. As long as the main program 886otherwise be picked up automatically. As long as the main program
932 931
933Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 932Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
934if necessary. You should only call this function right before you would 933if necessary. You should only call this function right before you would
935have 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
936runtime, 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).
937 940
938If you need to do some initialisation before AnyEvent watchers are 941If you need to do some initialisation before AnyEvent watchers are
939created, use C<post_detect>. 942created, use C<post_detect>.
940 943
941=item $guard = AnyEvent::post_detect { BLOCK } 944=item $guard = AnyEvent::post_detect { BLOCK }
1004 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1007 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1005 # as soon as it is 1008 # as soon as it is
1006 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1009 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1007 } 1010 }
1008 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
1009=back 1070=back
1010 1071
1011=head1 WHAT TO DO IN A MODULE 1072=head1 WHAT TO DO IN A MODULE
1012 1073
1013As 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
1046modules might create watchers when they are loaded, and AnyEvent will 1107modules might create watchers when they are loaded, and AnyEvent will
1047decide 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
1048might choose the wrong one unless you load the correct one yourself. 1109might choose the wrong one unless you load the correct one yourself.
1049 1110
1050You can chose to use a pure-perl implementation by loading the 1111You can chose to use a pure-perl implementation by loading the
1051C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1112C<AnyEvent::Loop> module, which gives you similar behaviour
1052everywhere, but letting AnyEvent chose the model is generally better. 1113everywhere, but letting AnyEvent chose the model is generally better.
1053 1114
1054=head2 MAINLOOP EMULATION 1115=head2 MAINLOOP EMULATION
1055 1116
1056Sometimes (often for short test scripts, or even standalone programs who 1117Sometimes (often for short test scripts, or even standalone programs who
1069 1130
1070 1131
1071=head1 OTHER MODULES 1132=head1 OTHER MODULES
1072 1133
1073The following is a non-exhaustive list of additional modules that use 1134The following is a non-exhaustive list of additional modules that use
1074AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1135AnyEvent as a client and can therefore be mixed easily with other
1075modules 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
1076come 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 :)
1077 1141
1078=over 4 1142=over 4
1079 1143
1080=item L<AnyEvent::Util> 1144=item L<AnyEvent::Util>
1081 1145
1101=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>
1102 1166
1103Implement event-based interfaces to the protocols of the same name (for 1167Implement event-based interfaces to the protocols of the same name (for
1104the 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
1105Client Protocol). 1169Client Protocol).
1106
1107=item L<AnyEvent::Handle::UDP>
1108
1109Here be danger!
1110
1111As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1112there are so many things wrong with AnyEvent::Handle::UDP, most notably
1113its use of a stream-based API with a protocol that isn't streamable, that
1114the only way to improve it is to delete it.
1115
1116It features data corruption (but typically only under load) and general
1117confusion. On top, the author is not only clueless about UDP but also
1118fact-resistant - some gems of his understanding: "connect doesn't work
1119with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1120packets", "I don't need to implement proper error checking as UDP doesn't
1121support error checking" and so on - he doesn't even understand what's
1122wrong with his module when it is explained to him.
1123
1124=item L<AnyEvent::DBI>
1125
1126Executes L<DBI> requests asynchronously in a proxy process for you,
1127notifying you in an event-based way when the operation is finished.
1128 1170
1129=item L<AnyEvent::AIO> 1171=item L<AnyEvent::AIO>
1130 1172
1131Truly 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
1132toolbox of every event programmer. AnyEvent::AIO transparently fuses 1174toolbox of every event programmer. AnyEvent::AIO transparently fuses
1133L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1175L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1134file I/O, and much more. 1176file I/O, and much more.
1135 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
1136=item L<AnyEvent::HTTPD> 1196=item L<AnyEvent::HTTPD>
1137 1197
1138A simple embedded webserver. 1198A simple embedded webserver.
1139 1199
1140=item L<AnyEvent::FastPing> 1200=item L<AnyEvent::FastPing>
1141 1201
1142The fastest ping in the west. 1202The fastest ping in the west.
1143 1203
1144=item L<Coro> 1204=item L<Coro>
1145 1205
1146Has 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 };
1147 1219
1148=back 1220=back
1149 1221
1150=cut 1222=cut
1151 1223
1152package AnyEvent; 1224package AnyEvent;
1153 1225
1154# basically a tuned-down version of common::sense 1226# basically a tuned-down version of common::sense
1155sub common_sense { 1227sub common_sense {
1156 # from common:.sense 3.4 1228 # from common:.sense 3.5
1229 local $^W;
1157 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00"; 1230 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1158 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) 1231 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1159 $^H |= 0x00000600; 1232 $^H |= 0x00000600;
1160} 1233}
1161 1234
1162BEGIN { AnyEvent::common_sense } 1235BEGIN { AnyEvent::common_sense }
1163 1236
1164use Carp (); 1237use Carp ();
1165 1238
1166our $VERSION = '5.31'; 1239our $VERSION = '7.01';
1167our $MODEL; 1240our $MODEL;
1168
1169our $AUTOLOAD;
1170our @ISA; 1241our @ISA;
1171
1172our @REGISTRY; 1242our @REGISTRY;
1173
1174our $VERBOSE; 1243our $VERBOSE;
1244our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1245our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!)
1175 1246
1176BEGIN { 1247BEGIN {
1177 require "AnyEvent/constants.pl"; 1248 require "AnyEvent/constants.pl";
1178 1249
1179 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1250 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1180 1251
1181 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1252 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1182 if ${^TAINT}; 1253 if ${^TAINT};
1183 1254
1184 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1255 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1256 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1185 1257
1186} 1258 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1259 if ${^TAINT};
1187 1260
1188our $MAX_SIGNAL_LATENCY = 10; 1261 # $ENV{PERL_ANYEVENT_xxx} now valid
1189 1262
1190our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1263 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1191 1264
1192{
1193 my $idx; 1265 my $idx;
1194 $PROTOCOL{$_} = ++$idx 1266 $PROTOCOL{$_} = ++$idx
1195 for reverse split /\s*,\s*/, 1267 for reverse split /\s*,\s*/,
1196 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1268 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1197} 1269}
1198 1270
1271our @post_detect;
1272
1273sub post_detect(&) {
1274 my ($cb) = @_;
1275
1276 push @post_detect, $cb;
1277
1278 defined wantarray
1279 ? bless \$cb, "AnyEvent::Util::postdetect"
1280 : ()
1281}
1282
1283sub AnyEvent::Util::postdetect::DESTROY {
1284 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1285}
1286
1287our $POSTPONE_W;
1288our @POSTPONE;
1289
1290sub _postpone_exec {
1291 undef $POSTPONE_W;
1292
1293 &{ shift @POSTPONE }
1294 while @POSTPONE;
1295}
1296
1297sub postpone(&) {
1298 push @POSTPONE, shift;
1299
1300 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1301
1302 ()
1303}
1304
1305sub log($$;@) {
1306 # only load the big bloated module when we actually are about to log something
1307 if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
1308 local ($!, $@);
1309 require AnyEvent::Log; # among other things, sets $VERBOSE to 9
1310 # AnyEvent::Log overwrites this function
1311 goto &log;
1312 }
1313
1314 0 # not logged
1315}
1316
1317sub _logger($;$) {
1318 my ($level, $renabled) = @_;
1319
1320 $$renabled = $level <= $VERBOSE;
1321
1322 my $logger = [(caller)[0], $level, $renabled];
1323
1324 $AnyEvent::Log::LOGGER{$logger+0} = $logger;
1325
1326# return unless defined wantarray;
1327#
1328# require AnyEvent::Util;
1329# my $guard = AnyEvent::Util::guard (sub {
1330# # "clean up"
1331# delete $LOGGER{$logger+0};
1332# });
1333#
1334# sub {
1335# return 0 unless $$renabled;
1336#
1337# $guard if 0; # keep guard alive, but don't cause runtime overhead
1338# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
1339# package AnyEvent::Log;
1340# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
1341# }
1342}
1343
1344if (length $ENV{PERL_ANYEVENT_LOG}) {
1345 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1346}
1347
1199my @models = ( 1348our @models = (
1200 [EV:: => AnyEvent::Impl::EV:: , 1], 1349 [EV:: => AnyEvent::Impl::EV::],
1201 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1350 [AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1202 # everything below here will not (normally) be autoprobed 1351 # everything below here will not (normally) be autoprobed
1203 # as the pureperl backend should work everywhere 1352 # as the pure perl backend should work everywhere
1204 # and is usually faster 1353 # and is usually faster
1354 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1205 [Event:: => AnyEvent::Impl::Event::, 1], 1355 [Event:: => AnyEvent::Impl::Event::], # slow, stable
1206 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1356 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1357 # everything below here should not be autoloaded
1207 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1358 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1208 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1209 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1359 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1210 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1360 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1211 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1361 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1212 [Wx:: => AnyEvent::Impl::POE::], 1362 [Wx:: => AnyEvent::Impl::POE::],
1213 [Prima:: => AnyEvent::Impl::POE::], 1363 [Prima:: => AnyEvent::Impl::POE::],
1214 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1364 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1215 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1365 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1366 [FLTK:: => AnyEvent::Impl::FLTK::],
1216); 1367);
1217 1368
1218our %method = map +($_ => 1), 1369our @isa_hook;
1370
1371sub _isa_set {
1372 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1373
1374 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1375 for 1 .. $#pkg;
1376
1377 grep $_ && $_->[1], @isa_hook
1378 and AE::_reset ();
1379}
1380
1381# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1382sub _isa_hook($$;$) {
1383 my ($i, $pkg, $reset_ae) = @_;
1384
1385 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1386
1387 _isa_set;
1388}
1389
1390# all autoloaded methods reserve the complete glob, not just the method slot.
1391# due to bugs in perls method cache implementation.
1219 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1392our @methods = qw(io timer time now now_update signal child idle condvar);
1220
1221our @post_detect;
1222
1223sub post_detect(&) {
1224 my ($cb) = @_;
1225
1226 push @post_detect, $cb;
1227
1228 defined wantarray
1229 ? bless \$cb, "AnyEvent::Util::postdetect"
1230 : ()
1231}
1232
1233sub AnyEvent::Util::postdetect::DESTROY {
1234 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1235}
1236 1393
1237sub detect() { 1394sub detect() {
1395 return $MODEL if $MODEL; # some programs keep references to detect
1396
1397 # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1398 # the author knows about the problems and what it does to AnyEvent as a whole
1399 # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
1400 # anyway.
1401 AnyEvent::log fatal => "IO::Async::Loop::AnyEvent detected - that module is broken by\n"
1402 . "design, abuses internals and breaks AnyEvent - will not continue."
1403 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1404
1405 local $!; # for good measure
1406 local $SIG{__DIE__}; # we use eval
1407
1238 # free some memory 1408 # free some memory
1239 *detect = sub () { $MODEL }; 1409 *detect = sub () { $MODEL };
1410 # undef &func doesn't correctly update the method cache. grmbl.
1411 # so we delete the whole glob. grmbl.
1412 # otoh, perl doesn't let me undef an active usb, but it lets me free
1413 # a glob with an active sub. hrm. i hope it works, but perl is
1414 # usually buggy in this department. sigh.
1415 delete @{"AnyEvent::"}{@methods};
1416 undef @methods;
1240 1417
1241 local $!; # for good measure
1242 local $SIG{__DIE__};
1243
1244 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1418 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1245 my $model = "AnyEvent::Impl::$1"; 1419 my $model = $1;
1420 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1246 if (eval "require $model") { 1421 if (eval "require $model") {
1422 AnyEvent::log 7 => "Loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1247 $MODEL = $model; 1423 $MODEL = $model;
1248 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1249 } else { 1424 } else {
1250 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1425 AnyEvent::log 4 => "Unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1251 } 1426 }
1252 } 1427 }
1253 1428
1254 # check for already loaded models 1429 # check for already loaded models
1255 unless ($MODEL) { 1430 unless ($MODEL) {
1256 for (@REGISTRY, @models) { 1431 for (@REGISTRY, @models) {
1257 my ($package, $model) = @$_; 1432 my ($package, $model) = @$_;
1258 if (${"$package\::VERSION"} > 0) { 1433 if (${"$package\::VERSION"} > 0) {
1259 if (eval "require $model") { 1434 if (eval "require $model") {
1435 AnyEvent::log 7 => "Autodetected model '$model', using it.";
1260 $MODEL = $model; 1436 $MODEL = $model;
1261 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1437 last;
1438 } else {
1439 AnyEvent::log 8 => "Detected event loop $package, but cannot load '$model', skipping: $@";
1440 }
1441 }
1442 }
1443
1444 unless ($MODEL) {
1445 # try to autoload a model
1446 for (@REGISTRY, @models) {
1447 my ($package, $model) = @$_;
1448 if (
1449 eval "require $package"
1450 and ${"$package\::VERSION"} > 0
1451 and eval "require $model"
1452 ) {
1453 AnyEvent::log 7 => "Autoloaded model '$model', using it.";
1454 $MODEL = $model;
1262 last; 1455 last;
1263 } 1456 }
1264 } 1457 }
1265 }
1266
1267 unless ($MODEL) {
1268 # try to autoload a model
1269 for (@REGISTRY, @models) {
1270 my ($package, $model, $autoload) = @$_;
1271 if (
1272 $autoload
1273 and eval "require $package"
1274 and ${"$package\::VERSION"} > 0
1275 and eval "require $model"
1276 ) {
1277 $MODEL = $model;
1278 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1279 last;
1280 }
1281 }
1282 1458
1283 $MODEL 1459 $MODEL
1284 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1460 or AnyEvent::log fatal => "Backend autodetection failed - did you properly install AnyEvent?";
1285 } 1461 }
1286 } 1462 }
1287 1463
1288 @models = (); # free probe data 1464 # free memory only needed for probing
1465 undef @models;
1466 undef @REGISTRY;
1289 1467
1290 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1468 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1291 unshift @ISA, $MODEL;
1292 1469
1293 # now nuke some methods that are overridden by the backend. 1470 # now nuke some methods that are overridden by the backend.
1294 # SUPER is not allowed. 1471 # SUPER usage is not allowed in these.
1295 for (qw(time signal child idle)) { 1472 for (qw(time signal child idle)) {
1296 undef &{"AnyEvent::Base::$_"} 1473 undef &{"AnyEvent::Base::$_"}
1297 if defined &{"$MODEL\::$_"}; 1474 if defined &{"$MODEL\::$_"};
1298 } 1475 }
1299 1476
1477 _isa_set;
1478
1479 # we're officially open!
1480
1300 if ($ENV{PERL_ANYEVENT_STRICT}) { 1481 if ($ENV{PERL_ANYEVENT_STRICT}) {
1301 eval { require AnyEvent::Strict }; 1482 require AnyEvent::Strict;
1302 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1303 if $@ && $VERBOSE;
1304 } 1483 }
1305 1484
1485 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1486 require AnyEvent::Debug;
1487 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1488 }
1489
1490 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1491 require AnyEvent::Socket;
1492 require AnyEvent::Debug;
1493
1494 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1495 $shell =~ s/\$\$/$$/g;
1496
1497 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1498 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1499 }
1500
1501 # now the anyevent environment is set up as the user told us to, so
1502 # call the actual user code - post detects
1503
1306 (shift @post_detect)->() while @post_detect; 1504 (shift @post_detect)->() while @post_detect;
1505 undef @post_detect;
1307 1506
1308 *post_detect = sub(&) { 1507 *post_detect = sub(&) {
1309 shift->(); 1508 shift->();
1310 1509
1311 undef 1510 undef
1312 }; 1511 };
1313 1512
1314 $MODEL 1513 $MODEL
1315} 1514}
1316 1515
1317sub AUTOLOAD { 1516for my $name (@methods) {
1318 (my $func = $AUTOLOAD) =~ s/.*://; 1517 *$name = sub {
1319
1320 $method{$func}
1321 or Carp::croak "$func: not a valid AnyEvent class method";
1322
1323 detect; 1518 detect;
1324 1519 # we use goto because
1325 my $class = shift; 1520 # a) it makes the thunk more transparent
1326 $class->$func (@_); 1521 # b) it allows us to delete the thunk later
1522 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1523 };
1327} 1524}
1328 1525
1329# utility function to dup a filehandle. this is used by many backends 1526# utility function to dup a filehandle. this is used by many backends
1330# to support binding more than one watcher per filehandle (they usually 1527# to support binding more than one watcher per filehandle (they usually
1331# allow only one watcher per fd, so we dup it to get a different one). 1528# allow only one watcher per fd, so we dup it to get a different one).
1355 1552
1356package AE; 1553package AE;
1357 1554
1358our $VERSION = $AnyEvent::VERSION; 1555our $VERSION = $AnyEvent::VERSION;
1359 1556
1557sub _reset() {
1558 eval q{
1360# fall back to the main API by default - backends and AnyEvent::Base 1559 # fall back to the main API by default - backends and AnyEvent::Base
1361# implementations can overwrite these. 1560 # implementations can overwrite these.
1362 1561
1363sub io($$$) { 1562 sub io($$$) {
1364 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1563 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1365} 1564 }
1366 1565
1367sub timer($$$) { 1566 sub timer($$$) {
1368 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1567 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1369} 1568 }
1370 1569
1371sub signal($$) { 1570 sub signal($$) {
1372 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1571 AnyEvent->signal (signal => $_[0], cb => $_[1])
1373} 1572 }
1374 1573
1375sub child($$) { 1574 sub child($$) {
1376 AnyEvent->child (pid => $_[0], cb => $_[1]) 1575 AnyEvent->child (pid => $_[0], cb => $_[1])
1377} 1576 }
1378 1577
1379sub idle($) { 1578 sub idle($) {
1380 AnyEvent->idle (cb => $_[0]) 1579 AnyEvent->idle (cb => $_[0]);
1381} 1580 }
1382 1581
1383sub cv(;&) { 1582 sub cv(;&) {
1384 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1583 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1385} 1584 }
1386 1585
1387sub now() { 1586 sub now() {
1388 AnyEvent->now 1587 AnyEvent->now
1389} 1588 }
1390 1589
1391sub now_update() { 1590 sub now_update() {
1392 AnyEvent->now_update 1591 AnyEvent->now_update
1393} 1592 }
1394 1593
1395sub time() { 1594 sub time() {
1396 AnyEvent->time 1595 AnyEvent->time
1596 }
1597
1598 *postpone = \&AnyEvent::postpone;
1599 *log = \&AnyEvent::log;
1600 };
1601 die if $@;
1397} 1602}
1603
1604BEGIN { _reset }
1398 1605
1399package AnyEvent::Base; 1606package AnyEvent::Base;
1400 1607
1401# default implementations for many methods 1608# default implementations for many methods
1402 1609
1403sub time { 1610sub time {
1404 eval q{ # poor man's autoloading {} 1611 eval q{ # poor man's autoloading {}
1405 # probe for availability of Time::HiRes 1612 # probe for availability of Time::HiRes
1406 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1613 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1407 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1614 *time = sub { Time::HiRes::time () };
1408 *AE::time = \&Time::HiRes::time; 1615 *AE::time = \& Time::HiRes::time ;
1616 *now = \&time;
1617 AnyEvent::log 8 => "using Time::HiRes for sub-second timing accuracy.";
1409 # if (eval "use POSIX (); (POSIX::times())... 1618 # if (eval "use POSIX (); (POSIX::times())...
1410 } else { 1619 } else {
1411 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1620 *time = sub { CORE::time };
1412 *AE::time = sub (){ time }; # epic fail 1621 *AE::time = sub (){ CORE::time };
1622 *now = \&time;
1623 AnyEvent::log 3 => "Using built-in time(), no sub-second resolution!";
1413 } 1624 }
1414
1415 *time = sub { AE::time }; # different prototypes
1416 }; 1625 };
1417 die if $@; 1626 die if $@;
1418 1627
1419 &time 1628 &time
1420} 1629}
1421 1630
1422*now = \&time; 1631*now = \&time;
1423
1424sub now_update { } 1632sub now_update { }
1425 1633
1634sub _poll {
1635 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1636}
1637
1426# default implementation for ->condvar 1638# default implementation for ->condvar
1639# in fact, the default should not be overwritten
1427 1640
1428sub condvar { 1641sub condvar {
1429 eval q{ # poor man's autoloading {} 1642 eval q{ # poor man's autoloading {}
1430 *condvar = sub { 1643 *condvar = sub {
1431 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1644 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1509 1722
1510sub signal { 1723sub signal {
1511 eval q{ # poor man's autoloading {} 1724 eval q{ # poor man's autoloading {}
1512 # probe for availability of Async::Interrupt 1725 # probe for availability of Async::Interrupt
1513 if (_have_async_interrupt) { 1726 if (_have_async_interrupt) {
1514 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1727 AnyEvent::log 8 => "Using Async::Interrupt for race-free signal handling.";
1515 1728
1516 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1729 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1517 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1730 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1518 1731
1519 } else { 1732 } else {
1520 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1733 AnyEvent::log 8 => "Using emulated perl signal handling with latency timer.";
1521 1734
1522 if (AnyEvent::WIN32) { 1735 if (AnyEvent::WIN32) {
1523 require AnyEvent::Util; 1736 require AnyEvent::Util;
1524 1737
1525 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1738 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1601 : sysread $SIGPIPE_R, (my $dummy), 9; 1814 : sysread $SIGPIPE_R, (my $dummy), 9;
1602 1815
1603 while (%SIG_EV) { 1816 while (%SIG_EV) {
1604 for (keys %SIG_EV) { 1817 for (keys %SIG_EV) {
1605 delete $SIG_EV{$_}; 1818 delete $SIG_EV{$_};
1606 $_->() for values %{ $SIG_CB{$_} || {} }; 1819 &$_ for values %{ $SIG_CB{$_} || {} };
1607 } 1820 }
1608 } 1821 }
1609 }; 1822 };
1610 }; 1823 };
1611 die if $@; 1824 die if $@;
1638 }; 1851 };
1639 1852
1640 *child = sub { 1853 *child = sub {
1641 my (undef, %arg) = @_; 1854 my (undef, %arg) = @_;
1642 1855
1643 defined (my $pid = $arg{pid} + 0) 1856 my $pid = $arg{pid};
1644 or Carp::croak "required option 'pid' is missing"; 1857 my $cb = $arg{cb};
1645 1858
1646 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1859 $PID_CB{$pid}{$cb+0} = $cb;
1647 1860
1648 unless ($CHLD_W) { 1861 unless ($CHLD_W) {
1649 $CHLD_W = AE::signal CHLD => \&_sigchld; 1862 $CHLD_W = AE::signal CHLD => \&_sigchld;
1650 # child could be a zombie already, so make at least one round 1863 # child could be a zombie already, so make at least one round
1651 &_sigchld; 1864 &_sigchld;
1652 } 1865 }
1653 1866
1654 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1867 bless [$pid, $cb+0], "AnyEvent::Base::child"
1655 }; 1868 };
1656 1869
1657 *AnyEvent::Base::child::DESTROY = sub { 1870 *AnyEvent::Base::child::DESTROY = sub {
1658 my ($pid, $cb) = @{$_[0]}; 1871 my ($pid, $icb) = @{$_[0]};
1659 1872
1660 delete $PID_CB{$pid}{$cb}; 1873 delete $PID_CB{$pid}{$icb};
1661 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1874 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1662 1875
1663 undef $CHLD_W unless keys %PID_CB; 1876 undef $CHLD_W unless keys %PID_CB;
1664 }; 1877 };
1665 }; 1878 };
1678 1891
1679 my ($cb, $w, $rcb) = $arg{cb}; 1892 my ($cb, $w, $rcb) = $arg{cb};
1680 1893
1681 $rcb = sub { 1894 $rcb = sub {
1682 if ($cb) { 1895 if ($cb) {
1683 $w = _time; 1896 $w = AE::time;
1684 &$cb; 1897 &$cb;
1685 $w = _time - $w; 1898 $w = AE::time - $w;
1686 1899
1687 # never use more then 50% of the time for the idle watcher, 1900 # never use more then 50% of the time for the idle watcher,
1688 # within some limits 1901 # within some limits
1689 $w = 0.0001 if $w < 0.0001; 1902 $w = 0.0001 if $w < 0.0001;
1690 $w = 5 if $w > 5; 1903 $w = 5 if $w > 5;
1737 1950
1738sub _send { 1951sub _send {
1739 # nop 1952 # nop
1740} 1953}
1741 1954
1955sub _wait {
1956 AnyEvent->_poll until $_[0]{_ae_sent};
1957}
1958
1742sub send { 1959sub send {
1743 my $cv = shift; 1960 my $cv = shift;
1744 $cv->{_ae_sent} = [@_]; 1961 $cv->{_ae_sent} = [@_];
1745 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1962 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1746 $cv->_send; 1963 $cv->_send;
1753 1970
1754sub ready { 1971sub ready {
1755 $_[0]{_ae_sent} 1972 $_[0]{_ae_sent}
1756} 1973}
1757 1974
1758sub _wait {
1759 $WAITING
1760 and !$_[0]{_ae_sent}
1761 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1762
1763 local $WAITING = 1;
1764 AnyEvent->one_event while !$_[0]{_ae_sent};
1765}
1766
1767sub recv { 1975sub recv {
1976 unless ($_[0]{_ae_sent}) {
1977 $WAITING
1978 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1979
1980 local $WAITING = 1;
1768 $_[0]->_wait; 1981 $_[0]->_wait;
1982 }
1769 1983
1770 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1984 $_[0]{_ae_croak}
1771 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1985 and Carp::croak $_[0]{_ae_croak};
1986
1987 wantarray
1988 ? @{ $_[0]{_ae_sent} }
1989 : $_[0]{_ae_sent}[0]
1772} 1990}
1773 1991
1774sub cb { 1992sub cb {
1775 my $cv = shift; 1993 my $cv = shift;
1776 1994
1792 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 2010 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1793} 2011}
1794 2012
1795# undocumented/compatibility with pre-3.4 2013# undocumented/compatibility with pre-3.4
1796*broadcast = \&send; 2014*broadcast = \&send;
1797*wait = \&_wait; 2015*wait = \&recv;
1798 2016
1799=head1 ERROR AND EXCEPTION HANDLING 2017=head1 ERROR AND EXCEPTION HANDLING
1800 2018
1801In general, AnyEvent does not do any error handling - it relies on the 2019In general, AnyEvent does not do any error handling - it relies on the
1802caller to do that if required. The L<AnyEvent::Strict> module (see also 2020caller to do that if required. The L<AnyEvent::Strict> module (see also
1814$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2032$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1815so on. 2033so on.
1816 2034
1817=head1 ENVIRONMENT VARIABLES 2035=head1 ENVIRONMENT VARIABLES
1818 2036
1819The following environment variables are used by this module or its 2037AnyEvent supports a number of environment variables that tune the
1820submodules. 2038runtime behaviour. They are usually evaluated when AnyEvent is
2039loaded, initialised, or a submodule that uses them is loaded. Many of
2040them also cause AnyEvent to load additional modules - for example,
2041C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2042loaded.
1821 2043
1822Note that AnyEvent will remove I<all> environment variables starting with 2044All the environment variables documented here start with
1823C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2045C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1824enabled. 2046namespace. Other modules are encouraged (but by no means required) to use
2047C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2048namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2049be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2050variables starting with C<AE_>, see below).
2051
2052All variables can also be set via the C<AE_> prefix, that is, instead
2053of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2054case there is a clash btween anyevent and another program that uses
2055C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2056variable to the empty string, as those variables take precedence.
2057
2058When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2059to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2060exists. If taint mode is on, then AnyEvent will remove I<all> environment
2061variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2062with C<undef> or the empty string, if the corresaponding C<AE_> variable
2063is set).
2064
2065The exact algorithm is currently:
2066
2067 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2068 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2069 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2070
2071This ensures that child processes will not see the C<AE_> variables.
2072
2073The following environment variables are currently known to AnyEvent:
1825 2074
1826=over 4 2075=over 4
1827 2076
1828=item C<PERL_ANYEVENT_VERBOSE> 2077=item C<PERL_ANYEVENT_VERBOSE>
1829 2078
1830By default, AnyEvent will be completely silent except in fatal 2079By default, AnyEvent will log messages with loglevel C<4> (C<error>) or
1831conditions. You can set this environment variable to make AnyEvent more 2080higher (see L<AnyEvent::Log>). You can set this environment variable to a
1832talkative. 2081numerical loglevel to make AnyEvent more (or less) talkative.
1833 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
2088everything else at defaults.
2089
1834When set to C<1> or higher, causes AnyEvent to warn about unexpected 2090When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected
1835conditions, such as not being able to load the event model specified by 2091conditions, such as not being able to load the event model specified by
1836C<PERL_ANYEVENT_MODEL>. 2092C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
2093is the minimum recommended level for use during development.
1837 2094
1838When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2095When set to C<7> or higher (info), AnyEvent reports which event model it
1839model it chooses. 2096chooses.
1840 2097
1841When 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
1842which optional modules it loads and how it implements certain features. 2099information on which optional modules it loads and how it implements
2100certain features.
2101
2102=item C<PERL_ANYEVENT_LOG>
2103
2104Accepts rather complex logging specifications. For example, you could log
2105all C<debug> messages of some module to stderr, warnings and above to
2106stderr, and errors and above to syslog, with:
2107
2108 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2109
2110For the rather extensive details, see L<AnyEvent::Log>.
2111
2112This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2113so will take effect even before AnyEvent has initialised itself.
2114
2115Note that specifying this environment variable causes the L<AnyEvent::Log>
2116module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2117using the latter saves a few hundred kB of memory unless a module
2118explicitly needs the extra features of AnyEvent::Log.
1843 2119
1844=item C<PERL_ANYEVENT_STRICT> 2120=item C<PERL_ANYEVENT_STRICT>
1845 2121
1846AnyEvent does not do much argument checking by default, as thorough 2122AnyEvent does not do much argument checking by default, as thorough
1847argument checking is very costly. Setting this variable to a true value 2123argument checking is very costly. Setting this variable to a true value
1854Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2130Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1855>>, it is definitely recommended to keep it off in production. Keeping 2131>>, it is definitely recommended to keep it off in production. Keeping
1856C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2132C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1857can be very useful, however. 2133can be very useful, however.
1858 2134
2135=item C<PERL_ANYEVENT_DEBUG_SHELL>
2136
2137If this env variable is nonempty, then its contents will be interpreted by
2138C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2139replacing every occurance of C<$$> by the process pid). The shell object
2140is saved in C<$AnyEvent::Debug::SHELL>.
2141
2142This happens when the first watcher is created.
2143
2144For example, to bind a debug shell on a unix domain socket in
2145F<< /tmp/debug<pid>.sock >>, you could use this:
2146
2147 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2148 # connect with e.g.: socat readline /tmp/debug123.sock
2149
2150Or to bind to tcp port 4545 on localhost:
2151
2152 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2153 # connect with e.g.: telnet localhost 4545
2154
2155Note that creating sockets in F</tmp> or on localhost is very unsafe on
2156multiuser systems.
2157
2158=item C<PERL_ANYEVENT_DEBUG_WRAP>
2159
2160Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2161debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2162
1859=item C<PERL_ANYEVENT_MODEL> 2163=item C<PERL_ANYEVENT_MODEL>
1860 2164
1861This can be used to specify the event model to be used by AnyEvent, before 2165This can be used to specify the event model to be used by AnyEvent, before
1862auto detection and -probing kicks in. It must be a string consisting 2166auto detection and -probing kicks in.
1863entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2167
2168It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2169or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1864and the resulting module name is loaded and if the load was successful, 2170resulting module name is loaded and - if the load was successful - used as
1865used as event model. If it fails to load AnyEvent will proceed with 2171event model backend. If it fails to load then AnyEvent will proceed with
1866auto detection and -probing. 2172auto detection and -probing.
1867 2173
1868This functionality might change in future versions. 2174If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2175nothing gets prepended and the module name is used as-is (hint: C<::> at
2176the end of a string designates a module name and quotes it appropriately).
1869 2177
1870For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2178For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1871could start your program like this: 2179could start your program like this:
1872 2180
1873 PERL_ANYEVENT_MODEL=Perl perl ... 2181 PERL_ANYEVENT_MODEL=Perl perl ...
2182
2183=item C<PERL_ANYEVENT_IO_MODEL>
2184
2185The current file I/O model - see L<AnyEvent::IO> for more info.
2186
2187At the moment, only C<Perl> (small, pure-perl, synchronous) and
2188C<IOAIO> (truly asynchronous) are supported. The default is C<IOAIO> if
2189L<AnyEvent::AIO> can be loaded, otherwise it is C<Perl>.
1874 2190
1875=item C<PERL_ANYEVENT_PROTOCOLS> 2191=item C<PERL_ANYEVENT_PROTOCOLS>
1876 2192
1877Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences 2193Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1878for IPv4 or IPv6. The default is unspecified (and might change, or be the result 2194for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1891but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2207but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1892- only support IPv4, never try to resolve or contact IPv6 2208- only support IPv4, never try to resolve or contact IPv6
1893addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2209addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1894IPv6, but prefer IPv6 over IPv4. 2210IPv6, but prefer IPv6 over IPv4.
1895 2211
2212=item C<PERL_ANYEVENT_HOSTS>
2213
2214This variable, if specified, overrides the F</etc/hosts> file used by
2215L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2216from that file instead.
2217
1896=item C<PERL_ANYEVENT_EDNS0> 2218=item C<PERL_ANYEVENT_EDNS0>
1897 2219
1898Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2220Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1899for DNS. This extension is generally useful to reduce DNS traffic, but 2221DNS. This extension is generally useful to reduce DNS traffic, especially
1900some (broken) firewalls drop such DNS packets, which is why it is off by 2222when DNSSEC is involved, but some (broken) firewalls drop such DNS
1901default. 2223packets, which is why it is off by default.
1902 2224
1903Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2225Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1904EDNS0 in its DNS requests. 2226EDNS0 in its DNS requests.
1905 2227
1906=item C<PERL_ANYEVENT_MAX_FORKS> 2228=item C<PERL_ANYEVENT_MAX_FORKS>
1912 2234
1913The default value for the C<max_outstanding> parameter for the default DNS 2235The default value for the C<max_outstanding> parameter for the default DNS
1914resolver - this is the maximum number of parallel DNS requests that are 2236resolver - this is the maximum number of parallel DNS requests that are
1915sent to the DNS server. 2237sent to the DNS server.
1916 2238
2239=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
2240
2241Perl has inherently racy signal handling (you can basically choose between
2242losing signals and memory corruption) - pure perl event loops (including
2243C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
2244have to poll regularly to avoid losing signals.
2245
2246Some event loops are racy, but don't poll regularly, and some event loops
2247are written in C but are still racy. For those event loops, AnyEvent
2248installs a timer that regularly wakes up the event loop.
2249
2250By default, the interval for this timer is C<10> seconds, but you can
2251override this delay with this environment variable (or by setting
2252the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
2253watchers).
2254
2255Lower values increase CPU (and energy) usage, higher values can introduce
2256long delays when reaping children or waiting for signals.
2257
2258The L<AnyEvent::Async> module, if available, will be used to avoid this
2259polling (with most event loops).
2260
1917=item C<PERL_ANYEVENT_RESOLV_CONF> 2261=item C<PERL_ANYEVENT_RESOLV_CONF>
1918 2262
1919The file to use instead of F</etc/resolv.conf> (or OS-specific 2263The absolute path to a F<resolv.conf>-style file to use instead of
1920configuration) in the default resolver. When set to the empty string, no 2264F</etc/resolv.conf> (or the OS-specific configuration) in the default
1921default config will be used. 2265resolver, or the empty string to select the default configuration.
1922 2266
1923=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2267=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1924 2268
1925When neither C<ca_file> nor C<ca_path> was specified during 2269When neither C<ca_file> nor C<ca_path> was specified during
1926L<AnyEvent::TLS> context creation, and either of these environment 2270L<AnyEvent::TLS> context creation, and either of these environment
1927variables exist, they will be used to specify CA certificate locations 2271variables are nonempty, they will be used to specify CA certificate
1928instead of a system-dependent default. 2272locations instead of a system-dependent default.
1929 2273
1930=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2274=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1931 2275
1932When these are set to C<1>, then the respective modules are not 2276When these are set to C<1>, then the respective modules are not
1933loaded. Mostly good for testing AnyEvent itself. 2277loaded. Mostly good for testing AnyEvent itself.
2265(even when used without AnyEvent), but most event loops have acceptable 2609(even when used without AnyEvent), but most event loops have acceptable
2266performance with or without AnyEvent. 2610performance with or without AnyEvent.
2267 2611
2268=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2612=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2269the actual event loop, only with extremely fast event loops such as EV 2613the actual event loop, only with extremely fast event loops such as EV
2270adds AnyEvent significant overhead. 2614does AnyEvent add significant overhead.
2271 2615
2272=item * You should avoid POE like the plague if you want performance or 2616=item * You should avoid POE like the plague if you want performance or
2273reasonable memory usage. 2617reasonable memory usage.
2274 2618
2275=back 2619=back
2574 2918
2575=item L<Time::HiRes> 2919=item L<Time::HiRes>
2576 2920
2577This module is part of perl since release 5.008. It will be used when the 2921This module is part of perl since release 5.008. It will be used when the
2578chosen event library does not come with a timing source of its own. The 2922chosen event library does not come with a timing source of its own. The
2579pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2923pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2580try to use a monotonic clock for timing stability. 2924try to use a monotonic clock for timing stability.
2581 2925
2582=back 2926=back
2583 2927
2584 2928
2650 2994
2651Tutorial/Introduction: L<AnyEvent::Intro>. 2995Tutorial/Introduction: L<AnyEvent::Intro>.
2652 2996
2653FAQ: L<AnyEvent::FAQ>. 2997FAQ: L<AnyEvent::FAQ>.
2654 2998
2655Utility functions: L<AnyEvent::Util>. 2999Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
3000(simply logging).
2656 3001
2657Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 3002Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2658L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 3003L<AnyEvent::Debug> (interactive shell, watcher tracing).
3004
3005Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
3006L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
3007L<Qt>, L<POE>, L<FLTK>.
2659 3008
2660Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 3009Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 3010L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 3011L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 3012L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
3013L<AnyEvent::Impl::FLTK>.
2664 3014
2665Non-blocking file handles, sockets, TCP clients and 3015Non-blocking handles, pipes, stream sockets, TCP clients and
2666servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 3016servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
3017
3018Asynchronous File I/O: L<AnyEvent::IO>.
2667 3019
2668Asynchronous DNS: L<AnyEvent::DNS>. 3020Asynchronous DNS: L<AnyEvent::DNS>.
2669 3021
2670Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 3022Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2671 3023
2674 3026
2675 3027
2676=head1 AUTHOR 3028=head1 AUTHOR
2677 3029
2678 Marc Lehmann <schmorp@schmorp.de> 3030 Marc Lehmann <schmorp@schmorp.de>
2679 http://home.schmorp.de/ 3031 http://anyevent.schmorp.de
2680 3032
2681=cut 3033=cut
2682 3034
26831 30351
2684 3036

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines