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.345 by root, Fri Dec 31 04:50:44 2010 UTC vs.
Revision 1.367 by root, Wed Aug 17 02:14:17 2011 UTC

… …
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
… …
482thing in an AnyEvent program, you I<have> to create at least one 482thing in an AnyEvent program, you I<have> to create at least one
483watcher before you C<fork> the child (alternatively, you can call 483watcher before you C<fork> the child (alternatively, you can call
484C<AnyEvent::detect>). 484C<AnyEvent::detect>).
485 485
486As most event loops do not support waiting for child events, they will be 486As 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 487emulated by AnyEvent in most cases, in which case the latency and race
488mentioned in the description of signal watchers apply. 488problems mentioned in the description of signal watchers apply.
489 489
490Example: fork a process and wait for it 490Example: fork a process and wait for it
491 491
492 my $done = AnyEvent->condvar; 492 my $done = AnyEvent->condvar;
493 493
… …
860use. If EV is not installed, then AnyEvent will fall back to its own 860use. If EV is not installed, then AnyEvent will fall back to its own
861pure-perl implementation, which is available everywhere as it comes with 861pure-perl implementation, which is available everywhere as it comes with
862AnyEvent itself. 862AnyEvent itself.
863 863
864 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 864 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 865 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866 866
867=item Backends that are transparently being picked up when they are used. 867=item Backends that are transparently being picked up when they are used.
868 868
869These will be used if they are already loaded when the first watcher 869These 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 870is created, in which case it is assumed that the application is using
… …
878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879 AnyEvent::Impl::POE based on POE, very slow, some limitations. 879 AnyEvent::Impl::POE based on POE, very slow, some limitations.
880 AnyEvent::Impl::Irssi used when running within irssi. 880 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async. 881 AnyEvent::Impl::IOAsync based on IO::Async.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. 882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
883 884
884=item Backends with special needs. 885=item Backends with special needs.
885 886
886Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
887otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
… …
932 933
933Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
934if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
935have created an AnyEvent watcher anyway, that is, as late as possible at 936have created an AnyEvent watcher anyway, that is, as late as possible at
936runtime, and not e.g. during initialisation of your module. 937runtime, and not e.g. during initialisation of your module.
938
939The effect of calling this function is as if a watcher had been created
940(specifically, actions that happen "when the first watcher is created"
941happen when calling detetc as well).
937 942
938If you need to do some initialisation before AnyEvent watchers are 943If you need to do some initialisation before AnyEvent watchers are
939created, use C<post_detect>. 944created, use C<post_detect>.
940 945
941=item $guard = AnyEvent::post_detect { BLOCK } 946=item $guard = AnyEvent::post_detect { BLOCK }
… …
1004 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1009 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1005 # as soon as it is 1010 # as soon as it is
1006 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1011 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1007 } 1012 }
1008 1013
1014=item AnyEvent::postpone { BLOCK }
1015
1016Arranges for the block to be executed as soon as possible, but not before
1017the call itself returns. In practise, the block will be executed just
1018before the event loop polls for new events, or shortly afterwards.
1019
1020This function never returns anything (to make the C<return postpone { ...
1021}> idiom more useful.
1022
1023To understand the usefulness of this function, consider a function that
1024asynchronously does something for you and returns some transaction
1025object or guard to let you cancel the operation. For example,
1026C<AnyEvent::Socket::tcp_connect>:
1027
1028 # start a conenction attempt unless one is active
1029 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
1030 delete $self->{connect_guard};
1031 ...
1032 };
1033
1034Imagine that this function could instantly call the callback, for
1035example, because it detects an obvious error such as a negative port
1036number. Invoking the callback before the function returns causes problems
1037however: the callback will be called and will try to delete the guard
1038object. But since the function hasn't returned yet, there is nothing to
1039delete. When the function eventually returns it will assign the guard
1040object to C<< $self->{connect_guard} >>, where it will likely never be
1041deleted, so the program thinks it is still trying to connect.
1042
1043This is where C<AnyEvent::postpone> should be used. Instead of calling the
1044callback directly on error:
1045
1046 $cb->(undef), return # signal error to callback, BAD!
1047 if $some_error_condition;
1048
1049It should use C<postpone>:
1050
1051 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1052 if $some_error_condition;
1053
1054=item AnyEvent::log $level, $msg[, @args]
1055
1056Log the given C<$msg> at the given C<$level>.
1057
1058Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> -
1059consequently, look at the L<AnyEvent::Log> documentation for details.
1060
1061If you want to sprinkle loads of logging calls around your code, consider
1062creating a logger callback with the C<AnyEvent::Log::logger< function.
1063
1009=back 1064=back
1010 1065
1011=head1 WHAT TO DO IN A MODULE 1066=head1 WHAT TO DO IN A MODULE
1012 1067
1013As a module author, you should C<use AnyEvent> and call AnyEvent methods 1068As a module author, you should C<use AnyEvent> and call AnyEvent methods
… …
1046modules might create watchers when they are loaded, and AnyEvent will 1101modules 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 1102decide 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. 1103might choose the wrong one unless you load the correct one yourself.
1049 1104
1050You can chose to use a pure-perl implementation by loading the 1105You can chose to use a pure-perl implementation by loading the
1051C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1106C<AnyEvent::Loop> module, which gives you similar behaviour
1052everywhere, but letting AnyEvent chose the model is generally better. 1107everywhere, but letting AnyEvent chose the model is generally better.
1053 1108
1054=head2 MAINLOOP EMULATION 1109=head2 MAINLOOP EMULATION
1055 1110
1056Sometimes (often for short test scripts, or even standalone programs who 1111Sometimes (often for short test scripts, or even standalone programs who
… …
1151 1206
1152package AnyEvent; 1207package AnyEvent;
1153 1208
1154# basically a tuned-down version of common::sense 1209# basically a tuned-down version of common::sense
1155sub common_sense { 1210sub common_sense {
1156 # from common:.sense 3.3 1211 # from common:.sense 3.4
1157 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00"; 1212 ${^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) 1213 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1159 $^H |= 0x00000600; 1214 $^H |= 0x00000600;
1160} 1215}
1161 1216
1162BEGIN { AnyEvent::common_sense } 1217BEGIN { AnyEvent::common_sense }
1163 1218
1164use Carp (); 1219use Carp ();
1165 1220
1166our $VERSION = '5.3'; 1221our $VERSION = '6.01';
1167our $MODEL; 1222our $MODEL;
1168 1223
1169our $AUTOLOAD;
1170our @ISA; 1224our @ISA;
1171 1225
1172our @REGISTRY; 1226our @REGISTRY;
1173 1227
1174our $VERBOSE; 1228our $VERBOSE;
… …
1180 1234
1181 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1235 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1182 if ${^TAINT}; 1236 if ${^TAINT};
1183 1237
1184 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1238 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1185
1186} 1239}
1187 1240
1188our $MAX_SIGNAL_LATENCY = 10; 1241our $MAX_SIGNAL_LATENCY = 10;
1189 1242
1190our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1243our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
… …
1194 $PROTOCOL{$_} = ++$idx 1247 $PROTOCOL{$_} = ++$idx
1195 for reverse split /\s*,\s*/, 1248 for reverse split /\s*,\s*/,
1196 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1249 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1197} 1250}
1198 1251
1252our @post_detect;
1253
1254sub post_detect(&) {
1255 my ($cb) = @_;
1256
1257 push @post_detect, $cb;
1258
1259 defined wantarray
1260 ? bless \$cb, "AnyEvent::Util::postdetect"
1261 : ()
1262}
1263
1264sub AnyEvent::Util::postdetect::DESTROY {
1265 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1266}
1267
1268our $POSTPONE_W;
1269our @POSTPONE;
1270
1271sub _postpone_exec {
1272 undef $POSTPONE_W;
1273
1274 &{ shift @POSTPONE }
1275 while @POSTPONE;
1276}
1277
1278sub postpone(&) {
1279 push @POSTPONE, shift;
1280
1281 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1282
1283 ()
1284}
1285
1286sub log($$;@) {
1287 require AnyEvent::Log;
1288 # AnyEvent::Log overwrites this function
1289 goto &log;
1290}
1291
1199my @models = ( 1292our @models = (
1200 [EV:: => AnyEvent::Impl::EV:: , 1], 1293 [EV:: => AnyEvent::Impl::EV:: , 1],
1201 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1294 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1202 # everything below here will not (normally) be autoprobed 1295 # everything below here will not (normally) be autoprobed
1203 # as the pureperl backend should work everywhere 1296 # as the pure perl backend should work everywhere
1204 # and is usually faster 1297 # and is usually faster
1205 [Event:: => AnyEvent::Impl::Event::, 1], 1298 [Event:: => AnyEvent::Impl::Event::, 1],
1206 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1299 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1207 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1300 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1208 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1301 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1209 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1302 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1210 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1303 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1211 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1304 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1212 [Wx:: => AnyEvent::Impl::POE::], 1305 [Wx:: => AnyEvent::Impl::POE::],
1213 [Prima:: => AnyEvent::Impl::POE::], 1306 [Prima:: => AnyEvent::Impl::POE::],
1214 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1307 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1215 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1308 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1309 [FLTK:: => AnyEvent::Impl::FLTK2::],
1216); 1310);
1217 1311
1218our %method = map +($_ => 1), 1312our @isa_hook;
1313
1314sub _isa_set {
1315 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1316
1317 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1318 for 1 .. $#pkg;
1319
1320 grep $_ && $_->[1], @isa_hook
1321 and AE::_reset ();
1322}
1323
1324# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1325sub _isa_hook($$;$) {
1326 my ($i, $pkg, $reset_ae) = @_;
1327
1328 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1329
1330 _isa_set;
1331}
1332
1333# all autoloaded methods reserve the complete glob, not just the method slot.
1334# due to bugs in perls method cache implementation.
1219 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1335our @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 1336
1237sub detect() { 1337sub detect() {
1338 return $MODEL if $MODEL; # some programs keep references to detect
1339
1340 local $!; # for good measure
1341 local $SIG{__DIE__}; # we use eval
1342
1238 # free some memory 1343 # free some memory
1239 *detect = sub () { $MODEL }; 1344 *detect = sub () { $MODEL };
1345 # undef &func doesn't correctly update the method cache. grmbl.
1346 # so we delete the whole glob. grmbl.
1347 # otoh, perl doesn't let me undef an active usb, but it lets me free
1348 # a glob with an active sub. hrm. i hope it works, but perl is
1349 # usually buggy in this department. sigh.
1350 delete @{"AnyEvent::"}{@methods};
1351 undef @methods;
1240 1352
1241 local $!; # for good measure
1242 local $SIG{__DIE__};
1243
1244 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1353 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1245 my $model = "AnyEvent::Impl::$1"; 1354 my $model = $1;
1355 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1246 if (eval "require $model") { 1356 if (eval "require $model") {
1247 $MODEL = $model; 1357 $MODEL = $model;
1248 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1358 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
1359 if $VERBOSE >= 7;
1249 } else { 1360 } else {
1250 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1361 AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1251 } 1362 }
1252 } 1363 }
1253 1364
1254 # check for already loaded models 1365 # check for already loaded models
1255 unless ($MODEL) { 1366 unless ($MODEL) {
1256 for (@REGISTRY, @models) { 1367 for (@REGISTRY, @models) {
1257 my ($package, $model) = @$_; 1368 my ($package, $model) = @$_;
1258 if (${"$package\::VERSION"} > 0) { 1369 if (${"$package\::VERSION"} > 0) {
1259 if (eval "require $model") { 1370 if (eval "require $model") {
1260 $MODEL = $model; 1371 $MODEL = $model;
1261 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1372 AnyEvent::log 7 => "autodetected model '$model', using it."
1373 if $VERBOSE >= 7;
1262 last; 1374 last;
1263 } 1375 }
1264 } 1376 }
1265 } 1377 }
1266 1378
… …
1273 and eval "require $package" 1385 and eval "require $package"
1274 and ${"$package\::VERSION"} > 0 1386 and ${"$package\::VERSION"} > 0
1275 and eval "require $model" 1387 and eval "require $model"
1276 ) { 1388 ) {
1277 $MODEL = $model; 1389 $MODEL = $model;
1278 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; 1390 AnyEvent::log 7 => "autoloaded model '$model', using it."
1391 if $VERBOSE >= 7;
1279 last; 1392 last;
1280 } 1393 }
1281 } 1394 }
1282 1395
1283 $MODEL 1396 $MODEL
1284 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1397 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1285 } 1398 }
1286 } 1399 }
1287 1400
1288 @models = (); # free probe data 1401 # free memory only needed for probing
1402 undef @models;
1403 undef @REGISTRY;
1289 1404
1290 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1405 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1291 unshift @ISA, $MODEL;
1292 1406
1293 # now nuke some methods that are overridden by the backend. 1407 # now nuke some methods that are overridden by the backend.
1294 # SUPER is not allowed. 1408 # SUPER usage is not allowed in these.
1295 for (qw(time signal child idle)) { 1409 for (qw(time signal child idle)) {
1296 undef &{"AnyEvent::Base::$_"} 1410 undef &{"AnyEvent::Base::$_"}
1297 if defined &{"$MODEL\::$_"}; 1411 if defined &{"$MODEL\::$_"};
1298 } 1412 }
1299 1413
1414 _isa_set;
1415
1416 # we're officially open!
1417
1300 if ($ENV{PERL_ANYEVENT_STRICT}) { 1418 if ($ENV{PERL_ANYEVENT_STRICT}) {
1301 eval { require AnyEvent::Strict }; 1419 require AnyEvent::Strict;
1302 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1303 if $@ && $VERBOSE;
1304 } 1420 }
1305 1421
1422 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1423 require AnyEvent::Debug;
1424 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1425 }
1426
1427 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1428 require AnyEvent::Socket;
1429 require AnyEvent::Debug;
1430
1431 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1432 $shell =~ s/\$\$/$$/g;
1433
1434 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1435 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1436 }
1437
1438 # now the anyevent environment is set up as the user told us to, so
1439 # call the actual user code - post detects
1440
1306 (shift @post_detect)->() while @post_detect; 1441 (shift @post_detect)->() while @post_detect;
1442 undef @post_detect;
1307 1443
1308 *post_detect = sub(&) { 1444 *post_detect = sub(&) {
1309 shift->(); 1445 shift->();
1310 1446
1311 undef 1447 undef
1312 }; 1448 };
1313 1449
1314 $MODEL 1450 $MODEL
1315} 1451}
1316 1452
1317sub AUTOLOAD { 1453for my $name (@methods) {
1318 (my $func = $AUTOLOAD) =~ s/.*://; 1454 *$name = sub {
1319
1320 $method{$func}
1321 or Carp::croak "$func: not a valid AnyEvent class method";
1322
1323 detect; 1455 detect;
1324 1456 # we use goto because
1325 my $class = shift; 1457 # a) it makes the thunk more transparent
1326 $class->$func (@_); 1458 # b) it allows us to delete the thunk later
1459 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1460 };
1327} 1461}
1328 1462
1329# utility function to dup a filehandle. this is used by many backends 1463# utility function to dup a filehandle. this is used by many backends
1330# to support binding more than one watcher per filehandle (they usually 1464# 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). 1465# allow only one watcher per fd, so we dup it to get a different one).
… …
1355 1489
1356package AE; 1490package AE;
1357 1491
1358our $VERSION = $AnyEvent::VERSION; 1492our $VERSION = $AnyEvent::VERSION;
1359 1493
1494sub _reset() {
1495 eval q{
1360# fall back to the main API by default - backends and AnyEvent::Base 1496 # fall back to the main API by default - backends and AnyEvent::Base
1361# implementations can overwrite these. 1497 # implementations can overwrite these.
1362 1498
1363sub io($$$) { 1499 sub io($$$) {
1364 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1500 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1365} 1501 }
1366 1502
1367sub timer($$$) { 1503 sub timer($$$) {
1368 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1504 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1369} 1505 }
1370 1506
1371sub signal($$) { 1507 sub signal($$) {
1372 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1508 AnyEvent->signal (signal => $_[0], cb => $_[1])
1373} 1509 }
1374 1510
1375sub child($$) { 1511 sub child($$) {
1376 AnyEvent->child (pid => $_[0], cb => $_[1]) 1512 AnyEvent->child (pid => $_[0], cb => $_[1])
1377} 1513 }
1378 1514
1379sub idle($) { 1515 sub idle($) {
1380 AnyEvent->idle (cb => $_[0]) 1516 AnyEvent->idle (cb => $_[0]);
1381} 1517 }
1382 1518
1383sub cv(;&) { 1519 sub cv(;&) {
1384 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1520 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1385} 1521 }
1386 1522
1387sub now() { 1523 sub now() {
1388 AnyEvent->now 1524 AnyEvent->now
1389} 1525 }
1390 1526
1391sub now_update() { 1527 sub now_update() {
1392 AnyEvent->now_update 1528 AnyEvent->now_update
1393} 1529 }
1394 1530
1395sub time() { 1531 sub time() {
1396 AnyEvent->time 1532 AnyEvent->time
1533 }
1534
1535 *postpone = \&AnyEvent::postpone;
1536 *log = \&AnyEvent::log;
1537 };
1538 die if $@;
1397} 1539}
1540
1541BEGIN { _reset }
1398 1542
1399package AnyEvent::Base; 1543package AnyEvent::Base;
1400 1544
1401# default implementations for many methods 1545# default implementations for many methods
1402 1546
1403sub time { 1547sub time {
1404 eval q{ # poor man's autoloading {} 1548 eval q{ # poor man's autoloading {}
1405 # probe for availability of Time::HiRes 1549 # probe for availability of Time::HiRes
1406 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1550 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1407 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1551 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
1552 if $AnyEvent::VERBOSE >= 8;
1553 *time = sub { Time::HiRes::time () };
1408 *AE::time = \&Time::HiRes::time; 1554 *AE::time = \& Time::HiRes::time ;
1409 # if (eval "use POSIX (); (POSIX::times())... 1555 # if (eval "use POSIX (); (POSIX::times())...
1410 } else { 1556 } else {
1411 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1557 AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
1558 *time = sub { CORE::time };
1412 *AE::time = sub (){ time }; # epic fail 1559 *AE::time = sub (){ CORE::time };
1413 } 1560 }
1414 1561
1415 *time = sub { AE::time }; # different prototypes 1562 *now = \&time;
1416 }; 1563 };
1417 die if $@; 1564 die if $@;
1418 1565
1419 &time 1566 &time
1420} 1567}
1421 1568
1422*now = \&time; 1569*now = \&time;
1423
1424sub now_update { } 1570sub now_update { }
1425 1571
1572sub _poll {
1573 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1574}
1575
1426# default implementation for ->condvar 1576# default implementation for ->condvar
1577# in fact, the default should not be overwritten
1427 1578
1428sub condvar { 1579sub condvar {
1429 eval q{ # poor man's autoloading {} 1580 eval q{ # poor man's autoloading {}
1430 *condvar = sub { 1581 *condvar = sub {
1431 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1582 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
… …
1509 1660
1510sub signal { 1661sub signal {
1511 eval q{ # poor man's autoloading {} 1662 eval q{ # poor man's autoloading {}
1512 # probe for availability of Async::Interrupt 1663 # probe for availability of Async::Interrupt
1513 if (_have_async_interrupt) { 1664 if (_have_async_interrupt) {
1514 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1665 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
1666 if $AnyEvent::VERBOSE >= 8;
1515 1667
1516 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1668 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1517 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1669 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1518 1670
1519 } else { 1671 } else {
1520 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1672 AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
1673 if $AnyEvent::VERBOSE >= 8;
1521 1674
1522 if (AnyEvent::WIN32) { 1675 if (AnyEvent::WIN32) {
1523 require AnyEvent::Util; 1676 require AnyEvent::Util;
1524 1677
1525 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1678 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
… …
1601 : sysread $SIGPIPE_R, (my $dummy), 9; 1754 : sysread $SIGPIPE_R, (my $dummy), 9;
1602 1755
1603 while (%SIG_EV) { 1756 while (%SIG_EV) {
1604 for (keys %SIG_EV) { 1757 for (keys %SIG_EV) {
1605 delete $SIG_EV{$_}; 1758 delete $SIG_EV{$_};
1606 $_->() for values %{ $SIG_CB{$_} || {} }; 1759 &$_ for values %{ $SIG_CB{$_} || {} };
1607 } 1760 }
1608 } 1761 }
1609 }; 1762 };
1610 }; 1763 };
1611 die if $@; 1764 die if $@;
… …
1638 }; 1791 };
1639 1792
1640 *child = sub { 1793 *child = sub {
1641 my (undef, %arg) = @_; 1794 my (undef, %arg) = @_;
1642 1795
1643 defined (my $pid = $arg{pid} + 0) 1796 my $pid = $arg{pid};
1644 or Carp::croak "required option 'pid' is missing"; 1797 my $cb = $arg{cb};
1645 1798
1646 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1799 $PID_CB{$pid}{$cb+0} = $cb;
1647 1800
1648 unless ($CHLD_W) { 1801 unless ($CHLD_W) {
1649 $CHLD_W = AE::signal CHLD => \&_sigchld; 1802 $CHLD_W = AE::signal CHLD => \&_sigchld;
1650 # child could be a zombie already, so make at least one round 1803 # child could be a zombie already, so make at least one round
1651 &_sigchld; 1804 &_sigchld;
1652 } 1805 }
1653 1806
1654 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1807 bless [$pid, $cb+0], "AnyEvent::Base::child"
1655 }; 1808 };
1656 1809
1657 *AnyEvent::Base::child::DESTROY = sub { 1810 *AnyEvent::Base::child::DESTROY = sub {
1658 my ($pid, $cb) = @{$_[0]}; 1811 my ($pid, $icb) = @{$_[0]};
1659 1812
1660 delete $PID_CB{$pid}{$cb}; 1813 delete $PID_CB{$pid}{$icb};
1661 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1814 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1662 1815
1663 undef $CHLD_W unless keys %PID_CB; 1816 undef $CHLD_W unless keys %PID_CB;
1664 }; 1817 };
1665 }; 1818 };
… …
1678 1831
1679 my ($cb, $w, $rcb) = $arg{cb}; 1832 my ($cb, $w, $rcb) = $arg{cb};
1680 1833
1681 $rcb = sub { 1834 $rcb = sub {
1682 if ($cb) { 1835 if ($cb) {
1683 $w = _time; 1836 $w = AE::time;
1684 &$cb; 1837 &$cb;
1685 $w = _time - $w; 1838 $w = AE::time - $w;
1686 1839
1687 # never use more then 50% of the time for the idle watcher, 1840 # never use more then 50% of the time for the idle watcher,
1688 # within some limits 1841 # within some limits
1689 $w = 0.0001 if $w < 0.0001; 1842 $w = 0.0001 if $w < 0.0001;
1690 $w = 5 if $w > 5; 1843 $w = 5 if $w > 5;
… …
1737 1890
1738sub _send { 1891sub _send {
1739 # nop 1892 # nop
1740} 1893}
1741 1894
1895sub _wait {
1896 AnyEvent->_poll until $_[0]{_ae_sent};
1897}
1898
1742sub send { 1899sub send {
1743 my $cv = shift; 1900 my $cv = shift;
1744 $cv->{_ae_sent} = [@_]; 1901 $cv->{_ae_sent} = [@_];
1745 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1902 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1746 $cv->_send; 1903 $cv->_send;
… …
1753 1910
1754sub ready { 1911sub ready {
1755 $_[0]{_ae_sent} 1912 $_[0]{_ae_sent}
1756} 1913}
1757 1914
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 { 1915sub recv {
1916 unless ($_[0]{_ae_sent}) {
1917 $WAITING
1918 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1919
1920 local $WAITING = 1;
1768 $_[0]->_wait; 1921 $_[0]->_wait;
1922 }
1769 1923
1770 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1924 $_[0]{_ae_croak}
1771 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1925 and Carp::croak $_[0]{_ae_croak};
1926
1927 wantarray
1928 ? @{ $_[0]{_ae_sent} }
1929 : $_[0]{_ae_sent}[0]
1772} 1930}
1773 1931
1774sub cb { 1932sub cb {
1775 my $cv = shift; 1933 my $cv = shift;
1776 1934
… …
1792 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1950 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1793} 1951}
1794 1952
1795# undocumented/compatibility with pre-3.4 1953# undocumented/compatibility with pre-3.4
1796*broadcast = \&send; 1954*broadcast = \&send;
1797*wait = \&_wait; 1955*wait = \&recv;
1798 1956
1799=head1 ERROR AND EXCEPTION HANDLING 1957=head1 ERROR AND EXCEPTION HANDLING
1800 1958
1801In general, AnyEvent does not do any error handling - it relies on the 1959In 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 1960caller to do that if required. The L<AnyEvent::Strict> module (see also
… …
1829 1987
1830By default, AnyEvent will be completely silent except in fatal 1988By default, AnyEvent will be completely silent except in fatal
1831conditions. You can set this environment variable to make AnyEvent more 1989conditions. You can set this environment variable to make AnyEvent more
1832talkative. 1990talkative.
1833 1991
1834When set to C<1> or higher, causes AnyEvent to warn about unexpected 1992When set to C<5> or higher, causes AnyEvent to warn about unexpected
1835conditions, such as not being able to load the event model specified by 1993conditions, such as not being able to load the event model specified by
1836C<PERL_ANYEVENT_MODEL>. 1994C<PERL_ANYEVENT_MODEL>.
1837 1995
1838When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1996When set to C<7> or higher, cause AnyEvent to report to STDERR which event
1839model it chooses. 1997model it chooses.
1840 1998
1841When set to C<8> or higher, then AnyEvent will report extra information on 1999When set to C<8> or higher, then AnyEvent will report extra information on
1842which optional modules it loads and how it implements certain features. 2000which optional modules it loads and how it implements certain features.
1843 2001
… …
1854Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2012Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1855>>, it is definitely recommended to keep it off in production. Keeping 2013>>, it is definitely recommended to keep it off in production. Keeping
1856C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2014C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1857can be very useful, however. 2015can be very useful, however.
1858 2016
2017=item C<PERL_ANYEVENT_DEBUG_SHELL>
2018
2019If this env variable is set, then its contents will be interpreted by
2020C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
2021C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
2022that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
2023
2024This takes place when the first watcher is created.
2025
2026For example, to bind a debug shell on a unix domain socket in
2027F<< /tmp/debug<pid>.sock >>, you could use this:
2028
2029 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2030
2031Note that creating sockets in F</tmp> is very unsafe on multiuser
2032systems.
2033
2034=item C<PERL_ANYEVENT_DEBUG_WRAP>
2035
2036Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2037debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2038
1859=item C<PERL_ANYEVENT_MODEL> 2039=item C<PERL_ANYEVENT_MODEL>
1860 2040
1861This can be used to specify the event model to be used by AnyEvent, before 2041This 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 2042auto detection and -probing kicks in.
1863entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2043
2044It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2045or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1864and the resulting module name is loaded and if the load was successful, 2046resulting 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 2047event model backend. If it fails to load then AnyEvent will proceed with
1866auto detection and -probing. 2048auto detection and -probing.
1867 2049
1868This functionality might change in future versions. 2050If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2051nothing gets prepended and the module name is used as-is (hint: C<::> at
2052the end of a string designates a module name and quotes it appropriately).
1869 2053
1870For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2054For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1871could start your program like this: 2055could start your program like this:
1872 2056
1873 PERL_ANYEVENT_MODEL=Perl perl ... 2057 PERL_ANYEVENT_MODEL=Perl perl ...
1874 2058
1875=item C<PERL_ANYEVENT_PROTOCOLS> 2059=item C<PERL_ANYEVENT_PROTOCOLS>
… …
2265(even when used without AnyEvent), but most event loops have acceptable 2449(even when used without AnyEvent), but most event loops have acceptable
2266performance with or without AnyEvent. 2450performance with or without AnyEvent.
2267 2451
2268=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2452=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 2453the actual event loop, only with extremely fast event loops such as EV
2270adds AnyEvent significant overhead. 2454does AnyEvent add significant overhead.
2271 2455
2272=item * You should avoid POE like the plague if you want performance or 2456=item * You should avoid POE like the plague if you want performance or
2273reasonable memory usage. 2457reasonable memory usage.
2274 2458
2275=back 2459=back
… …
2574 2758
2575=item L<Time::HiRes> 2759=item L<Time::HiRes>
2576 2760
2577This module is part of perl since release 5.008. It will be used when the 2761This 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 2762chosen 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 2763pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2580try to use a monotonic clock for timing stability. 2764try to use a monotonic clock for timing stability.
2581 2765
2582=back 2766=back
2583 2767
2584 2768
… …
2650 2834
2651Tutorial/Introduction: L<AnyEvent::Intro>. 2835Tutorial/Introduction: L<AnyEvent::Intro>.
2652 2836
2653FAQ: L<AnyEvent::FAQ>. 2837FAQ: L<AnyEvent::FAQ>.
2654 2838
2655Utility functions: L<AnyEvent::Util>. 2839Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2840(simply logging).
2656 2841
2657Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2842Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2658L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2843L<AnyEvent::Debug> (interactive shell, watcher tracing).
2844
2845Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2846L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2847L<Qt>, L<POE>, L<FLTK>.
2659 2848
2660Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2849Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2850L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2851L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2852L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2853L<AnyEvent::Impl::FLTK>.
2664 2854
2665Non-blocking file handles, sockets, TCP clients and 2855Non-blocking handles, pipes, stream sockets, TCP clients and
2666servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2856servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2667 2857
2668Asynchronous DNS: L<AnyEvent::DNS>. 2858Asynchronous DNS: L<AnyEvent::DNS>.
2669 2859
2670Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 2860Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines