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.349 by root, Mon Jul 4 21:14:42 2011 UTC vs.
Revision 1.366 by root, Wed Aug 17 02:02:38 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::FLTK based on FLTK. 883 AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
884 884
885=item Backends with special needs. 885=item Backends with special needs.
886 886
887Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
888otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
… …
933 933
934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
935if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
936have 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
937runtime, 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).
938 942
939If you need to do some initialisation before AnyEvent watchers are 943If you need to do some initialisation before AnyEvent watchers are
940created, use C<post_detect>. 944created, use C<post_detect>.
941 945
942=item $guard = AnyEvent::post_detect { BLOCK } 946=item $guard = AnyEvent::post_detect { BLOCK }
… …
1005 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1009 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1006 # as soon as it is 1010 # as soon as it is
1007 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1011 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1008 } 1012 }
1009 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
1010=back 1061=back
1011 1062
1012=head1 WHAT TO DO IN A MODULE 1063=head1 WHAT TO DO IN A MODULE
1013 1064
1014As a module author, you should C<use AnyEvent> and call AnyEvent methods 1065As a module author, you should C<use AnyEvent> and call AnyEvent methods
… …
1047modules might create watchers when they are loaded, and AnyEvent will 1098modules might create watchers when they are loaded, and AnyEvent will
1048decide on the event model to use as soon as it creates watchers, and it 1099decide on the event model to use as soon as it creates watchers, and it
1049might choose the wrong one unless you load the correct one yourself. 1100might choose the wrong one unless you load the correct one yourself.
1050 1101
1051You can chose to use a pure-perl implementation by loading the 1102You can chose to use a pure-perl implementation by loading the
1052C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1103C<AnyEvent::Loop> module, which gives you similar behaviour
1053everywhere, but letting AnyEvent chose the model is generally better. 1104everywhere, but letting AnyEvent chose the model is generally better.
1054 1105
1055=head2 MAINLOOP EMULATION 1106=head2 MAINLOOP EMULATION
1056 1107
1057Sometimes (often for short test scripts, or even standalone programs who 1108Sometimes (often for short test scripts, or even standalone programs who
… …
1162 1213
1163BEGIN { AnyEvent::common_sense } 1214BEGIN { AnyEvent::common_sense }
1164 1215
1165use Carp (); 1216use Carp ();
1166 1217
1167our $VERSION = '5.34'; 1218our $VERSION = '6.01';
1168our $MODEL; 1219our $MODEL;
1169 1220
1170our $AUTOLOAD;
1171our @ISA; 1221our @ISA;
1172 1222
1173our @REGISTRY; 1223our @REGISTRY;
1174 1224
1175our $VERBOSE; 1225our $VERBOSE;
… …
1181 1231
1182 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1232 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1183 if ${^TAINT}; 1233 if ${^TAINT};
1184 1234
1185 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1235 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1186
1187} 1236}
1188 1237
1189our $MAX_SIGNAL_LATENCY = 10; 1238our $MAX_SIGNAL_LATENCY = 10;
1190 1239
1191our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1240our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
… …
1195 $PROTOCOL{$_} = ++$idx 1244 $PROTOCOL{$_} = ++$idx
1196 for reverse split /\s*,\s*/, 1245 for reverse split /\s*,\s*/,
1197 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1246 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1198} 1247}
1199 1248
1249our @post_detect;
1250
1251sub post_detect(&) {
1252 my ($cb) = @_;
1253
1254 push @post_detect, $cb;
1255
1256 defined wantarray
1257 ? bless \$cb, "AnyEvent::Util::postdetect"
1258 : ()
1259}
1260
1261sub AnyEvent::Util::postdetect::DESTROY {
1262 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1263}
1264
1265our $POSTPONE_W;
1266our @POSTPONE;
1267
1268sub _postpone_exec {
1269 undef $POSTPONE_W;
1270
1271 &{ shift @POSTPONE }
1272 while @POSTPONE;
1273}
1274
1275sub postpone(&) {
1276 push @POSTPONE, shift;
1277
1278 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1279
1280 ()
1281}
1282
1283sub log($$;@) {
1284 require AnyEvent::Log;
1285 # AnyEvent::Log overwrites this function
1286 goto &log;
1287}
1288
1200my @models = ( 1289our @models = (
1201 [EV:: => AnyEvent::Impl::EV:: , 1], 1290 [EV:: => AnyEvent::Impl::EV:: , 1],
1202 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1291 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1203 # everything below here will not (normally) be autoprobed 1292 # everything below here will not (normally) be autoprobed
1204 # as the pureperl backend should work everywhere 1293 # as the pure perl backend should work everywhere
1205 # and is usually faster 1294 # and is usually faster
1206 [Event:: => AnyEvent::Impl::Event::, 1], 1295 [Event:: => AnyEvent::Impl::Event::, 1],
1207 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1296 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1208 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1297 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1209 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1298 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1210 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1299 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1211 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1300 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1212 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1301 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1213 [Wx:: => AnyEvent::Impl::POE::], 1302 [Wx:: => AnyEvent::Impl::POE::],
1214 [Prima:: => AnyEvent::Impl::POE::], 1303 [Prima:: => AnyEvent::Impl::POE::],
1215 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1304 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1216 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1305 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1217 [FLTK:: => AnyEvent::Impl::FLTK::], 1306 [FLTK:: => AnyEvent::Impl::FLTK2::],
1218); 1307);
1219 1308
1220our %method = map +($_ => 1), 1309our @isa_hook;
1310
1311sub _isa_set {
1312 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1313
1314 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1315 for 1 .. $#pkg;
1316
1317 grep $_ && $_->[1], @isa_hook
1318 and AE::_reset ();
1319}
1320
1321# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1322sub _isa_hook($$;$) {
1323 my ($i, $pkg, $reset_ae) = @_;
1324
1325 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1326
1327 _isa_set;
1328}
1329
1330# all autoloaded methods reserve the complete glob, not just the method slot.
1331# due to bugs in perls method cache implementation.
1221 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1332our @methods = qw(io timer time now now_update signal child idle condvar);
1222
1223our @post_detect;
1224
1225sub post_detect(&) {
1226 my ($cb) = @_;
1227
1228 push @post_detect, $cb;
1229
1230 defined wantarray
1231 ? bless \$cb, "AnyEvent::Util::postdetect"
1232 : ()
1233}
1234
1235sub AnyEvent::Util::postdetect::DESTROY {
1236 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1237}
1238 1333
1239sub detect() { 1334sub detect() {
1335 return $MODEL if $MODEL; # some programs keep references to detect
1336
1337 local $!; # for good measure
1338 local $SIG{__DIE__}; # we use eval
1339
1240 # free some memory 1340 # free some memory
1241 *detect = sub () { $MODEL }; 1341 *detect = sub () { $MODEL };
1342 # undef &func doesn't correctly update the method cache. grmbl.
1343 # so we delete the whole glob. grmbl.
1344 # otoh, perl doesn't let me undef an active usb, but it lets me free
1345 # a glob with an active sub. hrm. i hope it works, but perl is
1346 # usually buggy in this department. sigh.
1347 delete @{"AnyEvent::"}{@methods};
1348 undef @methods;
1242 1349
1243 local $!; # for good measure
1244 local $SIG{__DIE__};
1245
1246 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1350 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1247 my $model = "AnyEvent::Impl::$1"; 1351 my $model = $1;
1352 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1248 if (eval "require $model") { 1353 if (eval "require $model") {
1249 $MODEL = $model; 1354 $MODEL = $model;
1250 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1355 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
1356 if $VERBOSE >= 7;
1251 } else { 1357 } else {
1252 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1358 AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1253 } 1359 }
1254 } 1360 }
1255 1361
1256 # check for already loaded models 1362 # check for already loaded models
1257 unless ($MODEL) { 1363 unless ($MODEL) {
1258 for (@REGISTRY, @models) { 1364 for (@REGISTRY, @models) {
1259 my ($package, $model) = @$_; 1365 my ($package, $model) = @$_;
1260 if (${"$package\::VERSION"} > 0) { 1366 if (${"$package\::VERSION"} > 0) {
1261 if (eval "require $model") { 1367 if (eval "require $model") {
1262 $MODEL = $model; 1368 $MODEL = $model;
1263 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1369 AnyEvent::log 7 => "autodetected model '$model', using it."
1370 if $VERBOSE >= 7;
1264 last; 1371 last;
1265 } 1372 }
1266 } 1373 }
1267 } 1374 }
1268 1375
… …
1275 and eval "require $package" 1382 and eval "require $package"
1276 and ${"$package\::VERSION"} > 0 1383 and ${"$package\::VERSION"} > 0
1277 and eval "require $model" 1384 and eval "require $model"
1278 ) { 1385 ) {
1279 $MODEL = $model; 1386 $MODEL = $model;
1280 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; 1387 AnyEvent::log 7 => "autoloaded model '$model', using it."
1388 if $VERBOSE >= 7;
1281 last; 1389 last;
1282 } 1390 }
1283 } 1391 }
1284 1392
1285 $MODEL 1393 $MODEL
1286 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1394 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1287 } 1395 }
1288 } 1396 }
1289 1397
1290 @models = (); # free probe data 1398 # free memory only needed for probing
1399 undef @models;
1400 undef @REGISTRY;
1291 1401
1292 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1402 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1293 unshift @ISA, $MODEL;
1294 1403
1295 # now nuke some methods that are overridden by the backend. 1404 # now nuke some methods that are overridden by the backend.
1296 # SUPER is not allowed. 1405 # SUPER usage is not allowed in these.
1297 for (qw(time signal child idle)) { 1406 for (qw(time signal child idle)) {
1298 undef &{"AnyEvent::Base::$_"} 1407 undef &{"AnyEvent::Base::$_"}
1299 if defined &{"$MODEL\::$_"}; 1408 if defined &{"$MODEL\::$_"};
1300 } 1409 }
1301 1410
1411 _isa_set;
1412
1302 if ($ENV{PERL_ANYEVENT_STRICT}) { 1413 if ($ENV{PERL_ANYEVENT_STRICT}) {
1303 eval { require AnyEvent::Strict }; 1414 require AnyEvent::Strict;
1304 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1305 if $@ && $VERBOSE;
1306 } 1415 }
1307 1416
1417 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1418 require AnyEvent::Debug;
1419 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1420 }
1421
1422 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1423 require AnyEvent::Socket;
1424 require AnyEvent::Debug;
1425
1426 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1427 $shell =~ s/\$\$/$$/g;
1428
1429 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1430 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1431 }
1432
1308 (shift @post_detect)->() while @post_detect; 1433 (shift @post_detect)->() while @post_detect;
1434 undef @post_detect;
1309 1435
1310 *post_detect = sub(&) { 1436 *post_detect = sub(&) {
1311 shift->(); 1437 shift->();
1312 1438
1313 undef 1439 undef
1314 }; 1440 };
1315 1441
1316 $MODEL 1442 $MODEL
1317} 1443}
1318 1444
1319sub AUTOLOAD { 1445for my $name (@methods) {
1320 (my $func = $AUTOLOAD) =~ s/.*://; 1446 *$name = sub {
1321
1322 $method{$func}
1323 or Carp::croak "$func: not a valid AnyEvent class method";
1324
1325 detect; 1447 detect;
1326 1448 # we use goto because
1327 my $class = shift; 1449 # a) it makes the thunk more transparent
1328 $class->$func (@_); 1450 # b) it allows us to delete the thunk later
1451 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1452 };
1329} 1453}
1330 1454
1331# utility function to dup a filehandle. this is used by many backends 1455# utility function to dup a filehandle. this is used by many backends
1332# to support binding more than one watcher per filehandle (they usually 1456# to support binding more than one watcher per filehandle (they usually
1333# allow only one watcher per fd, so we dup it to get a different one). 1457# allow only one watcher per fd, so we dup it to get a different one).
… …
1357 1481
1358package AE; 1482package AE;
1359 1483
1360our $VERSION = $AnyEvent::VERSION; 1484our $VERSION = $AnyEvent::VERSION;
1361 1485
1486sub _reset() {
1487 eval q{
1362# fall back to the main API by default - backends and AnyEvent::Base 1488 # fall back to the main API by default - backends and AnyEvent::Base
1363# implementations can overwrite these. 1489 # implementations can overwrite these.
1364 1490
1365sub io($$$) { 1491 sub io($$$) {
1366 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1492 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1367} 1493 }
1368 1494
1369sub timer($$$) { 1495 sub timer($$$) {
1370 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1496 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1371} 1497 }
1372 1498
1373sub signal($$) { 1499 sub signal($$) {
1374 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1500 AnyEvent->signal (signal => $_[0], cb => $_[1])
1375} 1501 }
1376 1502
1377sub child($$) { 1503 sub child($$) {
1378 AnyEvent->child (pid => $_[0], cb => $_[1]) 1504 AnyEvent->child (pid => $_[0], cb => $_[1])
1379} 1505 }
1380 1506
1381sub idle($) { 1507 sub idle($) {
1382 AnyEvent->idle (cb => $_[0]) 1508 AnyEvent->idle (cb => $_[0]);
1383} 1509 }
1384 1510
1385sub cv(;&) { 1511 sub cv(;&) {
1386 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1512 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1387} 1513 }
1388 1514
1389sub now() { 1515 sub now() {
1390 AnyEvent->now 1516 AnyEvent->now
1391} 1517 }
1392 1518
1393sub now_update() { 1519 sub now_update() {
1394 AnyEvent->now_update 1520 AnyEvent->now_update
1395} 1521 }
1396 1522
1397sub time() { 1523 sub time() {
1398 AnyEvent->time 1524 AnyEvent->time
1525 }
1526
1527 *postpone = \&AnyEvent::postpone;
1528 *log = \&AnyEvent::log;
1529 };
1530 die if $@;
1399} 1531}
1532
1533BEGIN { _reset }
1400 1534
1401package AnyEvent::Base; 1535package AnyEvent::Base;
1402 1536
1403# default implementations for many methods 1537# default implementations for many methods
1404 1538
1405sub time { 1539sub time {
1406 eval q{ # poor man's autoloading {} 1540 eval q{ # poor man's autoloading {}
1407 # probe for availability of Time::HiRes 1541 # probe for availability of Time::HiRes
1408 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1542 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1409 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1543 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
1544 if $AnyEvent::VERBOSE >= 8;
1545 *time = sub { Time::HiRes::time () };
1410 *AE::time = \&Time::HiRes::time; 1546 *AE::time = \& Time::HiRes::time ;
1411 # if (eval "use POSIX (); (POSIX::times())... 1547 # if (eval "use POSIX (); (POSIX::times())...
1412 } else { 1548 } else {
1413 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1549 AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
1550 *time = sub { CORE::time };
1414 *AE::time = sub (){ time }; # epic fail 1551 *AE::time = sub (){ CORE::time };
1415 } 1552 }
1416 1553
1417 *time = sub { AE::time }; # different prototypes 1554 *now = \&time;
1418 }; 1555 };
1419 die if $@; 1556 die if $@;
1420 1557
1421 &time 1558 &time
1422} 1559}
1423 1560
1424*now = \&time; 1561*now = \&time;
1425
1426sub now_update { } 1562sub now_update { }
1427 1563
1564sub _poll {
1565 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1566}
1567
1428# default implementation for ->condvar 1568# default implementation for ->condvar
1569# in fact, the default should not be overwritten
1429 1570
1430sub condvar { 1571sub condvar {
1431 eval q{ # poor man's autoloading {} 1572 eval q{ # poor man's autoloading {}
1432 *condvar = sub { 1573 *condvar = sub {
1433 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1574 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
… …
1511 1652
1512sub signal { 1653sub signal {
1513 eval q{ # poor man's autoloading {} 1654 eval q{ # poor man's autoloading {}
1514 # probe for availability of Async::Interrupt 1655 # probe for availability of Async::Interrupt
1515 if (_have_async_interrupt) { 1656 if (_have_async_interrupt) {
1516 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1657 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
1658 if $AnyEvent::VERBOSE >= 8;
1517 1659
1518 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1660 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1519 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1661 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1520 1662
1521 } else { 1663 } else {
1522 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1664 AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
1665 if $AnyEvent::VERBOSE >= 8;
1523 1666
1524 if (AnyEvent::WIN32) { 1667 if (AnyEvent::WIN32) {
1525 require AnyEvent::Util; 1668 require AnyEvent::Util;
1526 1669
1527 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1670 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
… …
1603 : sysread $SIGPIPE_R, (my $dummy), 9; 1746 : sysread $SIGPIPE_R, (my $dummy), 9;
1604 1747
1605 while (%SIG_EV) { 1748 while (%SIG_EV) {
1606 for (keys %SIG_EV) { 1749 for (keys %SIG_EV) {
1607 delete $SIG_EV{$_}; 1750 delete $SIG_EV{$_};
1608 $_->() for values %{ $SIG_CB{$_} || {} }; 1751 &$_ for values %{ $SIG_CB{$_} || {} };
1609 } 1752 }
1610 } 1753 }
1611 }; 1754 };
1612 }; 1755 };
1613 die if $@; 1756 die if $@;
… …
1640 }; 1783 };
1641 1784
1642 *child = sub { 1785 *child = sub {
1643 my (undef, %arg) = @_; 1786 my (undef, %arg) = @_;
1644 1787
1645 defined (my $pid = $arg{pid} + 0) 1788 my $pid = $arg{pid};
1646 or Carp::croak "required option 'pid' is missing"; 1789 my $cb = $arg{cb};
1647 1790
1648 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1791 $PID_CB{$pid}{$cb+0} = $cb;
1649 1792
1650 unless ($CHLD_W) { 1793 unless ($CHLD_W) {
1651 $CHLD_W = AE::signal CHLD => \&_sigchld; 1794 $CHLD_W = AE::signal CHLD => \&_sigchld;
1652 # child could be a zombie already, so make at least one round 1795 # child could be a zombie already, so make at least one round
1653 &_sigchld; 1796 &_sigchld;
1654 } 1797 }
1655 1798
1656 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1799 bless [$pid, $cb+0], "AnyEvent::Base::child"
1657 }; 1800 };
1658 1801
1659 *AnyEvent::Base::child::DESTROY = sub { 1802 *AnyEvent::Base::child::DESTROY = sub {
1660 my ($pid, $cb) = @{$_[0]}; 1803 my ($pid, $icb) = @{$_[0]};
1661 1804
1662 delete $PID_CB{$pid}{$cb}; 1805 delete $PID_CB{$pid}{$icb};
1663 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1806 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1664 1807
1665 undef $CHLD_W unless keys %PID_CB; 1808 undef $CHLD_W unless keys %PID_CB;
1666 }; 1809 };
1667 }; 1810 };
… …
1680 1823
1681 my ($cb, $w, $rcb) = $arg{cb}; 1824 my ($cb, $w, $rcb) = $arg{cb};
1682 1825
1683 $rcb = sub { 1826 $rcb = sub {
1684 if ($cb) { 1827 if ($cb) {
1685 $w = _time; 1828 $w = AE::time;
1686 &$cb; 1829 &$cb;
1687 $w = _time - $w; 1830 $w = AE::time - $w;
1688 1831
1689 # never use more then 50% of the time for the idle watcher, 1832 # never use more then 50% of the time for the idle watcher,
1690 # within some limits 1833 # within some limits
1691 $w = 0.0001 if $w < 0.0001; 1834 $w = 0.0001 if $w < 0.0001;
1692 $w = 5 if $w > 5; 1835 $w = 5 if $w > 5;
… …
1739 1882
1740sub _send { 1883sub _send {
1741 # nop 1884 # nop
1742} 1885}
1743 1886
1887sub _wait {
1888 AnyEvent->_poll until $_[0]{_ae_sent};
1889}
1890
1744sub send { 1891sub send {
1745 my $cv = shift; 1892 my $cv = shift;
1746 $cv->{_ae_sent} = [@_]; 1893 $cv->{_ae_sent} = [@_];
1747 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1894 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1748 $cv->_send; 1895 $cv->_send;
… …
1755 1902
1756sub ready { 1903sub ready {
1757 $_[0]{_ae_sent} 1904 $_[0]{_ae_sent}
1758} 1905}
1759 1906
1760sub _wait {
1761 $WAITING
1762 and !$_[0]{_ae_sent}
1763 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1764
1765 local $WAITING = 1;
1766 AnyEvent->one_event while !$_[0]{_ae_sent};
1767}
1768
1769sub recv { 1907sub recv {
1908 unless ($_[0]{_ae_sent}) {
1909 $WAITING
1910 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1911
1912 local $WAITING = 1;
1770 $_[0]->_wait; 1913 $_[0]->_wait;
1914 }
1771 1915
1772 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1916 $_[0]{_ae_croak}
1773 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1917 and Carp::croak $_[0]{_ae_croak};
1918
1919 wantarray
1920 ? @{ $_[0]{_ae_sent} }
1921 : $_[0]{_ae_sent}[0]
1774} 1922}
1775 1923
1776sub cb { 1924sub cb {
1777 my $cv = shift; 1925 my $cv = shift;
1778 1926
… …
1794 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1942 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1795} 1943}
1796 1944
1797# undocumented/compatibility with pre-3.4 1945# undocumented/compatibility with pre-3.4
1798*broadcast = \&send; 1946*broadcast = \&send;
1799*wait = \&_wait; 1947*wait = \&recv;
1800 1948
1801=head1 ERROR AND EXCEPTION HANDLING 1949=head1 ERROR AND EXCEPTION HANDLING
1802 1950
1803In general, AnyEvent does not do any error handling - it relies on the 1951In general, AnyEvent does not do any error handling - it relies on the
1804caller to do that if required. The L<AnyEvent::Strict> module (see also 1952caller to do that if required. The L<AnyEvent::Strict> module (see also
… …
1831 1979
1832By default, AnyEvent will be completely silent except in fatal 1980By default, AnyEvent will be completely silent except in fatal
1833conditions. You can set this environment variable to make AnyEvent more 1981conditions. You can set this environment variable to make AnyEvent more
1834talkative. 1982talkative.
1835 1983
1836When set to C<1> or higher, causes AnyEvent to warn about unexpected 1984When set to C<5> or higher, causes AnyEvent to warn about unexpected
1837conditions, such as not being able to load the event model specified by 1985conditions, such as not being able to load the event model specified by
1838C<PERL_ANYEVENT_MODEL>. 1986C<PERL_ANYEVENT_MODEL>.
1839 1987
1840When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1988When set to C<7> or higher, cause AnyEvent to report to STDERR which event
1841model it chooses. 1989model it chooses.
1842 1990
1843When set to C<8> or higher, then AnyEvent will report extra information on 1991When set to C<8> or higher, then AnyEvent will report extra information on
1844which optional modules it loads and how it implements certain features. 1992which optional modules it loads and how it implements certain features.
1845 1993
… …
1856Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2004Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1857>>, it is definitely recommended to keep it off in production. Keeping 2005>>, it is definitely recommended to keep it off in production. Keeping
1858C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2006C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1859can be very useful, however. 2007can be very useful, however.
1860 2008
2009=item C<PERL_ANYEVENT_DEBUG_SHELL>
2010
2011If this env variable is set, then its contents will be interpreted by
2012C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
2013C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
2014that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
2015
2016This takes place when the first watcher is created.
2017
2018For example, to bind a debug shell on a unix domain socket in
2019F<< /tmp/debug<pid>.sock >>, you could use this:
2020
2021 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2022
2023Note that creating sockets in F</tmp> is very unsafe on multiuser
2024systems.
2025
2026=item C<PERL_ANYEVENT_DEBUG_WRAP>
2027
2028Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2029debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2030
1861=item C<PERL_ANYEVENT_MODEL> 2031=item C<PERL_ANYEVENT_MODEL>
1862 2032
1863This can be used to specify the event model to be used by AnyEvent, before 2033This can be used to specify the event model to be used by AnyEvent, before
1864auto detection and -probing kicks in. It must be a string consisting 2034auto detection and -probing kicks in.
1865entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2035
2036It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2037or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1866and the resulting module name is loaded and if the load was successful, 2038resulting module name is loaded and - if the load was successful - used as
1867used as event model. If it fails to load AnyEvent will proceed with 2039event model backend. If it fails to load then AnyEvent will proceed with
1868auto detection and -probing. 2040auto detection and -probing.
1869 2041
1870This functionality might change in future versions. 2042If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2043nothing gets prepended and the module name is used as-is (hint: C<::> at
2044the end of a string designates a module name and quotes it appropriately).
1871 2045
1872For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2046For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1873could start your program like this: 2047could start your program like this:
1874 2048
1875 PERL_ANYEVENT_MODEL=Perl perl ... 2049 PERL_ANYEVENT_MODEL=Perl perl ...
1876 2050
1877=item C<PERL_ANYEVENT_PROTOCOLS> 2051=item C<PERL_ANYEVENT_PROTOCOLS>
… …
2267(even when used without AnyEvent), but most event loops have acceptable 2441(even when used without AnyEvent), but most event loops have acceptable
2268performance with or without AnyEvent. 2442performance with or without AnyEvent.
2269 2443
2270=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2444=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2271the actual event loop, only with extremely fast event loops such as EV 2445the actual event loop, only with extremely fast event loops such as EV
2272adds AnyEvent significant overhead. 2446does AnyEvent add significant overhead.
2273 2447
2274=item * You should avoid POE like the plague if you want performance or 2448=item * You should avoid POE like the plague if you want performance or
2275reasonable memory usage. 2449reasonable memory usage.
2276 2450
2277=back 2451=back
… …
2576 2750
2577=item L<Time::HiRes> 2751=item L<Time::HiRes>
2578 2752
2579This module is part of perl since release 5.008. It will be used when the 2753This module is part of perl since release 5.008. It will be used when the
2580chosen event library does not come with a timing source of its own. The 2754chosen event library does not come with a timing source of its own. The
2581pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2755pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2582try to use a monotonic clock for timing stability. 2756try to use a monotonic clock for timing stability.
2583 2757
2584=back 2758=back
2585 2759
2586 2760
… …
2652 2826
2653Tutorial/Introduction: L<AnyEvent::Intro>. 2827Tutorial/Introduction: L<AnyEvent::Intro>.
2654 2828
2655FAQ: L<AnyEvent::FAQ>. 2829FAQ: L<AnyEvent::FAQ>.
2656 2830
2657Utility functions: L<AnyEvent::Util>. 2831Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2832(simply logging).
2658 2833
2659Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2834Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2660L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2835L<AnyEvent::Debug> (interactive shell, watcher tracing).
2836
2837Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2838L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2839L<Qt>, L<POE>, L<FLTK>.
2661 2840
2662Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2841Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2663L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2842L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2664L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2843L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2665L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2844L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2845L<AnyEvent::Impl::FLTK>.
2666 2846
2667Non-blocking file handles, sockets, TCP clients and 2847Non-blocking handles, pipes, stream sockets, TCP clients and
2668servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2848servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2669 2849
2670Asynchronous DNS: L<AnyEvent::DNS>. 2850Asynchronous DNS: L<AnyEvent::DNS>.
2671 2851
2672Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 2852Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

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