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.350 by root, Tue Aug 2 20:02:44 2011 UTC vs.
Revision 1.368 by root, Wed Aug 17 02:30:38 2011 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
… …
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
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
1010=back 1064=back
1011 1065
1012=head1 WHAT TO DO IN A MODULE 1066=head1 WHAT TO DO IN A MODULE
1013 1067
1014As 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
… …
1047modules might create watchers when they are loaded, and AnyEvent will 1101modules 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 1102decide 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. 1103might choose the wrong one unless you load the correct one yourself.
1050 1104
1051You can chose to use a pure-perl implementation by loading the 1105You can chose to use a pure-perl implementation by loading the
1052C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1106C<AnyEvent::Loop> module, which gives you similar behaviour
1053everywhere, but letting AnyEvent chose the model is generally better. 1107everywhere, but letting AnyEvent chose the model is generally better.
1054 1108
1055=head2 MAINLOOP EMULATION 1109=head2 MAINLOOP EMULATION
1056 1110
1057Sometimes (often for short test scripts, or even standalone programs who 1111Sometimes (often for short test scripts, or even standalone programs who
… …
1070 1124
1071 1125
1072=head1 OTHER MODULES 1126=head1 OTHER MODULES
1073 1127
1074The following is a non-exhaustive list of additional modules that use 1128The following is a non-exhaustive list of additional modules that use
1075AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1129AnyEvent as a client and can therefore be mixed easily with other
1076modules and other event loops in the same program. Some of the modules 1130AnyEvent modules and other event loops in the same program. Some of the
1077come as part of AnyEvent, the others are available via CPAN. 1131modules come as part of AnyEvent, the others are available via CPAN (see
1132L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*1> for
1133a longer non-exhaustive list), and the list is heavily biased towards
1134modules of the AnyEvent author himself :)
1078 1135
1079=over 4 1136=over 4
1080 1137
1081=item L<AnyEvent::Util> 1138=item L<AnyEvent::Util>
1082 1139
… …
1162 1219
1163BEGIN { AnyEvent::common_sense } 1220BEGIN { AnyEvent::common_sense }
1164 1221
1165use Carp (); 1222use Carp ();
1166 1223
1167our $VERSION = '5.34'; 1224our $VERSION = '6.01';
1168our $MODEL; 1225our $MODEL;
1169 1226
1170our $AUTOLOAD;
1171our @ISA; 1227our @ISA;
1172 1228
1173our @REGISTRY; 1229our @REGISTRY;
1174 1230
1175our $VERBOSE; 1231our $VERBOSE;
… …
1181 1237
1182 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1238 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1183 if ${^TAINT}; 1239 if ${^TAINT};
1184 1240
1185 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1241 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1186
1187} 1242}
1188 1243
1189our $MAX_SIGNAL_LATENCY = 10; 1244our $MAX_SIGNAL_LATENCY = 10;
1190 1245
1191our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1246our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
… …
1195 $PROTOCOL{$_} = ++$idx 1250 $PROTOCOL{$_} = ++$idx
1196 for reverse split /\s*,\s*/, 1251 for reverse split /\s*,\s*/,
1197 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1252 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1198} 1253}
1199 1254
1255our @post_detect;
1256
1257sub post_detect(&) {
1258 my ($cb) = @_;
1259
1260 push @post_detect, $cb;
1261
1262 defined wantarray
1263 ? bless \$cb, "AnyEvent::Util::postdetect"
1264 : ()
1265}
1266
1267sub AnyEvent::Util::postdetect::DESTROY {
1268 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1269}
1270
1271our $POSTPONE_W;
1272our @POSTPONE;
1273
1274sub _postpone_exec {
1275 undef $POSTPONE_W;
1276
1277 &{ shift @POSTPONE }
1278 while @POSTPONE;
1279}
1280
1281sub postpone(&) {
1282 push @POSTPONE, shift;
1283
1284 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1285
1286 ()
1287}
1288
1289sub log($$;@) {
1290 require AnyEvent::Log;
1291 # AnyEvent::Log overwrites this function
1292 goto &log;
1293}
1294
1200my @models = ( 1295our @models = (
1201 [EV:: => AnyEvent::Impl::EV:: , 1], 1296 [EV:: => AnyEvent::Impl::EV:: , 1],
1202 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1297 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1203 # everything below here will not (normally) be autoprobed 1298 # everything below here will not (normally) be autoprobed
1204 # as the pureperl backend should work everywhere 1299 # as the pure perl backend should work everywhere
1205 # and is usually faster 1300 # and is usually faster
1206 [Event:: => AnyEvent::Impl::Event::, 1], 1301 [Event:: => AnyEvent::Impl::Event::, 1],
1207 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1302 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1208 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1303 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1209 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1304 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1210 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1305 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1211 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1306 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1212 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1307 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1213 [Wx:: => AnyEvent::Impl::POE::], 1308 [Wx:: => AnyEvent::Impl::POE::],
1214 [Prima:: => AnyEvent::Impl::POE::], 1309 [Prima:: => AnyEvent::Impl::POE::],
1215 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1310 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1216 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1311 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1217 [FLTK:: => AnyEvent::Impl::FLTK::], 1312 [FLTK:: => AnyEvent::Impl::FLTK2::],
1218); 1313);
1219 1314
1220our %method = map +($_ => 1), 1315our @isa_hook;
1316
1317sub _isa_set {
1318 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1319
1320 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1321 for 1 .. $#pkg;
1322
1323 grep $_ && $_->[1], @isa_hook
1324 and AE::_reset ();
1325}
1326
1327# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1328sub _isa_hook($$;$) {
1329 my ($i, $pkg, $reset_ae) = @_;
1330
1331 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1332
1333 _isa_set;
1334}
1335
1336# all autoloaded methods reserve the complete glob, not just the method slot.
1337# due to bugs in perls method cache implementation.
1221 qw(io timer time now now_update signal child idle condvar DESTROY); 1338our @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 1339
1239sub detect() { 1340sub detect() {
1341 return $MODEL if $MODEL; # some programs keep references to detect
1342
1343 local $!; # for good measure
1344 local $SIG{__DIE__}; # we use eval
1345
1240 # free some memory 1346 # free some memory
1241 *detect = sub () { $MODEL }; 1347 *detect = sub () { $MODEL };
1348 # undef &func doesn't correctly update the method cache. grmbl.
1349 # so we delete the whole glob. grmbl.
1350 # otoh, perl doesn't let me undef an active usb, but it lets me free
1351 # a glob with an active sub. hrm. i hope it works, but perl is
1352 # usually buggy in this department. sigh.
1353 delete @{"AnyEvent::"}{@methods};
1354 undef @methods;
1242 1355
1243 local $!; # for good measure
1244 local $SIG{__DIE__};
1245
1246 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1356 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1247 my $model = "AnyEvent::Impl::$1"; 1357 my $model = $1;
1358 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1248 if (eval "require $model") { 1359 if (eval "require $model") {
1249 $MODEL = $model; 1360 $MODEL = $model;
1250 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1361 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
1362 if $VERBOSE >= 7;
1251 } else { 1363 } else {
1252 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1364 AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1253 } 1365 }
1254 } 1366 }
1255 1367
1256 # check for already loaded models 1368 # check for already loaded models
1257 unless ($MODEL) { 1369 unless ($MODEL) {
1258 for (@REGISTRY, @models) { 1370 for (@REGISTRY, @models) {
1259 my ($package, $model) = @$_; 1371 my ($package, $model) = @$_;
1260 if (${"$package\::VERSION"} > 0) { 1372 if (${"$package\::VERSION"} > 0) {
1261 if (eval "require $model") { 1373 if (eval "require $model") {
1262 $MODEL = $model; 1374 $MODEL = $model;
1263 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1375 AnyEvent::log 7 => "autodetected model '$model', using it."
1376 if $VERBOSE >= 7;
1264 last; 1377 last;
1265 } 1378 }
1266 } 1379 }
1267 } 1380 }
1268 1381
… …
1275 and eval "require $package" 1388 and eval "require $package"
1276 and ${"$package\::VERSION"} > 0 1389 and ${"$package\::VERSION"} > 0
1277 and eval "require $model" 1390 and eval "require $model"
1278 ) { 1391 ) {
1279 $MODEL = $model; 1392 $MODEL = $model;
1280 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; 1393 AnyEvent::log 7 => "autoloaded model '$model', using it."
1394 if $VERBOSE >= 7;
1281 last; 1395 last;
1282 } 1396 }
1283 } 1397 }
1284 1398
1285 $MODEL 1399 $MODEL
1286 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1400 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1287 } 1401 }
1288 } 1402 }
1289 1403
1290 @models = (); # free probe data 1404 # free memory only needed for probing
1405 undef @models;
1406 undef @REGISTRY;
1291 1407
1292 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1408 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1293 unshift @ISA, $MODEL;
1294 1409
1295 # now nuke some methods that are overridden by the backend. 1410 # now nuke some methods that are overridden by the backend.
1296 # SUPER is not allowed. 1411 # SUPER usage is not allowed in these.
1297 for (qw(time signal child idle)) { 1412 for (qw(time signal child idle)) {
1298 undef &{"AnyEvent::Base::$_"} 1413 undef &{"AnyEvent::Base::$_"}
1299 if defined &{"$MODEL\::$_"}; 1414 if defined &{"$MODEL\::$_"};
1300 } 1415 }
1301 1416
1417 _isa_set;
1418
1419 # we're officially open!
1420
1302 if ($ENV{PERL_ANYEVENT_STRICT}) { 1421 if ($ENV{PERL_ANYEVENT_STRICT}) {
1303 eval { require AnyEvent::Strict }; 1422 require AnyEvent::Strict;
1304 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1305 if $@ && $VERBOSE;
1306 } 1423 }
1307 1424
1425 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1426 require AnyEvent::Debug;
1427 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1428 }
1429
1430 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1431 require AnyEvent::Socket;
1432 require AnyEvent::Debug;
1433
1434 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1435 $shell =~ s/\$\$/$$/g;
1436
1437 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1438 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1439 }
1440
1441 # now the anyevent environment is set up as the user told us to, so
1442 # call the actual user code - post detects
1443
1308 (shift @post_detect)->() while @post_detect; 1444 (shift @post_detect)->() while @post_detect;
1445 undef @post_detect;
1309 1446
1310 *post_detect = sub(&) { 1447 *post_detect = sub(&) {
1311 shift->(); 1448 shift->();
1312 1449
1313 undef 1450 undef
1314 }; 1451 };
1315 1452
1316 $MODEL 1453 $MODEL
1317} 1454}
1318 1455
1319sub AUTOLOAD { 1456for my $name (@methods) {
1320 (my $func = $AUTOLOAD) =~ s/.*://; 1457 *$name = sub {
1321
1322 $method{$func}
1323 or Carp::croak "$func: not a valid AnyEvent class method";
1324
1325 detect; 1458 detect;
1326 1459 # we use goto because
1327 my $class = shift; 1460 # a) it makes the thunk more transparent
1328 $class->$func (@_); 1461 # b) it allows us to delete the thunk later
1462 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1463 };
1329} 1464}
1330 1465
1331# utility function to dup a filehandle. this is used by many backends 1466# utility function to dup a filehandle. this is used by many backends
1332# to support binding more than one watcher per filehandle (they usually 1467# 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). 1468# allow only one watcher per fd, so we dup it to get a different one).
… …
1357 1492
1358package AE; 1493package AE;
1359 1494
1360our $VERSION = $AnyEvent::VERSION; 1495our $VERSION = $AnyEvent::VERSION;
1361 1496
1497sub _reset() {
1498 eval q{
1362# fall back to the main API by default - backends and AnyEvent::Base 1499 # fall back to the main API by default - backends and AnyEvent::Base
1363# implementations can overwrite these. 1500 # implementations can overwrite these.
1364 1501
1365sub io($$$) { 1502 sub io($$$) {
1366 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1503 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1367} 1504 }
1368 1505
1369sub timer($$$) { 1506 sub timer($$$) {
1370 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1507 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1371} 1508 }
1372 1509
1373sub signal($$) { 1510 sub signal($$) {
1374 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1511 AnyEvent->signal (signal => $_[0], cb => $_[1])
1375} 1512 }
1376 1513
1377sub child($$) { 1514 sub child($$) {
1378 AnyEvent->child (pid => $_[0], cb => $_[1]) 1515 AnyEvent->child (pid => $_[0], cb => $_[1])
1379} 1516 }
1380 1517
1381sub idle($) { 1518 sub idle($) {
1382 AnyEvent->idle (cb => $_[0]) 1519 AnyEvent->idle (cb => $_[0]);
1383} 1520 }
1384 1521
1385sub cv(;&) { 1522 sub cv(;&) {
1386 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1523 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1387} 1524 }
1388 1525
1389sub now() { 1526 sub now() {
1390 AnyEvent->now 1527 AnyEvent->now
1391} 1528 }
1392 1529
1393sub now_update() { 1530 sub now_update() {
1394 AnyEvent->now_update 1531 AnyEvent->now_update
1395} 1532 }
1396 1533
1397sub time() { 1534 sub time() {
1398 AnyEvent->time 1535 AnyEvent->time
1536 }
1537
1538 *postpone = \&AnyEvent::postpone;
1539 *log = \&AnyEvent::log;
1540 };
1541 die if $@;
1399} 1542}
1543
1544BEGIN { _reset }
1400 1545
1401package AnyEvent::Base; 1546package AnyEvent::Base;
1402 1547
1403# default implementations for many methods 1548# default implementations for many methods
1404 1549
1405sub time { 1550sub time {
1406 eval q{ # poor man's autoloading {} 1551 eval q{ # poor man's autoloading {}
1407 # probe for availability of Time::HiRes 1552 # probe for availability of Time::HiRes
1408 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1553 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1409 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1554 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
1555 if $AnyEvent::VERBOSE >= 8;
1556 *time = sub { Time::HiRes::time () };
1410 *AE::time = \&Time::HiRes::time; 1557 *AE::time = \& Time::HiRes::time ;
1411 # if (eval "use POSIX (); (POSIX::times())... 1558 # if (eval "use POSIX (); (POSIX::times())...
1412 } else { 1559 } else {
1413 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1560 AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
1561 *time = sub { CORE::time };
1414 *AE::time = sub (){ time }; # epic fail 1562 *AE::time = sub (){ CORE::time };
1415 } 1563 }
1416 1564
1417 *time = sub { AE::time }; # different prototypes 1565 *now = \&time;
1418 }; 1566 };
1419 die if $@; 1567 die if $@;
1420 1568
1421 &time 1569 &time
1422} 1570}
1423 1571
1424*now = \&time; 1572*now = \&time;
1425
1426sub now_update { } 1573sub now_update { }
1427 1574
1575sub _poll {
1576 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1577}
1578
1428# default implementation for ->condvar 1579# default implementation for ->condvar
1580# in fact, the default should not be overwritten
1429 1581
1430sub condvar { 1582sub condvar {
1431 eval q{ # poor man's autoloading {} 1583 eval q{ # poor man's autoloading {}
1432 *condvar = sub { 1584 *condvar = sub {
1433 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1585 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
… …
1511 1663
1512sub signal { 1664sub signal {
1513 eval q{ # poor man's autoloading {} 1665 eval q{ # poor man's autoloading {}
1514 # probe for availability of Async::Interrupt 1666 # probe for availability of Async::Interrupt
1515 if (_have_async_interrupt) { 1667 if (_have_async_interrupt) {
1516 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1668 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
1669 if $AnyEvent::VERBOSE >= 8;
1517 1670
1518 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1671 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1519 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1672 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1520 1673
1521 } else { 1674 } else {
1522 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1675 AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
1676 if $AnyEvent::VERBOSE >= 8;
1523 1677
1524 if (AnyEvent::WIN32) { 1678 if (AnyEvent::WIN32) {
1525 require AnyEvent::Util; 1679 require AnyEvent::Util;
1526 1680
1527 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1681 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
… …
1603 : sysread $SIGPIPE_R, (my $dummy), 9; 1757 : sysread $SIGPIPE_R, (my $dummy), 9;
1604 1758
1605 while (%SIG_EV) { 1759 while (%SIG_EV) {
1606 for (keys %SIG_EV) { 1760 for (keys %SIG_EV) {
1607 delete $SIG_EV{$_}; 1761 delete $SIG_EV{$_};
1608 $_->() for values %{ $SIG_CB{$_} || {} }; 1762 &$_ for values %{ $SIG_CB{$_} || {} };
1609 } 1763 }
1610 } 1764 }
1611 }; 1765 };
1612 }; 1766 };
1613 die if $@; 1767 die if $@;
… …
1640 }; 1794 };
1641 1795
1642 *child = sub { 1796 *child = sub {
1643 my (undef, %arg) = @_; 1797 my (undef, %arg) = @_;
1644 1798
1645 defined (my $pid = $arg{pid} + 0) 1799 my $pid = $arg{pid};
1646 or Carp::croak "required option 'pid' is missing"; 1800 my $cb = $arg{cb};
1647 1801
1648 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1802 $PID_CB{$pid}{$cb+0} = $cb;
1649 1803
1650 unless ($CHLD_W) { 1804 unless ($CHLD_W) {
1651 $CHLD_W = AE::signal CHLD => \&_sigchld; 1805 $CHLD_W = AE::signal CHLD => \&_sigchld;
1652 # child could be a zombie already, so make at least one round 1806 # child could be a zombie already, so make at least one round
1653 &_sigchld; 1807 &_sigchld;
1654 } 1808 }
1655 1809
1656 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1810 bless [$pid, $cb+0], "AnyEvent::Base::child"
1657 }; 1811 };
1658 1812
1659 *AnyEvent::Base::child::DESTROY = sub { 1813 *AnyEvent::Base::child::DESTROY = sub {
1660 my ($pid, $cb) = @{$_[0]}; 1814 my ($pid, $icb) = @{$_[0]};
1661 1815
1662 delete $PID_CB{$pid}{$cb}; 1816 delete $PID_CB{$pid}{$icb};
1663 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1817 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1664 1818
1665 undef $CHLD_W unless keys %PID_CB; 1819 undef $CHLD_W unless keys %PID_CB;
1666 }; 1820 };
1667 }; 1821 };
… …
1680 1834
1681 my ($cb, $w, $rcb) = $arg{cb}; 1835 my ($cb, $w, $rcb) = $arg{cb};
1682 1836
1683 $rcb = sub { 1837 $rcb = sub {
1684 if ($cb) { 1838 if ($cb) {
1685 $w = _time; 1839 $w = AE::time;
1686 &$cb; 1840 &$cb;
1687 $w = _time - $w; 1841 $w = AE::time - $w;
1688 1842
1689 # never use more then 50% of the time for the idle watcher, 1843 # never use more then 50% of the time for the idle watcher,
1690 # within some limits 1844 # within some limits
1691 $w = 0.0001 if $w < 0.0001; 1845 $w = 0.0001 if $w < 0.0001;
1692 $w = 5 if $w > 5; 1846 $w = 5 if $w > 5;
… …
1740sub _send { 1894sub _send {
1741 # nop 1895 # nop
1742} 1896}
1743 1897
1744sub _wait { 1898sub _wait {
1745 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; 1899 AnyEvent->_poll until $_[0]{_ae_sent};
1746} 1900}
1747 1901
1748sub send { 1902sub send {
1749 my $cv = shift; 1903 my $cv = shift;
1750 $cv->{_ae_sent} = [@_]; 1904 $cv->{_ae_sent} = [@_];
… …
1762} 1916}
1763 1917
1764sub recv { 1918sub recv {
1765 unless ($_[0]{_ae_sent}) { 1919 unless ($_[0]{_ae_sent}) {
1766 $WAITING 1920 $WAITING
1767 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; 1921 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1768 1922
1769 local $WAITING = 1; 1923 local $WAITING = 1;
1770 $_[0]->_wait; 1924 $_[0]->_wait;
1771 } 1925 }
1772 1926
… …
1836 1990
1837By default, AnyEvent will be completely silent except in fatal 1991By default, AnyEvent will be completely silent except in fatal
1838conditions. You can set this environment variable to make AnyEvent more 1992conditions. You can set this environment variable to make AnyEvent more
1839talkative. 1993talkative.
1840 1994
1841When set to C<1> or higher, causes AnyEvent to warn about unexpected 1995When set to C<5> or higher, causes AnyEvent to warn about unexpected
1842conditions, such as not being able to load the event model specified by 1996conditions, such as not being able to load the event model specified by
1843C<PERL_ANYEVENT_MODEL>. 1997C<PERL_ANYEVENT_MODEL>.
1844 1998
1845When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1999When set to C<7> or higher, cause AnyEvent to report to STDERR which event
1846model it chooses. 2000model it chooses.
1847 2001
1848When set to C<8> or higher, then AnyEvent will report extra information on 2002When set to C<8> or higher, then AnyEvent will report extra information on
1849which optional modules it loads and how it implements certain features. 2003which optional modules it loads and how it implements certain features.
1850 2004
… …
1861Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2015Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1862>>, it is definitely recommended to keep it off in production. Keeping 2016>>, it is definitely recommended to keep it off in production. Keeping
1863C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2017C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1864can be very useful, however. 2018can be very useful, however.
1865 2019
2020=item C<PERL_ANYEVENT_DEBUG_SHELL>
2021
2022If this env variable is set, then its contents will be interpreted by
2023C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
2024C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
2025that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
2026
2027This takes place when the first watcher is created.
2028
2029For example, to bind a debug shell on a unix domain socket in
2030F<< /tmp/debug<pid>.sock >>, you could use this:
2031
2032 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2033
2034Note that creating sockets in F</tmp> is very unsafe on multiuser
2035systems.
2036
2037=item C<PERL_ANYEVENT_DEBUG_WRAP>
2038
2039Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2040debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2041
1866=item C<PERL_ANYEVENT_MODEL> 2042=item C<PERL_ANYEVENT_MODEL>
1867 2043
1868This can be used to specify the event model to be used by AnyEvent, before 2044This can be used to specify the event model to be used by AnyEvent, before
1869auto detection and -probing kicks in. It must be a string consisting 2045auto detection and -probing kicks in.
1870entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2046
2047It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2048or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1871and the resulting module name is loaded and if the load was successful, 2049resulting module name is loaded and - if the load was successful - used as
1872used as event model. If it fails to load AnyEvent will proceed with 2050event model backend. If it fails to load then AnyEvent will proceed with
1873auto detection and -probing. 2051auto detection and -probing.
1874 2052
1875This functionality might change in future versions. 2053If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2054nothing gets prepended and the module name is used as-is (hint: C<::> at
2055the end of a string designates a module name and quotes it appropriately).
1876 2056
1877For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2057For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1878could start your program like this: 2058could start your program like this:
1879 2059
1880 PERL_ANYEVENT_MODEL=Perl perl ... 2060 PERL_ANYEVENT_MODEL=Perl perl ...
1881 2061
1882=item C<PERL_ANYEVENT_PROTOCOLS> 2062=item C<PERL_ANYEVENT_PROTOCOLS>
… …
2272(even when used without AnyEvent), but most event loops have acceptable 2452(even when used without AnyEvent), but most event loops have acceptable
2273performance with or without AnyEvent. 2453performance with or without AnyEvent.
2274 2454
2275=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2455=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2276the actual event loop, only with extremely fast event loops such as EV 2456the actual event loop, only with extremely fast event loops such as EV
2277adds AnyEvent significant overhead. 2457does AnyEvent add significant overhead.
2278 2458
2279=item * You should avoid POE like the plague if you want performance or 2459=item * You should avoid POE like the plague if you want performance or
2280reasonable memory usage. 2460reasonable memory usage.
2281 2461
2282=back 2462=back
… …
2581 2761
2582=item L<Time::HiRes> 2762=item L<Time::HiRes>
2583 2763
2584This module is part of perl since release 5.008. It will be used when the 2764This module is part of perl since release 5.008. It will be used when the
2585chosen event library does not come with a timing source of its own. The 2765chosen event library does not come with a timing source of its own. The
2586pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2766pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2587try to use a monotonic clock for timing stability. 2767try to use a monotonic clock for timing stability.
2588 2768
2589=back 2769=back
2590 2770
2591 2771
… …
2657 2837
2658Tutorial/Introduction: L<AnyEvent::Intro>. 2838Tutorial/Introduction: L<AnyEvent::Intro>.
2659 2839
2660FAQ: L<AnyEvent::FAQ>. 2840FAQ: L<AnyEvent::FAQ>.
2661 2841
2662Utility functions: L<AnyEvent::Util>. 2842Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2843(simply logging).
2663 2844
2664Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2845Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2665L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2846L<AnyEvent::Debug> (interactive shell, watcher tracing).
2847
2848Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2849L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2850L<Qt>, L<POE>, L<FLTK>.
2666 2851
2667Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2852Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2668L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2853L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2669L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2854L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2670L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2855L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2856L<AnyEvent::Impl::FLTK>.
2671 2857
2672Non-blocking file handles, sockets, TCP clients and 2858Non-blocking handles, pipes, stream sockets, TCP clients and
2673servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2859servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2674 2860
2675Asynchronous DNS: L<AnyEvent::DNS>. 2861Asynchronous DNS: L<AnyEvent::DNS>.
2676 2862
2677Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 2863Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

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