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.358 by root, Sat Aug 13 02:35:32 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
1005 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1005 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1006 # as soon as it is 1006 # as soon as it is
1007 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1007 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1008 } 1008 }
1009 1009
1010=item AnyEvent::postpone { BLOCK }
1011
1012Arranges for the block to be executed as soon as possible, but not before
1013the call itself returns. In practise, the block will be executed just
1014before the event loop polls for new events, or shortly afterwards.
1015
1016This function never returns anything (to make the C<return postpone { ...
1017}> idiom more useful.
1018
1019To understand the usefulness of this function, consider a function that
1020asynchronously does something for you and returns some transaction
1021object or guard to let you cancel the operation. For example,
1022C<AnyEvent::Socket::tcp_connect>:
1023
1024 # start a conenction attempt unless one is active
1025 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
1026 delete $self->{connect_guard};
1027 ...
1028 };
1029
1030Imagine that this function could instantly call the callback, for
1031example, because it detects an obvious error such as a negative port
1032number. Invoking the callback before the function returns causes problems
1033however: the callback will be called and will try to delete the guard
1034object. But since the function hasn't returned yet, there is nothing to
1035delete. When the function eventually returns it will assign the guard
1036object to C<< $self->{connect_guard} >>, where it will likely never be
1037deleted, so the program thinks it is still trying to connect.
1038
1039This is where C<AnyEvent::postpone> should be used. Instead of calling the
1040callback directly on error:
1041
1042 $cb->(undef), return # signal error to callback, BAD!
1043 if $some_error_condition;
1044
1045It should use C<postpone>:
1046
1047 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1048 if $some_error_condition;
1049
1010=back 1050=back
1011 1051
1012=head1 WHAT TO DO IN A MODULE 1052=head1 WHAT TO DO IN A MODULE
1013 1053
1014As a module author, you should C<use AnyEvent> and call AnyEvent methods 1054As a module author, you should C<use AnyEvent> and call AnyEvent methods
1047modules might create watchers when they are loaded, and AnyEvent will 1087modules 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 1088decide 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. 1089might choose the wrong one unless you load the correct one yourself.
1050 1090
1051You can chose to use a pure-perl implementation by loading the 1091You can chose to use a pure-perl implementation by loading the
1052C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1092C<AnyEvent::Loop> module, which gives you similar behaviour
1053everywhere, but letting AnyEvent chose the model is generally better. 1093everywhere, but letting AnyEvent chose the model is generally better.
1054 1094
1055=head2 MAINLOOP EMULATION 1095=head2 MAINLOOP EMULATION
1056 1096
1057Sometimes (often for short test scripts, or even standalone programs who 1097Sometimes (often for short test scripts, or even standalone programs who
1165use Carp (); 1205use Carp ();
1166 1206
1167our $VERSION = '5.34'; 1207our $VERSION = '5.34';
1168our $MODEL; 1208our $MODEL;
1169 1209
1170our $AUTOLOAD;
1171our @ISA; 1210our @ISA;
1172 1211
1173our @REGISTRY; 1212our @REGISTRY;
1174 1213
1175our $VERBOSE; 1214our $VERBOSE;
1195 $PROTOCOL{$_} = ++$idx 1234 $PROTOCOL{$_} = ++$idx
1196 for reverse split /\s*,\s*/, 1235 for reverse split /\s*,\s*/,
1197 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1236 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1198} 1237}
1199 1238
1239our @post_detect;
1240
1241sub post_detect(&) {
1242 my ($cb) = @_;
1243
1244 push @post_detect, $cb;
1245
1246 defined wantarray
1247 ? bless \$cb, "AnyEvent::Util::postdetect"
1248 : ()
1249}
1250
1251sub AnyEvent::Util::postdetect::DESTROY {
1252 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1253}
1254
1255our $POSTPONE_W;
1256our @POSTPONE;
1257
1258sub _postpone_exec {
1259 undef $POSTPONE_W;
1260
1261 &{ shift @POSTPONE }
1262 while @POSTPONE;
1263}
1264
1265sub postpone(&) {
1266 push @POSTPONE, shift;
1267
1268 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1269
1270 ()
1271}
1272
1200my @models = ( 1273our @models = (
1201 [EV:: => AnyEvent::Impl::EV:: , 1], 1274 [EV:: => AnyEvent::Impl::EV:: , 1],
1202 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1275 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1203 # everything below here will not (normally) be autoprobed 1276 # everything below here will not (normally) be autoprobed
1204 # as the pureperl backend should work everywhere 1277 # as the pure perl backend should work everywhere
1205 # and is usually faster 1278 # and is usually faster
1206 [Event:: => AnyEvent::Impl::Event::, 1], 1279 [Event:: => AnyEvent::Impl::Event::, 1],
1207 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1280 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1208 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1281 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1209 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1282 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1210 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1283 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1211 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1284 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1212 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1285 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1213 [Wx:: => AnyEvent::Impl::POE::], 1286 [Wx:: => AnyEvent::Impl::POE::],
1214 [Prima:: => AnyEvent::Impl::POE::], 1287 [Prima:: => AnyEvent::Impl::POE::],
1215 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1288 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1216 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1289 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1217 [FLTK:: => AnyEvent::Impl::FLTK::], 1290 [FLTK:: => AnyEvent::Impl::FLTK2::],
1218); 1291);
1219 1292
1220our %method = map +($_ => 1), 1293# all autoloaded methods reserve the complete glob, not just the method slot.
1294# due to bugs in perls method cache implementation.
1221 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1295our @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 1296
1239sub detect() { 1297sub detect() {
1298 local $!; # for good measure
1299 local $SIG{__DIE__}; # we use eval
1300
1240 # free some memory 1301 # free some memory
1241 *detect = sub () { $MODEL }; 1302 *detect = sub () { $MODEL };
1303 # undef &func doesn't correctly update the method cache. grmbl.
1304 # so we delete the whole glob. grmbl.
1305 # otoh, perl doesn't let me undef an active usb, but it lets me free
1306 # a glob with an active sub. hrm. i hope it works, but perl is
1307 # usually buggy in this department. sigh.
1308 delete @{"AnyEvent::"}{@methods};
1309 undef @methods;
1242 1310
1243 local $!; # for good measure
1244 local $SIG{__DIE__};
1245
1246 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1311 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1247 my $model = "AnyEvent::Impl::$1"; 1312 my $model = $1;
1313 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1248 if (eval "require $model") { 1314 if (eval "require $model") {
1249 $MODEL = $model; 1315 $MODEL = $model;
1250 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1316 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1251 } else { 1317 } else {
1252 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1318 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1285 $MODEL 1351 $MODEL
1286 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1352 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1287 } 1353 }
1288 } 1354 }
1289 1355
1290 @models = (); # free probe data 1356 # free memory only needed for probing
1357 undef @models;
1358 undef @REGISTRY;
1291 1359
1292 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1360 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1293 unshift @ISA, $MODEL; 1361 unshift @ISA, $MODEL;
1294 1362
1295 # now nuke some methods that are overridden by the backend. 1363 # now nuke some methods that are overridden by the backend.
1296 # SUPER is not allowed. 1364 # SUPER usage is not allowed in these.
1297 for (qw(time signal child idle)) { 1365 for (qw(time signal child idle)) {
1298 undef &{"AnyEvent::Base::$_"} 1366 undef &{"AnyEvent::Base::$_"}
1299 if defined &{"$MODEL\::$_"}; 1367 if defined &{"$MODEL\::$_"};
1300 } 1368 }
1301 1369
1302 if ($ENV{PERL_ANYEVENT_STRICT}) { 1370 if ($ENV{PERL_ANYEVENT_STRICT}) {
1303 eval { require AnyEvent::Strict }; 1371 require AnyEvent::Strict;
1304 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1305 if $@ && $VERBOSE;
1306 } 1372 }
1307 1373
1374 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1375 require AnyEvent::Debug;
1376 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1377 }
1378
1379 if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1380 require AnyEvent::Socket;
1381 require AnyEvent::Debug;
1382
1383 my ($host, $service) = AnyEvent::Socket::parse_hostport ($ENV{PERL_ANYEVENT_DEBUG_SHELL});
1384 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1385 }
1386
1308 (shift @post_detect)->() while @post_detect; 1387 (shift @post_detect)->() while @post_detect;
1388 undef @post_detect;
1309 1389
1310 *post_detect = sub(&) { 1390 *post_detect = sub(&) {
1311 shift->(); 1391 shift->();
1312 1392
1313 undef 1393 undef
1314 }; 1394 };
1315 1395
1316 $MODEL 1396 $MODEL
1317} 1397}
1318 1398
1319sub AUTOLOAD { 1399for my $name (@methods) {
1320 (my $func = $AUTOLOAD) =~ s/.*://; 1400 *$name = sub {
1321
1322 $method{$func}
1323 or Carp::croak "$func: not a valid AnyEvent class method";
1324
1325 detect; 1401 detect;
1326 1402 # we use goto because
1327 my $class = shift; 1403 # a) it makes the thunk more transparent
1328 $class->$func (@_); 1404 # b) it allows us to delete the thunk later
1405 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1406 };
1329} 1407}
1330 1408
1331# utility function to dup a filehandle. this is used by many backends 1409# utility function to dup a filehandle. this is used by many backends
1332# to support binding more than one watcher per filehandle (they usually 1410# 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). 1411# allow only one watcher per fd, so we dup it to get a different one).
1357 1435
1358package AE; 1436package AE;
1359 1437
1360our $VERSION = $AnyEvent::VERSION; 1438our $VERSION = $AnyEvent::VERSION;
1361 1439
1440sub _reset() {
1441 eval q{
1362# fall back to the main API by default - backends and AnyEvent::Base 1442 # fall back to the main API by default - backends and AnyEvent::Base
1363# implementations can overwrite these. 1443 # implementations can overwrite these.
1364 1444
1365sub io($$$) { 1445 sub io($$$) {
1366 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1446 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1367} 1447 }
1368 1448
1369sub timer($$$) { 1449 sub timer($$$) {
1370 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1450 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1371} 1451 }
1372 1452
1373sub signal($$) { 1453 sub signal($$) {
1374 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1454 AnyEvent->signal (signal => $_[0], cb => $_[1])
1375} 1455 }
1376 1456
1377sub child($$) { 1457 sub child($$) {
1378 AnyEvent->child (pid => $_[0], cb => $_[1]) 1458 AnyEvent->child (pid => $_[0], cb => $_[1])
1379} 1459 }
1380 1460
1381sub idle($) { 1461 sub idle($) {
1382 AnyEvent->idle (cb => $_[0]) 1462 AnyEvent->idle (cb => $_[0]);
1383} 1463 }
1384 1464
1385sub cv(;&) { 1465 sub cv(;&) {
1386 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1466 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1387} 1467 }
1388 1468
1389sub now() { 1469 sub now() {
1390 AnyEvent->now 1470 AnyEvent->now
1391} 1471 }
1392 1472
1393sub now_update() { 1473 sub now_update() {
1394 AnyEvent->now_update 1474 AnyEvent->now_update
1395} 1475 }
1396 1476
1397sub time() { 1477 sub time() {
1398 AnyEvent->time 1478 AnyEvent->time
1479 }
1480
1481 *postpone = \&AnyEvent::postpone;
1482 };
1483 die if $@;
1399} 1484}
1485
1486BEGIN { _reset }
1400 1487
1401package AnyEvent::Base; 1488package AnyEvent::Base;
1402 1489
1403# default implementations for many methods 1490# default implementations for many methods
1404 1491
1423 1510
1424*now = \&time; 1511*now = \&time;
1425 1512
1426sub now_update { } 1513sub now_update { }
1427 1514
1515sub _poll {
1516 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1517}
1518
1428# default implementation for ->condvar 1519# default implementation for ->condvar
1520# in fact, the default should not be overwritten
1429 1521
1430sub condvar { 1522sub condvar {
1431 eval q{ # poor man's autoloading {} 1523 eval q{ # poor man's autoloading {}
1432 *condvar = sub { 1524 *condvar = sub {
1433 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1525 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1603 : sysread $SIGPIPE_R, (my $dummy), 9; 1695 : sysread $SIGPIPE_R, (my $dummy), 9;
1604 1696
1605 while (%SIG_EV) { 1697 while (%SIG_EV) {
1606 for (keys %SIG_EV) { 1698 for (keys %SIG_EV) {
1607 delete $SIG_EV{$_}; 1699 delete $SIG_EV{$_};
1608 $_->() for values %{ $SIG_CB{$_} || {} }; 1700 &$_ for values %{ $SIG_CB{$_} || {} };
1609 } 1701 }
1610 } 1702 }
1611 }; 1703 };
1612 }; 1704 };
1613 die if $@; 1705 die if $@;
1640 }; 1732 };
1641 1733
1642 *child = sub { 1734 *child = sub {
1643 my (undef, %arg) = @_; 1735 my (undef, %arg) = @_;
1644 1736
1645 defined (my $pid = $arg{pid} + 0) 1737 my $pid = $arg{pid};
1646 or Carp::croak "required option 'pid' is missing"; 1738 my $cb = $arg{cb};
1647 1739
1648 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1740 $PID_CB{$pid}{$cb+0} = $cb;
1649 1741
1650 unless ($CHLD_W) { 1742 unless ($CHLD_W) {
1651 $CHLD_W = AE::signal CHLD => \&_sigchld; 1743 $CHLD_W = AE::signal CHLD => \&_sigchld;
1652 # child could be a zombie already, so make at least one round 1744 # child could be a zombie already, so make at least one round
1653 &_sigchld; 1745 &_sigchld;
1654 } 1746 }
1655 1747
1656 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1748 bless [$pid, $cb+0], "AnyEvent::Base::child"
1657 }; 1749 };
1658 1750
1659 *AnyEvent::Base::child::DESTROY = sub { 1751 *AnyEvent::Base::child::DESTROY = sub {
1660 my ($pid, $cb) = @{$_[0]}; 1752 my ($pid, $icb) = @{$_[0]};
1661 1753
1662 delete $PID_CB{$pid}{$cb}; 1754 delete $PID_CB{$pid}{$icb};
1663 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1755 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1664 1756
1665 undef $CHLD_W unless keys %PID_CB; 1757 undef $CHLD_W unless keys %PID_CB;
1666 }; 1758 };
1667 }; 1759 };
1680 1772
1681 my ($cb, $w, $rcb) = $arg{cb}; 1773 my ($cb, $w, $rcb) = $arg{cb};
1682 1774
1683 $rcb = sub { 1775 $rcb = sub {
1684 if ($cb) { 1776 if ($cb) {
1685 $w = _time; 1777 $w = AE::time;
1686 &$cb; 1778 &$cb;
1687 $w = _time - $w; 1779 $w = AE::time - $w;
1688 1780
1689 # never use more then 50% of the time for the idle watcher, 1781 # never use more then 50% of the time for the idle watcher,
1690 # within some limits 1782 # within some limits
1691 $w = 0.0001 if $w < 0.0001; 1783 $w = 0.0001 if $w < 0.0001;
1692 $w = 5 if $w > 5; 1784 $w = 5 if $w > 5;
1739 1831
1740sub _send { 1832sub _send {
1741 # nop 1833 # nop
1742} 1834}
1743 1835
1836sub _wait {
1837 AnyEvent->_poll until $_[0]{_ae_sent};
1838}
1839
1744sub send { 1840sub send {
1745 my $cv = shift; 1841 my $cv = shift;
1746 $cv->{_ae_sent} = [@_]; 1842 $cv->{_ae_sent} = [@_];
1747 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1843 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1748 $cv->_send; 1844 $cv->_send;
1755 1851
1756sub ready { 1852sub ready {
1757 $_[0]{_ae_sent} 1853 $_[0]{_ae_sent}
1758} 1854}
1759 1855
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 { 1856sub recv {
1857 unless ($_[0]{_ae_sent}) {
1858 $WAITING
1859 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1860
1861 local $WAITING = 1;
1770 $_[0]->_wait; 1862 $_[0]->_wait;
1863 }
1771 1864
1772 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1865 $_[0]{_ae_croak}
1773 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1866 and Carp::croak $_[0]{_ae_croak};
1867
1868 wantarray
1869 ? @{ $_[0]{_ae_sent} }
1870 : $_[0]{_ae_sent}[0]
1774} 1871}
1775 1872
1776sub cb { 1873sub cb {
1777 my $cv = shift; 1874 my $cv = shift;
1778 1875
1794 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1891 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1795} 1892}
1796 1893
1797# undocumented/compatibility with pre-3.4 1894# undocumented/compatibility with pre-3.4
1798*broadcast = \&send; 1895*broadcast = \&send;
1799*wait = \&_wait; 1896*wait = \&recv;
1800 1897
1801=head1 ERROR AND EXCEPTION HANDLING 1898=head1 ERROR AND EXCEPTION HANDLING
1802 1899
1803In general, AnyEvent does not do any error handling - it relies on the 1900In 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 1901caller to do that if required. The L<AnyEvent::Strict> module (see also
1856Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 1953Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1857>>, it is definitely recommended to keep it off in production. Keeping 1954>>, it is definitely recommended to keep it off in production. Keeping
1858C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 1955C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1859can be very useful, however. 1956can be very useful, however.
1860 1957
1958=item C<PERL_ANYEVENT_DEBUG_SHELL>
1959
1960If this env variable is set, then its contents will be
1961interpreted by C<AnyEvent::Socket::parse_hostport> and an
1962C<AnyEvent::Debug::shell> is bound on that port. The shell object is saved
1963in C<$AnyEvent::Debug::SHELL>.
1964
1965For example, to bind a debug shell on a unix domain socket in
1966F</tmp/debug.sock>, you could use this:
1967
1968 PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug.sock perlprog
1969
1970=item C<PERL_ANYEVENT_DEBUG_WRAP>
1971
1972Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
1973debugging purposes. See C<AnyEvent::Debug::wrap> for details.
1974
1861=item C<PERL_ANYEVENT_MODEL> 1975=item C<PERL_ANYEVENT_MODEL>
1862 1976
1863This can be used to specify the event model to be used by AnyEvent, before 1977This 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 1978auto detection and -probing kicks in.
1865entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 1979
1980It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
1981or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1866and the resulting module name is loaded and if the load was successful, 1982resulting 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 1983event model backend. If it fails to load then AnyEvent will proceed with
1868auto detection and -probing. 1984auto detection and -probing.
1869 1985
1870This functionality might change in future versions. 1986If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
1987nothing gets prepended and the module name is used as-is (hint: C<::> at
1988the end of a string designates a module name and quotes it appropriately).
1871 1989
1872For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 1990For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1873could start your program like this: 1991could start your program like this:
1874 1992
1875 PERL_ANYEVENT_MODEL=Perl perl ... 1993 PERL_ANYEVENT_MODEL=Perl perl ...
1876 1994
1877=item C<PERL_ANYEVENT_PROTOCOLS> 1995=item C<PERL_ANYEVENT_PROTOCOLS>
2576 2694
2577=item L<Time::HiRes> 2695=item L<Time::HiRes>
2578 2696
2579This module is part of perl since release 5.008. It will be used when the 2697This 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 2698chosen 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 2699pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2582try to use a monotonic clock for timing stability. 2700try to use a monotonic clock for timing stability.
2583 2701
2584=back 2702=back
2585 2703
2586 2704
2654 2772
2655FAQ: L<AnyEvent::FAQ>. 2773FAQ: L<AnyEvent::FAQ>.
2656 2774
2657Utility functions: L<AnyEvent::Util>. 2775Utility functions: L<AnyEvent::Util>.
2658 2776
2659Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2777Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2660L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2778L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2661 2779
2662Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2780Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2663L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2781L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2664L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2782L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2665L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2783L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines